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 File Reference
#import <WFConnector/types.h>
+ Include dependency graph for wf_antfs_types.h:

Go to the source code of this file.

Classes

struct  ANTFS_DIRECTORY_HEADER
 Describes the ANT FS directory header. More...
 
struct  ANTFSP_DIRECTORY
 Describes the metadata for an ANT FS directory entry. More...
 
struct  WFANDPedometerFile_t
 Describes the file format for the A&D Pedometer. More...
 
struct  WFANDPedometerRecord_t
 Describes an individual record from the A&D Pedometer. More...
 
struct  WFAntFSClientParams_t
 ANT-FS Client Parameters. More...
 
struct  WFFitnessEquipmentSettings_t
 Represents the settings transferred to an FE machine. More...
 

Macros

#define _ANTFS_DIRECTORY_HEADER_T_
 
#define _ANTFS_RESPONSE_T_
 
#define _ANTFS_STATE_T_
 
#define _ANTFSP_DIRECTORY_T_
 
#define _WF_AND_PEDOMETER_FILE_T_
 
#define _WF_AND_PEDOMETER_RECORD_T_
 
#define _WF_ANTFS_CLIENT_ERROR_
 
#define _WF_ANTFS_CLIENT_PARAMS_
 
#define _WF_ANTFS_DEVICE_MODE_T_
 
#define _WF_ANTFS_DEVICE_TYPE_T_
 
#define _WF_FIT_FILE_PERMISSIONS_T_
 
#define _WF_FITNESS_EQUIPMENT_SETTINGS_T_
 
#define _WF_GENDER_T_
 
#define ANTFS_AUTH_PASSTHRU
 
#define ANTFS_FILE_DATA_TYPE_ANTFS
 Identifies the ANT FS file type. More...
 
#define ANTFS_FILE_SUB_TYPE_ACTIVITY
 Identifies the FIT Activity file sub-type. More...
 
#define ANTFS_FILE_SUB_TYPE_SETTINGS
 Identifies the FIT Settings file sub-type. More...
 
#define WF_ANTFS_PASSWORD_MAX_LENGTH
 The maximum length for an ANT FS password. More...
 

Enumerations

enum  ANTFS_RESPONSE {
  ANTFS_RESPONSE_NONE,
  ANTFS_RESPONSE_OPEN_PASS,
  ANTFS_RESPONSE_INIT_PASS,
  ANTFS_RESPONSE_SERIAL_FAIL,
  ANTFS_RESPONSE_REQUEST_SESSION_FAIL,
  ANTFS_RESPONSE_BEACON_OPEN,
  ANTFS_RESPONSE_BEACON_CLOSED,
  ANTFS_RESPONSE_CONNECT_PASS,
  ANTFS_RESPONSE_DISCONNECT_PASS,
  ANTFS_RESPONSE_DISCONNECT_BROADCAST_PASS,
  ANTFS_RESPONSE_CONNECTION_LOST,
  ANTFS_RESPONSE_AUTHENTICATE_NA,
  ANTFS_RESPONSE_AUTHENTICATE_PASS,
  ANTFS_RESPONSE_AUTHENTICATE_REJECT,
  ANTFS_RESPONSE_AUTHENTICATE_FAIL,
  ANTFS_RESPONSE_PAIRING_REQUEST,
  ANTFS_RESPONSE_PAIRING_TIMEOUT,
  ANTFS_RESPONSE_DOWNLOAD_REQUEST,
  ANTFS_RESPONSE_DOWNLOAD_PASS,
  ANTFS_RESPONSE_DOWNLOAD_REJECT,
  ANTFS_RESPONSE_DOWNLOAD_INVALID_INDEX,
  ANTFS_RESPONSE_DOWNLOAD_FILE_NOT_READABLE,
  ANTFS_RESPONSE_DOWNLOAD_NOT_READY,
  ANTFS_RESPONSE_DOWNLOAD_FAIL,
  ANTFS_RESPONSE_UPLOAD_REQUEST,
  ANTFS_RESPONSE_UPLOAD_PASS,
  ANTFS_RESPONSE_UPLOAD_REJECT,
  ANTFS_RESPONSE_UPLOAD_INVALID_INDEX,
  ANTFS_RESPONSE_UPLOAD_FILE_NOT_WRITEABLE,
  ANTFS_RESPONSE_UPLOAD_INSUFFICIENT_SPACE,
  ANTFS_RESPONSE_UPLOAD_FAIL,
  ANTFS_RESPONSE_ERASE_REQUEST,
  ANTFS_RESPONSE_ERASE_PASS,
  ANTFS_RESPONSE_ERASE_REJECT,
  ANTFS_RESPONSE_ERASE_FAIL,
  ANTFS_RESPONSE_MANUAL_TRANSFER_PASS,
  ANTFS_RESPONSE_MANUAL_TRANSFER_TRANSMIT_FAIL,
  ANTFS_RESPONSE_MANUAL_TRANSFER_RESPONSE_FAIL,
  ANTFS_RESPONSE_CANCEL_DONE
}
 Describes an ANT FS response. More...
 
