hardware_connector_types.h File Reference

#include <WFConnector/types.h>

Include dependency graph for hardware_connector_types.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	WFBikePowerCalibrationCapabilities_t
	Describes status information on auto zero functions and outputs of raw and offset torque values. More...
struct	WFBikePowerCalibrationCTF_t
	Describes the calibration response specific to the CTF type Bike Power meter. More...
struct	WFBikePowerCalibrationData_t
	Describes calibration information for a Bike Power sensor. More...
struct	WFBikePowerCalibrationGeneral_t
	Describes the general calibration response for the Bike Power meter. More...
struct	WFWeightScaleUserProfile_t
	Describes user profile data for the weight scale. More...

Macros
#define	_WF_ANT_BRIDGE_STATE_T_
#define	_WF_BIKE_POWER_CALIBRATION_CAPABILITIES_T_
#define	_WF_BIKE_POWER_CALIBRATION_CTF_T_
#define	_WF_BIKE_POWER_CALIBRATION_DATA_T_
#define	_WF_BIKE_POWER_CALIBRATION_GENERAL_T_
#define	_WF_BIKE_POWER_TYPE_T_
#define	_WF_BTLE_CH_ALERT_LEVEL_T_
#define	_WF_BTLE_TEMPERATURE_TYPE_T_
#define	_WF_CAL_CONFIDENCE_T_
#define	_WF_COMPARISON_TYPE_T_
#define	_WF_CONNECTION_CP_T_
#define	_WF_CONNECTOR_ERROR_DOMAIN_
#define	_WF_CP_RESPONSE_ORIGIN_T_
#define	_WF_DEVICE_CONTROL_POINT_ERROR_DOMAIN_
#define	_WF_FITNESS_EQUIPMENT_HR_SOURCE_T_
#define	_WF_FITNESS_EQUIPMENT_STATE_T_
#define	_WF_FITNESS_EQUIPMENT_TYPE_T_
#define	_WF_GEO_CACHE_PROGRAM_STATUS_T_
#define	_WF_GPS_FIX_TYPE_T_
#define	_WF_HARDWARE_CONNECTOR_STATE_T_
#define	_WF_NETWORK_TYPE_T_
#define	_WF_PROXIMITY_ALERT_MODE_T_
#define	_WF_PROXIMITY_ALERT_THRESHOLD_T_
#define	_WF_PROXIMITY_RANGE_T_
#define	_WF_SENSOR_CONNECTION_STATUS_T_
#define	_WF_SENSOR_SUBTYPE_T_
#define	_WF_SENSOR_TYPE_T_
#define	_WF_WEIGHT_SCALE_PROFILE_T_
#define	DEVICE_INPUT_BUFFER_SIZE
#define	WF_BPS_CALIBRATION_ID_CAPABILITIES
#define	WF_BPS_CALIBRATION_ID_CTF
#define	WF_BPS_CALIBRATION_ID_GENERAL_FAIL
#define	WF_BPS_CALIBRATION_ID_GENERAL_SUCCESS
#define	WF_MAX_SENSOR_CONNECTIONS
#define	WF_SENSOR_DEFAULT_SAMPLE_RATE
#define	WF_WSS_ACTIVITY_LEVEL_LIGHT_20
	Weight Scale User Profile - User's activity level. More...
#define	WF_WSS_ACTIVITY_LEVEL_LIGHT_40
	Weight Scale User Profile - User's activity level. More...
#define	WF_WSS_ACTIVITY_LEVEL_LIGHT_60
	Weight Scale User Profile - User's activity level. More...
#define	WF_WSS_ACTIVITY_LEVEL_REGULAR_1
	Weight Scale User Profile - User's activity level. More...
#define	WF_WSS_ACTIVITY_LEVEL_REGULAR_5
	Weight Scale User Profile - User's activity level. More...
#define	WF_WSS_ACTIVITY_LEVEL_REGULAR_9
	Weight Scale User Profile - User's activity level. More...
#define	WF_WSS_ACTIVITY_LEVEL_SEDENTARY
	Weight Scale User Profile - User's activity level. More...
#define	WF_WSS_GENDER_FEMALE
	Weight Scale User Profile - Female User. More...
#define	WF_WSS_GENDER_MALE
	Weight Scale User Profile - Male User. More...

Typedefs
typedef NSUInteger	WFConnectorError
	An error code for errors in the WFConnectorErrorDomain. More...
typedef NSUInteger	WFDeviceControlPointError
	An error code for errors in the WFDeviceControlPointErrorDomain. More...

