AntPlusCommonPcc

java.lang.Object
- com.dsi.ant.plugins.antplus.pccbase.AntPluginPcc
- - com.dsi.ant.plugins.antplus.pccbase.AntPlusCommonPcc

Direct Known Subclasses:

AntPlusBaseRemoteControlPcc, AntPlusBikePowerPcc, AntPlusEnvironmentPcc, AntPlusFitnessEquipmentPcc, AntPlusStrideSdmPcc, AntPlusWeightScalePcc
```
public abstract class AntPlusCommonPcc
extends AntPluginPcc
```
Adds common pages support to a PCC

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AntPlusCommonPcc.CommonDataPage` ANT+ Common Data Pages
`static interface`	`AntPlusCommonPcc.IBatteryStatusReceiver` Receiver for the BatteryStatus event, which is: Information about the battery status and operating time.
`static interface`	`AntPlusCommonPcc.IManufacturerIdentificationReceiver` Receiver for the ManufacturerIdentification event, which is: Information about the manufacturer and hardware.
`static interface`	`AntPlusCommonPcc.IManufacturerSpecificDataReceiver` Receiver for the ManufacturerSpecificData event, which is: Manufacturer specific data.
`class`	`AntPlusCommonPcc.IpcDefines` Defines the keys and values used to communicate between the PCC and plugin.
`static interface`	`AntPlusCommonPcc.IProductInformationReceiver` Receiver for the ProductInformation event, which is: Information about the product and software.
`static interface`	`AntPlusCommonPcc.IRequestFinishedReceiver` Receiver for the RequestFinished event, which is: Final result of the command requested.
`static interface`	`AntPlusCommonPcc.IRssiReceiver` Receiver for the rssi event, which is: Rssi of received messages.

Nested classes/interfaces inherited from class com.dsi.ant.plugins.antplus.pccbase.AntPluginPcc
AntPluginPcc.IDeviceStateChangeReceiver, AntPluginPcc.IPluginAccessResultReceiver<T extends AntPluginPcc>

Field Summary
- Fields inherited from class com.dsi.ant.plugins.antplus.pccbase.AntPluginPcc
  PATH_ANTPLUS_PLUGINS_PKG

Constructor Summary

Constructors
Constructor and Description

AntPlusCommonPcc()

Constructors
Constructor and Description
`AntPlusCommonPcc()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`requestCommonDataPage(AntPlusCommonPcc.CommonDataPage commonDataPage, AntPlusCommonPcc.IRequestFinishedReceiver requestFinishedReceiver)` Send a request to the device to send the requested `AntPlusCommonPcc.CommonDataPage`.
`void`	`subscribeBatteryStatusEvent(AntPlusCommonPcc.IBatteryStatusReceiver BatteryStatusReceiver)` Subscribe to receive BatteryStatus events, which contain: Information about the battery status and operating time.
`void`	`subscribeManufacturerIdentificationEvent(AntPlusCommonPcc.IManufacturerIdentificationReceiver ManufacturerIdentificationReceiver)` Subscribe to receive ManufacturerIdentification events, which contain: Information about the manufacturer and hardware.
`boolean`	`subscribeManufacturerSpecificDataEvent(AntPlusCommonPcc.IManufacturerSpecificDataReceiver ManufacturerSpecificDataReceiver)` Subscribe to receive ManufacturerSpecificData events, which contain: Manufacturer specific data.
`void`	`subscribeProductInformationEvent(AntPlusCommonPcc.IProductInformationReceiver ProductInformationReceiver)` Subscribe to receive ProductInformation events, which contain: Information about the product and software.
`boolean`	`subscribeRssiEvent(AntPlusCommonPcc.IRssiReceiver RssiReceiver)` Subscribe to receive Rssi events, which contain rssi signal strength data.
`boolean`	`supportsRssi()`

Methods inherited from class com.dsi.ant.plugins.antplus.pccbase.AntPluginPcc
getAntDeviceNumber, getCurrentDeviceState, getDeviceName, getInstalledPluginsVersionNumber, getInstalledPluginsVersionString, getMissingDependencyName, getMissingDependencyPackageName, isUserPreferredDeviceForPlugin, isUserRecognizedDevice, releaseAccess, startPluginManagerActivity

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AntPlusCommonPcc
```
public AntPlusCommonPcc()
```
- Method Detail
  - subscribeManufacturerIdentificationEvent
