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

Represents the most commonly used data available from the ANT+ combined Bike Speed and Cadence sensor. More...

#import <WFBikeSpeedCadenceData.h>

+ Inheritance diagram for WFBikeSpeedCadenceData:
+ Collaboration diagram for WFBikeSpeedCadenceData:

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 *) - formattedSpeed:
 Returns the speed as a string formatted for display. More...
 

Properties

float accumCadenceTime
 The accumulated time (in seconds) since the sensor was connected or reset. More...
 
ULONG accumCrankRevolutions
 The accumulated crank revolutions since the sensor was connected or reset. More...
 
float accumSpeedTime
 The accumulated time (in seconds) since the sensor was connected or reset. More...
 
ULONG accumWheelRevolutions
 The accumulated wheel revolutions since the sensor was connected or reset. More...
 
NSTimeInterval cadenceTimestamp
 The real-time timestamp for cadence data from the sensor (as an offset from the Cocoa reference date). More...
 
BOOL cadenceTimestampOverflow
 Indicates that the time between cadence data samples from the sensor has exceeded the rollover time (64 seconds). More...
 
UCHAR instantCrankRPM
 The instantaneous crank RPM, based on the last two sensor measurements. More...
 
USHORT instantWheelRPM
 The instantaneous wheel RPM, based on the last two sensor measurements. More...
 
BOOL isDataStale
 TRUE if data is considered stale, otherwise FALSE. More...
 
WFConnectorSettingssettings
 Gets the persistent settings for the Wahoo API. More...
 
NSTimeInterval speedTimestamp
 The real-time timestamp for speed data from the sensor (as an offset from the Cocoa reference date). More...
 
BOOL speedTimestampOverflow
 Indicates that the time between speed data samples from the sensor has exceeded the rollover time (64 seconds). More...
 

Detailed Description

Represents the most commonly used data available from the ANT+ combined Bike Speed and Cadence sensor.

ANT+ sensors send data in multiple packets. The WFBikeSpeedCadenceData 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.

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 RPMs).
- (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*) 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 km/h or MPH).

Property Documentation

- (float) accumCadenceTime
readwritenonatomicassign

The accumulated time (in seconds) since the sensor was connected or reset.

- (ULONG) accumCrankRevolutions
readwritenonatomicassign

The accumulated crank revolutions since the sensor was connected or reset.

- (float) accumSpeedTime
readwritenonatomicassign

The accumulated time (in seconds) since the sensor was connected or reset.

- (ULONG) accumWheelRevolutions
readwritenonatomicassign

The accumulated wheel revolutions since the sensor was connected or reset.

- (NSTimeInterval) cadenceTimestamp
readwritenonatomicassign

The real-time timestamp for cadence 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) cadenceTimestampOverflow
readwritenonatomicassign

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

- (UCHAR) instantCrankRPM
readwritenonatomicassign

The instantaneous crank RPM, based on the last two sensor measurements.

- (USHORT) instantWheelRPM
readwritenonatomicassign

The instantaneous wheel RPM, based on the last two sensor measurements.

- (BOOL) isDataStale
readnonatomicassigninherited

TRUE if data is considered stale, otherwise FALSE.

- (WFConnectorSettings*) settings
readnonatomicassigninherited

Gets the persistent settings for the Wahoo API.

- (NSTimeInterval) speedTimestamp
readwritenonatomicassign

The real-time timestamp for speed 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) speedTimestampOverflow
readwritenonatomicassign

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