com.dsi.ant.plugins.antplus.pcc

Class AntPlusWeightScalePcc.IpcDefines

java.lang.Object

com.dsi.ant.plugins.antplus.pcc.AntPlusWeightScalePcc.IpcDefines

Enclosing class:

AntPlusWeightScalePcc

public class AntPlusWeightScalePcc.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 int	MSG_CMD_WEIGHTSCALE_whatREQUESTADVANCEDMEASUREMENT Requests advanced weight measurements for the given user from the scale.
static int	MSG_CMD_WEIGHTSCALE_whatREQUESTBASICMEASUREMENT Requests a basic weight measurement from the scale.
static int	MSG_CMD_WEIGHTSCALE_whatREQUESTCAPABILITIES Requests the capabilities of weight scale and the identifier of the currently 'selected' user profile, if any.
static int	MSG_CMD_WEIGHTSCALE_whatREQUESTDOWNLOADALLHISTORY Requests a download of all of the history data from the device.
static java.lang.String	MSG_EVENT_WEIGHTSCALE_ADVANCEDMEASUREMENTFINISHED_PARAM_intSTATUSCODE The AntPlusWeightScalePcc.WeightScaleRequestStatus defining the result of the measurement task.
static java.lang.String	MSG_EVENT_WEIGHTSCALE_BASICMEASUREMENTFINISHED_PARAM_decimalBODYWEIGHT Body weight value, -1 = 'Invalid', null if request was unsuccessful.
static java.lang.String	MSG_EVENT_WEIGHTSCALE_BASICMEASUREMENTFINISHED_PARAM_intSTATUSCODE The AntPlusWeightScalePcc.WeightScaleRequestStatus defining the result of the measurement task.
static java.lang.String	MSG_EVENT_WEIGHTSCALE_BODYWEIGHTBROADCAST_PARAM_decimalBODYWEIGHT Body weight value of current broadcast.
static java.lang.String	MSG_EVENT_WEIGHTSCALE_BODYWEIGHTBROADCAST_PARAM_intBODYWEIGHTSTATUS The AntPlusWeightScalePcc.BodyWeightStatus of the current broadcast.
static java.lang.String	MSG_EVENT_WEIGHTSCALE_CAPABILITIESREQUESTFINISHED_PARAM_boolHISTORYSUPPORT Indicates if scale supports storage and download of measurement history.
static java.lang.String	MSG_EVENT_WEIGHTSCALE_CAPABILITIESREQUESTFINISHED_PARAM_boolUSERPROFILEEXCHANGESUPPORT Indicates if scale supports receiving a user profile.
static java.lang.String	MSG_EVENT_WEIGHTSCALE_CAPABILITIESREQUESTFINISHED_PARAM_boolUSERPROFILESELECTED Indicates if a user profile has been 'selected' on the scale.
static java.lang.String	MSG_EVENT_WEIGHTSCALE_CAPABILITIESREQUESTFINISHED_PARAM_intSTATUSCODE The AntPlusWeightScalePcc.WeightScaleRequestStatus defining the result of the request.
static java.lang.String	MSG_EVENT_WEIGHTSCALE_CAPABILITIESREQUESTFINISHED_PARAM_intUSERPROFILEID the user identifier of the scale's currently 'selected' user profile, -1 = 'Unassigned'.
static java.lang.String	MSG_EVENT_WEIGHTSCALE_DOWNLOADALLHISTORYFINISHED_PARAM_intSTATUSCODE The AntFsCommon.AntFsRequestStatusCode indicating the result of the request.
static int	MSG_EVENT_WEIGHTSCALE_whatADVANCEDMEASUREMENTFINISHED Receives the result of an advanced measurement request.
static int	MSG_EVENT_WEIGHTSCALE_whatBASICMEASUREMENTFINISHED Receives the result of a basic measurement request.
static int	MSG_EVENT_WEIGHTSCALE_whatBODYWEIGHTBROADCAST The weight value currently broadcast by the weight scale.
static int	MSG_EVENT_WEIGHTSCALE_whatCAPABILITIESREQUESTFINISHED Receives the result of a capabilities request.
static int	MSG_EVENT_WEIGHTSCALE_whatDOWNLOADALLHISTORYFINISHED Receives the result of a #requestDownloadAllHistory(IDownloadAllHistoryFinishedReceiver, IFitFileDownloadedReceiver, IAntFsProgressUpdateReceiver) command.
static java.lang.String	PATH_ANTPLUS_WEIGHTSCALEPLUGIN_PKG The plugin package path.
static java.lang.String	PATH_ANTPLUS_WEIGHTSCALEPLUGIN_SERVICE The plugin service path.

Constructor Summary

Constructors

Constructor and Description
AntPlusWeightScalePcc.IpcDefines()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

PATH_ANTPLUS_WEIGHTSCALEPLUGIN_PKG

