com.dsi.ant.plugins.antplus.pccbase

Class AntPlusCommonPcc.IpcDefines

java.lang.Object

com.dsi.ant.plugins.antplus.pccbase.AntPlusCommonPcc.IpcDefines

Enclosing class:

AntPlusCommonPcc

public class AntPlusCommonPcc.IpcDefines
extends java.lang.Object

Defines the keys and values used to communicate between the PCC and plugin. User code should never have to reference these defines.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MSG_CMD_BASECOMMONPAGES_REQUESTCOMMANDBURST_PARAM_arrayByteCOMMANDDATA The command data as defined for the requested command ID.
static java.lang.String	MSG_CMD_BASECOMMONPAGES_REQUESTCOMMANDBURST_PARAM_intREQUESTEDCOMMANDID The ID of the command being requested.
static java.lang.String	MSG_CMD_BASECOMMONPAGES_REQUESTDATAPAGE_PARAM_intREQUESTEDDATAPAGE
static int	MSG_CMD_BASECOMMONPAGES_whatREQUESTCOMMANDBURST Allow a slave device to issue a command to a master device, while providing a means of error checking and resolving ambiguities in case of reception failures.
static int	MSG_CMD_BASECOMMONPAGES_whatREQUESTCOMMANDSTATUS Request confirmation of status of commands sent from a slave to master device
static int	MSG_CMD_BASECOMMONPAGES_whatREQUESTDATAPAGE Generic request for a data page from a device.
static java.lang.String	MSG_EVENT_ALLDATAEVENTS_PARAM_longESTTIMESTAMP The estimated timestamp of when this event was triggered.
static java.lang.String	MSG_EVENT_ALLDATAEVENTS_PARAM_longEVENTFLAGS The informational flags about the event.
static java.lang.String	MSG_EVENT_BASECOMMONPAGES_BATTERYSTATUS_PARAM_decimalBATTERYVOLTAGE Current battery voltage (up to 1/256V resolution).
static java.lang.String	MSG_EVENT_BASECOMMONPAGES_BATTERYSTATUS_PARAM_intBATTERYIDENTIFIER Identifies the battery in system to which this battery status pertains
static java.lang.String	MSG_EVENT_BASECOMMONPAGES_BATTERYSTATUS_PARAM_intBATTERYSTATUSCODE The current reported BatteryStatus.
static java.lang.String	MSG_EVENT_BASECOMMONPAGES_BATTERYSTATUS_PARAM_intCUMULATIVEOPERATINGTIMERESOLUTION The resolution accuracy of the cumulativeOperatingTime.
static java.lang.String	MSG_EVENT_BASECOMMONPAGES_BATTERYSTATUS_PARAM_intNUMBEROFBATTERIES Specifies how many batteries are available in the system
static java.lang.String	MSG_EVENT_BASECOMMONPAGES_BATTERYSTATUS_PARAM_longCUMULATIVEOPERATINGTIME The cumulative operating time since the battery was inserted.
static java.lang.String	MSG_EVENT_BASECOMMONPAGES_GENERICCOMMAND_PARAM_intCOMMANDNUMBER The requested GenericCommandNumber.
static java.lang.String	MSG_EVENT_BASECOMMONPAGES_GENERICCOMMAND_PARAM_intMANUFACTURERID ANT+ Alliance managed manufacturer identifier of the remote control.
static java.lang.String	MSG_EVENT_BASECOMMONPAGES_GENERICCOMMAND_PARAM_intSEQUENCENUMBER Sequence number which increments with each new command received.
static java.lang.String	MSG_EVENT_BASECOMMONPAGES_GENERICCOMMAND_PARAM_intSERIALNUMBER The serial number of the remote control device.
static java.lang.String	MSG_EVENT_BASECOMMONPAGES_MANUFACTURERIDENTIFICATION_PARAM_intHARDWAREREVISION Manufacturer defined.
static java.lang.String	MSG_EVENT_BASECOMMONPAGES_MANUFACTURERIDENTIFICATION_PARAM_intMANUFACTURERID ANT+ Alliance managed manufacturer identifier.
static java.lang.String	MSG_EVENT_BASECOMMONPAGES_MANUFACTURERIDENTIFICATION_PARAM_intMODELNUMBER Manufacturer defined.
static java.lang.String	MSG_EVENT_BASECOMMONPAGES_MANUFACTURERSPECIFICDATA_PARAM_arrayByteRAWDATABYTES The raw eight bytes of the manufacturer specific page.
static java.lang.String	MSG_EVENT_BASECOMMONPAGES_PRODUCTINFORMATION_PARAM_intMAINSOFTWAREREVISION Manufacturer defined main software revision number.
static java.lang.String	MSG_EVENT_BASECOMMONPAGES_PRODUCTINFORMATION_PARAM_intSUPPLEMENTALSOFTWAREREVISION Manufacturer defined supplementary software revision number.
static java.lang.String	MSG_EVENT_BASECOMMONPAGES_PRODUCTINFORMATION_PARAM_longSERIALNUMBER Serial number of the device.
static java.lang.String	MSG_EVENT_BASECOMMONPAGES_REQUESTFINISHED_PARAM_intREQUESTSTATUS
static java.lang.String	MSG_EVENT_BASECOMMONPAGES_RSSI_PARAM_intRSSI
static int	MSG_EVENT_BASECOMMONPAGES_whatBATTERYSTATUS Information about the battery status and operating time.
static int	MSG_EVENT_BASECOMMONPAGES_whatGENERICCOMMAND Generic command received through page 73
static int	MSG_EVENT_BASECOMMONPAGES_whatMANUFACTURERIDENTIFICATION Information about the manufacturer and hardware.
static int	MSG_EVENT_BASECOMMONPAGES_whatMANUFACTURERSPECIFICDATA Manufacturer specific data.
static int	MSG_EVENT_BASECOMMONPAGES_whatPRODUCTINFORMATION Information about the product and software.
static int	MSG_EVENT_BASECOMMONPAGES_whatREQUESTFINISHED Final result of the command requested.
static int	MSG_EVENT_BASECOMMONPAGES_whatRSSI Generic RSSI event.