enum  ANTFS_STATE {
  ANTFS_STATE_IDLE,
  ANTFS_STATE_IDLE_POLLING_USB,
  ANTFS_STATE_OPEN,
  ANTFS_STATE_DISCONNECTING,
  ANTFS_STATE_SEARCHING,
  ANTFS_STATE_CONNECTED,
  ANTFS_STATE_AUTHENTICATING,
  ANTFS_STATE_TRANSPORT,
  ANTFS_STATE_DOWNLOADING,
  ANTFS_STATE_UPLOADING,
  ANTFS_STATE_ERASING,
  ANTFS_STATE_SENDING,
  ANTFS_STATE_RECEIVING
}
 Describes the ANT FS device state. More...
 
enum  WFAntFSClientError_t {
  WF_ANTFS_CLIENT_ERROR_UNSPECIFIED,
  WF_ANTFS_CLIENT_ERROR_DOWNLOAD
}
 Describes an error encountered by the ANT FS Client. More...
 
enum  WFAntFSDeviceMode_t {
  WF_ANTFS_DEVMODE_HOST,
  WF_ANTFS_DEVMODE_CLIENT
}
 Describes the ANT FS mode of a device. More...
 
enum  WFAntFSDeviceType_t {
  WF_ANTFS_DEVTYPE_WEIGHT_SCALE,
  WF_ANTFS_DEVTYPE_BLOOD_PRESSURE_CUFF,
  WF_ANTFS_DEVTYPE_AND_PEDOMETER,
  WF_ANTFS_DEVTYPE_GENERIC_FIT,
  WF_ANTFS_DEVTYPE_GARMIN_WATCH,
  WF_ANTFS_DEVTYPE_GARMIN_FR60,
  WF_ANTFS_DEVTYPE_GARMIN_FR310,
  WF_ANTFS_DEVTYPE_GARMIN_FR405,
  WF_ANTFS_DEVTYPE_GARMIN_FR610,
  WF_ANTFS_DEVTYPE_FE_WATCH,
  WF_ANTFS_DEVTYPE_GARMIN_FR910XT
}
 Describes a type of ANT FS enabled device. More...
 
enum  WFFitFilePermissions {
  FIT_PERMISSIONS_APPEND,
  FIT_PERMISSIONS_ARCHIVE,
  FIT_PERMISSIONS_ERASE,
  FIT_PERMISSIONS_WRITE,
  FIT_PERMISSIONS_READ
}
 Describes the bit-field values for ANT FS file permissions. More...
 
enum  WFGender_t {
  WF_GENDER_MALE,
  WF_GENDER_FEMALE
}
 Describes the gender. More...
 

Macro Definition Documentation