public static final java.lang.String PATH_ANTPLUS_WEIGHTSCALEPLUGIN_PKG

The plugin package path.

See Also:

Constant Field Values

PATH_ANTPLUS_WEIGHTSCALEPLUGIN_SERVICE

public static final java.lang.String PATH_ANTPLUS_WEIGHTSCALEPLUGIN_SERVICE

The plugin service path.

See Also:

Constant Field Values

MSG_EVENT_WEIGHTSCALE_whatBASICMEASUREMENTFINISHED

public static final int MSG_EVENT_WEIGHTSCALE_whatBASICMEASUREMENTFINISHED

Receives the result of a basic measurement request.

See Also:

Constant Field Values

MSG_EVENT_WEIGHTSCALE_BASICMEASUREMENTFINISHED_PARAM_intSTATUSCODE

public static final java.lang.String MSG_EVENT_WEIGHTSCALE_BASICMEASUREMENTFINISHED_PARAM_intSTATUSCODE

The AntPlusWeightScalePcc.WeightScaleRequestStatus defining the result of the measurement task. Sent in the MSG_EVENT_WEIGHTSCALE_whatBASICMEASUREMENTFINISHED event.

See Also:

Constant Field Values

MSG_EVENT_WEIGHTSCALE_BASICMEASUREMENTFINISHED_PARAM_decimalBODYWEIGHT

public static final java.lang.String MSG_EVENT_WEIGHTSCALE_BASICMEASUREMENTFINISHED_PARAM_decimalBODYWEIGHT

Body weight value, -1 = 'Invalid', null if request was unsuccessful. Sent in the MSG_EVENT_WEIGHTSCALE_whatBASICMEASUREMENTFINISHED event.

See Also:

Constant Field Values

MSG_EVENT_WEIGHTSCALE_whatADVANCEDMEASUREMENTFINISHED

public static final int MSG_EVENT_WEIGHTSCALE_whatADVANCEDMEASUREMENTFINISHED

Receives the result of an advanced measurement request.

See Also:

Constant Field Values

MSG_EVENT_WEIGHTSCALE_ADVANCEDMEASUREMENTFINISHED_PARAM_intSTATUSCODE

public static final java.lang.String MSG_EVENT_WEIGHTSCALE_ADVANCEDMEASUREMENTFINISHED_PARAM_intSTATUSCODE

The AntPlusWeightScalePcc.WeightScaleRequestStatus defining the result of the measurement task. Sent in the MSG_EVENT_WEIGHTSCALE_whatADVANCEDMEASUREMENTFINISHED event.

See Also:

Constant Field Values

MSG_EVENT_WEIGHTSCALE_whatCAPABILITIESREQUESTFINISHED

public static final int MSG_EVENT_WEIGHTSCALE_whatCAPABILITIESREQUESTFINISHED

Receives the result of a capabilities request.

See Also:

Constant Field Values

MSG_EVENT_WEIGHTSCALE_CAPABILITIESREQUESTFINISHED_PARAM_intSTATUSCODE

public static final java.lang.String MSG_EVENT_WEIGHTSCALE_CAPABILITIESREQUESTFINISHED_PARAM_intSTATUSCODE

The AntPlusWeightScalePcc.WeightScaleRequestStatus defining the result of the request. Sent in the MSG_EVENT_WEIGHTSCALE_whatCAPABILITIESREQUESTFINISHED event.

See Also:

Constant Field Values

MSG_EVENT_WEIGHTSCALE_CAPABILITIESREQUESTFINISHED_PARAM_intUSERPROFILEID

public static final java.lang.String MSG_EVENT_WEIGHTSCALE_CAPABILITIESREQUESTFINISHED_PARAM_intUSERPROFILEID

the user identifier of the scale's currently 'selected' user profile, -1 = 'Unassigned'. Sent in the MSG_EVENT_WEIGHTSCALE_whatCAPABILITIESREQUESTFINISHED event.

See Also:

Constant Field Values

MSG_EVENT_WEIGHTSCALE_CAPABILITIESREQUESTFINISHED_PARAM_boolHISTORYSUPPORT

public static final java.lang.String MSG_EVENT_WEIGHTSCALE_CAPABILITIESREQUESTFINISHED_PARAM_boolHISTORYSUPPORT

Indicates if scale supports storage and download of measurement history. Sent in the MSG_EVENT_WEIGHTSCALE_whatCAPABILITIESREQUESTFINISHED event.

See Also:

Constant Field Values

MSG_EVENT_WEIGHTSCALE_CAPABILITIESREQUESTFINISHED_PARAM_boolUSERPROFILEEXCHANGESUPPORT

public static final java.lang.String MSG_EVENT_WEIGHTSCALE_CAPABILITIESREQUESTFINISHED_PARAM_boolUSERPROFILEEXCHANGESUPPORT

