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

Provides a means of communicating with, and transferring data from a Blood Pressure Profile ANT FS device. More...

#import <WFBloodPressureManager.h>

+ Inheritance diagram for WFBloodPressureManager:
+ Collaboration diagram for WFBloodPressureManager:

Instance Methods

(ULONG- clientSerialNumber
 The client serial number (as specified in the ANT FS Beacon). More...
 
(BOOL- connectToDevice:passkeyLength:
 Initiates a connection request to the ANT FS device. More...
 
(WFAntFSDeviceType_t- deviceType
 The type of device managed by this WFAntFileManager. More...
 
(BOOL- disconnectDevice
 Destroys the connection to the device. More...
 
(BOOL- eraseDeviceData
 Erases all records stored on the device. More...
 
(NSArray *) - getFitRecordsFromFile:cancelPointer:
 Returns a collection of WFFitRecord instances representing the records in the FIT file at the specified path. More...
 
(BOOL- requestDirectoryInfo
 Initiates a request for directory information from the device. More...
 
(BOOL- requestFile:fileSize:
 Initiates a request to download the file a the specified index. More...
 
(BOOL- setDevicePasskey:passkeyLength:
 Updates the passkey used to authenticate the connection. More...
 
(BOOL- setDeviceTime
 Initiates a request to set the time on the device to the current system time. More...
 

Properties

id< WFAntFSDeviceDelegatedelegate
 Gets or sets the instance which will handle delegated methods for the WFAntFSDevice. More...
 

Detailed Description

Provides a means of communicating with, and transferring data from a Blood Pressure Profile ANT FS device.

Method Documentation

- (ULONG) clientSerialNumber

The client serial number (as specified in the ANT FS Beacon).

Returns
The 32-bit client serial number.
- (BOOL) connectToDevice: (UCHAR *)  pucPasskey
passkeyLength: (UCHAR ucLength 

Initiates a connection request to the ANT FS device.

Parameters
pucPasskeyA pointer to a buffer where the passkey used to authenticate with the device is stored.
ucLengthThe length of the passkey, in bytes.
Returns
TRUE if the connection request was initiated successfully, otherwise FALSE.
- (WFAntFSDeviceType_t) deviceType

The type of device managed by this WFAntFileManager.

Returns
A WFAntFSDeviceType_t representing the device type.
- (BOOL) disconnectDevice

Destroys the connection to the device.

Returns
TRUE if the disconnect request was sent successfully, otherwise FALSE.
- (BOOL) eraseDeviceData

Erases all records stored on the device.

The blood pressure cuff stores a certain number of records (typically 50) in its internal memory. This method will erase all records.

Returns
TRUE if the erase operation was successful, otherwise FALSE.
- (NSArray*) getFitRecordsFromFile: (NSString *)  filePath
cancelPointer: (volatile BOOL *)  pbCancel 

Returns a collection of WFFitRecord instances representing the records in the FIT file at the specified path.

Parameters
filePathThe path to the FIT file.
pbCancelA pointer to a BOOL used to cancel the FIT parsing operation. Set this value to NULL if the ability to cancel is not desired. Setting the value of the underlying BOOL to TRUE during the FIT parsing operation will cancel the operation in progress.
Returns
An array containing the file records.
- (BOOL) requestDirectoryInfo

Initiates a request for directory information from the device.

Returns
TRUE if the request was sent successfully, otherwise FALSE.
- (BOOL) requestFile: (USHORT usFileIndex
fileSize: (ULONG ulFileSize 

Initiates a request to download the file a the specified index.

Parameters
usFileIndexThe file system index of the requested file.
ulFileSizeThe size of the requested file, in bytes.
Returns
TRUE if the request was sent successfully, otherwise FALSE.
- (BOOL) setDevicePasskey: (UCHAR *)  pucPasskey
passkeyLength: (UCHAR ucLength 

Updates the passkey used to authenticate the connection.

Note
This does not modify the passkey stored on the device.
Parameters
pucPasskeyA pointer to a buffer where the passkey used to authenticate with the device is stored.
ucLengthThe length of the passkey, in bytes.
Returns
TRUE if the passkey was updated successfully, otherwise FALSE.
- (BOOL) setDeviceTime

Initiates a request to set the time on the device to the current system time.

Returns
TRUE if the request was sent successfully, otherwise FALSE.

Property Documentation

- (id<WFAntFSDeviceDelegate>) delegate
readwritenonatomicretaininherited

Gets or sets the instance which will handle delegated methods for the WFAntFSDevice.

Note
The WFAntFSDeviceDelegate protocol defines common functionallity for all types of ANT FS devices. The WFAntFileManagerDelegate and WFAntFSClientDelegate protocols extend this protocol for the specific FS mode. The delegate property should be set to a delegate of the appropriate specific protocol for the mode. As of API v2.1.3, this would be WFAntFileManagerDelegate for ANT FS devices using host mode, and WFAntFSClientDelegate for client mode devices.