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

Represents the odometer history for the Wahoo BlueSC bike speed and cadence sensor (or similar). More...

#import <WFOdometerHistory.h>

+ Inheritance diagram for WFOdometerHistory:
+ Collaboration diagram for WFOdometerHistory:

Instance Methods

(float) - getDistanceForWeek:
 Returns the distance traveled during the specified week. More...
 
(float) - getOdometerForWeek:
 Returns the odometer reading as of the end of the specified week. More...
 
(ULONG- getWheelRevolutionsForWeek:
 Returns the raw wheel revolutions as of the end of the specified week. More...
 

Protected Attributes

ULONG aulHistoryBuffer [WF_ODOMETER_HISTORY_MAX_SIZE]
 

Properties

float bikeWheelCircumference
 Gets or sets the bike wheel circumference, in meters. More...
 
ULONG ulCurrentWheelRevolutions
 Gets the current total wheel revolutions for the device. More...
 

Detailed Description

Represents the odometer history for the Wahoo BlueSC bike speed and cadence sensor (or similar).

The Wahoo Fitness BlueSC provides the ability to record odometer history by week for the past year.

Method Documentation

- (float) getDistanceForWeek: (UCHAR ucWeek

Returns the distance traveled during the specified week.

Parameters
ucWeekThe number for which to get the odometer reading. The current week is 0, the previous week is 1, the week before that is 2, etc. The earliest week possible is WF_ODOMETER_HISTORY_MAX_SIZE.
Returns
The odometer distance traveled during the specified week. For the earliest available week, this will be the distance traveled up to and including that week. For the current week, this will be the distance traveled this week, up till now. If an invalid week is specified, or if there is no history for that week, the return will be WF_ODOMETER_HISTORY_INVALID.
- (float) getOdometerForWeek: (UCHAR ucWeek

Returns the odometer reading as of the end of the specified week.

Parameters
ucWeekThe number for which to get the odometer reading. The current week is 0, the previous week is 1, the week before that is 2, etc. The earliest week possible is WF_ODOMETER_HISTORY_MAX_SIZE.
Returns
The odometer reading as of the end of the specified week. If an invalid week is specified, or if there is no history for that week, the return will be WF_ODOMETER_HISTORY_INVALID.
- (ULONG) getWheelRevolutionsForWeek: (UCHAR ucWeek

Returns the raw wheel revolutions as of the end of the specified week.

Parameters
ucWeekThe number for which to get the wheel revolutions. The current week is 0, the previous week is 1, the week before that is 2, etc. The earliest week possible is WF_ODOMETER_HISTORY_MAX_SIZE.
Returns
The cumulative wheel revolutions as of the end of the specified week. If an invalid week is specified, or if there is no history for that week, the return will be WF_ODOMETER_WHEEL_REVS_INVALID.

Member Data Documentation

- (ULONG aulHistoryBuffer[WF_ODOMETER_HISTORY_MAX_SIZE])
protected

Property Documentation

- (float) bikeWheelCircumference
readwritenonatomicassign

Gets or sets the bike wheel circumference, in meters.

Note
The default value is 2.07 m (207 cm), or whatever value is set in the WFConnectorSettings::bikeWheelCircumference property.
- (ULONG) ulCurrentWheelRevolutions
readwritenonatomicassign

Gets the current total wheel revolutions for the device.