Constructor Summary

Constructors

Constructor and Description
AntPlusCommonPcc.IpcDefines()

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MSG_EVENT_ALLDATAEVENTS_PARAM_longESTTIMESTAMP

public static final java.lang.String MSG_EVENT_ALLDATAEVENTS_PARAM_longESTTIMESTAMP

The estimated timestamp of when this event was triggered.

See Also:

Constant Field Values

MSG_EVENT_ALLDATAEVENTS_PARAM_longEVENTFLAGS

public static final java.lang.String MSG_EVENT_ALLDATAEVENTS_PARAM_longEVENTFLAGS

The informational flags about the event.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_whatMANUFACTURERIDENTIFICATION

public static final int MSG_EVENT_BASECOMMONPAGES_whatMANUFACTURERIDENTIFICATION

Information about the manufacturer and hardware.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_MANUFACTURERIDENTIFICATION_PARAM_intHARDWAREREVISION

public static final java.lang.String MSG_EVENT_BASECOMMONPAGES_MANUFACTURERIDENTIFICATION_PARAM_intHARDWAREREVISION

Manufacturer defined. Sent in the MSG_EVENT_BASECOMMONPAGES_whatMANUFACTURERIDENTIFICATION event.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_MANUFACTURERIDENTIFICATION_PARAM_intMANUFACTURERID

public static final java.lang.String MSG_EVENT_BASECOMMONPAGES_MANUFACTURERIDENTIFICATION_PARAM_intMANUFACTURERID

ANT+ Alliance managed manufacturer identifier. Sent in the MSG_EVENT_BASECOMMONPAGES_whatMANUFACTURERIDENTIFICATION event.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_MANUFACTURERIDENTIFICATION_PARAM_intMODELNUMBER

public static final java.lang.String MSG_EVENT_BASECOMMONPAGES_MANUFACTURERIDENTIFICATION_PARAM_intMODELNUMBER

Manufacturer defined. Sent in the MSG_EVENT_BASECOMMONPAGES_whatMANUFACTURERIDENTIFICATION event.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_whatPRODUCTINFORMATION

public static final int MSG_EVENT_BASECOMMONPAGES_whatPRODUCTINFORMATION

Information about the product and software.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_PRODUCTINFORMATION_PARAM_intMAINSOFTWAREREVISION

