Package com.dsi.ant.plugins.antplus.pcc
Class AntPlusGeocachePcc.IpcDefines
java.lang.Object
com.dsi.ant.plugins.antplus.pcc.AntPlusGeocachePcc.IpcDefines
- Enclosing class:
- AntPlusGeocachePcc
Defines the keys and values used to communicate between the PCC and plugin.
User code should never have to reference these defines.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Random or pseudo-random number from 0-65535 that will be hashed by the geocache to produce an authentication token.static final String
Serial number of the GPS receiver.static final String
If true, notifies the plugin to update the logged visits data to include this 'visit'.static final String
If true, all current data on the device will be erased, and the device will be programmed with only the data provided in programmingData (which therefore must include the minimum required data).static final String
This PIN must match the current PIN on the device if it is set.static final String
If true, notifies the plugin to send progress updates.static final String
The deviceID of the target device to make the request on.static final int
Requests the specified device to generate an auth token.static final int
Requests the current device list.static final int
Requests the data available from the specified device.static final int
Requests the plugin to program the specified device with the provided data.static final String
TheAntPlusGeocachePcc.GeocacheRequestStatus
defining the result of the authentication token request.static final String
The authentication token sent by the device, or -1 if the request was unsuccessful.static final String
Devices currently available to connect to.static final String
The character identification of devices in the current devices list.static final String
AAntPlusGeocachePcc.DeviceChangingCode
indicating what is changing on the list.static final String
The device ID of a device that has changed according to the changeCode or -1 if N/A for current code.static final String
The complete set of data downloaded from the device or null if the download was unsuccessful.static final String
TheAntPlusGeocachePcc.GeocacheRequestStatus
defining the result of the download.static final String
TheAntPlusGeocachePcc.GeocacheRequestStatus
defining the result of the programming task.static final String
The total number of work units to finish in the given task.static final String
The current number of work units finished.static final int
Receives the result of a finished authentication token request.static final int
Broadcasts the current list of devices available to connect to along with information identifying any change since the last update, if applicable.static final int
Receives the result of a finished data download.static final int
Receives the result of a finished programming task.static final int
Communicates the work done.static final int
Geocache specific parameter to request access to the geocache singletonstatic final String
The plugin package path.static final String
The plugin service path. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
PATH_ANTPLUS_GEOCACHEPLUGIN_PKG
The plugin package path.- See Also:
-
PATH_ANTPLUS_GEOCACHEPLUGIN_SERVICE
The plugin service path.- See Also:
-
MSG_REQACC_PARAM_MODE_iCONTINUOUSSEARCH
public static final int MSG_REQACC_PARAM_MODE_iCONTINUOUSSEARCHGeocache specific parameter to request access to the geocache singleton- See Also:
-
MSG_EVENT_GEOCACHE_whatAVAILABLEDEVICELIST
public static final int MSG_EVENT_GEOCACHE_whatAVAILABLEDEVICELISTBroadcasts the current list of devices available to connect to along with information identifying any change since the last update, if applicable.- See Also:
-
MSG_EVENT_GEOCACHE_AVAILABLEDEVICELIST_PARAM_arrayIntDEVICEIDS
Devices currently available to connect to. Sent in theMSG_EVENT_GEOCACHE_whatAVAILABLEDEVICELIST
event.- See Also:
-
MSG_EVENT_GEOCACHE_AVAILABLEDEVICELIST_PARAM_arrayStringDEVICEIDENTIFIERSTRINGS
public static final String MSG_EVENT_GEOCACHE_AVAILABLEDEVICELIST_PARAM_arrayStringDEVICEIDENTIFIERSTRINGSThe character identification of devices in the current devices list. Note: The length of this array and the indices correlate directly with the currentDevices list. Sent in theMSG_EVENT_GEOCACHE_whatAVAILABLEDEVICELIST
event.- See Also:
-
MSG_EVENT_GEOCACHE_AVAILABLEDEVICELIST_PARAM_intCHANGECODE
AAntPlusGeocachePcc.DeviceChangingCode
indicating what is changing on the list. Sent in theMSG_EVENT_GEOCACHE_whatAVAILABLEDEVICELIST
event.- See Also:
-
MSG_EVENT_GEOCACHE_AVAILABLEDEVICELIST_PARAM_intCHANGINGDEVICEID
The device ID of a device that has changed according to the changeCode or -1 if N/A for current code. Sent in theMSG_EVENT_GEOCACHE_whatAVAILABLEDEVICELIST
event.- See Also:
-
MSG_EVENT_GEOCACHE_whatSIMPLEPROGRESSUPDATE
public static final int MSG_EVENT_GEOCACHE_whatSIMPLEPROGRESSUPDATECommunicates the work done. The percentage of work done is 100*(workUnitsFinished/totalUnitsWork).- See Also:
-
MSG_EVENT_GEOCACHE_SIMPLEPROGRESSUPDATE_PARAM_intWORKUNITSFINISHED
The current number of work units finished. Sent in theMSG_EVENT_GEOCACHE_whatSIMPLEPROGRESSUPDATE
event.- See Also:
-
MSG_EVENT_GEOCACHE_SIMPLEPROGRESSUPDATE_PARAM_intTOTALUNITSWORK
The total number of work units to finish in the given task. Sent in theMSG_EVENT_GEOCACHE_whatSIMPLEPROGRESSUPDATE
event.- See Also:
-
MSG_EVENT_GEOCACHE_whatPROGRAMMINGFINISHED
public static final int MSG_EVENT_GEOCACHE_whatPROGRAMMINGFINISHEDReceives the result of a finished programming task.- See Also:
-
MSG_EVENT_GEOCACHE_PROGRAMMINGFINISHED_PARAM_intSTATUSCODE
TheAntPlusGeocachePcc.GeocacheRequestStatus
defining the result of the programming task. Sent in theMSG_EVENT_GEOCACHE_whatPROGRAMMINGFINISHED
event.- See Also:
-
MSG_EVENT_GEOCACHE_whatDATADOWNLOADFINISHED
public static final int MSG_EVENT_GEOCACHE_whatDATADOWNLOADFINISHEDReceives the result of a finished data download.- See Also:
-
MSG_EVENT_GEOCACHE_DATADOWNLOADFINISHED_PARAM_intSTATUSCODE
TheAntPlusGeocachePcc.GeocacheRequestStatus
defining the result of the download. Sent in theMSG_EVENT_GEOCACHE_whatDATADOWNLOADFINISHED
event.- See Also:
-
MSG_EVENT_GEOCACHE_DATADOWNLOADFINISHED_PARAM_bundleDOWNLOADEDDATA
The complete set of data downloaded from the device or null if the download was unsuccessful. To see what data is present on the device iterate through theBaseBundle.keySet()
comparing with the keys defined inAntPlusGeocachePcc.GeocacheDeviceData
. Sent in theMSG_EVENT_GEOCACHE_whatDATADOWNLOADFINISHED
event.- See Also:
-
MSG_EVENT_GEOCACHE_whatAUTHTOKENREQUESTFINISHED
public static final int MSG_EVENT_GEOCACHE_whatAUTHTOKENREQUESTFINISHEDReceives the result of a finished authentication token request.- See Also:
-
MSG_EVENT_GEOCACHE_AUTHTOKENREQUESTFINISHED_PARAM_intSTATUSCODE
TheAntPlusGeocachePcc.GeocacheRequestStatus
defining the result of the authentication token request. Sent in theMSG_EVENT_GEOCACHE_whatAUTHTOKENREQUESTFINISHED
event.- See Also:
-
MSG_EVENT_GEOCACHE_AUTHTOKENREQUESTFINISHED_PARAM_longAUTHTOKEN
The authentication token sent by the device, or -1 if the request was unsuccessful. Sent in theMSG_EVENT_GEOCACHE_whatAUTHTOKENREQUESTFINISHED
event.- See Also:
-
MSG_CMD_GEOCACHE_whatREQUESTCURRENTDEVICELIST
public static final int MSG_CMD_GEOCACHE_whatREQUESTCURRENTDEVICELISTRequests the current device list. The list will come in on the receiver passed toAntPlusGeocachePcc.requestListAndRequestAccess(Context, IPluginAccessResultReceiver, IDeviceStateChangeReceiver, IAvailableDeviceListReceiver)
.- See Also:
-
MSG_CMD_GEOCACHE_whatREQUESTDEVICEDATA
public static final int MSG_CMD_GEOCACHE_whatREQUESTDEVICEDATARequests the data available from the specified device.- See Also:
-
MSG_CMD_GEOCACHE_REQUESTDEVICEDATA_PARAM_boolUPDATEVISITCOUNT
If true, notifies the plugin to update the logged visits data to include this 'visit'. Devices will only be auto-updated once during any period the plugin detects it is within range regardless of how many times this flag is set, so always setting this flag to true is recommended. Sent in theMSG_CMD_GEOCACHE_whatREQUESTDEVICEDATA
command.- See Also:
-
MSG_CMD_GEOCACHE_whatREQUESTAUTHTOKEN
public static final int MSG_CMD_GEOCACHE_whatREQUESTAUTHTOKENRequests the specified device to generate an auth token.- See Also:
-
MSG_CMD_GEOCACHE_REQUESTAUTHTOKEN_PARAM_intNONCE
Random or pseudo-random number from 0-65535 that will be hashed by the geocache to produce an authentication token. Sent in theMSG_CMD_GEOCACHE_whatREQUESTAUTHTOKEN
command.- See Also:
-
MSG_CMD_GEOCACHE_REQUESTAUTHTOKEN_PARAM_longSERIALNUMBER
Serial number of the GPS receiver. Sent in theMSG_CMD_GEOCACHE_whatREQUESTAUTHTOKEN
command.- See Also:
-
MSG_CMD_GEOCACHE_whatREQUESTDEVICEPROGRAMMING
public static final int MSG_CMD_GEOCACHE_whatREQUESTDEVICEPROGRAMMINGRequests the plugin to program the specified device with the provided data. If the device is not programmed, the minimum required data must be sent in the programmingData bundle. But, if the device is already programmed, the existing data will be overwritten according to the behaviour defined by the clearAllExistingData parameter.- See Also:
-
MSG_CMD_GEOCACHE_REQUESTDEVICEPROGRAMMING_PARAM_longPROGRAMMINGPIN
This PIN must match the current PIN on the device if it is set. If the device's PIN is not set, the value of this parameter is not used.- See Also:
-
MSG_CMD_GEOCACHE_REQUESTDEVICEPROGRAMMING_PARAM_boolCLEARALLEXISTINGDATA
If true, all current data on the device will be erased, and the device will be programmed with only the data provided in programmingData (which therefore must include the minimum required data). If false, allows for partial data update where all existing non-provided data fields will be maintained on the device and only provided data fields are overwritten. If the device is not programmed this parameter is ignored. Sent in theMSG_CMD_GEOCACHE_whatREQUESTDEVICEPROGRAMMING
command.- See Also:
-
MSG_CMD_GEOCACHE_REQUESTS_PARAM_boolSUBSCRIBEPROGRESSUPDATES
If true, notifies the plugin to send progress updates.- See Also:
-
MSG_CMD_GEOCACHE_REQUESTS_PARAM_intTARGETDEVICEID
The deviceID of the target device to make the request on.- See Also:
-
-
Constructor Details
-
IpcDefines
public IpcDefines()
-