#define _ANTFS_DIRECTORY_HEADER_T_
#define _ANTFS_RESPONSE_T_
#define _ANTFS_STATE_T_
#define _ANTFSP_DIRECTORY_T_
#define _WF_AND_PEDOMETER_FILE_T_
#define _WF_AND_PEDOMETER_RECORD_T_
#define _WF_ANTFS_CLIENT_ERROR_
#define _WF_ANTFS_CLIENT_PARAMS_
#define _WF_ANTFS_DEVICE_MODE_T_
#define _WF_ANTFS_DEVICE_TYPE_T_
#define _WF_FIT_FILE_PERMISSIONS_T_
#define _WF_FITNESS_EQUIPMENT_SETTINGS_T_
#define _WF_GENDER_T_
#define ANTFS_AUTH_PASSTHRU
#define ANTFS_FILE_DATA_TYPE_ANTFS

Identifies the ANT FS file type.

#define ANTFS_FILE_SUB_TYPE_ACTIVITY

Identifies the FIT Activity file sub-type.

#define ANTFS_FILE_SUB_TYPE_SETTINGS

Identifies the FIT Settings file sub-type.

#define WF_ANTFS_PASSWORD_MAX_LENGTH

The maximum length for an ANT FS password.

Enumeration Type Documentation

Describes an ANT FS response.

Enumerator
ANTFS_RESPONSE_NONE 

No response.

ANTFS_RESPONSE_OPEN_PASS 

The serial line was opened successfully.

ANTFS_RESPONSE_INIT_PASS 

The serial line was initialized successfully.

ANTFS_RESPONSE_SERIAL_FAIL 

Failed to initialize the serial line.

ANTFS_RESPONSE_REQUEST_SESSION_FAIL 

The request for a session failed.

ANTFS_RESPONSE_BEACON_OPEN 

Client beacon opened.

ANTFS_RESPONSE_BEACON_CLOSED 

Client beacon closed.

ANTFS_RESPONSE_CONNECT_PASS 

Connection succeeded.

ANTFS_RESPONSE_DISCONNECT_PASS 

Disconnect succeeded.

ANTFS_RESPONSE_DISCONNECT_BROADCAST_PASS 

Broadcast disconnect succeeded.

ANTFS_RESPONSE_CONNECTION_LOST 

The connection was lost.

ANTFS_RESPONSE_AUTHENTICATE_NA 

Authentication is not available.

ANTFS_RESPONSE_AUTHENTICATE_PASS 

Authentication passed.

ANTFS_RESPONSE_AUTHENTICATE_REJECT 

The authentication was rejected by the client.

ANTFS_RESPONSE_AUTHENTICATE_FAIL 

Authentication failed.

ANTFS_RESPONSE_PAIRING_REQUEST 

Request for pairing.

ANTFS_RESPONSE_PAIRING_TIMEOUT 

Pairing request timed out.

ANTFS_RESPONSE_DOWNLOAD_REQUEST 

Request for download.

ANTFS_RESPONSE_DOWNLOAD_PASS 

The download request passed.

ANTFS_RESPONSE_DOWNLOAD_REJECT 

The download request was rejected by the client.

ANTFS_RESPONSE_DOWNLOAD_INVALID_INDEX 

Invalid file index.

ANTFS_RESPONSE_DOWNLOAD_FILE_NOT_READABLE 

Requested file cannot be read.

ANTFS_RESPONSE_DOWNLOAD_NOT_READY 

Download not ready.

ANTFS_RESPONSE_DOWNLOAD_FAIL 

The download failed.

ANTFS_RESPONSE_UPLOAD_REQUEST 

Upload request.

ANTFS_RESPONSE_UPLOAD_PASS 

The upload request passed.

ANTFS_RESPONSE_UPLOAD_REJECT 

The upload request was rejected.

ANTFS_RESPONSE_UPLOAD_INVALID_INDEX 

Invalid file index.

ANTFS_RESPONSE_UPLOAD_FILE_NOT_WRITEABLE 

Requested upload cannot be written.

ANTFS_RESPONSE_UPLOAD_INSUFFICIENT_SPACE 

Insufficient space to write the requested upload.

ANTFS_RESPONSE_UPLOAD_FAIL 

The upload failed.

ANTFS_RESPONSE_ERASE_REQUEST 

Request to erase a file.

ANTFS_RESPONSE_ERASE_PASS 

The erase request passed.

