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

#import <WFWahooMotionAnalysisCalibratorRunning.h>

+ Inheritance diagram for WFWahooMotionAnalysisCalibratorRunning:
+ Collaboration diagram for WFWahooMotionAnalysisCalibratorRunning:

Instance Methods

(void) - abortCalibration
 Abort the calibration process. More...
 
(bool) - beginCalibration
 Begin the calibration process. More...
 
(bool) - continueCalibration
 Continue the calibration process when paused. More...
 
(instancetype) - initForActivity:withSensorConnection:
 The designated initialiser. More...
 
(instancetype) - initWithSensorConnection:
 The designated initialiser. More...
 
(void) - resetCurrentPhase
 Resets the current calibration phase and puts the calibration process in a paused state. More...
 
(bool) - retryCalibrationProfileUpload
 Retry uploading the new calibration profile. More...
 
(bool) - uploadDefaultCalibrationProfile
 Upload default calibration profile. More...
 
(bool) - uploadDefaultCalibrationProfileForActivity:gender:andStature:
 Upload default calibration profile for users gender and stature. More...
 

Properties

NSNumber * averageSpeedForCurrentPhase
 Setter for average speed during current calibration phase. More...
 
int currentPhase
 The current calibration phase. More...
 
id
< WFWahooMotionAnalysisCalibratorDelegate
delegate
 The delegate which will receive event/progress update callbacks. More...
 
bool extendedCalibrationEnabled
 The Regular calibration process requires the user to walk or run at a single speed for two minutes (single phase). More...
 
WFMotionAnalysisRunningCalibrationGender_t gender
 If the users gender is known it will be used to improve the calibration. More...
 
int numberOfPhases
 The number of calibration phases. More...
 
NSTimeInterval remainingTimeInPhase
 The time remaining in the current calibration phase. More...
 
WFSensorConnectionsensorConnection
 The Sensor Connection which is being used to preform the calibration. More...
 
WFWahooMotionAnalysisCalibratorState_t state
 The current state of this calibrator instance. More...
 
double stature
 If the users stature (height) is known it will be used to improve the calibration Units are in centimeters. More...
 
WFWahooMotionAnalysisCalibratorWorkingStatus_t workingStatus
 The current working status of this calibrator instance. More...
 

Method Documentation

- (void) abortCalibration

Abort the calibration process.

Returns
false if an error occurred
- (bool) beginCalibration

Begin the calibration process.

Returns
false if an error occurred
- (bool) continueCalibration

Continue the calibration process when paused.

Returns
false if an error occurred
- (instancetype) initForActivity: (WFMotionAnalysisRunningCalibratorActivity_t)  activity
withSensorConnection: (WFSensorConnection *)  sensorConnection 

The designated initialiser.

Parameters
activityRunning or walking
- (instancetype) initWithSensorConnection: (WFSensorConnection *)  sensorConnection

The designated initialiser.

- (void) resetCurrentPhase

Resets the current calibration phase and puts the calibration process in a paused state.

Call continueCalibration: to continue the calibration process.

- (bool) retryCalibrationProfileUpload

Retry uploading the new calibration profile.

Returns
false if an error occurred
- (bool) uploadDefaultCalibrationProfile

Upload default calibration profile.

Returns
false if an error occurred
- (bool) uploadDefaultCalibrationProfileForActivity: (WFMotionAnalysisRunningCalibratorActivity_t)  activity
gender: (WFMotionAnalysisRunningCalibrationGender_t)  gender
andStature: (NSNumber *)  stature 

Upload default calibration profile for users gender and stature.

Parameters
activityThe activity to upload the default calibration for (walking or running).
genderUse WF_MOTION_ANALYSIS_RUNNING_CALIBRATOR_GENDER_UNKNOWN if not known.
statureUsers stature (height) in centimeter. Use nil if unkown.
Returns
false if an error occurred

Property Documentation

- (NSNumber*) averageSpeedForCurrentPhase
readwritenonatomicassign

Setter for average speed during current calibration phase.

If speed is required to continue the calibration process the delegate method wahooMotionAnalysisCalibrator:doesRequireSpeedToContinue: is called. Respond to the delegate call using this setter to continue.

- (int) currentPhase
readnonatomicassign

The current calibration phase.

- (id<WFWahooMotionAnalysisCalibratorDelegate>) delegate
readwritenonatomicassigninherited

The delegate which will receive event/progress update callbacks.

- (bool) extendedCalibrationEnabled
readwritenonatomicassign

The Regular calibration process requires the user to walk or run at a single speed for two minutes (single phase).

The Extended calibration requires the user to run at three different speeds for two minutes each (three phases). For the best result the speeds should be as distinct as possible. The resulting speed estimate can be more accurate than the result from the the regular calibration process.

The extended calibration is only supported for running calibration, not for walking calibration

- (WFMotionAnalysisRunningCalibrationGender_t) gender
readwritenonatomicassign

If the users gender is known it will be used to improve the calibration.

- (int) numberOfPhases
readnonatomicassign

The number of calibration phases.

- (NSTimeInterval) remainingTimeInPhase
readnonatomicassign

The time remaining in the current calibration phase.

- (WFSensorConnection*) sensorConnection
readnonatomicassigninherited

The Sensor Connection which is being used to preform the calibration.

- (WFWahooMotionAnalysisCalibratorState_t) state
readnonatomicassigninherited

The current state of this calibrator instance.

- (double) stature
readwritenonatomicassign

If the users stature (height) is known it will be used to improve the calibration Units are in centimeters.

- (WFWahooMotionAnalysisCalibratorWorkingStatus_t) workingStatus
readnonatomicassigninherited

The current working status of this calibrator instance.

This is only valid when the current state is WF_WAHOO_MOTION_ANALYSIS_CALIBRATOR_STATE_WORKING.