com.dsi.ant.plugins.antplus.pcc

Class AntPlusBloodPressurePcc

java.lang.Object

com.dsi.ant.plugins.antplus.pccbase.AntPluginPcc

com.dsi.ant.plugins.antplus.pcc.AntPlusBloodPressurePcc

public class AntPlusBloodPressurePcc
extends AntPluginPcc

Enables communication between a client and the BloodPressure plugin service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AntPlusBloodPressurePcc.BloodPressureMeasurement Contains the data of a blood pressure FIT message.
static class	AntPlusBloodPressurePcc.DownloadMeasurementsStatusCode Defines the status codes for the requestDownloadMeasurements(boolean, boolean, com.dsi.ant.plugins.antplus.pcc.AntPlusBloodPressurePcc.IDownloadMeasurementsStatusReceiver, com.dsi.ant.plugins.antplus.pcc.AntPlusBloodPressurePcc.IMeasurementDownloadedReceiver, com.dsi.ant.plugins.antplus.common.AntFsCommon.IAntFsProgressUpdateReceiver) request.
static interface	AntPlusBloodPressurePcc.IDownloadAllHistoryFinishedReceiver Receiver for the DownloadAllHistoryFinished event, which is: Receives the result of a #requestDownloadAllHistory(IDownloadAllHistoryFinishedReceiver, IFitFileDownloadedReceiver, IAntFsProgressUpdateReceiver) command.
static interface	AntPlusBloodPressurePcc.IDownloadMeasurementsStatusReceiver Receiver for the DownloadMeasurementsStatus event, which is: Receives the status of a #requestDownloadMeasurements(boolean, boolean, IDownloadMeasurementsStatusReceiver, IMeasurementDownloadedReceiver, IAntFsProgressUpdateReceiver) request.
static interface	AntPlusBloodPressurePcc.IMeasurementDownloadedReceiver Receiver for the MeasurementDownloaded event, which is: Receives measurements as they are downloaded by a #requestDownloadMeasurements(boolean, boolean, IDownloadMeasurementsStatusReceiver, IMeasurementDownloadedReceiver, IAntFsProgressUpdateReceiver) request.
class	AntPlusBloodPressurePcc.IpcDefines Defines the keys and values used to communicate between the PCC and plugin.
static interface	AntPlusBloodPressurePcc.IResetDataAndSetTimeFinishedReceiver Receiver for the ResetDataAndSetTimeFinished event, which is: Receives the result of a AntPlusBloodPressurePcc#requestResetDataAndSetTime(boolean, IResetDataAndSetTimeFinishedReceiver, IAntFsProgressUpdateReceiver) command.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancelDownloadMeasurementsMonitor() Cancels an open requestDownloadMeasurements in monitorForNewMeasurements mode made by this application.
int	getAntFsManufacturerID() Retrieves the ANT-FS manufacturer ID of the device accessed by this PCC.
static PccReleaseHandle<AntPlusBloodPressurePcc>	requestAccess(Activity userActivity, Context bindToContext, AntPluginPcc.IPluginAccessResultReceiver<AntPlusBloodPressurePcc> resultReceiver, AntPluginPcc.IDeviceStateChangeReceiver stateReceiver) Sends a request to the plugin to access a device and receive a live PCC instance.
static PccReleaseHandle<AntPlusBloodPressurePcc>	requestAccess(Activity userActivity, Context bindToContext, boolean skipPreferredSearch, int searchProximityThreshold, AntPluginPcc.IPluginAccessResultReceiver<AntPlusBloodPressurePcc> resultReceiver, AntPluginPcc.IDeviceStateChangeReceiver stateReceiver) Sends a request to the plugin to access a device and receive a live PCC instance.
static PccReleaseHandle<AntPlusBloodPressurePcc>	requestAccess(Context bindToContext, int antDeviceNumber, int searchProximityThreshold, AntPluginPcc.IPluginAccessResultReceiver<AntPlusBloodPressurePcc> resultReceiver, AntPluginPcc.IDeviceStateChangeReceiver stateReceiver) Sends a request to the plugin to access a device and receive a live PCC instance.
static AsyncScanController<AntPlusBloodPressurePcc>	requestAsyncScanController(Context bindToContext, int searchProximityThreshold, AsyncScanController.IAsyncScanResultReceiver scanResultReceiver) Sends a request to the plugin to start an asynchronous search for available devices.
boolean	requestDownloadMeasurements(boolean downloadNewOnly, boolean monitorForNewMeasurements, AntPlusBloodPressurePcc.IDownloadMeasurementsStatusReceiver downloadMeasurementStatusReceiver, AntPlusBloodPressurePcc.IMeasurementDownloadedReceiver measurementDownloadedReceiver, AntFsCommon.IAntFsProgressUpdateReceiver antFsProgressUpdateRecevier) Requests downloading measurements from the blood pressure device.
boolean	requestResetDataAndSetTime(boolean doSetTime, AntPlusBloodPressurePcc.IResetDataAndSetTimeFinishedReceiver resetDataAndSetTimeFinishedReceiver, AntFsCommon.IAntFsProgressUpdateReceiver antFsProgressUpdateRecevier) Requests the measurement history file to be cleared and optionally updates the device time to the current time.

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

