Wahoo Fitness API  3.6.1
Documentation for the iPhone version of the Wahoo Fitness API.
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Pages
WFHeartrateConnection Class Reference

Represents a connection to an ANT+ Heart Rate Monitor sensor. More...

#import <WFHeartrateConnection.h>

+ Inheritance diagram for WFHeartrateConnection:
+ Collaboration diagram for WFHeartrateConnection:

Instance Methods

(void) - disconnect
 Disconnects the sensor. More...
 
(void) - disconnect:
 Disconnects the sensor and for BTLE peripheral, ensures the BTLE connection is closed. More...
 
(WFSensorData *) - getData
 Retrieves the most current data available from the sensor. More...
 
(WFHeartrateData *) - getHeartrateData
 Returns the latest data available from the sensor. More...
 
(WFHeartrateRawData *) - getHeartrateRawData
 Returns the latest raw (unformatted) data available from the sensor. More...
 
(WFWahooMotionAnalysisData *) - getMotionAnalysisData
 Returns the latest data available from the sensor. More...
 
(WFSensorData *) - getRawData
 Retrieves the most current raw data available from the sensor. More...
 
(BOOL- hasData
 Returns a boolean value indicating whether new data is available. More...
 
(WFBTLEServiceProcessor *) - serviceProcessorForSensorType:
 Returns a WFBTLEService derived instance which handles BTLE service processing for the specified sensor type. More...
 
(float) - signalEfficiency
 Returns the signal efficiency for the connected sensor. More...
 
Methods related to Activity Type Management
(BOOL- getActivityType
 Request the current activity type from the device. More...
 
(BOOL- setActivityType:
 Set the activity type (mode) of the device. More...
 
Methods related to Motion Analysis Calibration Management
(BOOL- getActivityCalibrationForActivityType:
 Request the current calibration profile from the device for a specific activity type. More...
 
(BOOL- setActivityCalibration:
 Set the calibration profile on the device for a specific activity type. More...
 
(BOOL- resetActivityCalibrationToDefaultsForActivityType:
 Reset the calibration to default for a specific activity type. More...
 
Methods related to device vibration
(BOOL- performVibrationWithPattern:
 Perform vibration. More...
 

Protected Attributes

id
< WFWahooActivitySessionManagementDelegate > 
activitySessionManagementDelegate
 
id
< WFHeartrateConnectionTICKRXDelegate
heartrateConnectionTICKRXDelegate
 The delegate which will receive TICKRX related callbacks. More...
 
id
< WFHeartrateConnectionTICKRXSpeedProvider
motionAnalysisProcessingSpeedProvider
 The delegate responsible for returning current speed used in motion analysis processing. More...
 

Properties

WFSensorConnectionStatus_t connectionStatus
 Gets the current connection status. More...
 
id< WFSensorConnectionDelegatedelegate
 Specifies the WFSensorConnectionDelegate instance which will handle callback methods for this WFSensorConnection. More...
 
NSString * deviceIDString
 Returns the Device ID of the connected sensor for both ANT and BTLE. More...
 
WFDeviceInformationdeviceInformation
 
USHORT deviceNumber
 Gets the ANT device ID of the connected sensor. More...
 
NSString * deviceUUIDString
 Specifies the BTLE Device UUID String. More...
 
BOOL didTimeout
 Gets a boolean value indicating whether a connection timeout occurred. More...
 
WFSensorConnectionError_t error
 Get the error status for the connection. More...
 
BOOL hasAntBridgeSupport
 Gets a boolean value indicating whether this WFSensorConnection instance is connected to a device which supports the Wahoo Fitness ANT Bridge. More...
 
BOOL hasError
 TRUE if an error has occured, otherwise FALSE. More...
 
BOOL hasValidParams
 Gets a boolean value indicating whether this WFSensorConnection has valid connection parameters. More...
 
BOOL hasWildcardParams
 Gets a boolean value indicating whether the connection parameters for this WFSensorConnection indicate a wildcard search. More...
 
BOOL isANTConnection
 TRUE if the sensor is a ANT device, otherwise FALSE. More...
 
BOOL isBTLEConnection
 TRUE if the sensor is a BTLE device, otherwise FALSE. More...
 
BOOL isConnected
 TRUE if the sensor is currently connected, otherwise FALSE. More...
 
BOOL isValid
 Gets a boolean value indicating whether this WFSensorConnection instance is valid. More...
 
WFNetworkType_t networkType
 Specifies the network type of this WFSensorConnection (ANT+, BTLE, etc). More...
 
WFSensorSubType_t sensorSubType
 Gets the sensor sub type for this WFSensorConnection. More...
 
WFSensorType_t sensorType
 Gets the sensor type for this WFSensorConnection. More...
 
BOOL tickrxDeviceIsReady
 A flag to indicate if the device is ready - if the device is not yet ready, commands should not be sent. More...
 
NSTimeInterval timeSinceLastMessage
 Gets the time since the last ANT message was received (in seconds). More...
 
UCHAR transmissionType
 Gets the ANT transmission type of the connected sensor. More...
 

Detailed Description

Represents a connection to an ANT+ Heart Rate Monitor sensor.

Method Documentation

- (void) disconnect

Disconnects the sensor.

- (void) disconnect: (BOOL bKillPeripheralConnection

Disconnects the sensor and for BTLE peripheral, ensures the BTLE connection is closed.

BTLE peripheral connections are held in a "peripheral pool" to facilitate multiple logical connections to the same physical device. Normally, when the last logical connection (WFSensorConnection) is disconnected, the BTLE connection will be held in the pool briefly to reduce the overhead of any subsequent connection requests from the application. To override this behaviour, the disconnect: method may be invoked with the bKillPeripheralConnection parameter set to TRUE. In this case, if the WFSensorConnection requesting the disconnect is the last logical connection to the BTLE peripheral, the BTLE peripheral connection will be closed immediately and the BTLE peripheral will be removed from the pool.

Note
For ANT+ devices, this method behaves exactly the same as the disconnect method, regardless of the value of the bKillPeripheralConnection parameter.
Parameters
bKillPeripheralConnectionTRUE if the underlying BTLE connection should be closed immediately, otherwise FALSE.
- (BOOL) getActivityCalibrationForActivityType: (WFWahooMotionAnalysisActivityType_t)  activityType

Request the current calibration profile from the device for a specific activity type.

The delegate will be notified using the appropriate callback.

See also
WFHeartrateConnectionTICKRXDelegate hrTICKRXConnection:didGetActivityCalibration:error:
Returns
FALSE if the command could not be sent.
Note: a return value of TRUE does not guarantee that the command completed successfully.

Provided by category WFHeartrateConnection(TICKRX).

- (BOOL) getActivityType

Request the current activity type from the device.

The delegate will be notified using the appropriate callback.

See also
WFHeartrateConnectionTICKRXDelegate hrTICKRXConnection:didGetActivityType:error:
Returns
FALSE if the command could not be sent.
Note: a return value of TRUE does not guarantee that the command completed successfully.

Provided by category WFHeartrateConnection(TICKRX).

- (WFSensorData*) getData

Retrieves the most current data available from the sensor.

Note
WFSensorData is an abstract base class for all sensor data types. The specific type will be determined by the type of sensor. The instance returned must be cast to the specific type in order to be useful.
Returns
A WFSensorData derived instance containing data if available, otherwise nil.
- (WFHeartrateData*) getHeartrateData

Returns the latest data available from the sensor.

See also
- getData (WFSensorConnection)
Returns
A WFHeartrateData instance containing data if available, otherwise nil.
- (WFHeartrateRawData*) getHeartrateRawData

Returns the latest raw (unformatted) data available from the sensor.

See also
- getRawData (WFSensorConnection)
Returns
A WFHeartrateRawData instance containing data if available, otherwise nil.
- (WFWahooMotionAnalysisData*) getMotionAnalysisData

Returns the latest data available from the sensor.

See also
- getData (WFSensorConnection)
Returns
A WFWahooMotionAnalysisData instance containing data if available, otherwise nil.

Provided by category WFHeartrateConnection(TICKRX).

- (WFSensorData*) getRawData

Retrieves the most current raw data available from the sensor.

Note
This method will return raw (unformatted) data from the sensor. It is made available for applications which require processing of data as close to the original measured values a possible. There may be other rarely used data available via this method as well. For most applications, the getData method should be used instead.

WFSensorData is an abstract base class for all sensor data types. The specific type will be determined by the type of sensor. The instance returned must be cast to the specific type in order to be useful.
Returns
A WFSensorData derived instance containing data if available, otherwise nil.
- (BOOL) hasData

Returns a boolean value indicating whether new data is available.

Returns
TRUE if new data is available since the last time getData was invoked, otherwise FALSE.
- (BOOL) performVibrationWithPattern: (NSArray *)  vibrationPattern

Perform vibration.

Parameters
vibrationPatternThe vibration timing pattern, consisting of an array with up to five vibration step objects. Each step object is a dictionary containing vibration on- and off duration in seconds:"onDuration": @(<on duration in seconds>), @"offDuration": @(<off duration="" in="" seconds>="">)}

Provided by category WFHeartrateConnection(TICKRX).

- (BOOL) resetActivityCalibrationToDefaultsForActivityType: (WFWahooMotionAnalysisActivityType_t)  activityType

Reset the calibration to default for a specific activity type.

The delegate will be notified using the appropriate callback.

See also
WFHeartrateConnectionTICKRXDelegate hrTICKRXConnection:didResetActivityCalibrationToDefaultsWithError:
Parameters
activityTypeThe activity type for which the calibration should be reset.
Returns
FALSE if the command could not be sent.
Note: a return value of TRUE does not guarantee that the command completed successfully.

Provided by category WFHeartrateConnection(TICKRX).

- (WFBTLEServiceProcessor*) serviceProcessorForSensorType: (WFSensorType_t eSensorType

Returns a WFBTLEService derived instance which handles BTLE service processing for the specified sensor type.

Parameters
eSensorTypeThe sensor type.
Returns
A WFBTLEService derived instance if successful, otherwise nil.
- (BOOL) setActivityCalibration: (WFWahooMotionAnalysisCalibrationProfile *)  calibrationProfile

Set the calibration profile on the device for a specific activity type.

The delegate will be notified using the appropriate callback.

See also
WFHeartrateConnectionTICKRXDelegate hrTICKRXConnection:didSetActivityCalibrationWithError:
Parameters
calibrationProfileThe desired calibration profile to upload to the device. Note that the calibration profile itself belongs to a specific activity type.
Returns
FALSE if the command could not be sent.
Note: a return value of TRUE does not guarantee that the command completed successfully.

Provided by category WFHeartrateConnection(TICKRX).

- (BOOL) setActivityType: (WFWahooMotionAnalysisActivityType_t)  activityType

Set the activity type (mode) of the device.

The delegate will be notified using the appropriate callback.

See also
WFHeartrateConnectionTICKRXDelegate hrTICKRXConnection:didSetActivityType:error:
Parameters
activityTypeThe desired activity type for the device.
Returns
FALSE if the command could not be sent.
Note: a return value of TRUE does not guarantee that the command completed successfully.

Provided by category WFHeartrateConnection(TICKRX).

- (float) signalEfficiency

Returns the signal efficiency for the connected sensor.

Returns
For ANT connections, this property represents the ratio of messages received from the sensor over the number of messages expected (range [0, 1.0]). This value should give a good indication of the reception quality for the sensor. For BTLE connections, this property represents the RSSI (in dBm). If the sensor is not currently connected, the return value is -1.

Member Data Documentation

- (id<WFWahooActivitySessionManagementDelegate>) activitySessionManagementDelegate
protected
- (id<WFHeartrateConnectionTICKRXDelegate>) heartrateConnectionTICKRXDelegate
readwritenonatomicassignprotected

The delegate which will receive TICKRX related callbacks.

Provided by category WFHeartrateConnection(TICKRX).

- (id<WFHeartrateConnectionTICKRXSpeedProvider>) motionAnalysisProcessingSpeedProvider
readwritenonatomicassignprotected

The delegate responsible for returning current speed used in motion analysis processing.

Provided by category WFHeartrateConnection(TICKRX).

Property Documentation

- (WFSensorConnectionStatus_t) connectionStatus
readnonatomicassigninherited

Gets the current connection status.

- (id<WFSensorConnectionDelegate>) delegate
readwritenonatomicretaininherited

Specifies the WFSensorConnectionDelegate instance which will handle callback methods for this WFSensorConnection.

- (NSString*) deviceIDString
readnonatomicassigninherited

Returns the Device ID of the connected sensor for both ANT and BTLE.

- (WFDeviceInformation*) deviceInformation
readnonatomicretaininherited
- (USHORT) deviceNumber
readnonatomicassigninherited

Gets the ANT device ID of the connected sensor.

- (NSString*) deviceUUIDString
readnonatomicassigninherited

Specifies the BTLE Device UUID String.

- (BOOL) didTimeout
readnonatomicassigninherited

Gets a boolean value indicating whether a connection timeout occurred.

- (WFSensorConnectionError_t) error
readnonatomicassigninherited

Get the error status for the connection.

- (BOOL) hasAntBridgeSupport
readnonatomicassigninherited

Gets a boolean value indicating whether this WFSensorConnection instance is connected to a device which supports the Wahoo Fitness ANT Bridge.

See also
- enableAntBridge: (WFHardwareConnector)
WFConnectorSettings::isAntBridgeAutoEnabled
- (BOOL) hasError
readnonatomicassigninherited

TRUE if an error has occured, otherwise FALSE.

- (BOOL) hasValidParams
readnonatomicassigninherited

Gets a boolean value indicating whether this WFSensorConnection has valid connection parameters.

When the WFSensorConnection is initiated as a wildcard search, the connection parameters (WFSensorConnection::deviceNumber, WFSensorConnection::transmissionType, etc.) are not set to a specific device. Once the sensor connection is established, the connection parameters will contain values which uniquely identify the connected sensor. At this point the connection parameters may be persisted and used in the future to establish a connection with this same sensor (pairing).

The value of this property is TRUE when the connection parameters are suitable for uniquely identifying a specific sensor. Otherwise, the value is FALSE.

See also
WFSensorConnection::hasWildcardParams
- (BOOL) hasWildcardParams
readnonatomicassigninherited

Gets a boolean value indicating whether the connection parameters for this WFSensorConnection indicate a wildcard search.

See also
WFSensorConnection::hasValidParams
- (BOOL) isANTConnection
readnonatomicassigninherited

TRUE if the sensor is a ANT device, otherwise FALSE.

- (BOOL) isBTLEConnection
readnonatomicassigninherited

TRUE if the sensor is a BTLE device, otherwise FALSE.

- (BOOL) isConnected
readnonatomicassigninherited

TRUE if the sensor is currently connected, otherwise FALSE.

- (BOOL) isValid
readnonatomicassigninherited

Gets a boolean value indicating whether this WFSensorConnection instance is valid.

The WFSensorConnection is invalidated when the sensor is disconnected, or when the API is reset.

Note
The WFSensorConnection instance returned via the requestSensorConnection: (WFHardwareConnector) method should be retained by the application for retrieving data and managing the connection. The Wahoo API will also maintain a reference to this instance (it may be retrieved by the getSensorConnections: (WFHardwareConnector) method). When the sensor is disconnected, the WFSensorConnection instance is invalidated. At this point, the Wahoo API will release its reference to the instance. Once this happens, the instance may not be used to retrieve data, and any properties of the instance will contain spurious values, and should not be used. An application may check for this state with the WFSensorConnection::isValid property.
- (WFNetworkType_t) networkType
readnonatomicassigninherited

Specifies the network type of this WFSensorConnection (ANT+, BTLE, etc).

- (WFSensorSubType_t) sensorSubType
readnonatomicassigninherited

Gets the sensor sub type for this WFSensorConnection.

- (WFSensorType_t) sensorType
readnonatomicassigninherited

Gets the sensor type for this WFSensorConnection.

- (BOOL) tickrxDeviceIsReady
readnonatomicassign

A flag to indicate if the device is ready - if the device is not yet ready, commands should not be sent.

When the device is not yet ready, the hrTICKRXConnectionDidReceiveDeviceReady: delegate callback should be called after a short period of time (this should not take longer than 5 seconds after the device connection is correctly established).

Provided by category WFHeartrateConnection(TICKRX).

- (NSTimeInterval) timeSinceLastMessage
readnonatomicassigninherited

Gets the time since the last ANT message was received (in seconds).

WF_INVALID_DATA_TIME if unknown or invalid.

- (UCHAR) transmissionType
readnonatomicassigninherited

Gets the ANT transmission type of the connected sensor.