IR Schema

From XAP Automation
Jump to: navigation, search

IR Schema v1.1

This schema describes xAP messages that describe IR signals to be transmitted, and those received. In addition there are some extensions specific to the RedRat series of IR control.

Change History:

  • v1.0 1st June 2004 First released.
  • v1.1 15th June 2004 RedRat extensions modified to use .Info and .Event classes.

Core Schema

Class=IR.Receive

An IR command has been received and recognised by the RR.

IR.Signal
{
Device=[Name of IR Device e.g. SliMP3]
-- mandatory
Signal=[Name of IR signal e.g. Play, Stop, Next]
-- mandatory
}

Class=IR.Transmit

IR.Signal
{
Device=[Name of IR Device e.g. SliMP3]
-- mandatory
Signal=[Name of IR signal e.g. Play, Stop, Next]
-- mandatory
}


IR.Pronto
{
IR=[Pronto IR string of text]
}

RedRat Extension Schema

Class = RedRat.Control

RR2s and RR3s have a red LED to give visual feedback of events e.g. signal output. This causes a blink of this red LED.

Blink
{
}

This sets the enabled/disabled state of the IR detector. A Detector.Event message is generated when this changes.

IR.Detector
{
Enable=[ Yes | No ]
-- mandatory
}

This sets the location information for a particular RedRat, notably its Name field, used in the Address parameters of a xAP message. A copy of the incoming block is sent out again as a Class=RedRat.Control.Event message when the details are updated.

RedRat.Location
{
Name=[New name for the RedRat]
-- optional
Desc=[New location description text]
-- optional
}

This queries the current detector status. A Detector.Info message is sent out as a result of this command.

Detector.Query
{
}

This queries the matching RedRat(s) and sends out a RedRat.Info, RedRat.Version and RedRat.USB (if appropriate) block in the response.

RedRat.Query
{
}

Class=RedRat.Control.Event

This is sent out whenever the IR detector on the RedRat has its status changed.

Detector.Event
{
Enabled=[ Yes | No ]
-- mandatory
}

A RedRat.Location block is sent out whenever the location details for the RedRat are updated.

RedRat.Location
{
Name=[New name for the RedRat]
-- optional
Desc=[New location description text]
-- optional
}

Class=RedRat.Control.Info

This is sent out whenever the status of the IR detector on the RedRat is queried.

Detector.Info
{
Enabled=[ Yes | No | Unknown ]
-- mandatory
}

These next few blocks are sent out whenever a RedRat is queried for its information.

RedRat.Info
{
Name=
Desc=
Serial=
Firmware=
Company=
}


RedRat.Version
{
Major=
Minor=
} 


RedRat.USB
{
ProductName=
Serial=
VendorID=
ProductID=
}