Method Detail

requestAccess

public static PccReleaseHandle<AntPlusBloodPressurePcc> requestAccess(Activity userActivity,
                                                      Context bindToContext,
                                                      boolean skipPreferredSearch,
                                                      int searchProximityThreshold,
                                                      AntPluginPcc.IPluginAccessResultReceiver<AntPlusBloodPressurePcc> resultReceiver,
                                                      AntPluginPcc.IDeviceStateChangeReceiver stateReceiver)

Sends a request to the plugin to access a device and receive a live PCC instance. If the minimum version of the desired plugin is installed, this will start a search for a device to connect to and return the result on the provided result receiver. This method displays a search dialog UI while the search is in progress.

If the user has a preferred device set for this plugin and skipPreferredSearch is not set true, this request will attempt to connect to that device first. Then if the search for the preferred device times-out, the user can choose to retry, cancel, or search for other devices. If there is no preferred device configured or skipPreferredSearch is set to true, the search will begin directly at searching for other devices.During the search for other devices, a list of devices detected in range is presented to the user. Any time during the search the user can select a device from the list to connect to, and can optionally save a name for that device and set it as the preferred device for future searches.

Regardless of how the search proceeds, as soon as a device is connected or if an error occurs or the user cancels then the result will be posted to the supplied result receiver.

Note: During the search this function will display UI elements to display the progress of the search to the user and allow them to interact and control the search. If this is not acceptable to the calling application, then do not use this version of requestAccess().

Parameters:

userActivity - The current foreground activity. Used to display search progress and results.

bindToContext - The context to which the plugin will be bound. Used for plugin lifecycle management.

skipPreferredSearch - True = Don't automatically connect to user's preferred device, but always go to search for other devices.

searchProximityThreshold - It is recommended to always use -1 to use the user's default settings unless your application has a specific reason to do otherwise. This value represents the signal strength 'proximity' requirement on finding matches during searching, if a device does not meet the requirements it will not show up in the search at all. The value is a generic signal strength from 1-10 where 1 is the strongest (ie: closest) and 10 is the lowest(ie: farthest away). 0 = don't use proximity search and -1 = use plugin user-specified default.

resultReceiver - The receiver to receive the results of the request. Possible returns include:

• RequestAccessResult.SUCCESS
• RequestAccessResult.USER_CANCELLED
• RequestAccessResult.CHANNEL_NOT_AVAILABLE
• RequestAccessResult.BAD_PARAMS
• RequestAccessResult.ADAPTER_NOT_DETECTED
• RequestAccessResult.DEPENDENCY_NOT_INSTALLED
• RequestAccessResult.OTHER_FAILURE

stateReceiver - The receiver to receive the state updates of the accessed device, assuming the request is successful. This receiver will receive notifications of all state changes to the device that occur subsequent to the initial state returned in the result receiver.

Returns:

A release handle for the device. This can be used to guarantee the device is properly shutdown and cleaned up, even before the device is actually received through the result receiver.

requestAccess

public static PccReleaseHandle<AntPlusBloodPressurePcc> requestAccess(Activity userActivity,
                                                      Context bindToContext,
                                                      AntPluginPcc.IPluginAccessResultReceiver<AntPlusBloodPressurePcc> resultReceiver,
                                                      AntPluginPcc.IDeviceStateChangeReceiver stateReceiver)

Sends a request to the plugin to access a device and receive a live PCC instance. If the minimum version of the desired plugin is installed, this will start a search for a device to connect to and return the result on the provided result receiver. This method displays a search dialog UI while the search is in progress. This overload calls #requestAccess(Activity, Context, boolean, int, IPluginAccessResultReceiver, IDeviceStateChangeReceiver) with skipPreferrredSearch=false and searchProximityThreshold=-1(user default).