Indicates if scale supports receiving a user profile. Sent in the MSG_EVENT_WEIGHTSCALE_whatCAPABILITIESREQUESTFINISHED event.

See Also:

Constant Field Values

MSG_EVENT_WEIGHTSCALE_CAPABILITIESREQUESTFINISHED_PARAM_boolUSERPROFILESELECTED

public static final java.lang.String MSG_EVENT_WEIGHTSCALE_CAPABILITIESREQUESTFINISHED_PARAM_boolUSERPROFILESELECTED

Indicates if a user profile has been 'selected' on the scale. The 'selected' profile is used to calculate advanced body measurements in the absence of an application-provided profile. Sent in the MSG_EVENT_WEIGHTSCALE_whatCAPABILITIESREQUESTFINISHED event.

See Also:

Constant Field Values

MSG_EVENT_WEIGHTSCALE_whatDOWNLOADALLHISTORYFINISHED

public static final int MSG_EVENT_WEIGHTSCALE_whatDOWNLOADALLHISTORYFINISHED

Receives the result of a #requestDownloadAllHistory(IDownloadAllHistoryFinishedReceiver, IFitFileDownloadedReceiver, IAntFsProgressUpdateReceiver) command.

See Also:

Constant Field Values

MSG_EVENT_WEIGHTSCALE_DOWNLOADALLHISTORYFINISHED_PARAM_intSTATUSCODE

public static final java.lang.String MSG_EVENT_WEIGHTSCALE_DOWNLOADALLHISTORYFINISHED_PARAM_intSTATUSCODE

The AntFsCommon.AntFsRequestStatusCode indicating the result of the request. Sent in the MSG_EVENT_WEIGHTSCALE_whatDOWNLOADALLHISTORYFINISHED event.

See Also:

Constant Field Values

MSG_EVENT_WEIGHTSCALE_whatBODYWEIGHTBROADCAST

public static final int MSG_EVENT_WEIGHTSCALE_whatBODYWEIGHTBROADCAST

The weight value currently broadcast by the weight scale. This event is useful for dynamic value scale and specialized scenarios, but most applictions should preferably use the request methods for greater conveniences.

See Also:

Constant Field Values

MSG_EVENT_WEIGHTSCALE_BODYWEIGHTBROADCAST_PARAM_intBODYWEIGHTSTATUS

public static final java.lang.String MSG_EVENT_WEIGHTSCALE_BODYWEIGHTBROADCAST_PARAM_intBODYWEIGHTSTATUS

The AntPlusWeightScalePcc.BodyWeightStatus of the current broadcast. The bodyWeight parameter will only be non-null if this parameter is AntPlusWeightScalePcc.BodyWeightStatus.VALID. Sent in the MSG_EVENT_WEIGHTSCALE_whatBODYWEIGHTBROADCAST event.

See Also:

Constant Field Values

MSG_EVENT_WEIGHTSCALE_BODYWEIGHTBROADCAST_PARAM_decimalBODYWEIGHT

public static final java.lang.String MSG_EVENT_WEIGHTSCALE_BODYWEIGHTBROADCAST_PARAM_decimalBODYWEIGHT

Body weight value of current broadcast. Sent in the MSG_EVENT_WEIGHTSCALE_whatBODYWEIGHTBROADCAST event.

See Also:

Constant Field Values

MSG_CMD_WEIGHTSCALE_whatREQUESTBASICMEASUREMENT

public static final int MSG_CMD_WEIGHTSCALE_whatREQUESTBASICMEASUREMENT

Requests a basic weight measurement from the scale.

See Also:

Constant Field Values

MSG_CMD_WEIGHTSCALE_whatREQUESTADVANCEDMEASUREMENT

public static final int MSG_CMD_WEIGHTSCALE_whatREQUESTADVANCEDMEASUREMENT

Requests advanced weight measurements for the given user from the scale. The advanced measurements will only be calculated when a valid user profile is available to the weight scale; this requires a scale that supports device profiles, and for a user profile to be provided in this function or for the scale to have a user profile already 'selected'. Note: If you specify a user profile for this request and the weight scale supports user profiles, it should set the given profile as the new 'selected' profile.

See Also:

Constant Field Values

MSG_CMD_WEIGHTSCALE_whatREQUESTCAPABILITIES

public static final int MSG_CMD_WEIGHTSCALE_whatREQUESTCAPABILITIES

Requests the capabilities of weight scale and the identifier of the currently 'selected' user profile, if any.

See Also:

Constant Field Values

MSG_CMD_WEIGHTSCALE_whatREQUESTDOWNLOADALLHISTORY

public static final int MSG_CMD_WEIGHTSCALE_whatREQUESTDOWNLOADALLHISTORY

Requests a download of all of the history data from the device.

See Also:

Constant Field Values

Constructor Detail

AntPlusWeightScalePcc.IpcDefines

public AntPlusWeightScalePcc.IpcDefines()