Enumerations
enum	{   WFConnectionErrorNone,   WFConnectionErrorHardwareNotReady,   WFConnectionErrorKeyNotPresent,   WFConnectionErrorBTLENotSupported,   WFConnectionErrorTypeNotSpecified,   WFConnectionErrorInvalidParams,   WFConnectionErrorDiscoveryInProgress,   WFConnectionDeviceRejectedConnection }
enum	{   WFDeviceControlPointErrorNone,   WFDeviceControlPointErrorCommandNotSupported,   WFDeviceControlPointErrorInvalidParameter,   WFDeviceControlPointErrorOperationFailed,   WFDeviceControlPointErrorBusy,   WFDeviceControlPointErrorNoResponse,   WFDeviceControlPointErrorUserCancelled,   WFDeviceControlPointErrorMalformedResponse,   WFDeviceControlPointErrorUnableToSend,   WFDeviceControlPointErrorTransferFormatNotSupported }
enum	wf_connection_cp_role_t {   WF_CONNECTION_CP_CONNECTION_ROLE_MASTER,   WF_CONNECTION_CP_CONNECTION_ROLE_ADMIN }
enum	wf_cp_response_origin_t {   WF_CP_RESPONSE_ORIGIN_BLE,   WF_CP_RESPONSE_ORIGIN_ANT,   WF_CP_RESPONSE_ORIGIN_ANT_TO_BLE_ECHO }
enum	WFAntBridgeState_t {   WF_ANT_BRIDGE_STATE_INVALID,   WF_ANT_BRIDGE_STATE_UNAVAILABLE,   WF_ANT_BRIDGE_STATE_AVAILABLE,   WF_ANT_BRIDGE_STATE_READY,   WF_ANT_BRIDGE_STATE_ACTIVE }
enum	WFBikePowerType_t {   WF_BIKE_POWER_TYPE_UNIDENTIFIED,   WF_BIKE_POWER_TYPE_POWER_ONLY,   WF_BIKE_POWER_TYPE_CRANK_TORQUE,   WF_BIKE_POWER_TYPE_WHEEL_TORQUE,   WF_BIKE_POWER_TYPE_CTF,   WF_BIKE_POWER_TYPE_BTLE }
	Describes the type of Bike Power Meter. More...
enum	WFBTLEChAlertLevel_t {   WF_BTLE_CH_ALERT_LEVEL_NONE,   WF_BTLE_CH_ALERT_LEVEL_MILD,   WF_BTLE_CH_ALERT_LEVEL_HIGH }
	Describes the alert level for the BTLE Alert Level characteristic. More...
enum	WFBTLETemperatureType_t {   WF_BTLE_TEMPERATURE_TYPE_UNKNOWN,   WF_BTLE_TEMPERATURE_TYPE_ARMPIT,   WF_BTLE_TEMPERATURE_TYPE_BODY,   WF_BTLE_TEMPERATURE_TYPE_EAR,   WF_BTLE_TEMPERATURE_TYPE_FINGER,   WF_BTLE_TEMPERATURE_TYPE_GI_TRACT,   WF_BTLE_TEMPERATURE_TYPE_MOUTH,   WF_BTLE_TEMPERATURE_TYPE_RECTUM,   WF_BTLE_TEMPERATURE_TYPE_TOE,   WF_BTLE_TEMPERATURE_TYPE_TYMPANUM }
	Describes the type of temperature measurement. More...
enum	WFCalConfidence_t {   WF_CAL_CONFIDENCE_LOW,   WF_CAL_CONFIDENCE_MODERATE,   WF_CAL_CONFIDENCE_HIGH,   WF_CAL_CONFIDENCE_ERROR }
	Describes the confidence in the accuracy of a calorimeter measurement. More...
enum	WFComparisonType_t {   WF_COMPARISON_TYPE_NONE,   WF_COMPARISON_TYPE_LESS_THAN,   WF_COMPARISON_TYPE_LESS_THAN_OR_EQUAL,   WF_COMPARISON_TYPE_EQUAL,   WF_COMPARISON_TYPE_GREATER_THAN_OR_EQUAL,   WF_COMPARISON_TYPE_GREATER_THAN }
	Describes a method of comparing data. More...
enum	WFFitnessEquipmentHRSource_t {   WF_FE_HR_SOURCE_INVALID,   WF_FE_HR_SOURCE_ANTPLUS,   WF_FE_HR_SOURCE_EM,   WF_FE_HR_SOURCE_FE }
	Describes the source of the HRM data in the Fitness Equipment message. More...
enum	WFFitnessEquipmentState_t {   WF_FE_STATE_ASLEEP,   WF_FE_STATE_READY,   WF_FE_STATE_IN_USE,   WF_FE_STATE_FINISHED,   WF_FE_INVALID_EQUIPMENT_STATE }
	Describes the state of a Fitness Equipment machine. More...
enum	WFFitnessEquipmentType_t {   WF_FETYPE_NONE,   WF_FETYPE_GENERAL,   WF_FETYPE_TREADMILL,   WF_FETYPE_ELLIPTICAL,   WF_FETYPE_BIKE,   WF_FETYPE_ROWER,   WF_FETYPE_CLIMBER }
	Describes the type of Fitness Equipment machine. More...