If the user has a preferred device set for this plugin and skipPreferredSearch is not set true, this request will attempt to connect to that device first. Then if the search for the preferred device times-out, the user can choose to retry, cancel, or search for other devices. If there is no preferred device configured or skipPreferredSearch is set to true, the search will begin directly at searching for other devices.During the search for other devices, a list of devices detected in range is presented to the user. Any time during the search the user can select a device from the list to connect to, and can optionally save a name for that device and set it as the preferred device for future searches.

Regardless of how the search proceeds, as soon as a device is connected or if an error occurs or the user cancels then the result will be posted to the supplied result receiver.

Note: During the search this function will display UI elements to display the progress of the search to the user and allow them to interact and control the search. If this is not acceptable to the calling application, then do not use this version of requestAccess().

Parameters:

userActivity - The current foreground activity. Used to display search progress and results.

bindToContext - The context to which the plugin will be bound. Used for plugin lifecycle management.

resultReceiver - The receiver to receive the results of the request. Possible returns include:

• RequestAccessResult.SUCCESS
• RequestAccessResult.USER_CANCELLED
• RequestAccessResult.CHANNEL_NOT_AVAILABLE
• RequestAccessResult.BAD_PARAMS
• RequestAccessResult.ADAPTER_NOT_DETECTED
• RequestAccessResult.DEPENDENCY_NOT_INSTALLED
• RequestAccessResult.OTHER_FAILURE

stateReceiver - The receiver to receive the state updates of the accessed device, assuming the request is successful. This receiver will receive notifications of all state changes to the device that occur subsequent to the initial state returned in the result receiver.

Returns:

A release handle for the device. This can be used to guarantee the device is properly shutdown and cleaned up, even before the device is actually received through the result receiver.

requestAccess

public static PccReleaseHandle<AntPlusBloodPressurePcc> requestAccess(Context bindToContext,
                                                      int antDeviceNumber,
                                                      int searchProximityThreshold,
                                                      AntPluginPcc.IPluginAccessResultReceiver<AntPlusBloodPressurePcc> resultReceiver,
                                                      AntPluginPcc.IDeviceStateChangeReceiver stateReceiver)

Sends a request to the plugin to access a device and receive a live PCC instance. If the minimum version of the desired plugin is installed, this will start an asynchronous search for a device to connect to and return the result on the provided result receiver.

The plugin will attempt to connect to a device with the provided deviceNumber and return a result when the device is connected or the search fails. The search will timeout after 10s, if you wish to keep searching you can call this method again.

Note: If you set deviceNumber to 0 it will connect to the first available/found device.

Parameters:

bindToContext - The context to which the plugin will be bound. Used for plugin lifecycle management.

antDeviceNumber - DeviceNumber to attempt to connect to. A deviceNumber of 0 indicates a desire to connect to first available device.

searchProximityThreshold - This value represents the signal strength 'proximity' requirement on finding matches during searching, if a device does not meet the requirements it will not show up in the search at all. The value is a generic signal strength threshold from 1-10 where 1 is the strongest (ie: closest) and 10 is the lowest(ie: farthest away). 0 = don't use proximity search.

resultReceiver - The receiver to receive the results of the request. Possible returns include:

• RequestAccessResult.SUCCESS
• RequestAccessResult.SEARCH_TIMEOUT
• RequestAccessResult.CHANNEL_NOT_AVAILABLE
• RequestAccessResult.BAD_PARAMS
• RequestAccessResult.ADAPTER_NOT_DETECTED
• RequestAccessResult.DEPENDENCY_NOT_INSTALLED
• RequestAccessResult.OTHER_FAILURE

stateReceiver - The receiver to receive the state updates of the accessed device, assuming the request is successful. This receiver will receive notifications of all state changes to the device that occur subsequent to the initial state returned in the result receiver.

Returns:

A release handle for the device. This can be used to guarantee the device is properly shutdown and cleaned up, even before the device is actually received through the result receiver.

requestAsyncScanController

public static AsyncScanController<AntPlusBloodPressurePcc> requestAsyncScanController(Context bindToContext,
                                                                      int searchProximityThreshold,
                                                                      AsyncScanController.IAsyncScanResultReceiver scanResultReceiver)

Sends a request to the plugin to start an asynchronous search for available devices. Using the returned AsyncScanController you can view available devices (including devices already connected to the plugin by other applications), receive user saved info and preferences for available devices, and eventually request access to a device you desire to connect to.

