com.dsi.ant.plugins.antplus.pccbase

Class AntPluginPcc

java.lang.Object

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

Direct Known Subclasses:

AntPlusBaseControllableDevicePcc, AntPlusBloodPressurePcc, AntPlusCommonPcc, AntPlusGeocachePcc, AntPlusLegacyCommonPcc, AntPlusWatchDownloaderPcc

public abstract class AntPluginPcc
extends java.lang.Object

Defines the base interface and common routines to all PCCs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AntPluginPcc.IDeviceStateChangeReceiver Allows clients to receive state updates of an accessed device.
static interface	AntPluginPcc.IPluginAccessResultReceiver<T extends AntPluginPcc> Allows clients to receive the results from all the access request functions.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PATH_ANTPLUS_PLUGINS_PKG The official ANT+ plugins package name

Constructor Summary

Constructors

Constructor and Description
AntPluginPcc()

Method Summary

Methods

Modifier and Type	Method and Description
int	getAntDeviceNumber() Retrieves the deviceNumber of the device accessed by this PCC.
DeviceState	getCurrentDeviceState() Retrieves the current device state.
java.lang.String	getDeviceName() Retrieves a display friendly name for the device accessed by this PCC.
static int	getInstalledPluginsVersionNumber(Context currentContext) Returns the version code of the installed plugins package or -1 if not installed or -2 if disabled.
static java.lang.String	getInstalledPluginsVersionString(Context currentContext) Returns the version string of the installed plugins package or null if not installed.
static java.lang.String	getMissingDependencyName() Retrieves the display name of the last reported missing dependency.
static java.lang.String	getMissingDependencyPackageName() Retrieves the package name of the last reported missing dependency.
boolean	isUserPreferredDeviceForPlugin() Returns a value indicating if this device is set as the preferred device for this plugin type in the user's device database.
boolean	isUserRecognizedDevice() Returns a value indicating if this device has been saved to the user's device database.
void	releaseAccess() Signals plugin to release our access to the device and shuts down this PCC.
static boolean	startPluginManagerActivity(Activity activity) Launches the ANT+ Plugin Manager.

Methods inherited from class java.lang.Object

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

Field Detail

PATH_ANTPLUS_PLUGINS_PKG

public static final java.lang.String PATH_ANTPLUS_PLUGINS_PKG

The official ANT+ plugins package name

See Also:

Constant Field Values

Constructor Detail

AntPluginPcc

public AntPluginPcc()

Method Detail

getInstalledPluginsVersionNumber

public static int getInstalledPluginsVersionNumber(Context currentContext)

Returns the version code of the installed plugins package or -1 if not installed or -2 if disabled.

Parameters:

currentContext - A valid context (to access the Android package manager)

Returns:

The version code of the installed plugins package or -1 if not installed or -2 if disabled.

getInstalledPluginsVersionString

public static java.lang.String getInstalledPluginsVersionString(Context currentContext)

Returns the version string of the installed plugins package or null if not installed.

Parameters:

currentContext - A valid context (to access the Android package manager)

Returns:

The version string of the installed plugins package or null if not installed.

startPluginManagerActivity

public static boolean startPluginManagerActivity(Activity activity)

Launches the ANT+ Plugin Manager. The ANT+ Plugin Manager provides access to view and modify devices saved in the plugin device database and control default plugin settings. It is also available as a stand alone application, but the ability to launch it from your own application is useful in situations where a user wants extra convenience or doesn't already have the stand alone launcher installed. For example, you could place this launch command in your application's own settings menu.

Parameters:

activity - The activity to launch the plugin manager activity from.

Returns:

True if ANT+ Plugins is installed and enabled and the activity will successfully start. False if ANT+ Plugins is not installed or not enabled and the activity will fail to start.

getMissingDependencyPackageName

public static java.lang.String getMissingDependencyPackageName()

Retrieves the package name of the last reported missing dependency. When the result of requesting access is RequestAccessResult.DEPENDENCY_NOT_INSTALLED, this function can be used to retrieve the package name of the missing required package. This package name can be used to acquire the required package from the Play Store or elsewhere.

Returns:

The package name of the last reported missing dependency.

getMissingDependencyName

public static java.lang.String getMissingDependencyName()

Retrieves the display name of the last reported missing dependency. When the result of requesting access is RequestAccessResult.DEPENDENCY_NOT_INSTALLED, this function can be used to retrieve the display name of the missing required package. This name can be used to display to the user the missing dependency.

Returns:

The display name of the last reported missing dependency.

getDeviceName

public java.lang.String getDeviceName()

Retrieves a display friendly name for the device accessed by this PCC. This name is the user's saved name if this device is saved in the user's device database, or a generated name if it isn't.

Returns:

The name of the device this PCC is accessing.

getAntDeviceNumber

public int getAntDeviceNumber()

Retrieves the deviceNumber of the device accessed by this PCC.

Returns:

The ANT channel deviceNumber of the device this PCC is accessing. If the value is negative it means the plugin does not support this function.

isUserRecognizedDevice

public boolean isUserRecognizedDevice()

Returns a value indicating if this device has been saved to the user's device database.

Returns:

True if the device is saved in the user's device database.

isUserPreferredDeviceForPlugin

public boolean isUserPreferredDeviceForPlugin()

Returns a value indicating if this device is set as the preferred device for this plugin type in the user's device database.

Returns:

True if the device is set as the preferred device for this plugin.

getCurrentDeviceState

public DeviceState getCurrentDeviceState()

Retrieves the current device state.

Returns:

The DeviceState of the current device state.

releaseAccess

public void releaseAccess()

Signals plugin to release our access to the device and shuts down this PCC. This function should be called to close every PCC obtained in a successful access request when an application is done using the PCC or the application is closing. Note: This is equivalent to calling PccReleaseHandle.close()