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

Represents the data available from a Wahoo Fitness device which supports Motion Analysis. More...

#import <WFWahooMotionAnalysisData.h>

+ Inheritance diagram for WFWahooMotionAnalysisData:
+ Collaboration diagram for WFWahooMotionAnalysisData:

Instance Methods

(NSString *) - formattedCadence
 Returns the cadenceRPM in string form, formatted to two decimal places. More...
 
(NSTimeInterval) - timeSinceMotion
 Returns time in seconds that have elapsed since the last known motion event. More...
 

Properties

BOOL isDataStale
 TRUE if data is considered stale, otherwise FALSE. More...
 
WFConnectorSettingssettings
 Gets the persistent settings for the Wahoo API. More...
 
Generic Fields
WFWahooMotionAnalysisActivityType_t activityType
 The current activity type of the device. More...
 
NSTimeInterval motionTimestamp
 Time interval since the first instant of 1 January 2001, GMT (Based on NSDate timeIntervalSinceReferenceDate). More...
 
uint32_t motionCount
 Cumulative motion count (eg. More...
 
double cadenceRPM
 Instantaneous Cadence (motion's per minute). More...
 
Specific Fields for activityType = WF_WAHOO_MOTION_ANALYSIS_ACTIVITY_TYPE_RUNNING
NSNumber * runningSquaredJerkX
 A measure of the current jerk in the x direction of the device. More...
 
NSNumber * runningSquaredJerkY
 A measure of the current jerk in the y direction of the device. More...
 
NSNumber * runningSquaredJerkZ
 A measure of the current jerk in the z direction of the device. More...
 
WFWahooRunningSmoothnessDatarunningSmoothnessData
 Current running smoothness. More...
 
NSNumber * runningGroundContactTimeSeconds
 Current Ground Contact Time. More...
 
NSNumber * runningVerticalOscillationMetres
 Current Vertical Oscillation. More...
 
WFWahooMotionAnalysisRunningIsRunningStatus_t runningIsRunningStatus
 Current isRunning status. More...
 
Specific Fields for activityType = WF_WAHOO_MOTION_ANALYSIS_ACTIVITY_TYPE_INDOOR_CYCLING
NSNumber * indoorCyclingTrunkAngleDegrees
 Current trunk (torso) angle in degrees. More...
 
WFWahooMotionAnalysisIndoorCyclingRiderPosition_t indoorCyclingRiderPosition
 Current rider position. More...
 
NSNumber * indoorCyclingCumulativeSittingTime
 Cumulative Sitting time, in seconds. More...
 
NSNumber * indoorCyclingCumulativeStandingTime
 Cumulative Standing time, in seconds. More...
 
Specific Fields for activityType = WF_WAHOO_MOTION_ANALYSIS_ACTIVITY_TYPE_X_COUNTING
NSNumber * xCountingCumulativeMovingTime
 Cumulative time elapsed of the user/device moving (not being still), in seconds. More...
 
NSNumber * xCountingCumulativeCorrectPositionHeldTime
 Cumulative time elapsed of the user/device being (still) in the "correct position", in seconds. More...
 
NSNumber * xCountingCumulativeIncorrectPositionHeldTime
 Cumulative time elapsed of the user/device being (still) in a position other than the "correct, in seconds. More...
 
WFWahooMotionAnalysisDeviceOrientation_t xCountingCurrentDeviceOrientation
 Current orientation of the device. More...
 
Specific Fields for activityType = WF_WAHOO_MOTION_ANALYSIS_ACTIVITY_TYPE_ELLIPTICAL
NSNumber * ellipticalInstantaneousSpeed
 

Detailed Description

Represents the data available from a Wahoo Fitness device which supports Motion Analysis.

Method Documentation

- (NSString*) formattedCadence

Returns the cadenceRPM in string form, formatted to two decimal places.

No units etc. are included in the string.

- (NSTimeInterval) timeSinceMotion

Returns time in seconds that have elapsed since the last known motion event.

Property Documentation

- (WFWahooMotionAnalysisActivityType_t) activityType
readwritenonatomicassign

The current activity type of the device.


This dictates what fields will be valid/set in this instance of the object.

- (double) cadenceRPM
readwritenonatomicassign

Instantaneous Cadence (motion's per minute).

- (NSNumber*) ellipticalInstantaneousSpeed
readwritenonatomicretain
- (NSNumber*) indoorCyclingCumulativeSittingTime
readwritenonatomicretain

Cumulative Sitting time, in seconds.

- (NSNumber*) indoorCyclingCumulativeStandingTime
readwritenonatomicretain

Cumulative Standing time, in seconds.

- (WFWahooMotionAnalysisIndoorCyclingRiderPosition_t) indoorCyclingRiderPosition
readwritenonatomicassign

Current rider position.

- (NSNumber*) indoorCyclingTrunkAngleDegrees
readwritenonatomicretain

Current trunk (torso) angle in degrees.

Range is 0 to 359.
0 degrees = Face down (trunk parallel to ground)
90 degrees = Upright (feet to ground)
180 degrees = Face up (trunk parallel to ground)
270 degrees = Head to ground, feet to sky.

- (BOOL) isDataStale
readnonatomicassigninherited

TRUE if data is considered stale, otherwise FALSE.

- (uint32_t) motionCount
readwritenonatomicassign

Cumulative motion count (eg.

step count, crank rev count etc.)

- (NSTimeInterval) motionTimestamp
readwritenonatomicassign

Time interval since the first instant of 1 January 2001, GMT (Based on NSDate timeIntervalSinceReferenceDate).

- (NSNumber*) runningGroundContactTimeSeconds
readwritenonatomicretain

Current Ground Contact Time.

Units are seconds.

- (WFWahooMotionAnalysisRunningIsRunningStatus_t) runningIsRunningStatus
readwritenonatomicassign

Current isRunning status.

- (WFWahooRunningSmoothnessData*) runningSmoothnessData
readwritenonatomicretain

Current running smoothness.


Running smoothness is only available when the WFHeartrateConnectionTICKRXSpeedProvider delegate is set, and the delegate returns valid speed data.

- (NSNumber*) runningSquaredJerkX
readwritenonatomicretain

A measure of the current jerk in the x direction of the device.


The value is squared, take the square root to obtain the original value.
Units are m2/s5.

- (NSNumber*) runningSquaredJerkY
readwritenonatomicretain

A measure of the current jerk in the y direction of the device.


The value is squared, take the square root to obtain the original value.
Units are m2/s5.

- (NSNumber*) runningSquaredJerkZ
readwritenonatomicretain

A measure of the current jerk in the z direction of the device.


The value is squared, take the square root to obtain the original value.
Units are m2/s5.

- (NSNumber*) runningVerticalOscillationMetres
readwritenonatomicretain

Current Vertical Oscillation.

Units are metres.

- (WFConnectorSettings*) settings
readnonatomicassigninherited

Gets the persistent settings for the Wahoo API.

- (NSNumber*) xCountingCumulativeCorrectPositionHeldTime
readwritenonatomicretain

Cumulative time elapsed of the user/device being (still) in the "correct position", in seconds.

- (NSNumber*) xCountingCumulativeIncorrectPositionHeldTime
readwritenonatomicretain

Cumulative time elapsed of the user/device being (still) in a position other than the "correct, in seconds.

- (NSNumber*) xCountingCumulativeMovingTime
readwritenonatomicretain

Cumulative time elapsed of the user/device moving (not being still), in seconds.

- (WFWahooMotionAnalysisDeviceOrientation_t) xCountingCurrentDeviceOrientation
readwritenonatomicassign

Current orientation of the device.