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

Represents the data available from the BTLE Running Speed and Cadence sensor. More...

#import <WFBTLEFootpodData.h>

+ Inheritance diagram for WFBTLEFootpodData:
+ Collaboration diagram for WFBTLEFootpodData:

Instance Methods

(NSString *) - formattedCadence:
 Returns the cadence as a string formatted for display. More...
 
(NSString *) - formattedDistance:
 Returns the distance as a string formatted for display. More...
 
(NSString *) - formattedPace:
 Returns the pace as a string formatted for display. More...
 
(NSString *) - formattedSpeed:
 Returns the speed as a string formatted for display. More...
 

Properties

float accumulatedDistance
 The accumulated distance measurement. More...
 
ULONG accumulatedStride
 The accumulated stride count. More...
 
WFBTLECommonDatabtleCommonData
 Gets the metadata for the BTLE device. More...
 
float cadence
 The measure of strides accumulated in time (strides per minute). More...
 
WFBTLESensorLocation_t eSensorLocation
 Gets a WFBTLESensorLocation_t which describes the sensor location. More...
 
float instantaneousSpeed
 The instantaneous speed in meters per second. More...
 
float instStrideLength
 Gets the instantaneous stride length in meters, when available. More...
 
BOOL isDataStale
 TRUE if data is considered stale, otherwise FALSE. More...
 
float lastTime
 The time of the last distance and/or speed computation. More...
 
WFBTLERSCFeatures_tpstFeatures
 Gets a pointer to a WFBTLERSCFeatures_t structure which contains information about the device features. More...
 
WFConnectorSettingssettings
 Gets the persistent settings for the Wahoo API. More...
 
NSTimeInterval timestamp
 The real-time timestamp for data from the sensor (as an offset from the Cocoa reference date). More...
 
BOOL timestampOverflow
 Indicates that the time between data samples from the sensor has exceeded the rollover time (64 seconds). More...
 

Detailed Description

Represents the data available from the BTLE Running Speed and Cadence sensor.

BTLE sensors send data in multiple packets. The WFBTLEFootpodData combines the most commonly used of this data into a single entity. The data represents the latest of each data type sent from the sensor.

Note
The WFBTLEFootpodData is an extension of the WFFootpodData class. This class is specific to the data available from the BTLE footpod sensors. Much of the data is the same as that available from the ANT+ footpod sensors.

Method Documentation

- (NSString*) formattedCadence: (BOOL showUnits

Returns the cadence as a string formatted for display.

See also
WFConnectorSettings
Parameters
showUnitsIf TRUE the units will be included in the string returned. Otherwise, the units are not included.
Returns
The formatted display string (cadence in s/m).
- (NSString*) formattedDistance: (BOOL showUnits

Returns the distance as a string formatted for display.

See also
WFConnectorSettings
Parameters
showUnitsIf TRUE the units will be included in the string returned. Otherwise, the units are not included.
Returns
The formatted display string (distance in km or miles).
- (NSString*) formattedPace: (BOOL showUnits

Returns the pace as a string formatted for display.

See also
WFConnectorSettings
Parameters
showUnitsIf TRUE the units will be included in the string returned. Otherwise, the units are not included.
Returns
The formatted display string (pace in min/km or min/mile).
- (NSString*) formattedSpeed: (BOOL showUnits

Returns the speed as a string formatted for display.

See also
WFConnectorSettings
Parameters
showUnitsIf TRUE the units will be included in the string returned. Otherwise, the units are not included.
Returns
The formatted display string (speed in m/s or ft/s).

Property Documentation

- (float) accumulatedDistance
readwritenonatomicassigninherited

The accumulated distance measurement.

When available, this value is similar to the WFFootpodRawData::distance value, but with a larger roll over value.

- (ULONG) accumulatedStride
readwritenonatomicassigninherited

The accumulated stride count.

When available, this value is similar to the WFFootpodRawData::strideCount value, but with a larger roll over value.

- (WFBTLECommonData*) btleCommonData
readwritenonatomicretain

Gets the metadata for the BTLE device.

- (float) cadence
readwritenonatomicassigninherited

The measure of strides accumulated in time (strides per minute).

- (WFBTLESensorLocation_t) eSensorLocation
readwritenonatomicassign

Gets a WFBTLESensorLocation_t which describes the sensor location.

- (float) instantaneousSpeed
readwritenonatomicassigninherited

The instantaneous speed in meters per second.

- (float) instStrideLength
readwritenonatomicassign

Gets the instantaneous stride length in meters, when available.

- (BOOL) isDataStale
readnonatomicassigninherited

TRUE if data is considered stale, otherwise FALSE.

- (float) lastTime
readwritenonatomicassigninherited

The time of the last distance and/or speed computation.

Time starts when SDM is powered ON and continues until it is powered OFF. The integral component of the time data from the sensor is a single byte. Therefore, the time value will roll over after 256 seconds. This should be taken into account when calculating time offsets.

- (WFBTLERSCFeatures_t*) pstFeatures
readnonatomicassign

Gets a pointer to a WFBTLERSCFeatures_t structure which contains information about the device features.

Note
If the sensor does not report features, this property will be nil.
- (WFConnectorSettings*) settings
readnonatomicassigninherited

Gets the persistent settings for the Wahoo API.

- (NSTimeInterval) timestamp
readwritenonatomicassigninherited

The real-time timestamp for data from the sensor (as an offset from the Cocoa reference date).

Time values from the sensors are implemented as an offset in seconds between the time when the sensor is turned on and the time when a data sample is taken. This value is typically a 16-bit unsigned integer in units of 1/1024 second. The rollover is then 64 seconds.

A base real-time value is stored when the first sample from the sensor is received. The timestamp of each subsequent sample is the base time value offset by the time value offset from the sensor. If the time between samples is greater than the rollover time, the base time value is set to the time the first sample after the delay is received.

- (BOOL) timestampOverflow
readwritenonatomicassigninherited

Indicates that the time between data samples from the sensor has exceeded the rollover time (64 seconds).