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_btle_types.h
Go to the documentation of this file.
1 //
2 // wf_btle_types.h
3 // WFConnector
4 //
5 // Created by Michael Moore on 2/28/12.
6 // Copyright (c) 2012 Wahoo Fitness. All rights reserved.
7 //
8 
9 #ifndef _wf_btle_types_h_
10 #define _wf_btle_types_h_
11 
13 #define WF_BTLE_BATT_LEVEL_INVALID 0xFF
14 
15 
17 // Battery Service Macros and Definitions.
19 
21 typedef enum
22 {
31 
33 
35 typedef enum
36 {
45 
47 
49 typedef enum
50 {
59 
61 
63 typedef enum
64 {
73 
75 
77 typedef struct
78 {
87 
89 
90 
92 // Glucose Service Macros and Definitions.
94 
96 typedef struct
97 {
120 
122 
124 typedef enum
125 {
148 
150 
152 typedef enum
153 {
166 
168 
172 typedef union
173 {
177  struct
178  {
180  BOOL bBatteryLow : 1;
182  BOOL bSensorMalfunction : 1;
184  BOOL bSampleSizeInsufficient : 1;
186  BOOL bStripInsertionError : 1;
188  BOOL bStripTypeIncorrect : 1;
190  BOOL bResultTooHigh : 1;
192  BOOL bResultTooLow : 1;
194  BOOL bTemperatureTooHigh : 1;
196  BOOL bTemperatureTooLow : 1;
198  BOOL bReadInterrupted : 1;
200  BOOL bGeneralDeviceFault : 1;
202  BOOL bTimeFault : 1;
203  BOOL : 1;
204  BOOL : 1;
205  BOOL : 1;
206  BOOL : 1;
207  };
208 
210 
212 typedef struct
213 {
217  NSTimeInterval baseTime;
228 
230 
232 typedef enum
233 {
250 
252 
254 typedef enum
255 {
268 
270 
272 typedef enum
273 {
284 
286 
288 typedef enum
289 {
304 
306 
308 typedef enum
309 {
322 
324 
326 typedef enum
327 {
332 
334 
336 typedef struct
337 {
357  float medication;
361  float hbA1c;
362 
364 
365 
367 typedef enum
368 {
383 
385 
387 typedef enum
388 {
403 
405 
406 
408 // Blood Pressure Service Macros and Definitions.
410 
412 typedef enum
413 {
420 
422 
424 typedef struct
425 {
436 
438 
439 
441 // RSC Service Macros and Definitions.
443 
445 typedef struct
446 {
457 
459 
460 
462 // CSC Service Macros and Definitions.
464 
466 typedef struct
467 {
474 
476 
478 typedef enum
479 {
502 
504 
506 typedef enum
507 {
541 
543 
545 typedef enum
546 {
559 
561 
562 #endif // _wf_btle_types_h_
Sample taken from whole blood - source not determined.
Definition: wf_btle_types.h:141
WFBTLEGlucoseSampleType_t sampleType
The sample type.
Definition: wf_btle_types.h:223
Brunch.
Definition: wf_btle_types.h:249
Command to report stored records.
Definition: wf_btle_types.h:372
No health issues.
Definition: wf_btle_types.h:301
Sample taken from a finger.
Definition: wf_btle_types.h:157
Medication measured in milligrams.
Definition: wf_btle_types.h:329
Battery is not present.
Definition: wf_btle_types.h:28
The battery is not currently charging.
Definition: wf_btle_types.h:56
Describes available features of a BTLE Glucose Monitor device.
Definition: wf_btle_types.h:96
WFBTLEGlucoseSampleLocation_t sampleLocation
The sample location.
Definition: wf_btle_types.h:225
Sample taken from an alternate test site.
Definition: wf_btle_types.h:159
Sample taken from capillary plasma.
Definition: wf_btle_types.h:131
Bedtime.
Definition: wf_btle_types.h:267
Tested by health care professional.
Definition: wf_btle_types.h:279
Command affects the first record.
Definition: wf_btle_types.h:400
BOOL bTempHighLowDetect
Can detect high or low sensor temperature.
Definition: wf_btle_types.h:111
WFBTLERecordOpCode_t
Describes a BTLE Record Access command code.
Definition: wf_btle_types.h:367
BOOL bSampleSize
Supports sample size.
Definition: wf_btle_types.h:103
WFBTLEBattStatePresent_t batteryPresent
Indicates whether the battery is present.
Definition: wf_btle_types.h:80
The battery level is critically low.
Definition: wf_btle_types.h:72
BOOL bStripTypeErrorDetect
Can detect strip type error.
Definition: wf_btle_types.h:107
Breakfast.
Definition: wf_btle_types.h:237
Carbohydrate ID not defined.
Definition: wf_btle_types.h:235
USHORT usSequence
The measurement sequence for this record.
Definition: wf_btle_types.h:215
BOOL bMultipleBond
Supports multiple bond.
Definition: wf_btle_types.h:119
The battery level is good.
Definition: wf_btle_types.h:70
WFBTLEGlucoseTesterInfo_t
Describes the tester information.
Definition: wf_btle_types.h:272
WFBTLEGlucoseSampleType_t
Describes a glucose sample type.
Definition: wf_btle_types.h:124
USHORT usExerciseDuration
The exercise duration, measured in seconds.
Definition: wf_btle_types.h:351
Battery presence is not known.
Definition: wf_btle_types.h:24
UCHAR ucExerciseIntensity
The exercise intensity, measured in percent.
Definition: wf_btle_types.h:353
The bike sensor is located in the right crankset.
Definition: wf_btle_types.h:493
Command to get the current gear ratio of the device.
Definition: wf_btle_types.h:540
The sensor location is other than the specified locations.
Definition: wf_btle_types.h:481
Sample taken from the earlobe.
Definition: wf_btle_types.h:161
Command affects all records.
Definition: wf_btle_types.h:392
WFBTLEGlucoseMealInfo_t mealInfo
The meal information.
Definition: wf_btle_types.h:345
Determination of battery discharge state is not supported.
Definition: wf_btle_types.h:40
Supper.
Definition: wf_btle_types.h:247
WFBTLEBattStateCritical_t batteryCritical
Indicates whether the battery level is critical.
Definition: wf_btle_types.h:86
The sensor is located on the hip.
Definition: wf_btle_types.h:487
The bike sensor is located in the hub.
Definition: wf_btle_types.h:499
Command to update the sensor location (not supported on BlueSC).
Definition: wf_btle_types.h:554
Immediate-acting insulin.
Definition: wf_btle_types.h:317
Sample taken from interstitial fluid.
Definition: wf_btle_types.h:145
OP CODE not defined.
Definition: wf_btle_types.h:370
Short-acting insulin.
Definition: wf_btle_types.h:315
WFBTLEGlucoseSensorStatus_t sensorStatus
The sensor status.
Definition: wf_btle_types.h:227
Casual.
Definition: wf_btle_types.h:265
Health information not available.
Definition: wf_btle_types.h:303
BOOL bCalibrationSupported
TRUE if the device supports a calibration procedure, otherwise FALSE.
Definition: wf_btle_types.h:454
Command to begin the calibration process (currently unused).
Definition: wf_btle_types.h:552
The battery is currently charging.
Definition: wf_btle_types.h:58
Pulse Rate is below the lower limit.
Definition: wf_btle_types.h:419
Response to retrieve stored records command.
Definition: wf_btle_types.h:513
WFBTLEBattStateCharging_t
Describes whether the battery is currently charging.
Definition: wf_btle_types.h:49
Command to delete stored records.
Definition: wf_btle_types.h:515
Meal information not defined.
Definition: wf_btle_types.h:257
BOOL bMultipleSensorLocationsSupported
TRUE if the device can be mounted in alternate locations, otherwise FALSE.
Definition: wf_btle_types.h:456
USHORT usSequence
The measurement sequence number.
Definition: wf_btle_types.h:339
Represents the battery power state.
Definition: wf_btle_types.h:77
WFBTLEGlucoseHealthInfo_t healthInfo
The health information.
Definition: wf_btle_types.h:349
BOOL bImproperPosition
TRUE if an improper measurement position was detected, otherwise FALSE.
Definition: wf_btle_types.h:435
WFBTLEBPPulseRange_t pulseRange
A WFBTLEBPPulseRange_t value describing the detected pulse rate.
Definition: wf_btle_types.h:433
Command to set the gear ratio on the device.
Definition: wf_btle_types.h:534
Pulse Rate is within the acceptable range.
Definition: wf_btle_types.h:415
WFBTLEBattStateCritical_t
Describes whether the battery level is critical.
Definition: wf_btle_types.h:63
Code indicating a record count response (sent from the device).
Definition: wf_btle_types.h:380
unsigned short USHORT
Definition: types.h:121
The battery is not currently discharging.
Definition: wf_btle_types.h:42
float concentration
The glucose concentration, measured in mg/dL.
Definition: wf_btle_types.h:221
Represents the status flags for the BTLE Glucose Monitor sensor.
Definition: wf_btle_types.h:172
BOOL bSpeedMeasurementSupported
TRUE if the device supports speed measurement, otherwise FALSE.
Definition: wf_btle_types.h:469
WFBTLEGlucoseCarbId_t carbohydrateId
The carbohydrate ID.
Definition: wf_btle_types.h:341
BOOL bInstStrideLengthMeasurementSupported
TRUE if the device supports instantaneous stride length measurement, otherwise FALSE.
Definition: wf_btle_types.h:448
BOOL bBodyMovementDetected
TRUE if body movement was detected during measurement, otherwise FALSE.
Definition: wf_btle_types.h:427
BOOL bStripInsertErrorDetect
Can detect strip insertion error.
Definition: wf_btle_types.h:105
Represents the context of a glucose measurement.
Definition: wf_btle_types.h:336
The battery is currently discharging.
Definition: wf_btle_types.h:44
BOOL bTotalDistanceMeasurementSupported
TRUE if the device supports total distance measurement, otherwise FALSE.
Definition: wf_btle_types.h:450
float carbohydrate
The carbohydrate quantity, measured in kilograms.
Definition: wf_btle_types.h:343
BOOL bCadenceMeasurementSupported
TRUE if the device supports cadence measurement, otherwise FALSE.
Definition: wf_btle_types.h:471
Sample taken from venous whole blood.
Definition: wf_btle_types.h:133
The battery critical state is not known.
Definition: wf_btle_types.h:66
Command to retrieve the sensor locations (not supported on BlueSC).
Definition: wf_btle_types.h:556
BOOL bReadInterruptDetect
Can detect read interrupt.
Definition: wf_btle_types.h:113
Medication measured in milliliters.
Definition: wf_btle_types.h:331
SSHORT ssTimeOffset
The offset of the measurement from the base time.
Definition: wf_btle_types.h:219
WFBTLEGlucoseMedId_t
Describes the medication ID.
Definition: wf_btle_types.h:308
signed short SSHORT
Definition: types.h:120
Minor health issues.
Definition: wf_btle_types.h:293
Command to set the time on the device.
Definition: wf_btle_types.h:522
Pre-mixed insulin.
Definition: wf_btle_types.h:321
Before a meal.
Definition: wf_btle_types.h:259
signed char BOOL
Definition: types.h:110
Command affects records less than or equal to a specified value.
Definition: wf_btle_types.h:394
BOOL bWalkingOrRunningSupported
TRUE if the device supports indicating running or walking, otherwise FALSE.
Definition: wf_btle_types.h:452
Lunch.
Definition: wf_btle_types.h:239
The battery charging state is not known.
Definition: wf_btle_types.h:52
WFBTLEGlucoseTesterInfo_t testerInfo
The tester information.
Definition: wf_btle_types.h:347
Under stress.
Definition: wf_btle_types.h:299
Rapid-acting insulin.
Definition: wf_btle_types.h:313
Command to delete stored records.
Definition: wf_btle_types.h:374
WFBTLEBPPulseRange_t
Describes the Pulse Rate Range detected by the Blood Pressure Monitor.
Definition: wf_btle_types.h:412
Represents the features of a Bike Speed and Cadence device.
Definition: wf_btle_types.h:466
Determination of battery critical state is not supported.
Definition: wf_btle_types.h:68
WFBTLEGlucoseMealInfo_t
Describes the meal information.
Definition: wf_btle_types.h:254
Sample taken from control solution.
Definition: wf_btle_types.h:147
WFBTLEBattStateDischarging_t
Describes whether the battery is currently discharging.
Definition: wf_btle_types.h:35
The sample location is not defined.
Definition: wf_btle_types.h:155
WFBTLEGlucoseHealthInfo_t
Describes the health information.
Definition: wf_btle_types.h:288
Command affects the last record.
Definition: wf_btle_types.h:402
The sample location is not available.
Definition: wf_btle_types.h:165
WFBTLEGlucoseCarbId_t
Describes the carbohydrate ID.
Definition: wf_btle_types.h:232
After a meal.
Definition: wf_btle_types.h:261
The bike sensor is located on the left pedal.
Definition: wf_btle_types.h:495
Sample taken from arterial whole blood.
Definition: wf_btle_types.h:137
unsigned char UCHAR
Definition: types.h:118
float hbA1c
HbA1c, measured in percent.
Definition: wf_btle_types.h:361
Tester information not defined.
Definition: wf_btle_types.h:275
BOOL bGeneralDeviceFault
Supports general device fault.
Definition: wf_btle_types.h:115
Code indicating a response to a command (sent from the device).
Definition: wf_btle_types.h:558
Represents the data for a glucose measurement.
Definition: wf_btle_types.h:212
Code indicating a response to a command (sent from the device).
Definition: wf_btle_types.h:526
Self tested.
Definition: wf_btle_types.h:277
BOOL bSensorMalfunctionDetect
Can detect sensor malfunction.
Definition: wf_btle_types.h:101
Sample taken from plasma - source not determined.
Definition: wf_btle_types.h:143
The battery is not chargeable.
Definition: wf_btle_types.h:54
The sensor is located in the shoe.
Definition: wf_btle_types.h:485
NSTimeInterval baseTime
The base time value.
Definition: wf_btle_types.h:217
The sensor is located on the top of the shoe.
Definition: wf_btle_types.h:483
Major health issues.
Definition: wf_btle_types.h:295
The bike sensor is located on the right pedal.
Definition: wf_btle_types.h:497
Command to retrieve stored records.
Definition: wf_btle_types.h:511
Sample taken from arterial plasma.
Definition: wf_btle_types.h:139
Command to abort the current operation.
Definition: wf_btle_types.h:376
OP CODE not defined.
Definition: wf_btle_types.h:548
WFBTLERecordOperator_t
Describes the operator for a BTLE Glucose Monitor record command.
Definition: wf_btle_types.h:387
Long-acting insulin.
Definition: wf_btle_types.h:319
BOOL bTimeFault
Supports time fault.
Definition: wf_btle_types.h:117
float medication
The medication quantity (units specified by medicationUnits).
Definition: wf_btle_types.h:357
The bike sensor is located in the left crankset.
Definition: wf_btle_types.h:491
BOOL bResultHighLowDetect
Can detect high or low result.
Definition: wf_btle_types.h:109
Code indicating a response to a command (sent from the device).
Definition: wf_btle_types.h:382
The battery discharge state is not known.
Definition: wf_btle_types.h:38
WFBTLECSCOpCode_t
Describes a command code for the BTLE Bike Speed and Cadence Sensor.
Definition: wf_btle_types.h:545
Determination of battery presence is not supported.
Definition: wf_btle_types.h:26
BOOL bMultipleSensorLocationsSupported
TRUE if the device can be mounted in alternate locations, otherwise FALSE.
Definition: wf_btle_types.h:473
WFBTLEBattStatePresent_t
Describes whether a battery is present.
Definition: wf_btle_types.h:21
Command to report the record count.
Definition: wf_btle_types.h:378
BOOL bLowBatteryDetect
Can detect low battery condition.
Definition: wf_btle_types.h:99
Sample type not defined.
Definition: wf_btle_types.h:127
Sample taken from a control solution.
Definition: wf_btle_types.h:163
Sample taken from capillary whole blood.
Definition: wf_btle_types.h:129
The bike sensor is located on the wheel.
Definition: wf_btle_types.h:489
WFBTLESensorLocation_t
Describes the location of a sensor.
Definition: wf_btle_types.h:478
During menses.
Definition: wf_btle_types.h:297
Pulse Rate exceeds the upper limit.
Definition: wf_btle_types.h:417
Fasting.
Definition: wf_btle_types.h:263
OP CODE not defined.
Definition: wf_btle_types.h:509
BOOL bCuffTooLoose
TRUE if the cuff fit is too loose, otherwise FALSE.
Definition: wf_btle_types.h:429
Drink.
Definition: wf_btle_types.h:245
Battery is present.
Definition: wf_btle_types.h:30
Snack.
Definition: wf_btle_types.h:243
The bike sensor is located in the rear dropout.
Definition: wf_btle_types.h:501
NULL operator.
Definition: wf_btle_types.h:390
Represents the status reported by the Blood Pressure Monitor.
Definition: wf_btle_types.h:424
Tested by laboratory.
Definition: wf_btle_types.h:281
Command affects records greater than or equal to a specified value.
Definition: wf_btle_types.h:396
BOOL bIrregularPulseDetected
TRUE if the an irregular pulse was detected, otherwise FALSE.
Definition: wf_btle_types.h:431
Represents the features of a Running Speed and Cadence device.
Definition: wf_btle_types.h:445
WFBTLEBattStateDischarging_t batteryDischarging
Indicates whether the battery is discharging.
Definition: wf_btle_types.h:82
Health information not defined.
Definition: wf_btle_types.h:291
WFBTLEGlucoseMedUnits_t
Describes the medication units.
Definition: wf_btle_types.h:326
WFBTLEGlucoseSampleLocation_t
Describes the location where a glucose sample was taken.
Definition: wf_btle_types.h:152
USHORT usStatus
The raw status bytes.
Definition: wf_btle_types.h:175
Tester information not available.
Definition: wf_btle_types.h:283
Command affects records within range of specified values.
Definition: wf_btle_types.h:398
Sample taken from venous plasma.
Definition: wf_btle_types.h:135
Medication ID not defined.
Definition: wf_btle_types.h:311
WFBTLEGlucoseMedId_t medicationId
The medication ID.
Definition: wf_btle_types.h:355
WFBTLEBattStateCharging_t batteryCharging
Indicates whether the battery is charging.
Definition: wf_btle_types.h:84
WFBTLEWahooCSCOpCode_t
Describes an odometer command code for the Wahoo Fitness BlueSC.
Definition: wf_btle_types.h:506
Command to reset the cumulative wheel revolutions (odometer).
Definition: wf_btle_types.h:550
WFBTLEGlucoseMedUnits_t medicationUnits
The medication units.
Definition: wf_btle_types.h:359
Command to abort the current operation.
Definition: wf_btle_types.h:524
Dinner.
Definition: wf_btle_types.h:241