Note: The scan is started automatically, and must be stopped by your application to avoid resource leaks. (See the controller documentation for more details: AsyncScanController.

Parameters:

bindToContext - The context to which the plugin will be bound. Used for plugin lifecycle management.

searchProximityThreshold - This value represents the signal strength 'proximity' requirement on finding matches during searching, if a device does not meet the requirements it will not show up in the search at all. The value is a generic signal strength rating from 1-10 where 1 is the strongest (ie: closest) and 10 is the lowest(ie: farthest away). 0 = don't use proximity search.

scanResultReceiver - The receiver to receive the info for available devices and status of the scan.

Returns:

The controller object for the asynchronous controller. Note: The scan is started automatically, and must be stopped by your application to avoid resource leaks. (See the controller documentation for more details: AsyncScanController.

getAntFsManufacturerID

public int getAntFsManufacturerID()

Retrieves the ANT-FS manufacturer ID of the device accessed by this PCC.

Returns:

The ANT-FS Manufacturer ID of the device this PCC is accessing. If the value is -1, it means that the manufacturer ID is not available yet, and it should be requested again after a delay.

requestDownloadMeasurements

public boolean requestDownloadMeasurements(boolean downloadNewOnly,
                                  boolean monitorForNewMeasurements,
                                  AntPlusBloodPressurePcc.IDownloadMeasurementsStatusReceiver downloadMeasurementStatusReceiver,
                                  AntPlusBloodPressurePcc.IMeasurementDownloadedReceiver measurementDownloadedReceiver,
                                  AntFsCommon.IAntFsProgressUpdateReceiver antFsProgressUpdateRecevier)

Requests downloading measurements from the blood pressure device. The downloadNewOnly parameter controls downloading only the measurements newer than your app's last successful measurement downloaded through this function. The monitorForNewMeasurements parameter enables this function to continuously monitor for new measurements recorded and return them as they are detected until this request is cancelled.

Parameters:

downloadNewOnly - True to limit the returned measurements to only those which are newer than your last measurement received through this function. False to download all measurements regardless of the time they were created.

monitorForNewMeasurements - False to limit downloading to existing files and automatically close the request when finished downloading. True to continue to monitor the device for new measurements and return them until this request is cancelled. When downloading existing files finishes and monitoring begins, the IDownloadMeasurementsStatusReceiver will receive a PROGRESS_MONITORING code. The monitoring will continue indefinitely until cancelDownloadMeasurementsMonitor is called.

downloadMeasurementStatusReceiver - The receiver to receive the status of the measurement downloads.

measurementDownloadedReceiver - The receiver to receive each measurement from the device as it is downloaded.

antFsProgressUpdateRecevier - Optional. The receiver to receive the state updates of the ANT-FS connection or null. This receiver allows you to monitor the download progress.

Returns:

True if request was submitted successfully and you are guaranteed a result on the result receiver.

Since:

v2.1.1, requires AntPlusPlugins v.2.2.2 or greater.

cancelDownloadMeasurementsMonitor

public boolean cancelDownloadMeasurementsMonitor()

Cancels an open requestDownloadMeasurements in monitorForNewMeasurements mode made by this application. When using the requestDownloadNewMeasurements in monitorForNewMeasurements mode, this command is the only way to cancel that request and stop monitoring.

Returns:

True if the monitoring is cancelled. False if there was an error canceling or no monitoring is open.

Since:

v2.1.1, requires AntPlusPlugins v.2.2.2 or greater. Returns false and returns an UNRECOGNIZED finished code if not supported.

requestResetDataAndSetTime

public boolean requestResetDataAndSetTime(boolean doSetTime,
                                 AntPlusBloodPressurePcc.IResetDataAndSetTimeFinishedReceiver resetDataAndSetTimeFinishedReceiver,
                                 AntFsCommon.IAntFsProgressUpdateReceiver antFsProgressUpdateRecevier)

Requests the measurement history file to be cleared and optionally updates the device time to the current time.

Parameters:

doSetTime - True to update the device time to the current UTC time. False to leave the device time untouched.

resetDataAndSetTimeFinishedReceiver - The receiver to receive the result of the request.

antFsProgressUpdateRecevier - Optional. The receiver to receive the state updates of the ANT-FS connection or null. This receiver allows you to monitor the download progress.

Returns:

True if request was submitted successfully and you are guaranteed a result on the result receiver.

Since:

v2.1.4, requires AntPlusPlugins v.2.2.5 or greater.