enum	WFGeoCacheProgramStatus_t {   WF_GEO_CACHE_PROGRAM_OK,   WF_GEO_CACHE_PROGRAM_PIN_NOT_SET,   WF_GEO_CACHE_PROGRAM_PIN_MISMATCH,   WF_GEO_CACHE_PROGRAM_COMM_ERROR,   WF_GEO_CACHE_PROGRAM_WRONG_STATE }
	Describes the status of a request to program the GeoCache device. More...
enum	WFGPSFixType_t {   WF_GPS_FIX_TYPE_NONE,   WF_GPS_FIX_TYPE_SEARCHING,   WF_GPS_FIX_TYPE_PROPAGATING,   WF_GPS_FIX_TYPE_LAST_KNOWN_POSITION,   WF_GPS_FIX_TYPE_2D,   WF_GPS_FIX_TYPE_2D_WAAS,   WF_GPS_FIX_TYPE_2D_DIFFERENTIAL,   WF_GPS_FIX_TYPE_3D,   WF_GPS_FIX_TYPE_3D_WAAS,   WF_GPS_FIX_TYPE_3D_DIFFERENTIAL }
	Describes the type and quality of the GPS fix. More...
enum	WFHardwareConnectorState_t {   WF_HWCONN_STATE_NOT_CONNECTED,   WF_HWCONN_STATE_CONNECTED,   WF_HWCONN_STATE_ACTIVE,   WF_HWCONN_STATE_RESET,   WF_HWCONN_STATE_BT40_ENABLED,   WF_HWCONN_STATE_BT_BONDING_MODE }
	Describes the state of the WFHardwareConnector. More...
enum	WFNetworkType_t {   WF_NETWORKTYPE_UNSPECIFIED,   WF_NETWORKTYPE_ANTPLUS,   WF_NETWORKTYPE_BTLE,   WF_NETWORKTYPE_SUUNTO,   WF_NETWORKTYPE_ANY }
	Describes a type of hardware sensor device. More...
enum	WFProximityAlertMode_t {   WF_PROXIMITY_ALERT_MODE_FARTHER,   WF_PROXIMITY_ALERT_MODE_CLOSER }
	Describes the proximity alert mode. More...
enum	WFProximityAlertThreshold_t {   WF_PROXIMITY_ALERT_THRESHOLD_DISABLED,   WF_PROXIMITY_ALERT_THRESHOLD_1,   WF_PROXIMITY_ALERT_THRESHOLD_2,   WF_PROXIMITY_ALERT_THRESHOLD_3,   WF_PROXIMITY_ALERT_THRESHOLD_4,   WF_PROXIMITY_ALERT_THRESHOLD_5,   WF_PROXIMITY_ALERT_THRESHOLD_6,   WF_PROXIMITY_ALERT_THRESHOLD_7,   WF_PROXIMITY_ALERT_THRESHOLD_8,   WF_PROXIMITY_ALERT_THRESHOLD_9,   WF_PROXIMITY_ALERT_THRESHOLD_10 }
	Describes the threshold for proximity alert. More...
enum	WFProximityRange_t {   WF_PROXIMITY_RANGE_DISABLED,   WF_PROXIMITY_RANGE_1,   WF_PROXIMITY_RANGE_2,   WF_PROXIMITY_RANGE_3,   WF_PROXIMITY_RANGE_4,   WF_PROXIMITY_RANGE_5,   WF_PROXIMITY_RANGE_6,   WF_PROXIMITY_RANGE_7,   WF_PROXIMITY_RANGE_8,   WF_PROXIMITY_RANGE_9,   WF_PROXIMITY_RANGE_10 }
	Describes the proximity range for pairing ANT devices. More...
enum	WFSensorConnectionStatus_t {   WF_SENSOR_CONNECTION_STATUS_IDLE,   WF_SENSOR_CONNECTION_STATUS_CONNECTING,   WF_SENSOR_CONNECTION_STATUS_CONNECTED,   WF_SENSOR_CONNECTION_STATUS_INTERRUPTED,   WF_SENSOR_CONNECTION_STATUS_DISCONNECTING }
	Describes the connection state of an ANT sensor. More...
enum	WFSensorSubType_t {   WF_SENSOR_SUBTYPE_UNSPECIFIED,   WF_SENSOR_SUBTYPE_BIKE_POWER_KICKR,   WF_SENSOR_SUBTYPE_BIKE_POWER_KICKR_SNAP,   WF_SENSOR_SUBTYPE_BIKE_POWER_STAGE_ONE,   WF_SENSOR_SUBTYPE_BIKE_POWER_IN_RIDE,   WF_SENSOR_SUBTYPE_DISPLAY_RFLKT,   WF_SENSOR_SUBTYPE_DISPLAY_ECHO,   WF_SENSOR_SUBTYPE_DISPLAY_CASIO_TYPE1,   WF_SENSOR_SUBTYPE_DISPLAY_TIMEX_RUN_X50,   WF_SENSOR_SUBTYPE_DISPLAY_ECHO_FIT,   WF_SENSOR_SUBTYPE_HEARTRATE_TICKR,   WF_SENSOR_SUBTYPE_HEARTRATE_TICKR_X,   WF_SENSOR_SUBTYPE_HEARTRATE_TICKR_RUN }
	Describes a specific hardware implementation of a generic device profile. More...