```
public void subscribeManufacturerIdentificationEvent(AntPlusCommonPcc.IManufacturerIdentificationReceiver ManufacturerIdentificationReceiver)
```
    Subscribe to receive ManufacturerIdentification events, which contain: Information about the manufacturer and hardware. This function can also be used to unsubscribe from an event, by passing null as the receiver.
    
    Parameters:
    ManufacturerIdentificationReceiver - receiver to receive events (or null to unsubscribe from this event).
  - subscribeProductInformationEvent
```
public void subscribeProductInformationEvent(AntPlusCommonPcc.IProductInformationReceiver ProductInformationReceiver)
```
    Subscribe to receive ProductInformation events, which contain: Information about the product and software. This function can also be used to unsubscribe from an event, by passing null as the receiver.
    
    Parameters:
    ProductInformationReceiver - receiver to receive events (or null to unsubscribe from this event).
  - subscribeBatteryStatusEvent
```
public void subscribeBatteryStatusEvent(AntPlusCommonPcc.IBatteryStatusReceiver BatteryStatusReceiver)
```
    Subscribe to receive BatteryStatus events, which contain: Information about the battery status and operating time. This function can also be used to unsubscribe from an event, by passing null as the receiver.
    
    Parameters:
    BatteryStatusReceiver - receiver to receive events (or null to unsubscribe from this event).
  - subscribeManufacturerSpecificDataEvent
```
public boolean subscribeManufacturerSpecificDataEvent(AntPlusCommonPcc.IManufacturerSpecificDataReceiver ManufacturerSpecificDataReceiver)
```
    Subscribe to receive ManufacturerSpecificData events, which contain: Manufacturer specific data. This function can also be used to unsubscribe from an event, by passing null as the receiver.
    
    Parameters:
    ManufacturerSpecificDataReceiver - receiver to receive events (or null to unsubscribe from this event).
    
    Returns:
    true if successful
    Since:
    
    2.1.5; requires Plugin Service 2.2.6+
  - subscribeRssiEvent
```
public boolean subscribeRssiEvent(AntPlusCommonPcc.IRssiReceiver RssiReceiver)
```
    Subscribe to receive Rssi events, which contain rssi signal strength data. This function can also be used to unsubscribe from an event, by passing null as the receiver.
    
    Parameters:
    RssiReceiver - receiver to receive events (or null to unsubscribe from this event).
    
    Returns:
    true if successful
    Since:
    
    3.2.3; requires Plugin Service 3.2.3+
  - requestCommonDataPage
```
public boolean requestCommonDataPage(AntPlusCommonPcc.CommonDataPage commonDataPage,
                            AntPlusCommonPcc.IRequestFinishedReceiver requestFinishedReceiver)
```
    Send a request to the device to send the requested AntPlusCommonPcc.CommonDataPage. This command is optional and may not be supported by all devices. If it is unsupported the device will not respond.
    
    Parameters:
    commonDataPage - The AntPlusCommonPcc.CommonDataPage to be requested from the device.
    requestFinishedReceiver - Receiver for the results of the command request.
    
    Returns:
    True if request was submitted successfully and you are guaranteed a result on the result receiver.
  - supportsRssi
```
public boolean supportsRssi()
```

Class AntPlusCommonPcc

Nested Class Summary

Nested classes/interfaces inherited from class com.dsi.ant.plugins.antplus.pccbase.AntPluginPcc

Field Summary

Fields inherited from class com.dsi.ant.plugins.antplus.pccbase.AntPluginPcc

Constructor Summary

Method Summary

Methods inherited from class com.dsi.ant.plugins.antplus.pccbase.AntPluginPcc

Methods inherited from class java.lang.Object

Constructor Detail

AntPlusCommonPcc

Method Detail

subscribeManufacturerIdentificationEvent

subscribeProductInformationEvent

subscribeBatteryStatusEvent

subscribeManufacturerSpecificDataEvent

subscribeRssiEvent

requestCommonDataPage

supportsRssi