ANTFS_RESPONSE_ERASE_REJECT 

The erase request was rejected.

ANTFS_RESPONSE_ERASE_FAIL 

The erase request failed.

ANTFS_RESPONSE_MANUAL_TRANSFER_PASS 

The manual transfer request passed.

ANTFS_RESPONSE_MANUAL_TRANSFER_TRANSMIT_FAIL 

Manual request transmit failed.

ANTFS_RESPONSE_MANUAL_TRANSFER_RESPONSE_FAIL 

Manual request response failed.

ANTFS_RESPONSE_CANCEL_DONE 

The request to cancel has been processed.

Describes the ANT FS device state.

Enumerator
ANTFS_STATE_IDLE 

The device is idle.

ANTFS_STATE_IDLE_POLLING_USB 

Polling USB for available device.

ANTFS_STATE_OPEN 

The serial line is open.

ANTFS_STATE_DISCONNECTING 

The device is disconnecting.

ANTFS_STATE_SEARCHING 

The device is searching for a peer device.

ANTFS_STATE_CONNECTED 

The device is connected to a peer device.

ANTFS_STATE_AUTHENTICATING 

ANT FS authentication state.

ANTFS_STATE_TRANSPORT 

ANT FS transport state.

ANTFS_STATE_DOWNLOADING 

ANT FS download state.

ANTFS_STATE_UPLOADING 

ANT FS upload state.

ANTFS_STATE_ERASING 

ANT FS erase state.

ANTFS_STATE_SENDING 

The device is sending data.

ANTFS_STATE_RECEIVING 

THe device is receiving data.

Describes an error encountered by the ANT FS Client.

Enumerator
WF_ANTFS_CLIENT_ERROR_UNSPECIFIED 

Unspecified error.

WF_ANTFS_CLIENT_ERROR_DOWNLOAD 

An error was encountered during the download process.

Describes the ANT FS mode of a device.

Enumerator
WF_ANTFS_DEVMODE_HOST 

The device is ANT FS Host mode.

WF_ANTFS_DEVMODE_CLIENT 

The device is ANT FS Client mode.

Describes a type of ANT FS enabled device.

Enumerator
WF_ANTFS_DEVTYPE_WEIGHT_SCALE 

Specifies the ANT FS enabled weight scale.

WF_ANTFS_DEVTYPE_BLOOD_PRESSURE_CUFF 

Specifies the ANT FS enabled blood pressure cuff.

WF_ANTFS_DEVTYPE_AND_PEDOMETER 

Specifies the A&D pedometer.

WF_ANTFS_DEVTYPE_GENERIC_FIT 

Specifies a generic ANT FS enabled device which uses FIT protocol.

WF_ANTFS_DEVTYPE_GARMIN_WATCH 

Specifies any supported Garmin fitness watch.

WF_ANTFS_DEVTYPE_GARMIN_FR60 

Specifies the Garmin Forerunner 60.

WF_ANTFS_DEVTYPE_GARMIN_FR310 

Specifies the Garmin Forerunner 310.

WF_ANTFS_DEVTYPE_GARMIN_FR405 

Specifies the Garmin Forerunner 405.

WF_ANTFS_DEVTYPE_GARMIN_FR610 

Specifies the Garmin Forerunner 610.

WF_ANTFS_DEVTYPE_FE_WATCH 

Specifies an ANT FS enabled watch supporting the Fitness Equipment profile.

WF_ANTFS_DEVTYPE_GARMIN_FR910XT 

Specifies the Garmin Forerunner 910XT.

Describes the bit-field values for ANT FS file permissions.

Enumerator
FIT_PERMISSIONS_APPEND 

Appending data is allowed.

FIT_PERMISSIONS_ARCHIVE 

The file has been downloaded.

FIT_PERMISSIONS_ERASE 

The file may be erased.

FIT_PERMISSIONS_WRITE 

The file may be written.

FIT_PERMISSIONS_READ 

The file may be read.

enum WFGender_t

Describes the gender.

Enumerator
WF_GENDER_MALE 

Male.

WF_GENDER_FEMALE 

Female.