enum	WFSensorType_t {   WF_SENSORTYPE_NONE,   WF_SENSORTYPE_BIKE_POWER,   WF_SENSORTYPE_BIKE_SPEED,   WF_SENSORTYPE_BIKE_CADENCE,   WF_SENSORTYPE_BIKE_SPEED_CADENCE,   WF_SENSORTYPE_FOOTPOD,   WF_SENSORTYPE_HEARTRATE,   WF_SENSORTYPE_WEIGHT_SCALE,   WF_SENSORTYPE_ANT_FS,   WF_SENSORTYPE_LOCATION,   WF_SENSORTYPE_CALORIMETER,   WF_SENSORTYPE_GEO_CACHE,   WF_SENSORTYPE_FITNESS_EQUIPMENT,   WF_SENSORTYPE_MULTISPORT_SPEED_DISTANCE,   WF_SENSORTYPE_PROXIMITY,   WF_SENSORTYPE_HEALTH_THERMOMETER,   WF_SENSORTYPE_BLOOD_PRESSURE,   WF_SENSORTYPE_BTLE_GLUCOSE,   WF_SENSORTYPE_GLUCOSE,   WF_SENSORTYPE_DISPLAY,   WF_SENSORTYPE_WAHOO_RAW_SENSOR }
	Describes a type of hardware sensor device. More...

Variables
FOUNDATION_EXPORT NSString *const	WFConnectorErrorDomain
	Error domain for the WFHardwareConnector. More...
FOUNDATION_EXPORT NSString *const	WFDeviceControlPointErrorDomain
	Error domain for the Device (also known as Sensor) "Control Point" errors. More...

Macro Definition Documentation

#define _WF_ANT_BRIDGE_STATE_T_

#define _WF_BIKE_POWER_CALIBRATION_CAPABILITIES_T_

#define _WF_BIKE_POWER_CALIBRATION_CTF_T_

#define _WF_BIKE_POWER_CALIBRATION_DATA_T_

#define _WF_BIKE_POWER_CALIBRATION_GENERAL_T_

#define _WF_BIKE_POWER_TYPE_T_

#define _WF_BTLE_CH_ALERT_LEVEL_T_

#define _WF_BTLE_TEMPERATURE_TYPE_T_

#define _WF_CAL_CONFIDENCE_T_

#define _WF_COMPARISON_TYPE_T_

#define _WF_CONNECTION_CP_T_

#define _WF_CONNECTOR_ERROR_DOMAIN_

#define _WF_CP_RESPONSE_ORIGIN_T_

#define _WF_DEVICE_CONTROL_POINT_ERROR_DOMAIN_

#define _WF_FITNESS_EQUIPMENT_HR_SOURCE_T_

#define _WF_FITNESS_EQUIPMENT_STATE_T_

#define _WF_FITNESS_EQUIPMENT_TYPE_T_

#define _WF_GEO_CACHE_PROGRAM_STATUS_T_

#define _WF_GPS_FIX_TYPE_T_

#define _WF_HARDWARE_CONNECTOR_STATE_T_

#define _WF_NETWORK_TYPE_T_

#define _WF_PROXIMITY_ALERT_MODE_T_

#define _WF_PROXIMITY_ALERT_THRESHOLD_T_

#define _WF_PROXIMITY_RANGE_T_

#define _WF_SENSOR_CONNECTION_STATUS_T_

#define _WF_SENSOR_SUBTYPE_T_

#define _WF_SENSOR_TYPE_T_

#define _WF_WEIGHT_SCALE_PROFILE_T_

#define DEVICE_INPUT_BUFFER_SIZE

#define WF_BPS_CALIBRATION_ID_CAPABILITIES

#define WF_BPS_CALIBRATION_ID_CTF

#define WF_BPS_CALIBRATION_ID_GENERAL_FAIL

#define WF_BPS_CALIBRATION_ID_GENERAL_SUCCESS

#define WF_MAX_SENSOR_CONNECTIONS

#define WF_SENSOR_DEFAULT_SAMPLE_RATE

#define WF_WSS_ACTIVITY_LEVEL_LIGHT_20

Weight Scale User Profile - User's activity level.

#define WF_WSS_ACTIVITY_LEVEL_LIGHT_40

Weight Scale User Profile - User's activity level.

#define WF_WSS_ACTIVITY_LEVEL_LIGHT_60

Weight Scale User Profile - User's activity level.

#define WF_WSS_ACTIVITY_LEVEL_REGULAR_1

Weight Scale User Profile - User's activity level.

#define WF_WSS_ACTIVITY_LEVEL_REGULAR_5

Weight Scale User Profile - User's activity level.

#define WF_WSS_ACTIVITY_LEVEL_REGULAR_9

