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
WFProximityConnection Class Reference

Represents a connection to a BTLE Proximity sensor. More...

#import <WFProximityConnection.h>

+ Inheritance diagram for WFProximityConnection:
+ Collaboration diagram for WFProximityConnection:

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...
 
(WFProximityData *) - getProximityData
 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...
 
(BOOL- isInRange
 Returns a boolean value indicating whether the device is within the specified proximity threshold. More...
 
(void) - proximityConnection:proximityAlert:proximityMode:signalLoss:
 Invoked when the WFProximityConnection receives an alert from the device indicating that the device proximity has crossed the specified threshold. More...
 
(BOOL- sendImmediateAlert:
 Sends a request for the proximity device to alert at the specified level. More...
 
(WFBTLEServiceProcessor *) - serviceProcessorForSensorType:
 Returns a WFBTLEService derived instance which handles BTLE service processing for the specified sensor type. More...
 
(BOOL- setAlertLevel:
 Sets the level at which the device is to alert when an alert condition is present. More...
 
(BOOL- setProximityAlertThreshold:alertLevel:
 Sets the alert threshold and level for alerts received by the application. More...
 
(BOOL- setProximityMode:
 Sets the proximity mode for alerts received by the application. More...
 
(float) - signalEfficiency
 Returns the signal efficiency for the connected sensor. 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...
 
id< WFProximityDelegateproximityDelegate
 Specifies the WFProximityDelegate instance which will handle callback methods for this WFProximityConnection. More...
 
WFSensorSubType_t sensorSubType
 Gets the sensor sub type for this WFSensorConnection. More...
 
WFSensorType_t sensorType
 Gets the sensor type for this WFSensorConnection. 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 a BTLE Proximity 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.
- (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.
- (WFProximityData*) getProximityData

Returns the latest data available from the sensor.

See also
- getData (WFSensorConnection)
Returns
A WFProximityData instance containing data if available, otherwise nil.
- (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) isInRange

Returns a boolean value indicating whether the device is within the specified proximity threshold.

See also
- setProximityAlertThreshold:alertLevel:
- setProximityMode:
Returns
TRUE if the device is within the specified threshold, or if the proximity threshold is disabled. Otherwise, FALSE.
- (void) proximityConnection: (WFProximityConnection *)  proxConn
proximityAlert: (WFBTLEChAlertLevel_t alertLevel
proximityMode: (WFProximityAlertMode_t mode
signalLoss: (int)  signalLoss 
requiredinherited

Invoked when the WFProximityConnection receives an alert from the device indicating that the device proximity has crossed the specified threshold.

Parameters
proxConnThe WFProximityConnection instance.
alertLevelThe level of alert issued by the device.
modeThe proximity mode.
signalLossThe difference between the transmitted signal level and the received signal level.
- (BOOL) sendImmediateAlert: (WFBTLEChAlertLevel_t alertLevel

Sends a request for the proximity device to alert at the specified level.

Note
This method affects the alert indication on the device.
Parameters
alertLevelThe level at which the device is to alert.
Returns
TRUE if the request was sent successfully, otherwise FALSE.
- (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) setAlertLevel: (WFBTLEChAlertLevel_t alertLevel

Sets the level at which the device is to alert when an alert condition is present.

Note
This method affects the alert indication on the device. To set the alert level for alerts received by the application through the WFProximityDelegate methods, use the setProximityAlertThreshold:alertLevel: method instead.
Parameters
alertLevelThe new alert level.
Returns
TRUE if the alert level was set successfully, otherwise FALSE.
- (BOOL) setProximityAlertThreshold: (WFProximityAlertThreshold_t threshold
alertLevel: (WFBTLEChAlertLevel_t alertLevel 

Sets the alert threshold and level for alerts received by the application.

Note
This method affects the alert indication which will be sent to the application through the WFProximityDelegate methods. To modify alert indications on the device, use the setAlertLevel: method instead.
See also
- isInRange:
- setProximityMode:
Parameters
thresholdThe threshold past which an alert will be issued.
alertLevelThe alert level.
Returns
TRUE if the values are set successfully, otherwise FALSE.
- (BOOL) setProximityMode: (WFProximityAlertMode_t mode

Sets the proximity mode for alerts received by the application.

Note
This method affects the alert indication which will be sent to the application through the WFProximityDelegate methods. The mode determines whether the alert will be issued when the device is moving farther away or when it is moving closer.
Parameters
modeThe proximity mode.
Returns
TRUE if the mode was set successfully, otherwise FALSE.
- (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.

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).

- (id<WFProximityDelegate>) proximityDelegate
readwritenonatomicretain

Specifies the WFProximityDelegate instance which will handle callback methods for this WFProximityConnection.

- (WFSensorSubType_t) sensorSubType
readnonatomicassigninherited

Gets the sensor sub type for this WFSensorConnection.

- (WFSensorType_t) sensorType
readnonatomicassigninherited

Gets the sensor type for this WFSensorConnection.

- (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.