public static final java.lang.String MSG_EVENT_BASECOMMONPAGES_PRODUCTINFORMATION_PARAM_intMAINSOFTWAREREVISION

Manufacturer defined main software revision number. Sent in the MSG_EVENT_BASECOMMONPAGES_whatPRODUCTINFORMATION event.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_PRODUCTINFORMATION_PARAM_intSUPPLEMENTALSOFTWAREREVISION

public static final java.lang.String MSG_EVENT_BASECOMMONPAGES_PRODUCTINFORMATION_PARAM_intSUPPLEMENTALSOFTWAREREVISION

Manufacturer defined supplementary software revision number. Sent in the MSG_EVENT_BASECOMMONPAGES_whatPRODUCTINFORMATION event.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_PRODUCTINFORMATION_PARAM_longSERIALNUMBER

public static final java.lang.String MSG_EVENT_BASECOMMONPAGES_PRODUCTINFORMATION_PARAM_longSERIALNUMBER

Serial number of the device. Sent in the MSG_EVENT_BASECOMMONPAGES_whatPRODUCTINFORMATION event.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_whatBATTERYSTATUS

public static final int MSG_EVENT_BASECOMMONPAGES_whatBATTERYSTATUS

Information about the battery status and operating time.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_BATTERYSTATUS_PARAM_longCUMULATIVEOPERATINGTIME

public static final java.lang.String MSG_EVENT_BASECOMMONPAGES_BATTERYSTATUS_PARAM_longCUMULATIVEOPERATINGTIME

The cumulative operating time since the battery was inserted. Sent in the MSG_EVENT_BASECOMMONPAGES_whatBATTERYSTATUS event.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_BATTERYSTATUS_PARAM_decimalBATTERYVOLTAGE

public static final java.lang.String MSG_EVENT_BASECOMMONPAGES_BATTERYSTATUS_PARAM_decimalBATTERYVOLTAGE

Current battery voltage (up to 1/256V resolution). Sent in the MSG_EVENT_BASECOMMONPAGES_whatBATTERYSTATUS event.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_BATTERYSTATUS_PARAM_intBATTERYSTATUSCODE

public static final java.lang.String MSG_EVENT_BASECOMMONPAGES_BATTERYSTATUS_PARAM_intBATTERYSTATUSCODE

The current reported BatteryStatus. Sent in the MSG_EVENT_BASECOMMONPAGES_whatBATTERYSTATUS event.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_BATTERYSTATUS_PARAM_intCUMULATIVEOPERATINGTIMERESOLUTION

public static final java.lang.String MSG_EVENT_BASECOMMONPAGES_BATTERYSTATUS_PARAM_intCUMULATIVEOPERATINGTIMERESOLUTION

The resolution accuracy of the cumulativeOperatingTime. Sent in the MSG_EVENT_BASECOMMONPAGES_whatBATTERYSTATUS event.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_BATTERYSTATUS_PARAM_intNUMBEROFBATTERIES

public static final java.lang.String MSG_EVENT_BASECOMMONPAGES_BATTERYSTATUS_PARAM_intNUMBEROFBATTERIES

Specifies how many batteries are available in the system

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_BATTERYSTATUS_PARAM_intBATTERYIDENTIFIER

public static final java.lang.String MSG_EVENT_BASECOMMONPAGES_BATTERYSTATUS_PARAM_intBATTERYIDENTIFIER

Identifies the battery in system to which this battery status pertains

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_whatMANUFACTURERSPECIFICDATA

public static final int MSG_EVENT_BASECOMMONPAGES_whatMANUFACTURERSPECIFICDATA

Manufacturer specific data.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_MANUFACTURERSPECIFICDATA_PARAM_arrayByteRAWDATABYTES

public static final java.lang.String MSG_EVENT_BASECOMMONPAGES_MANUFACTURERSPECIFICDATA_PARAM_arrayByteRAWDATABYTES

The raw eight bytes of the manufacturer specific page. Sent in the MSG_EVENT_BASECOMMONPAGES_whatMANUFACTURERSPECIFICDATA event.

See Also:

Constant Field Values

MSG_CMD_BASECOMMONPAGES_whatREQUESTCOMMANDBURST

public static final int MSG_CMD_BASECOMMONPAGES_whatREQUESTCOMMANDBURST