Weight Scale User Profile - User's activity level.

#define WF_WSS_ACTIVITY_LEVEL_SEDENTARY

Weight Scale User Profile - User's activity level.

#define WF_WSS_GENDER_FEMALE

Weight Scale User Profile - Female User.

#define WF_WSS_GENDER_MALE

Weight Scale User Profile - Male User.

Typedef Documentation

typedef NSUInteger WFConnectorError

An error code for errors in the WFConnectorErrorDomain.

typedef NSUInteger WFDeviceControlPointError

An error code for errors in the WFDeviceControlPointErrorDomain.

Enumeration Type Documentation

anonymous enum

Enumerator
WFConnectionErrorNone	No error has occured.
WFConnectionErrorHardwareNotReady	The hardware is not ready.
WFConnectionErrorKeyNotPresent	The fisica key is not present.
WFConnectionErrorBTLENotSupported	BTLE is not supported on this device.
WFConnectionErrorTypeNotSpecified	The sensor type was not specified.
WFConnectionErrorInvalidParams	The connection parameters are invalid.
WFConnectionErrorDiscoveryInProgress	A device discovery is currently in progress.
WFConnectionDeviceRejectedConnection	A device rejected the attempted connection.

anonymous enum

Enumerator
WFDeviceControlPointErrorNone	No error has occured.
WFDeviceControlPointErrorCommandNotSupported	Command which was issued is not supported.
WFDeviceControlPointErrorInvalidParameter	A parameter is invalid.
WFDeviceControlPointErrorOperationFailed	The desired operation failed.
WFDeviceControlPointErrorBusy	The command could not be performed because the device is busy.
WFDeviceControlPointErrorNoResponse	No response was recevied after sending the command (Timeout)
WFDeviceControlPointErrorUserCancelled	The operation was deliberately cancelled.
WFDeviceControlPointErrorMalformedResponse	The response was malformed.
WFDeviceControlPointErrorUnableToSend	Commands/data can not be sent to the device at this time.
WFDeviceControlPointErrorTransferFormatNotSupported	The device will (or did) transfer data/information/file in a format which is not supported.

enum wf_connection_cp_role_t

Enumerator
WF_CONNECTION_CP_CONNECTION_ROLE_MASTER
WF_CONNECTION_CP_CONNECTION_ROLE_ADMIN

enum wf_cp_response_origin_t

Enumerator
WF_CP_RESPONSE_ORIGIN_BLE
WF_CP_RESPONSE_ORIGIN_ANT
WF_CP_RESPONSE_ORIGIN_ANT_TO_BLE_ECHO

enum WFAntBridgeState_t

Enumerator
WF_ANT_BRIDGE_STATE_INVALID	The ANT Bridge state is not defined.
WF_ANT_BRIDGE_STATE_UNAVAILABLE	The ANT Bridge is not available.
WF_ANT_BRIDGE_STATE_AVAILABLE	The ANT Bridge is available but not configured.
WF_ANT_BRIDGE_STATE_READY	The ANT Bridge is available and configured but not in use.
WF_ANT_BRIDGE_STATE_ACTIVE	The ANT Bridge is in active use.

enum WFBikePowerType_t

Describes the type of Bike Power Meter.

Enumerator
WF_BIKE_POWER_TYPE_UNIDENTIFIED	Indicates that the power meter type has not been determined.
WF_BIKE_POWER_TYPE_POWER_ONLY	Indicates the ANT+ Power Only power meter type.
WF_BIKE_POWER_TYPE_CRANK_TORQUE	Indicates the ANT+ Crank Torque power meter type.
WF_BIKE_POWER_TYPE_WHEEL_TORQUE	Indicates the ANT+ Wheel Torque power meter type.
WF_BIKE_POWER_TYPE_CTF	Indicates the ANT+ Crank Torque Frequency power meter type.
WF_BIKE_POWER_TYPE_BTLE	Indicated the bluetooth power meter type.

enum WFBTLEChAlertLevel_t

Describes the alert level for the BTLE Alert Level characteristic.

Enumerator
WF_BTLE_CH_ALERT_LEVEL_NONE	No Alert.
WF_BTLE_CH_ALERT_LEVEL_MILD	Mild Alert.
WF_BTLE_CH_ALERT_LEVEL_HIGH	High Alert.

enum WFBTLETemperatureType_t

Describes the type of temperature measurement.

Enumerator
WF_BTLE_TEMPERATURE_TYPE_UNKNOWN	Temperature type is not known.
WF_BTLE_TEMPERATURE_TYPE_ARMPIT	Temperature measured in the armpit.
WF_BTLE_TEMPERATURE_TYPE_BODY	Temperature measured on the body.
WF_BTLE_TEMPERATURE_TYPE_EAR	Temperature measured in the ear.
WF_BTLE_TEMPERATURE_TYPE_FINGER	Temperature measured on the finger.
WF_BTLE_TEMPERATURE_TYPE_GI_TRACT	Temperature measured in the GI tract.
WF_BTLE_TEMPERATURE_TYPE_MOUTH	Temperature measured in the mouth.
WF_BTLE_TEMPERATURE_TYPE_RECTUM	Temperature measured in the rectum.
WF_BTLE_TEMPERATURE_TYPE_TOE	Temperature measured on the toe.
WF_BTLE_TEMPERATURE_TYPE_TYMPANUM	Temperature measured in the tympanum.

