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

Represents the raw data available from the ANT+ Heart Rate Monitor sensor. More...

#import <WFHeartrateRawData.h>

+ Inheritance diagram for WFHeartrateRawData:
+ Collaboration diagram for WFHeartrateRawData:

Properties

UCHAR beatCount
 A single byte value which increments with each heart beat event. More...
 
USHORT beatTime
 Represents the time of the last valid heart beat event. More...
 
WFBTLECommonDatabtleCommonData
 Common sensor data for BTLE sensors, provides information about the sensor. More...
 
WFCommonDatacommonData
 Common sensor data, provides information about the sensor. More...
 
UCHAR computedHeartrate
 Instantaneous heart rate, in beats per minute. More...
 
BOOL isDataStale
 TRUE if data is considered stale, otherwise FALSE. More...
 
USHORT previousBeatTime
 Represents the time of the previous valid heart beat event. More...
 
WFConnectorSettingssettings
 Gets the persistent settings for the Wahoo API. More...
 

Detailed Description

Represents the raw data available from the ANT+ Heart Rate Monitor sensor.

ANT+ sensors send data in multiple packets. The WFHeartrateRawData combines the more advanced (less commonly used) of this data into a single entity. The data represents the latest of each data type sent from the sensor.

Property Documentation

- (UCHAR) beatCount
readwritenonatomicassign

A single byte value which increments with each heart beat event.

This value will roll over every 255 counts.

- (USHORT) beatTime
readwritenonatomicassign

Represents the time of the last valid heart beat event.

The time units are 1/1024 seconds. Since the values are stored in two byte integers which have a maximum value of 65536, the value will roll over at 64 seconds (65536 / 1024). This should be taken into consideration when determining the currency of the data.

- (WFBTLECommonData*) btleCommonData
readwritenonatomicretain

Common sensor data for BTLE sensors, provides information about the sensor.

Note
This property is only available for BTLE sensors. All other sensors will have a nil value.
- (WFCommonData*) commonData
readnonatomicassign

Common sensor data, provides information about the sensor.

- (UCHAR) computedHeartrate
readwritenonatomicassign

Instantaneous heart rate, in beats per minute.

The valid values are 1-255, a value of 0 represents invalid data.

- (BOOL) isDataStale
readnonatomicassigninherited

TRUE if data is considered stale, otherwise FALSE.

- (USHORT) previousBeatTime
readwritenonatomicassign

Represents the time of the previous valid heart beat event.

See the WFHeartrateData::beatTime documentation for explanation of time values.

- (WFConnectorSettings*) settings
readnonatomicassigninherited

Gets the persistent settings for the Wahoo API.