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
WFHardwareConnector.h
Go to the documentation of this file.
1 //
2 // WFHardwareConnector.h
3 // WFHardwareConnector
4 //
5 // Created by Michael Moore on 2/9/10.
6 // Copyright 2010 Wahoo Fitness. All rights reserved.
7 //
8 
9 #import <Foundation/Foundation.h>
10 #import <WFConnector/hardware_connector_types.h>
11 #import <WFConnector/_WFHardwareConnector.h>
12 
13 
14 #define WF_API_VERSION @"3.6.1"
15 
16 
17 @class WFSensorConnection;
18 @class WFConnectionParams;
19 @class WFConnectorSettings;
20 @class WFFisicaInfo;
21 
22 
23 #pragma mark -
24 #pragma mark WFHardwareConnector Interface Declaration
25 
37 {
38 }
39 
40 
41 #pragma mark -
42 #pragma mark WFHardwareConnector Property Declarations
43 
47 @property (nonatomic, readonly) NSString* apiVersion;
48 
59 @property (nonatomic, readonly) BOOL isAntBridgeActive;
60 
72 @property (nonatomic, readonly) BOOL isAntBridgeEnabled;
73 
88 @property (nonatomic, readonly) BOOL isFisicaConnected;
89 
99 @property (nonatomic, readonly) BOOL isBTLEEnabled;
100 
110 @property (nonatomic, readonly) BOOL isCommunicationHWReady;
111 
115 @property (nonatomic, readonly) BOOL hasBTLESupport;
116 
121 @property (nonatomic, readonly) WFFisicaInfo* fisicaInfo;
122 
130 @property (nonatomic, assign) NSTimeInterval sampleRate;
131 
133 @property (nonatomic, readonly) WFConnectorSettings* settings;
134 
135 
136 #pragma mark -
137 #pragma mark WFHardwareConnector Method Declarations
138 
144 - (UCHAR)availableChannelCount;
145 
171 - (WFHardwareConnectorState_t) currentState;
172 
242 - (BOOL)discoverDevicesOfType:(WFSensorType_t)eSensorType onNetwork:(WFNetworkType_t)eNetworkType searchTimeout:(NSTimeInterval)timeout DEPRECATED_MSG_ATTRIBUTE("Please see WFDiscoveryManager class");
243 
261 - (NSSet*)cancelDiscoveryOnNetwork:(WFNetworkType_t)eNetworkType DEPRECATED_MSG_ATTRIBUTE("Please see WFDiscoveryManager class");
288 - (BOOL)enableAntBridge:(BOOL)bEnable;
289 
304 - (BOOL)enableBTLE:(BOOL)bEnable;
305 
350 - (BOOL)enableBTLE:(BOOL)bEnable inBondingMode:(BOOL)bBondingMode;
351 
361 - (NSArray*)getSensorConnections:(WFSensorType_t)sensorType;
362 
435 - (WFSensorConnection*)requestSensorConnection:(WFConnectionParams*)params;
436 
461 - (WFSensorConnection*)requestSensorConnection:(WFConnectionParams*)params withProximity:(WFProximityRange_t)proximity;
462 
492 - (WFSensorConnection*)requestSensorConnection:(WFConnectionParams*)params withProximity:(WFProximityRange_t)proximity error:(NSError**)ppError;
493 
507 - (BOOL)resetConnections;
508 
512 - (void)resetSampleTimer;
513 
528 - (void)setSampleTimerDataCheck:(BOOL)checkData;
529 
530 // START Build-specific method declarations.
531 //
532 // Mac OSX-only methods.
533 
534 #if !defined(WF_API_BUILD) || defined(MAC_OSX_BUILD)
535 /* These methods are only applicable for the Mac OSX build. */
536 
550 - (BOOL)openUSBSession:(ULONG)ulBaudRate;
551 
562 - (BOOL)openUSBSession:(ULONG)ulBaudRate deviceNumber:(UCHAR)ucUSBDeviceNumber;
563 
564 #endif
565 
566 // iOS-only methods.
567 
568 #if !defined(WF_API_BUILD) || !defined(MAC_OSX_BUILD)
569 /* These methods are only applicable for the iOS build. */
570 
581 - (void)prepareForBackground;
582 
593 - (void)returnFromBackground;
594 
595 #endif
596 // END Build-specific method declarations.
597 
598 #pragma mark -
599 #pragma mark WFHardwareConnector Data Access Methods
600 
609 - (BOOL)resetAllSensorData;
610 
611 
616 - (NSURL*)getWahooFinessUtilityAppUrl;
617 
618 
619 #pragma mark -
620 #pragma mark WFHardwareConnector Class Method Declarations
621 
631 + (WFHardwareConnector*)sharedConnector;
632 
633 @end
WFProximityRange_t
Describes the proximity range for pairing ANT devices.
Definition: hardware_connector_types.h:557
Represents the connection parameters used to establish a connection to an ANT device.
Definition: WFConnectionParams.h:23
Provides a means of persisting settings for the WFConnector.
Definition: WFConnectorSettings.h:28
Represents the internal-use base class for the WFHardwareConnector.
Definition: _WFHardwareConnector.h:15
The WFHardwareConnector represents the bridge between the fisica sensor receiver (dongle or case) and...
Definition: WFHardwareConnector.h:36
signed char BOOL
Definition: types.h:110
WFHardwareConnectorState_t
Describes the state of the WFHardwareConnector.
Definition: hardware_connector_types.h:28
unsigned char UCHAR
Definition: types.h:118
Represents the connection for an ANT sensor.
Definition: WFSensorConnection.h:43
unsigned long ULONG
Definition: types.h:133
Definition: WFDiscoveryManager.h:18
WFSensorType_t
Describes a type of hardware sensor device.
Definition: hardware_connector_types.h:52
Represents information describing the properties and capabilities of the currently connected fisica d...
Definition: WFFisicaInfo.h:17
WFNetworkType_t
Describes a type of hardware sensor device.
Definition: hardware_connector_types.h:146