enum WFCalConfidence_t

Describes the confidence in the accuracy of a calorimeter measurement.

Enumerator
WF_CAL_CONFIDENCE_LOW	Indicates a low confidence in the accuracy of the measurement.
WF_CAL_CONFIDENCE_MODERATE	Indicates a reasonable confidence in the accuracy of the measurement.
WF_CAL_CONFIDENCE_HIGH	Indicates a high confidence in the accuracy of the measurement.
WF_CAL_CONFIDENCE_ERROR	Indicates an error.

enum WFComparisonType_t

Describes a method of comparing data.

Enumerator
WF_COMPARISON_TYPE_NONE	No comparison specified.
WF_COMPARISON_TYPE_LESS_THAN	The comparison is TRUE if the item on the left is less than the item on the right.
WF_COMPARISON_TYPE_LESS_THAN_OR_EQUAL	The comparison is TRUE if the item on the left is less than or equal to the item on the right.
WF_COMPARISON_TYPE_EQUAL	The comparison is TRUE if the item on the left is equal to the item on the right.
WF_COMPARISON_TYPE_GREATER_THAN_OR_EQUAL	The comparison is TRUE if the item on the left is greater than or equal to the item on the right.
WF_COMPARISON_TYPE_GREATER_THAN	The comparison is TRUE if the item on the left is greater than the item on the right.

enum WFFitnessEquipmentHRSource_t

Describes the source of the HRM data in the Fitness Equipment message.

Enumerator
WF_FE_HR_SOURCE_INVALID	No HRM available - do not interpret HRM data.
WF_FE_HR_SOURCE_ANTPLUS	HRM data from an ANT+ HRM sensor.
WF_FE_HR_SOURCE_EM	HRM data from an EM (5kHz) heart rate monitor.
WF_FE_HR_SOURCE_FE	HRM data from hand contact sensor on the Fitness Equipment.

enum WFFitnessEquipmentState_t

Describes the state of a Fitness Equipment machine.

Enumerator
WF_FE_STATE_ASLEEP	The FE machine is off.
WF_FE_STATE_READY	The FE machine is on, awaiting connection.
WF_FE_STATE_IN_USE	The FE machine is in use, workout in progreas.
WF_FE_STATE_FINISHED	The workout is paused or finished. If the next state is WF_FE_STATE_IN_USE, interpret as paused, if the next state is WF_FE_STATE_READY, interpret as finished.
WF_FE_INVALID_EQUIPMENT_STATE

enum WFFitnessEquipmentType_t

Describes the type of Fitness Equipment machine.

Enumerator
WF_FETYPE_NONE	No FE type specified.
WF_FETYPE_GENERAL	Non-specific FE machine - should broadcast basic FE data.
WF_FETYPE_TREADMILL	Specifies the treadmill.
WF_FETYPE_ELLIPTICAL	Specifies the elliptical trainer.
WF_FETYPE_BIKE	Specifies the stationary bike.
WF_FETYPE_ROWER	Specifies the rower.
WF_FETYPE_CLIMBER	Specifies the climber.

enum WFGeoCacheProgramStatus_t

Describes the status of a request to program the GeoCache device.

Enumerator
WF_GEO_CACHE_PROGRAM_OK	The programming request was initialized successfully.
WF_GEO_CACHE_PROGRAM_PIN_NOT_SET	The PIN was not specified (PIN must be non-zero).
WF_GEO_CACHE_PROGRAM_PIN_MISMATCH	The specified PIN does not match the PIN on the device.
WF_GEO_CACHE_PROGRAM_COMM_ERROR	A communication error occured while initiating the programming request.
WF_GEO_CACHE_PROGRAM_WRONG_STATE	The GeoCache sensor is in the wrong state for programming. The sensor is likely either not connected, or not authenticated.

enum WFGPSFixType_t

Describes the type and quality of the GPS fix.

Enumerator
WF_GPS_FIX_TYPE_NONE	No fix. Position data is not accurate.
WF_GPS_FIX_TYPE_SEARCHING	The GPS receiver is searching for satellites.
WF_GPS_FIX_TYPE_PROPAGATING	The GPS receiver had a fix, but is currently without a fix. The position data is calculated based on changes from a last known fix.
WF_GPS_FIX_TYPE_LAST_KNOWN_POSITION	The GPS receiver had a fix, but is currently without a fix. The position data has not been updated since the last known position.
WF_GPS_FIX_TYPE_2D	A position has been obtained that is accurate in 2 dimensions (horizontal only).
WF_GPS_FIX_TYPE_2D_WAAS	A 2D position has been obtained and is using WAAS corrections for better positional accuracy.
WF_GPS_FIX_TYPE_2D_DIFFERENTIAL	A 2D position has been obtained and is using differential corrections for better positional accuracy.
WF_GPS_FIX_TYPE_3D	A position has been obtained that is accurate in 3 dimensions (vertical and horizontal).
WF_GPS_FIX_TYPE_3D_WAAS	A 3D position has been obtained and is using WAAS corrections for better positional accuracy.
WF_GPS_FIX_TYPE_3D_DIFFERENTIAL	A 3D position has been obtained and is using differential correct ions for better positional accuracy.