Allow a slave device to issue a command to a master device, while providing a means of error checking and resolving ambiguities in case of reception failures.

See Also:

Constant Field Values

MSG_CMD_BASECOMMONPAGES_REQUESTCOMMANDBURST_PARAM_intREQUESTEDCOMMANDID

public static final java.lang.String MSG_CMD_BASECOMMONPAGES_REQUESTCOMMANDBURST_PARAM_intREQUESTEDCOMMANDID

The ID of the command being requested.

See Also:

Constant Field Values

MSG_CMD_BASECOMMONPAGES_REQUESTCOMMANDBURST_PARAM_arrayByteCOMMANDDATA

public static final java.lang.String MSG_CMD_BASECOMMONPAGES_REQUESTCOMMANDBURST_PARAM_arrayByteCOMMANDDATA

The command data as defined for the requested command ID. It is required to be a multiple of 8 bytes.

See Also:

Constant Field Values

MSG_CMD_BASECOMMONPAGES_whatREQUESTCOMMANDSTATUS

public static final int MSG_CMD_BASECOMMONPAGES_whatREQUESTCOMMANDSTATUS

Request confirmation of status of commands sent from a slave to master device

See Also:

Constant Field Values

MSG_CMD_BASECOMMONPAGES_whatREQUESTDATAPAGE

public static final int MSG_CMD_BASECOMMONPAGES_whatREQUESTDATAPAGE

Generic request for a data page from a device.

See Also:

Constant Field Values

MSG_CMD_BASECOMMONPAGES_REQUESTDATAPAGE_PARAM_intREQUESTEDDATAPAGE

public static final java.lang.String MSG_CMD_BASECOMMONPAGES_REQUESTDATAPAGE_PARAM_intREQUESTEDDATAPAGE

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_whatREQUESTFINISHED

public static final int MSG_EVENT_BASECOMMONPAGES_whatREQUESTFINISHED

Final result of the command requested.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_REQUESTFINISHED_PARAM_intREQUESTSTATUS

public static final java.lang.String MSG_EVENT_BASECOMMONPAGES_REQUESTFINISHED_PARAM_intREQUESTSTATUS

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_whatGENERICCOMMAND

public static final int MSG_EVENT_BASECOMMONPAGES_whatGENERICCOMMAND

Generic command received through page 73

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_GENERICCOMMAND_PARAM_intSERIALNUMBER

public static final java.lang.String MSG_EVENT_BASECOMMONPAGES_GENERICCOMMAND_PARAM_intSERIALNUMBER

The serial number of the remote control device. Sent in the MSG_EVENT_BASECOMMONPAGES_whatGENERICCOMMAND event.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_GENERICCOMMAND_PARAM_intMANUFACTURERID

public static final java.lang.String MSG_EVENT_BASECOMMONPAGES_GENERICCOMMAND_PARAM_intMANUFACTURERID

ANT+ Alliance managed manufacturer identifier of the remote control. Sent in the MSG_EVENT_BASECOMMONPAGES_whatGENERICCOMMAND event.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_GENERICCOMMAND_PARAM_intSEQUENCENUMBER

public static final java.lang.String MSG_EVENT_BASECOMMONPAGES_GENERICCOMMAND_PARAM_intSEQUENCENUMBER

Sequence number which increments with each new command received. Sent in the MSG_EVENT_BASECOMMONPAGES_whatGENERICCOMMAND event.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_GENERICCOMMAND_PARAM_intCOMMANDNUMBER

public static final java.lang.String MSG_EVENT_BASECOMMONPAGES_GENERICCOMMAND_PARAM_intCOMMANDNUMBER

The requested GenericCommandNumber. Sent in the MSG_EVENT_BASECOMMONPAGES_whatGENERICCOMMAND event.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_whatRSSI

public static final int MSG_EVENT_BASECOMMONPAGES_whatRSSI

Generic RSSI event.

See Also:

Constant Field Values

MSG_EVENT_BASECOMMONPAGES_RSSI_PARAM_intRSSI

public static final java.lang.String MSG_EVENT_BASECOMMONPAGES_RSSI_PARAM_intRSSI

See Also:

Constant Field Values

Constructor Detail

AntPlusCommonPcc.IpcDefines

public AntPlusCommonPcc.IpcDefines()