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
wf_antfs_types.h
Go to the documentation of this file.
1 /*
2  * wf_antfs_types.h
3  * WFConnector
4  *
5  * Created by Michael Moore on 6/9/10.
6  * Copyright 2010 Wahoo Fitness. All rights reserved.
7  *
8  */
9 
10 #ifndef _WF_ANTFS_TYPES_H_
11 #define _WF_ANTFS_TYPES_H_
12 
13 //#import <WFConnector/common_types.h>
14 #import <WFConnector/types.h>
15 
16 
18 #define WF_ANTFS_PASSWORD_MAX_LENGTH 255
19 
21 #define ANTFS_FILE_DATA_TYPE_ANTFS 0x80
22 
23 #define ANTFS_FILE_SUB_TYPE_ACTIVITY 0x04
24 
25 #define ANTFS_FILE_SUB_TYPE_SETTINGS 0x02
26 
27 
28 #ifndef _WF_ANTFS_DEVICE_TYPE_T_
29 #define _WF_ANTFS_DEVICE_TYPE_T_
30 
31 typedef enum
32 {
55 
57 
58 #endif // _WF_ANTFS_DEVICE_TYPE_T_
59 
60 #ifndef _WF_ANTFS_DEVICE_MODE_T_
61 #define _WF_ANTFS_DEVICE_MODE_T_
62 
63 typedef enum
64 {
69 
71 
72 #endif // _WF_ANTFS_DEVICE_MODE_T_
73 
74 #ifndef _ANTFS_RESPONSE_T_
75 #define _ANTFS_RESPONSE_T_
76 
77 typedef enum
78 {
98  ANTFS_RESPONSE_DISCONNECT_BROADCAST_PASS, // ANT-FS Broadcast, client only (so far...)
158 
159 #endif // _ANTFS_RESPONSE_T_
160 
161 #ifndef _ANTFS_STATE_T_
162 #define _ANTFS_STATE_T_
163 
164 typedef enum
165 {
192 
193 } ANTFS_STATE;
194 #endif // _ANTFS_STATE_T_
195 
196 #ifndef _ANTFSP_DIRECTORY_T_
197 #define _ANTFSP_DIRECTORY_T_
198 
201 typedef struct
202 {
262 #endif // _ANTFSP_DIRECTORY_T_
263 
264 #ifndef _WF_FIT_FILE_PERMISSIONS_T_
265 #define _WF_FIT_FILE_PERMISSIONS_T_
266 
267 typedef enum
268 {
279 
281 #endif // _WF_FIT_FILE_PERMISSIONS_T_
282 
283 
284 #ifndef _ANTFS_DIRECTORY_HEADER_T_
285 #define _ANTFS_DIRECTORY_HEADER_T_
286 
289 typedef struct
290 {
342 #endif // _ANTFS_DIRECTORY_HEADER_T_
343 
344 #ifndef _WF_AND_PEDOMETER_RECORD_T_
345 #define _WF_AND_PEDOMETER_RECORD_T_
346 
349 typedef struct
350 {
359 
361 #endif // _WF_AND_PEDOMETER_RECORD_T_
362 
363 #ifndef _WF_AND_PEDOMETER_FILE_T_
364 #define _WF_AND_PEDOMETER_FILE_T_
365 
368 typedef struct
369 {
404 
406 #endif // _WF_AND_PEDOMETER_FILE_T_
407 
408 #ifndef _WF_ANTFS_CLIENT_PARAMS_
409 #define _WF_ANTFS_CLIENT_PARAMS_
410 #define ANTFS_AUTH_PASSTHRU ((UCHAR) 0x00)
411 
412 typedef struct
413 {
437 #endif // _WF_ANTFS_CLIENT_PARAMS_
438 
439 #ifndef _WF_ANTFS_CLIENT_ERROR_
440 #define _WF_ANTFS_CLIENT_ERROR_
441 
442 typedef enum
443 {
448 
450 #endif // _WF_ANTFS_CLIENT_ERROR_
451 
452 #ifndef _WF_GENDER_T_
453 #define _WF_GENDER_T_
454 
455 typedef enum
456 {
461 
462 } WFGender_t;
463 #endif // _WF_GENDER_T_
464 
465 #ifndef _WF_FITNESS_EQUIPMENT_SETTINGS_T_
466 #define _WF_FITNESS_EQUIPMENT_SETTINGS_T_
467 
468 typedef struct
469 {
471  __unsafe_unretained NSString* userName;
473  float weight;
475  float height;
484 
486 #endif // _WF_FITNESS_EQUIPMENT_SETTINGS_T_
487 
488 
489 #endif // _WF_ANTFS_TYPES_H_
UCHAR ucReserved04
Reserved byte.
Definition: wf_antfs_types.h:320
USHORT usBeaconDeviceType
Client device type (in beacon).
Definition: wf_antfs_types.h:417
The device is ANT FS Client mode.
Definition: wf_antfs_types.h:68
Pairing request timed out.
Definition: wf_antfs_types.h:112
Authentication failed.
Definition: wf_antfs_types.h:108
WFANDPedometerRecord_t stFifthDayBefore
The record from five days before.
Definition: wf_antfs_types.h:397
Specifies a generic ANT FS enabled device which uses FIT protocol.
Definition: wf_antfs_types.h:40
Specifies the Garmin Forerunner 310.
Definition: wf_antfs_types.h:46
USHORT usBeaconDeviceManufID
Client manufacturing ID (in beacon).
Definition: wf_antfs_types.h:419
Invalid file index.
Definition: wf_antfs_types.h:120
WFGender_t gender
Gender.
Definition: wf_antfs_types.h:479
BOOL bPairingEnabled
Pairing is enabled/disabled.
Definition: wf_antfs_types.h:425
The download request was rejected by the client.
Definition: wf_antfs_types.h:118
The device is searching for a peer device.
Definition: wf_antfs_types.h:175
ULONG ulFileSize
Size of file in bytes.
Definition: wf_antfs_types.h:252
Specifies the A&D pedometer.
Definition: wf_antfs_types.h:38
The file may be written.
Definition: wf_antfs_types.h:276
The file may be read.
Definition: wf_antfs_types.h:278
UCHAR ucReserved05
Reserved byte.
Definition: wf_antfs_types.h:322
WFANDPedometerRecord_t stFirstDayBefore
The record for the previous day.
Definition: wf_antfs_types.h:389
Describes an individual record from the A&D Pedometer.
Definition: wf_antfs_types.h:349
ANT FS erase state.
Definition: wf_antfs_types.h:187
ANT FS authentication state.
Definition: wf_antfs_types.h:179
Describes the metadata for an ANT FS directory entry.
Definition: wf_antfs_types.h:201
The manual transfer request passed.
Definition: wf_antfs_types.h:150
UCHAR ucExerciseHours
The total number of exercise hours.
Definition: wf_antfs_types.h:352
Request for download.
Definition: wf_antfs_types.h:114
An error was encountered during the download process.
Definition: wf_antfs_types.h:447
Request for pairing.
Definition: wf_antfs_types.h:110
The erase request failed.
Definition: wf_antfs_types.h:148
The download failed.
Definition: wf_antfs_types.h:126
Appending data is allowed.
Definition: wf_antfs_types.h:270
ULONG ulSerialNumber
Client serial number.
Definition: wf_antfs_types.h:415
Upload request.
Definition: wf_antfs_types.h:128
BOOL bDataAvailable
Data is available/not available for download.
Definition: wf_antfs_types.h:429
Female.
Definition: wf_antfs_types.h:460
The upload request passed.
Definition: wf_antfs_types.h:130
Specifies any supported Garmin fitness watch.
Definition: wf_antfs_types.h:42
THe device is receiving data.
Definition: wf_antfs_types.h:191
USHORT usFileNumber
Number used to identify a specific instance of a file sub-type.
Definition: wf_antfs_types.h:224
Male.
Definition: wf_antfs_types.h:458
unsigned short USHORT
Definition: types.h:121
UCHAR ucAuthType
Authentication type to include in beacon.
Definition: wf_antfs_types.h:431
ANTFS_RESPONSE
Describes an ANT FS response.
Definition: wf_antfs_types.h:77
BOOL bIsWeightMetric
Specifies whether the WFANDPedometerFile_t::ucWeight value is defined in metric units.
Definition: wf_antfs_types.h:387
The connection was lost.
Definition: wf_antfs_types.h:100
ULONG ulTimestamp
The number of seconds elapsed since 00:00 in the morning of December 31, 1989.
Definition: wf_antfs_types.h:340
BOOL hrmEnabled
TRUE if FE machine should connect to HRM.
Definition: wf_antfs_types.h:481
Specifies the ANT FS enabled blood pressure cuff.
Definition: wf_antfs_types.h:36
Invalid file index.
Definition: wf_antfs_types.h:134
Specifies the Garmin Forerunner 60.
Definition: wf_antfs_types.h:44
USHORT usTotalCalories
The total number of calories burned.
Definition: wf_antfs_types.h:358
Manual request response failed.
Definition: wf_antfs_types.h:154
WFGender_t
Describes the gender.
Definition: wf_antfs_types.h:455
The serial line is open.
Definition: wf_antfs_types.h:171
WFANDPedometerRecord_t stSixthDayBefore
The record from six days before.
Definition: wf_antfs_types.h:399
signed char BOOL
Definition: types.h:110
The download request passed.
Definition: wf_antfs_types.h:116
UCHAR ucReserved02
Reserved byte.
Definition: wf_antfs_types.h:316
UCHAR ucPairingTimeout
In seconds.
Definition: wf_antfs_types.h:435
Describes the ANT FS directory header.
Definition: wf_antfs_types.h:289
Describes the file format for the A&D Pedometer.
Definition: wf_antfs_types.h:368
Specifies the Garmin Forerunner 610.
Definition: wf_antfs_types.h:50
Client beacon opened.
Definition: wf_antfs_types.h:90
The file may be erased.
Definition: wf_antfs_types.h:274
UCHAR ucExerciseMinutes
The number of exercise minutes (in addition to the total hours).
Definition: wf_antfs_types.h:354
The device is connected to a peer device.
Definition: wf_antfs_types.h:177
Manual request transmit failed.
Definition: wf_antfs_types.h:152
USHORT usTotalSteps
The total number of steps taken.
Definition: wf_antfs_types.h:356
WFAntFSClientError_t
Describes an error encountered by the ANT FS Client.
Definition: wf_antfs_types.h:442
Specifies the Garmin Forerunner 405.
Definition: wf_antfs_types.h:48
Polling USB for available device.
Definition: wf_antfs_types.h:169
unsigned char UCHAR
Definition: types.h:118
ANT FS download state.
Definition: wf_antfs_types.h:183
WFANDPedometerRecord_t stSecondDayBefore
The record from two days before.
Definition: wf_antfs_types.h:391
UCHAR ucTimeFormat
Defines how the system will keep track of Date/Time Stamps.
Definition: wf_antfs_types.h:312
Broadcast disconnect succeeded.
Definition: wf_antfs_types.h:98
UCHAR ucLinkPeriod
Link Channel Period.
Definition: wf_antfs_types.h:423
BOOL bUploadEnabled
Upload is enabled/disabled.
Definition: wf_antfs_types.h:427
Requested upload cannot be written.
Definition: wf_antfs_types.h:136
ANT-FS Client Parameters.
Definition: wf_antfs_types.h:412
WFAntFSDeviceType_t
Describes a type of ANT FS enabled device.
Definition: wf_antfs_types.h:31
Insufficient space to write the requested upload.
Definition: wf_antfs_types.h:138
The erase request was rejected.
Definition: wf_antfs_types.h:146
Authentication is not available.
Definition: wf_antfs_types.h:102
Client beacon closed.
Definition: wf_antfs_types.h:92
BOOL bIsStrideMetric
Specifies whether the WFANDPedometerFile_t::ucStrideLength value is defined in metric units...
Definition: wf_antfs_types.h:378
WFANDPedometerRecord_t stFourthDayBefore
The record from four days before.
Definition: wf_antfs_types.h:395
ULONG ulSystemTime
The number of seconds elapsed since the system was powered up.
Definition: wf_antfs_types.h:329
UCHAR ucGeneralFlags
Bit mapped flags of file permissions.
Definition: wf_antfs_types.h:246
UCHAR ucVersion
The version of the Directory File Structure.
Definition: wf_antfs_types.h:298
The upload request was rejected.
Definition: wf_antfs_types.h:132
UCHAR ucElementLength
The length of each structure in bytes.
Definition: wf_antfs_types.h:302
Failed to initialize the serial line.
Definition: wf_antfs_types.h:86
UCHAR ucBeaconFrequency
Link Radio Frequency.
Definition: wf_antfs_types.h:421
WFAntFSDeviceMode_t
Describes the ANT FS mode of a device.
Definition: wf_antfs_types.h:63
Unspecified error.
Definition: wf_antfs_types.h:445
The request for a session failed.
Definition: wf_antfs_types.h:88
UCHAR age
Age, measured in years.
Definition: wf_antfs_types.h:477
No response.
Definition: wf_antfs_types.h:80
UCHAR ucWeight
Specifies the weight.
Definition: wf_antfs_types.h:385
ANTFS_STATE
Describes the ANT FS device state.
Definition: wf_antfs_types.h:164
WFANDPedometerRecord_t stCurrentDay
The record from the current day.
Definition: wf_antfs_types.h:403
UCHAR ucFileDataType
This field specifies the data type of the file.
Definition: wf_antfs_types.h:214
Disconnect succeeded.
Definition: wf_antfs_types.h:96
The device is disconnecting.
Definition: wf_antfs_types.h:173
WFFitFilePermissions
Describes the bit-field values for ANT FS file permissions.
Definition: wf_antfs_types.h:267
The serial line was initialized successfully.
Definition: wf_antfs_types.h:84
UCHAR ucFileSubType
Specifies the data sub type of the .FIT file.
Definition: wf_antfs_types.h:218
UCHAR ucReserved01
Reserved byte.
Definition: wf_antfs_types.h:314
The erase request passed.
Definition: wf_antfs_types.h:144
The authentication was rejected by the client.
Definition: wf_antfs_types.h:106
The device is ANT FS Host mode.
Definition: wf_antfs_types.h:66
The serial line was opened successfully.
Definition: wf_antfs_types.h:82
ANT FS transport state.
Definition: wf_antfs_types.h:181
Specifies the ANT FS enabled weight scale.
Definition: wf_antfs_types.h:34
unsigned long ULONG
Definition: types.h:133
ANT FS upload state.
Definition: wf_antfs_types.h:185
UCHAR ucSpecificFlags
Bit mapped flags of file data type specific permissions.
Definition: wf_antfs_types.h:233
UCHAR ucReserved03
Reserved byte.
Definition: wf_antfs_types.h:318
The file has been downloaded.
Definition: wf_antfs_types.h:272
float height
Height, measured in meters.
Definition: wf_antfs_types.h:475
UCHAR ucBeaconTimeout
In seconds.
Definition: wf_antfs_types.h:433
float weight
Weight, measured in kilograms.
Definition: wf_antfs_types.h:473
The upload failed.
Definition: wf_antfs_types.h:140
Specifies the Garmin Forerunner 910XT.
Definition: wf_antfs_types.h:54
USHORT usFileIndex
This field specifies the data file index.
Definition: wf_antfs_types.h:208
WFANDPedometerRecord_t stThirdDayBefore
The record from three days before.
Definition: wf_antfs_types.h:393
The request to cancel has been processed.
Definition: wf_antfs_types.h:156
Specifies an ANT FS enabled watch supporting the Fitness Equipment profile.
Definition: wf_antfs_types.h:52
Represents the settings transferred to an FE machine.
Definition: wf_antfs_types.h:468
Requested file cannot be read.
Definition: wf_antfs_types.h:122
Authentication passed.
Definition: wf_antfs_types.h:104
The device is sending data.
Definition: wf_antfs_types.h:189
Connection succeeded.
Definition: wf_antfs_types.h:94
The device is idle.
Definition: wf_antfs_types.h:167
UCHAR ucStrideLength
Specifies the stride length.
Definition: wf_antfs_types.h:376
__unsafe_unretained NSString * userName
User display name.
Definition: wf_antfs_types.h:471
Request to erase a file.
Definition: wf_antfs_types.h:142
Download not ready.
Definition: wf_antfs_types.h:124
ULONG ulTimestamp
The number of seconds elapsed since 00:00 in the morning of December 31, 1989.
Definition: wf_antfs_types.h:260
WFANDPedometerRecord_t stSeventhDayBefore
The record from seven days before.
Definition: wf_antfs_types.h:401
USHORT hrmDeviceId
The device ID of the HRM which should be connected (requires hrmEnabled = TRUE).
Definition: wf_antfs_types.h:483