enum WFHardwareConnectorState_t

Describes the state of the WFHardwareConnector.

Enumerator
WF_HWCONN_STATE_NOT_CONNECTED	The fisica device is not physically connected to the iPod.
WF_HWCONN_STATE_CONNECTED	The fisica device is physically connected to the iPod.
WF_HWCONN_STATE_ACTIVE	The fisica device is connected and communication is established (norml operating mode).
WF_HWCONN_STATE_RESET	The fisica device is performing a reset operation.
WF_HWCONN_STATE_BT40_ENABLED	The BTLE hardware is enabled.
WF_HWCONN_STATE_BT_BONDING_MODE	The BTLE controller is in bonding mode.

enum WFNetworkType_t

Describes a type of hardware sensor device.

Enumerator
WF_NETWORKTYPE_UNSPECIFIED	The network type is not specified. This value may not be used for connection requests. If used, the connection request will fail.
WF_NETWORKTYPE_ANTPLUS	Default, ANT+ standard network.
WF_NETWORKTYPE_BTLE	Specifies BTLE devices.
WF_NETWORKTYPE_SUUNTO	Specifies Suunto devices.
WF_NETWORKTYPE_ANY	Wildcard for any available network. This value may be specified in connection request. When used, connection attempt is made on any available network. The first connection to be established will be used. Connection requests on other network types will be cancelled.

enum WFProximityAlertMode_t

Describes the proximity alert mode.

Enumerator
WF_PROXIMITY_ALERT_MODE_FARTHER	Alert is issued as the device moves farther away.
WF_PROXIMITY_ALERT_MODE_CLOSER	Alert is issued as the device moves closer.

enum WFProximityAlertThreshold_t

Describes the threshold for proximity alert.

The proximity connection will monitor the RSSI value for the connected device. If the signal power loss (TX Power - RSSI) crosses a specified threshold, an alert is issued.

Enumerator
WF_PROXIMITY_ALERT_THRESHOLD_DISABLED	Proximity alert is disabled.
WF_PROXIMITY_ALERT_THRESHOLD_1	Proximity threshold 1 of 10 (Signal loss 35 dBm).
WF_PROXIMITY_ALERT_THRESHOLD_2	Proximity threshold 1 of 10 (Signal loss 40 dBm).
WF_PROXIMITY_ALERT_THRESHOLD_3	Proximity threshold 1 of 10 (Signal loss 45 dBm).
WF_PROXIMITY_ALERT_THRESHOLD_4	Proximity threshold 1 of 10 (Signal loss 50 dBm).
WF_PROXIMITY_ALERT_THRESHOLD_5	Proximity threshold 1 of 10 (Signal loss 55 dBm).
WF_PROXIMITY_ALERT_THRESHOLD_6	Proximity threshold 1 of 10 (Signal loss 60 dBm).
WF_PROXIMITY_ALERT_THRESHOLD_7	Proximity threshold 1 of 10 (Signal loss 65 dBm).
WF_PROXIMITY_ALERT_THRESHOLD_8	Proximity threshold 1 of 10 (Signal loss 70 dBm).
WF_PROXIMITY_ALERT_THRESHOLD_9	Proximity threshold 1 of 10 (Signal loss 75 dBm).
WF_PROXIMITY_ALERT_THRESHOLD_10	Proximity threshold 1 of 10 (Signal loss 80 dBm).

enum WFProximityRange_t

Describes the proximity range for pairing ANT devices.

Enumerator
WF_PROXIMITY_RANGE_DISABLED	Proximity searching is disabled.
WF_PROXIMITY_RANGE_1	Proximity range 1 of 10 (closest range).
WF_PROXIMITY_RANGE_2	Proximity range 2 of 10.
WF_PROXIMITY_RANGE_3	Proximity range 3 of 10.
WF_PROXIMITY_RANGE_4	Proximity range 4 of 10.
WF_PROXIMITY_RANGE_5	Proximity range 5 of 10.
WF_PROXIMITY_RANGE_6	Proximity range 6 of 10.
WF_PROXIMITY_RANGE_7	Proximity range 7 of 10.
WF_PROXIMITY_RANGE_8	Proximity range 8 of 10.
WF_PROXIMITY_RANGE_9	Proximity range 9 of 10.
WF_PROXIMITY_RANGE_10	Proximity range 10 of 10 (farthest range).

