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
WFHeartrateConnection(TICKRX) Category Reference

WFHeartrateConnection+TICKRX. More...

#import <WFHeartrateConnection+TICKRX.h>

Instance Methods

(WFWahooMotionAnalysisData *) - getMotionAnalysisData
 Returns the latest data available from the sensor. More...
 
Methods related to Activity Type Management
(BOOL- getActivityType
 Request the current activity type from the device. More...
 
(BOOL- setActivityType:
 Set the activity type (mode) of the device. More...
 
Methods related to Motion Analysis Calibration Management
(BOOL- getActivityCalibrationForActivityType:
 Request the current calibration profile from the device for a specific activity type. More...
 
(BOOL- setActivityCalibration:
 Set the calibration profile on the device for a specific activity type. More...
 
(BOOL- resetActivityCalibrationToDefaultsForActivityType:
 Reset the calibration to default for a specific activity type. More...
 
Methods related to device vibration
(BOOL- performVibrationWithPattern:
 Perform vibration. More...
 

Properties

id
< WFHeartrateConnectionTICKRXDelegate
heartrateConnectionTICKRXDelegate
 The delegate which will receive TICKRX related callbacks. More...
 
id
< WFHeartrateConnectionTICKRXSpeedProvider
motionAnalysisProcessingSpeedProvider
 The delegate responsible for returning current speed used in motion analysis processing. More...
 
BOOL tickrxDeviceIsReady
 A flag to indicate if the device is ready - if the device is not yet ready, commands should not be sent. More...
 

Detailed Description

WFHeartrateConnection+TICKRX.

Method Documentation

- (BOOL) getActivityCalibrationForActivityType: (WFWahooMotionAnalysisActivityType_t)  activityType

Request the current calibration profile from the device for a specific activity type.

The delegate will be notified using the appropriate callback.

See also
WFHeartrateConnectionTICKRXDelegate hrTICKRXConnection:didGetActivityCalibration:error:
Returns
FALSE if the command could not be sent.
Note: a return value of TRUE does not guarantee that the command completed successfully.

Extends class WFHeartrateConnection.

- (BOOL) getActivityType

Request the current activity type from the device.

The delegate will be notified using the appropriate callback.

See also
WFHeartrateConnectionTICKRXDelegate hrTICKRXConnection:didGetActivityType:error:
Returns
FALSE if the command could not be sent.
Note: a return value of TRUE does not guarantee that the command completed successfully.

Extends class WFHeartrateConnection.

- (WFWahooMotionAnalysisData*) getMotionAnalysisData

Returns the latest data available from the sensor.

See also
- getData (WFSensorConnection)
Returns
A WFWahooMotionAnalysisData instance containing data if available, otherwise nil.

Extends class WFHeartrateConnection.

- (BOOL) performVibrationWithPattern: (NSArray *)  vibrationPattern

Perform vibration.

Parameters
vibrationPatternThe vibration timing pattern, consisting of an array with up to five vibration step objects. Each step object is a dictionary containing vibration on- and off duration in seconds:"onDuration": @(<on duration in seconds>), @"offDuration": @(<off duration="" in="" seconds>="">)}

Extends class WFHeartrateConnection.

- (BOOL) resetActivityCalibrationToDefaultsForActivityType: (WFWahooMotionAnalysisActivityType_t)  activityType

Reset the calibration to default for a specific activity type.

The delegate will be notified using the appropriate callback.

See also
WFHeartrateConnectionTICKRXDelegate hrTICKRXConnection:didResetActivityCalibrationToDefaultsWithError:
Parameters
activityTypeThe activity type for which the calibration should be reset.
Returns
FALSE if the command could not be sent.
Note: a return value of TRUE does not guarantee that the command completed successfully.

Extends class WFHeartrateConnection.

- (BOOL) setActivityCalibration: (WFWahooMotionAnalysisCalibrationProfile *)  calibrationProfile

Set the calibration profile on the device for a specific activity type.

The delegate will be notified using the appropriate callback.

See also
WFHeartrateConnectionTICKRXDelegate hrTICKRXConnection:didSetActivityCalibrationWithError:
Parameters
calibrationProfileThe desired calibration profile to upload to the device. Note that the calibration profile itself belongs to a specific activity type.
Returns
FALSE if the command could not be sent.
Note: a return value of TRUE does not guarantee that the command completed successfully.

Extends class WFHeartrateConnection.

- (BOOL) setActivityType: (WFWahooMotionAnalysisActivityType_t)  activityType

Set the activity type (mode) of the device.

The delegate will be notified using the appropriate callback.

See also
WFHeartrateConnectionTICKRXDelegate hrTICKRXConnection:didSetActivityType:error:
Parameters
activityTypeThe desired activity type for the device.
Returns
FALSE if the command could not be sent.
Note: a return value of TRUE does not guarantee that the command completed successfully.

Extends class WFHeartrateConnection.

Property Documentation

- (id<WFHeartrateConnectionTICKRXDelegate>) heartrateConnectionTICKRXDelegate
readwritenonatomicassign

The delegate which will receive TICKRX related callbacks.

Extends class WFHeartrateConnection.

- (id<WFHeartrateConnectionTICKRXSpeedProvider>) motionAnalysisProcessingSpeedProvider
readwritenonatomicassign

The delegate responsible for returning current speed used in motion analysis processing.

Extends class WFHeartrateConnection.

- (BOOL) tickrxDeviceIsReady
readnonatomicassign

A flag to indicate if the device is ready - if the device is not yet ready, commands should not be sent.

When the device is not yet ready, the hrTICKRXConnectionDidReceiveDeviceReady: delegate callback should be called after a short period of time (this should not take longer than 5 seconds after the device connection is correctly established).

Extends class WFHeartrateConnection.