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

This class represents a collection of general information about a device. More...

#import <WFDeviceInformation.h>

+ Inheritance diagram for WFDeviceInformation:
+ Collaboration diagram for WFDeviceInformation:

Instance Methods

(NSArray *) - connecitonParamsForAllSupportSensorTypes
 Returns NSArray of WFConnectionParams for each supported sensor type These can then be used with requestSensorConnection:withProximity:error: (WFHardwareConnector) to make a connections You need 1 WFSensorConnection per sensor type. More...
 
(WFConnectionParams *) - connectionParamsForSensorType:
 Gets an instance of WFConnectionParams that is configured for a given sensor type. More...
 
(BOOL- isBatteryLevelSupported
 TRUE if the device supports battery level, otherwise FALSE. More...
 

Protected Attributes

NSDate * _lastUpdate
 
BOOL dummyDevice
 
NSDate * lastlastUpdate
 
NSMutableArray * updateDeltas
 

Properties

double batteryLevel
 Gets the last known battery level. More...
 
BOOL connected
 TRUE if the sensor is currently connected, otherwise FALSE. More...
 
NSString * deviceIdentifier
 BTLE UUID or ANT+ Device ID. More...
 
NSString * firmwareVersion
 Gets firmware version if known. More...
 
NSString * hardwareVersion
 Gets hardware version if known. More...
 
NSDate * lastUpdate
 The date when this device was last seen. More...
 
NSString * manufacturer
 Manufacturer's name if known. More...
 
NSString * name
 Name of the device. More...
 
WFNetworkType_t networkType
 Gets the network type of the devie, BTLE or ANT. More...
 
NSString * productKey
 Unque product key for known devices. More...
 
NSString * rawName
 Raw Bluetooth advertising name. More...
 
NSString * serialNumber
 Gets serial number if known. More...
 
double signalStrength
 Gets the last known signal strength. More...
 
NSArray * supportedSensorTypes
 Array of WFSensorType_t wrapped in NSNumbers that are supported by this device. More...
 
double signalStrenth UNAVAILABLE_ATTRIBUTE
 
NSUUID * UUID
 Unquie ID for this device, BTL devices use the UUID, ANT+ use a 128. More...
 

Detailed Description

This class represents a collection of general information about a device.

It is returned either during a discovery process or from the WFSensorConnection::deviceInformation

Information isn't always availible and it is populated when and if it becomes availible. Some require the device to be connected before they are populated.

Method Documentation

- (NSArray*) connecitonParamsForAllSupportSensorTypes

Returns NSArray of WFConnectionParams for each supported sensor type These can then be used with requestSensorConnection:withProximity:error: (WFHardwareConnector) to make a connections You need 1 WFSensorConnection per sensor type.

- (WFConnectionParams*) connectionParamsForSensorType: (WFSensorType_t sensorType

Gets an instance of WFConnectionParams that is configured for a given sensor type.

This can then be used with requestSensorConnection:withProximity:error: (WFHardwareConnector) to make a connection

- (BOOL) isBatteryLevelSupported

TRUE if the device supports battery level, otherwise FALSE.

Member Data Documentation

- (NSDate*) _lastUpdate
protected
- (BOOL) dummyDevice
protected
- (NSDate*) lastlastUpdate
protected
- (NSMutableArray*) updateDeltas
protected

Property Documentation

- (double) batteryLevel
readnonatomicassign

Gets the last known battery level.

range 0...1, -1 being not known

- (BOOL) connected
readnonatomicassign

TRUE if the sensor is currently connected, otherwise FALSE.

- (NSString *) deviceIdentifier
readnonatomiccopy

BTLE UUID or ANT+ Device ID.

- (NSString *) firmwareVersion
readnonatomiccopy

Gets firmware version if known.

- (NSString *) hardwareVersion
readnonatomiccopy

Gets hardware version if known.

- (NSDate*) lastUpdate
readatomiccopy

The date when this device was last seen.

- (NSString *) manufacturer
readnonatomiccopy

Manufacturer's name if known.

- (NSString *) name
readnonatomiccopy

Name of the device.

This may be different to the WFDeviceInformation::rawName and is best used for UI display.

- (WFNetworkType_t) networkType
readnonatomicassign

Gets the network type of the devie, BTLE or ANT.

- (NSString *) productKey
readnonatomiccopy

Unque product key for known devices.

This is for Wahoo Fitness products and selected 3rd parties.

Note
If you would like a device added to this list then please submit a support ticket.
- (NSString *) rawName
readnonatomiccopy

Raw Bluetooth advertising name.

This may be different to the WFDeviceInformation::name that is recomended for UI display.

- (NSString *) serialNumber
readnonatomiccopy

Gets serial number if known.

- (double) signalStrength
readatomicassign

Gets the last known signal strength.

range 0...1, 1 being nearly perfect

- (NSArray *) supportedSensorTypes
readnonatomicretain

Array of WFSensorType_t wrapped in NSNumbers that are supported by this device.

Note
Eg. TICKR X supports WF_SENSORTYPE_HEARTRATE, WF_SENSORTYPE_FOOTPOD & WF_SENSORTYPE_BIKE_SPEED_CADENCE
- (double signalStrenth) UNAVAILABLE_ATTRIBUTE
readatomicassign
- (NSUUID *) UUID
readnonatomicretain

Unquie ID for this device, BTL devices use the UUID, ANT+ use a 128.