enum WFSensorConnectionStatus_t

Describes the connection state of an ANT sensor.

Enumerator
WF_SENSOR_CONNECTION_STATUS_IDLE	No active connection.
WF_SENSOR_CONNECTION_STATUS_CONNECTING	The connection is in process of being established.
WF_SENSOR_CONNECTION_STATUS_CONNECTED	The sensor connection is established and active.
WF_SENSOR_CONNECTION_STATUS_INTERRUPTED	The connection was interrupted (usually occurs when fisica is disconnected).
WF_SENSOR_CONNECTION_STATUS_DISCONNECTING	The connection is in process of being disconnected.

enum WFSensorSubType_t

Describes a specific hardware implementation of a generic device profile.

Enumerator
WF_SENSOR_SUBTYPE_UNSPECIFIED	The sub-type is not specified.
WF_SENSOR_SUBTYPE_BIKE_POWER_KICKR	Specifies the Wahoo KICKR Bike Trainer.
WF_SENSOR_SUBTYPE_BIKE_POWER_KICKR_SNAP	Specifies the Wahoo KICKR SNAP Bike Trainer.
WF_SENSOR_SUBTYPE_BIKE_POWER_STAGE_ONE	Specifies the Stages StageOne Bike Power Meter.
WF_SENSOR_SUBTYPE_BIKE_POWER_IN_RIDE	Specifies the Kurt InRide Bike Trainer.
WF_SENSOR_SUBTYPE_DISPLAY_RFLKT	Specifies the RFLKT watch display.
WF_SENSOR_SUBTYPE_DISPLAY_ECHO	Specifies a Megellan Echo Watch subtype.
WF_SENSOR_SUBTYPE_DISPLAY_CASIO_TYPE1	Specifies the Casio Type1 Watch Eg. STB-1000
WF_SENSOR_SUBTYPE_DISPLAY_TIMEX_RUN_X50
WF_SENSOR_SUBTYPE_DISPLAY_ECHO_FIT
WF_SENSOR_SUBTYPE_HEARTRATE_TICKR	Specifies the Wahoo TICKR Heart Rate sensor.
WF_SENSOR_SUBTYPE_HEARTRATE_TICKR_X	Specifies the Wahoo TICKR X Heart Rate sensor.
WF_SENSOR_SUBTYPE_HEARTRATE_TICKR_RUN	Specifies the Wahoo TICKR Run Heart Rate sensor.

enum WFSensorType_t

Describes a type of hardware sensor device.

Enumerator
WF_SENSORTYPE_NONE	Specifies non-existent sensor.
WF_SENSORTYPE_BIKE_POWER	Specifies the bike power sensor.
WF_SENSORTYPE_BIKE_SPEED	Specifies the bike speed sensor.
WF_SENSORTYPE_BIKE_CADENCE	Specifies the bike cadence sensor.
WF_SENSORTYPE_BIKE_SPEED_CADENCE	Specifies the combined bike speed and cadence sensor.
WF_SENSORTYPE_FOOTPOD	Specifies the FootPod stride and distance sensor.
WF_SENSORTYPE_HEARTRATE	Specifies the heart rate monitor sensor.
WF_SENSORTYPE_WEIGHT_SCALE	Specifies the Weight Scale monitor sensor.
WF_SENSORTYPE_ANT_FS	Specifies a generic ANT FS device.
WF_SENSORTYPE_LOCATION	Specifies the GPS location sensor.
WF_SENSORTYPE_CALORIMETER	Specifies the calorimeter sensor.
WF_SENSORTYPE_GEO_CACHE	Specifies the GeoCache sensor.
WF_SENSORTYPE_FITNESS_EQUIPMENT	Specifies the Fitness Equipment sensor.
WF_SENSORTYPE_MULTISPORT_SPEED_DISTANCE	Specifies the Multi-Sport Speed and Distance sensor.
WF_SENSORTYPE_PROXIMITY	Specifies the BTLE Proximity sensor.
WF_SENSORTYPE_HEALTH_THERMOMETER	Specifies the BTLE Health Thermometer sensor.
WF_SENSORTYPE_BLOOD_PRESSURE	Specifies the BTLE Blood Pressure sensor.
WF_SENSORTYPE_BTLE_GLUCOSE	Specifies the BTLE Blood Glucose Monitor sensor.
WF_SENSORTYPE_GLUCOSE	Specifies the ANT+ Blood Glucose Monitor sensor.
WF_SENSORTYPE_DISPLAY	Specifies the BTLE Display sensor.
WF_SENSORTYPE_WAHOO_RAW_SENSOR	Specifies a BLE device which implements the Wahoo Raw Sensor Service.

Variable Documentation

FOUNDATION_EXPORT NSString* const WFConnectorErrorDomain

Error domain for the WFHardwareConnector.

FOUNDATION_EXPORT NSString* const WFDeviceControlPointErrorDomain

Error domain for the Device (also known as Sensor) "Control Point" errors.