Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
Fitness Machine Service Client

This is the client for the Fitness Machine Service. More...

Detailed Description

This is the client for the Fitness Machine Service.

Data Structures

struct  st_ble_ftmc_evt_data_t
 Fitness Machine Service Client event data. More...
 
struct  st_ble_ftmc_hdls_t
 Fitness Machine Service attribute handles. More...
 
struct  st_ble_ftmc_init_param_t
 Fitness Machine Service initialization parameters. More...
 
struct  st_ble_ftmc_connect_param_t
 Fitness Machine Service Client connection parameters. More...
 
struct  st_ble_ftmc_disconnect_param_t
 Fitness Machine Service disconnection parameters. More...
 
struct  st_ble_ftmc_fitness_machine_feature_t
 Fitness Machine Feature characteristic parameters. More...
 
struct  st_ble_ftmc_treadmill_data_t
 Treadmill Data characteristic parameters. More...
 
struct  st_ble_ftmc_cross_trainer_data_t
 Cross Trainer Data characteristic parameters. More...
 
struct  st_ble_ftmc_step_climber_data_t
 Step Climber Data characteristic parameters. More...
 
struct  st_ble_ftmc_stair_climber_data_t
 Stair Climber Data characteristic parameters. More...
 
struct  st_ble_ftmc_rower_data_t
 Rower Data characteristic parameters. More...
 
struct  st_ble_ftmc_indoor_bike_data_t
 Indoor Bike Data characteristic parameters. More...
 
struct  st_ble_ftmc_training_status_t
 Training Status characteristic parameters. More...
 
struct  st_ble_ftmc_supported_speed_range_t
 Supported Speed Range characteristic parameters. More...
 
struct  st_ble_ftmc_supported_inclination_range_t
 Supported Inclination Range characteristic parameters. More...
 
struct  st_ble_ftmc_supported_resistance_level_range_t
 Supported Resistance Level Range characteristic parameters. More...
 
struct  st_ble_ftmc_supported_power_range_t
 Supported Power Range characteristic parameters. More...
 
struct  st_ble_ftmc_supported_heart_rate_range_t
 Supported Heart Rate Range characteristic parameters. More...
 
struct  st_ble_ftmc_fitness_machine_control_point_t
 Fitness Machine Control Point characteristic parameters. More...
 
struct  st_ble_ftmc_fitness_machine_status_t
 Fitness Machine Status characteristic parameters. More...
 

Macros

#define BLE_FTMC_TRAINING_STATUS_STRING_LEN   (18)
 Training Status String Length. More...
 
#define BLE_FTMC_FITNESS_MACHINE_FEATURE_LEN   (8)
 Fitness Machine Feature characteristic value length. More...
 
#define BLE_FTMC_TREADMILL_DATA_LEN   (34)
 Treadmill Data characteristic value length. More...
 
#define BLE_FTMC_CROSS_TRAINER_DATA_LEN   (41)
 Cross Trainer Data characteristic value length. More...
 
#define BLE_FTMC_STEP_CLIMBER_DATA_LEN   (23)
 Step Climber Data characteristic value length. More...
 
#define BLE_FTMC_STAIR_CLIMBER_DATA_LEN   (23)
 Stair Climber Data characteristic value length. More...
 
#define BLE_FTMC_ROWER_DATA_LEN   (30)
 Rower Data characteristic value length. More...
 
#define BLE_FTMC_INDOOR_BIKE_DATA_LEN   (30)
 Indoor Bike Data characteristic value length. More...
 
#define BLE_FTMC_TRAINING_STATUS_LEN   (20)
 Training Status characteristic value length. More...
 
#define BLE_FTMC_SUPPORTED_SPEED_RANGE_LEN   (6)
 Supported Speed Range characteristic value length. More...
 
#define BLE_FTMC_SUPPORTED_INCLINATION_RANGE_LEN   (6)
 Supported Inclination Range characteristic value length. More...
 
#define BLE_FTMC_SUPPORTED_RESISTANCE_LEVEL_RANGE_LEN   (6)
 Supported Resistance Level Range characteristic value length. More...
 
#define BLE_FTMC_SUPPORTED_POWER_RANGE_LEN   (6)
 Supported Power Range characteristic value length. More...
 
#define BLE_FTMC_SUPPORTED_HEART_RATE_RANGE_LEN   (3)
 Supported Heart Rate Range characteristic value length. More...
 
#define BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_LEN   (11)
 Fitness Machine Control Point characteristic value length. More...
 
#define BLE_FTMC_FITNESS_MACHINE_STATUS_LEN   (11)
 Fitness Machine Status characteristic value length. More...
 

Typedefs

typedef void(* ble_ftmc_app_cb_t) (uint16_t type, ble_status_t result, st_ble_ftmc_evt_data_t *p_data)
 Fitness Machine Service Client event callback. More...
 

Enumerations

enum  e_ble_ftmc_event_t {
  BLE_FTMC_EVENT_FITNESS_MACHINE_FEATURE_READ_RSP,
  BLE_FTMC_EVENT_TREADMILL_DATA_HDL_VAL_NTF,
  BLE_FTMC_EVENT_CROSS_TRAINER_DATA_HDL_VAL_NTF,
  BLE_FTMC_EVENT_STEP_CLIMBER_DATA_HDL_VAL_NTF,
  BLE_FTMC_EVENT_STAIR_CLIMBER_DATA_HDL_VAL_NTF,
  BLE_FTMC_EVENT_ROWER_DATA_HDL_VAL_NTF,
  BLE_FTMC_EVENT_INDOOR_BIKE_DATA_HDL_VAL_NTF,
  BLE_FTMC_EVENT_TRAINING_STATUS_HDL_VAL_NTF,
  BLE_FTMC_EVENT_TRAINING_STATUS_READ_RSP,
  BLE_FTMC_EVENT_SUPPORTED_SPEED_RANGE_READ_RSP,
  BLE_FTMC_EVENT_SUPPORTED_INCLINATION_RANGE_READ_RSP,
  BLE_FTMC_EVENT_SUPPORTED_RESISTANCE_LEVEL_RANGE_READ_RSP,
  BLE_FTMC_EVENT_SUPPORTED_POWER_RANGE_READ_RSP,
  BLE_FTMC_EVENT_SUPPORTED_HEART_RATE_RANGE_READ_RSP,
  BLE_FTMC_EVENT_FITNESS_MACHINE_CONTROL_POINT_HDL_VAL_IND,
  BLE_FTMC_EVENT_FITNESS_MACHINE_CONTROL_POINT_WRITE_RSP,
  BLE_FTMC_EVENT_FITNESS_MACHINE_STATUS_HDL_VAL_NTF,
  BLE_FTMC_EVENT_CLI_CNFG_WRITE_RSP,
  BLE_FTMC_EVENT_ERROR_RSP
}
 Fitness Machine Service Client event type. More...
 
enum  e_ble_ftmc_training_status_t {
  BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_OTHER = 0,
  BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_IDLE = 1,
  BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_WARMING_UP = 2,
  BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_LOW_INTENSITY_INTERVAL = 3,
  BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_HIGH_INTENSITY_INTERVAL = 4,
  BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_RECOVERY_INTERVAL = 5,
  BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_ISOMETRIC = 6,
  BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_HEART_RATE_CONTROL = 7,
  BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_FITNESS_TEST = 8,
  BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_COOL_DOWN = 11,
  BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_WATT_CONTROL = 12,
  BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_MANUAL_MODE__QUICK_START_ = 13,
  BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_PRE_WORKOUT = 14,
  BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_POST_WORKOUT = 15,
  BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_SPEED_OUTSIDE_OF_CONTROL_REGION_LOW = 9,
  BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_SPEED_OUTSIDE_OF_CONTROL_REGION_HIGH = 10
}
 Training Status enumeration. More...
 
enum  e_ble_ftmc_fitness_machine_control_point_op_code_t {
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_REQUEST_CONTROL = 0,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_RESET = 1,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGET_SPEED = 2,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGET_INCLINATION = 3,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGET_RESISTANCE_LEVEL = 4,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGET_POWER = 5,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGET_HEART_RATE = 6,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_START_OR_RESUME = 7,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_STOP_OR_PAUSE = 8,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGETED_EXPENDED_ENERGY = 9,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGETED_NUMBER_OF_STEPS = 10,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGETED_NUMBER_OF_STRIDES = 11,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGETED_DISTANCE = 12,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGETED_TRAINING_TIME = 13,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGETED_TIME_IN_TWO_HEART_RATE_ZONES = 14,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGETED_TIME_IN_THREE_HEART_RATE_ZONES = 15,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGETED_TIME_IN_FIVE_HEART_RATE_ZONES = 16,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_INDOOR_BIKE_SIMULATION_PARAMETERS = 17,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_WHEEL_CIRCUMFERENCE = 18,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SPIN_DOWN_CONTROL = 19,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGETED_CADENCE = 20,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_RESPONSE_CODE = 128
}
 Op Code enumeration. More...
 
enum  e_ble_ftmc_fitness_machine_control_point_control_information_t {
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_CONTROL_INFORMATION_RESERVED_FOR_FUTURE_USE = 0,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_CONTROL_INFORMATION_STOP = 1,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_CONTROL_INFORMATION_PAUSE = 2
}
 Control Information enumeration. More...
 
enum  e_ble_ftmc_fitness_machine_control_point_control_parameter_t {
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_CONTROL_PARAMETER_RESERVED_FOR_FUTURE_USE = 0,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_CONTROL_PARAMETER_START = 1,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_CONTROL_PARAMETER_IGNORE = 2
}
 Control Parameter enumeration. More...
 
enum  e_ble_ftmc_fitness_machine_control_point_result_code_t {
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_RESULT_CODE_RESERVED_FOR_FUTURE_USE = 0,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_RESULT_CODE_SUCCESS = 1,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_RESULT_CODE_OP_CODE_NOT_SUPPORTED = 2,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_RESULT_CODE_INVALID_PARAMETER = 3,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_RESULT_CODE_OPERATION_FAILED = 4,
  BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_RESULT_CODE_CONTROL_NOT_PERMITTED = 5
}
 Result Code enumeration. More...
 
enum  e_ble_ftmc_fitness_machine_status_op_code_t {
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_RESERVED_FOR_FUTURE_USE = 0,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_RESET = 1,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_FITNESS_MACHINE_STOPPED_OR_PAUSED_BY_THE_USER = 2,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_FITNESS_MACHINE_STOPPED_BY_SAFETY_KEY = 3,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_FITNESS_MACHINE_STARTED_OR_RESUMED_BY_THE_USER = 4,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGET_SPEED_CHANGED = 5,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGET_INCLINE_CHANGED = 6,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGET_RESISTANCE_LEVEL_CHANGED = 7,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGET_POWER_CHANGED = 8,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGET_HEART_RATE_CHANGED = 9,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGETED_EXPENDED_ENERGY_CHANGED = 10,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGETED_NUMBER_OF_STEPS_CHANGED = 11,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGETED_NUMBER_OF_STRIDES_CHANGED = 12,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGETED_DISTANCE_CHANGED = 13,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGETED_TRAINING_TIME_CHANGED = 14,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGETED_TIME_IN_TWO_HEART_RATE_ZONES_CHANGED = 15,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGETED_TIME_IN_THREE_HEART_RATE_ZONES_CHANGED = 16,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGETED_TIME_IN_FIVE_HEART_RATE_ZONES_CHANGED = 17,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_INDOOR_BIKE_SIMULATION_PARAMETERS_CHANGED = 18,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_WHEEL_CIRCUMFERENCE_CHANGED = 19,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_SPIN_DOWN_STATUS = 20,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGETED_CADENCE_CHANGED = 21,
  BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_CONTROL_PERMISSION_LOST = 255
}
 Op Code enumeration. More...
 
enum  e_ble_ftmc_fitness_machine_status_control_information_t {
  BLE_FTMC_FITNESS_MACHINE_STATUS_CONTROL_POINT_CONTROL_INFORMATION_RESERVED_FOR_FUTURE_USE = 0,
  BLE_FTMC_FITNESS_MACHINE_STATUS_CONTROL_POINT_CONTROL_INFORMATION_STOP = 1,
  BLE_FTMC_FITNESS_MACHINE_STATUS_CONTROL_POINT_CONTROL_INFORMATION_PAUSE = 2
}
 Control Information enumeration. More...
 
enum  e_ble_ftmc_fitness_machine_status_spindown_status_t {
  BLE_FTMC_FITNESS_MACHINE_STATUS_SPIN_DOWN_STATUS_RESERVED_FOR_FUTURE_USE = 0,
  BLE_FTMC_FITNESS_MACHINE_STATUS_SPIN_DOWN_STATUS_SPIN_DOWN_REQUESTED = 1,
  BLE_FTMC_FITNESS_MACHINE_STATUS_SPIN_DOWN_STATUS_SUCCESS = 2,
  BLE_FTMC_FITNESS_MACHINE_STATUS_SPIN_DOWN_STATUS_ERROR = 3,
  BLE_FTMC_FITNESS_MACHINE_STATUS_SPIN_DOWN_STATUS_STOP_PEDALING = 4
}
 Spin Down Status enumeration. More...
 

Functions

ble_status_t R_BLE_FTMC_Init (const st_ble_ftmc_init_param_t *p_param)
 Initialize Fitness Machine Service Client. More...
 
ble_status_t R_BLE_FTMC_Connect (uint16_t conn_hdl, const st_ble_ftmc_connect_param_t *p_param)
 Perform Fitness Machine Service Client connection settings. More...
 
ble_status_t R_BLE_FTMC_Disconnect (uint16_t conn_hdl, st_ble_ftmc_disconnect_param_t *p_param)
 Retrieve Fitness Machine Service Client connection specific settings before disconnection. More...
 
ble_status_t R_BLE_FTMC_ReadFitnessMachineFeature (uint16_t conn_hdl)
 Read Fitness Machine Feature characteristic value from remote GATT database. More...
 
ble_status_t R_BLE_FTMC_SetTreadmillDataCliCnfg (uint16_t conn_hdl, uint16_t cli_cnfg)
 Set Treadmill Data characteristic cli cnfg. More...
 
ble_status_t R_BLE_FTMC_SetCrossTrainerDataCliCnfg (uint16_t conn_hdl, uint16_t cli_cnfg)
 Set Cross Trainer Data characteristic cli cnfg. More...
 
ble_status_t R_BLE_FTMC_SetStepClimberDataCliCnfg (uint16_t conn_hdl, uint16_t cli_cnfg)
 Set Step Climber Data characteristic cli cnfg. More...
 
ble_status_t R_BLE_FTMC_SetStairClimberDataCliCnfg (uint16_t conn_hdl, uint16_t cli_cnfg)
 Set Stair Climber Data characteristic cli cnfg. More...
 
ble_status_t R_BLE_FTMC_SetRowerDataCliCnfg (uint16_t conn_hdl, uint16_t cli_cnfg)
 Set Rower Data characteristic cli cnfg. More...
 
ble_status_t R_BLE_FTMC_SetIndoorBikeDataCliCnfg (uint16_t conn_hdl, uint16_t cli_cnfg)
 Set Indoor Bike Data characteristic cli cnfg. More...
 
ble_status_t R_BLE_FTMC_ReadTrainingStatus (uint16_t conn_hdl)
 Read Training Status characteristic value from remote GATT database. More...
 
ble_status_t R_BLE_FTMC_SetTrainingStatusCliCnfg (uint16_t conn_hdl, uint16_t cli_cnfg)
 Set Training Status characteristic cli cnfg. More...
 
ble_status_t R_BLE_FTMC_ReadSupportedSpeedRange (uint16_t conn_hdl)
 Read Supported Speed Range characteristic value from remote GATT database. More...
 
ble_status_t R_BLE_FTMC_ReadSupportedInclinationRange (uint16_t conn_hdl)
 Read Supported Inclination Range characteristic value from remote GATT database. More...
 
ble_status_t R_BLE_FTMC_ReadSupportedResistanceLevelRange (uint16_t conn_hdl)
 Read Supported Resistance Level Range characteristic value from remote GATT database. More...
 
ble_status_t R_BLE_FTMC_ReadSupportedPowerRange (uint16_t conn_hdl)
 Read Supported Power Range characteristic value from remote GATT database. More...
 
ble_status_t R_BLE_FTMC_ReadSupportedHeartRateRange (uint16_t conn_hdl)
 Read Supported Heart Rate Range characteristic value from remote GATT database. More...
 
ble_status_t R_BLE_FTMC_WriteFitnessMachineControlPoint (uint16_t conn_hdl, const st_ble_ftmc_fitness_machine_control_point_t *p_app_value)
 Write Fitness Machine Control Point characteristic value to remote GATT database. More...
 
ble_status_t R_BLE_FTMC_SetFitnessMachineControlPointCliCnfg (uint16_t conn_hdl, uint16_t cli_cnfg)
 Set Fitness Machine Control Point characteristic cli cnfg. More...
 
ble_status_t R_BLE_FTMC_SetFitnessMachineStatusCliCnfg (uint16_t conn_hdl, uint16_t cli_cnfg)
 Set Fitness Machine Status characteristic cli cnfg. More...
 
void R_BLE_FTMC_ServDiscCb (uint16_t conn_hdl, uint8_t idx, uint16_t type, void *p_param)
 
uint32_t R_BLE_FTMC_GetVersion (void)
 Return version of the FTMC service client. More...
 

Variables

const uint8_t BLE_FTMC_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Fitness Machine Service UUID. More...
 
const uint8_t BLE_FTMC_FITNESS_MACHINE_FEATURE_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Fitness Machine Feature characteristic UUID. More...
 
const uint8_t BLE_FTMC_TREADMILL_DATA_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Treadmill Data characteristic UUID. More...
 
const uint8_t BLE_FTMC_CROSS_TRAINER_DATA_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Cross Trainer Data characteristic UUID. More...
 
const uint8_t BLE_FTMC_STEP_CLIMBER_DATA_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Step Climber Data characteristic UUID. More...
 
const uint8_t BLE_FTMC_STAIR_CLIMBER_DATA_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Stair Climber Data characteristic UUID. More...
 
const uint8_t BLE_FTMC_ROWER_DATA_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Rower Data characteristic UUID. More...
 
const uint8_t BLE_FTMC_INDOOR_BIKE_DATA_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Indoor Bike Data characteristic UUID. More...
 
const uint8_t BLE_FTMC_TRAINING_STATUS_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Training Status characteristic UUID. More...
 
const uint8_t BLE_FTMC_SUPPORTED_SPEED_RANGE_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Supported Speed Range characteristic UUID. More...
 
const uint8_t BLE_FTMC_SUPPORTED_INCLINATION_RANGE_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Supported Inclination Range characteristic UUID. More...
 
const uint8_t BLE_FTMC_SUPPORTED_RESISTANCE_LEVEL_RANGE_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Supported Resistance Level Range characteristic UUID. More...
 
const uint8_t BLE_FTMC_SUPPORTED_POWER_RANGE_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Supported Power Range characteristic UUID. More...
 
const uint8_t BLE_FTMC_SUPPORTED_HEART_RATE_RANGE_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Supported Heart Rate Range characteristic UUID. More...
 
const uint8_t BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Fitness Machine Control Point characteristic UUID. More...
 
const uint8_t BLE_FTMC_FITNESS_MACHINE_STATUS_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Fitness Machine Status characteristic UUID. More...
 

Macro Definition Documentation

◆ BLE_FTMC_TRAINING_STATUS_STRING_LEN

#define BLE_FTMC_TRAINING_STATUS_STRING_LEN   (18)

Training Status String Length.

◆ BLE_FTMC_FITNESS_MACHINE_FEATURE_LEN

#define BLE_FTMC_FITNESS_MACHINE_FEATURE_LEN   (8)

Fitness Machine Feature characteristic value length.

◆ BLE_FTMC_TREADMILL_DATA_LEN

#define BLE_FTMC_TREADMILL_DATA_LEN   (34)

Treadmill Data characteristic value length.

◆ BLE_FTMC_CROSS_TRAINER_DATA_LEN

#define BLE_FTMC_CROSS_TRAINER_DATA_LEN   (41)

Cross Trainer Data characteristic value length.

◆ BLE_FTMC_STEP_CLIMBER_DATA_LEN

#define BLE_FTMC_STEP_CLIMBER_DATA_LEN   (23)

Step Climber Data characteristic value length.

◆ BLE_FTMC_STAIR_CLIMBER_DATA_LEN

#define BLE_FTMC_STAIR_CLIMBER_DATA_LEN   (23)

Stair Climber Data characteristic value length.

◆ BLE_FTMC_ROWER_DATA_LEN

#define BLE_FTMC_ROWER_DATA_LEN   (30)

Rower Data characteristic value length.

◆ BLE_FTMC_INDOOR_BIKE_DATA_LEN

#define BLE_FTMC_INDOOR_BIKE_DATA_LEN   (30)

Indoor Bike Data characteristic value length.

◆ BLE_FTMC_TRAINING_STATUS_LEN

#define BLE_FTMC_TRAINING_STATUS_LEN   (20)

Training Status characteristic value length.

◆ BLE_FTMC_SUPPORTED_SPEED_RANGE_LEN

#define BLE_FTMC_SUPPORTED_SPEED_RANGE_LEN   (6)

Supported Speed Range characteristic value length.

◆ BLE_FTMC_SUPPORTED_INCLINATION_RANGE_LEN

#define BLE_FTMC_SUPPORTED_INCLINATION_RANGE_LEN   (6)

Supported Inclination Range characteristic value length.

◆ BLE_FTMC_SUPPORTED_RESISTANCE_LEVEL_RANGE_LEN

#define BLE_FTMC_SUPPORTED_RESISTANCE_LEVEL_RANGE_LEN   (6)

Supported Resistance Level Range characteristic value length.

◆ BLE_FTMC_SUPPORTED_POWER_RANGE_LEN

#define BLE_FTMC_SUPPORTED_POWER_RANGE_LEN   (6)

Supported Power Range characteristic value length.

◆ BLE_FTMC_SUPPORTED_HEART_RATE_RANGE_LEN

#define BLE_FTMC_SUPPORTED_HEART_RATE_RANGE_LEN   (3)

Supported Heart Rate Range characteristic value length.

◆ BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_LEN

#define BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_LEN   (11)

Fitness Machine Control Point characteristic value length.

◆ BLE_FTMC_FITNESS_MACHINE_STATUS_LEN

#define BLE_FTMC_FITNESS_MACHINE_STATUS_LEN   (11)

Fitness Machine Status characteristic value length.

Typedef Documentation

◆ ble_ftmc_app_cb_t

typedef void(* ble_ftmc_app_cb_t) (uint16_t type, ble_status_t result, st_ble_ftmc_evt_data_t *p_data)

Fitness Machine Service Client event callback.

Enumeration Type Documentation

◆ e_ble_ftmc_event_t

Fitness Machine Service Client event type.

Enumerator
BLE_FTMC_EVENT_FITNESS_MACHINE_FEATURE_READ_RSP 

Fitness Machine Feature characteristic read response event

BLE_FTMC_EVENT_TREADMILL_DATA_HDL_VAL_NTF 

Treadmill Data characteristic handle value notification event

BLE_FTMC_EVENT_CROSS_TRAINER_DATA_HDL_VAL_NTF 

Cross Trainer Data characteristic handle value notification event

BLE_FTMC_EVENT_STEP_CLIMBER_DATA_HDL_VAL_NTF 

Step Climber Data characteristic handle value notification event

BLE_FTMC_EVENT_STAIR_CLIMBER_DATA_HDL_VAL_NTF 

Stair Climber Data characteristic handle value notification event

BLE_FTMC_EVENT_ROWER_DATA_HDL_VAL_NTF 

Rower Data characteristic handle value notification event

BLE_FTMC_EVENT_INDOOR_BIKE_DATA_HDL_VAL_NTF 

Indoor Bike Data characteristic handle value notification event

BLE_FTMC_EVENT_TRAINING_STATUS_HDL_VAL_NTF 

Training Status characteristic handle value notification event

BLE_FTMC_EVENT_TRAINING_STATUS_READ_RSP 

Training Status characteristic read response event

BLE_FTMC_EVENT_SUPPORTED_SPEED_RANGE_READ_RSP 

Supported Speed Range characteristic read response event

BLE_FTMC_EVENT_SUPPORTED_INCLINATION_RANGE_READ_RSP 

Supported Inclination Range characteristic read response event

BLE_FTMC_EVENT_SUPPORTED_RESISTANCE_LEVEL_RANGE_READ_RSP 

Supported Resistance Level Range characteristic read response event

BLE_FTMC_EVENT_SUPPORTED_POWER_RANGE_READ_RSP 

Supported Power Range characteristic read response event

BLE_FTMC_EVENT_SUPPORTED_HEART_RATE_RANGE_READ_RSP 

Supported Heart Rate Range characteristic read response event

BLE_FTMC_EVENT_FITNESS_MACHINE_CONTROL_POINT_HDL_VAL_IND 

Fitness Machine Control Point characteristic handle value indication event

BLE_FTMC_EVENT_FITNESS_MACHINE_CONTROL_POINT_WRITE_RSP 

Fitness Machine Control Point characteristic write response event

BLE_FTMC_EVENT_FITNESS_MACHINE_STATUS_HDL_VAL_NTF 

Fitness Machine Status characteristic handle value notification event

BLE_FTMC_EVENT_CLI_CNFG_WRITE_RSP 

Cli Cnfig write response

BLE_FTMC_EVENT_ERROR_RSP 

error response

◆ e_ble_ftmc_training_status_t

Training Status enumeration.

Enumerator
BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_OTHER 

Training Status Other

BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_IDLE 

Training Status Idle

BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_WARMING_UP 

Training Status Warming Up

BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_LOW_INTENSITY_INTERVAL 

Training Status Low Intensity Interval

BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_HIGH_INTENSITY_INTERVAL 

Training Status High Intensity Interval

BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_RECOVERY_INTERVAL 

Training Status Recovery Interval

BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_ISOMETRIC 

Training Status sometric

BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_HEART_RATE_CONTROL 

Training Status Heart Rate Control

BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_FITNESS_TEST 

Training Status Fitness Test

BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_COOL_DOWN 

Training Status Cool Down

BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_WATT_CONTROL 

Training Status Watt Control

BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_MANUAL_MODE__QUICK_START_ 

Training Status Manual Mode (Quick Start)

BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_PRE_WORKOUT 

Training Status Pre-Workout

BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_POST_WORKOUT 

Training Status Post-Workout

BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_SPEED_OUTSIDE_OF_CONTROL_REGION_LOW 

Training Status Speed Outside of Control Region - Low (increase speed to return to controllable region)

BLE_FTMC_TRAINING_STATUS_TRAINING_STATUS_SPEED_OUTSIDE_OF_CONTROL_REGION_HIGH 

Training Status Speed Outside of Control Region - High (decrease speed to return to controllable region)

◆ e_ble_ftmc_fitness_machine_control_point_op_code_t

Op Code enumeration.

Enumerator
BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_REQUEST_CONTROL 

Op Code for Request Control

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_RESET 

Op Code for Reset

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGET_SPEED 

Op Code for Set Target Speed

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGET_INCLINATION 

Op Code for Set Target Inclination

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGET_RESISTANCE_LEVEL 

Op Code for Set Target Resistance Level

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGET_POWER 

Op Code for Set Target Power

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGET_HEART_RATE 

Op Code for Set Target Heart Rate

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_START_OR_RESUME 

Op Code for Start or Resume

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_STOP_OR_PAUSE 

Op Code for Stop or Pause

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGETED_EXPENDED_ENERGY 

Op Code for Set Targeted Expended Energy

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGETED_NUMBER_OF_STEPS 

Op Code for Set Targeted Number of Steps

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGETED_NUMBER_OF_STRIDES 

Op Code for Set Targeted Number of Strides

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGETED_DISTANCE 

Op Code for Set Targeted Distance

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGETED_TRAINING_TIME 

Op Code for Set Targeted Training Time

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGETED_TIME_IN_TWO_HEART_RATE_ZONES 

Op Code for Set Targeted Time in Two Heart Rate Zones

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGETED_TIME_IN_THREE_HEART_RATE_ZONES 

Op Code for Set Targeted Time in Three Heart Rate Zones

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGETED_TIME_IN_FIVE_HEART_RATE_ZONES 

Op Code for Set Targeted Time in Five Heart Rate Zones

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_INDOOR_BIKE_SIMULATION_PARAMETERS 

Op Code for Set Indoor Bike Simulation Parameters

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_WHEEL_CIRCUMFERENCE 

Op Code for Set Wheel Circumference

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SPIN_DOWN_CONTROL 

Op Code for Spin Down Control

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_SET_TARGETED_CADENCE 

Op Code for Set Targeted Cadence

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_OP_CODE_RESPONSE_CODE 

Op Code for Response Code

◆ e_ble_ftmc_fitness_machine_control_point_control_information_t

Control Information enumeration.

Enumerator
BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_CONTROL_INFORMATION_RESERVED_FOR_FUTURE_USE 

Control Information Value Reserved for Future Use

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_CONTROL_INFORMATION_STOP 

Control Information Value to Stop

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_CONTROL_INFORMATION_PAUSE 

Control Information Value to Pause

◆ e_ble_ftmc_fitness_machine_control_point_control_parameter_t

Control Parameter enumeration.

Enumerator
BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_CONTROL_PARAMETER_RESERVED_FOR_FUTURE_USE 

Control Parameter Value Reserved for Future Use

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_CONTROL_PARAMETER_START 

Control Parameter Value to Start

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_CONTROL_PARAMETER_IGNORE 

Control Parameter Value to Ignore

◆ e_ble_ftmc_fitness_machine_control_point_result_code_t

Result Code enumeration.

Enumerator
BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_RESULT_CODE_RESERVED_FOR_FUTURE_USE 

Result Code Value Reserved for Future Use

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_RESULT_CODE_SUCCESS 

Result Code Value for Success

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_RESULT_CODE_OP_CODE_NOT_SUPPORTED 

Result Code Value for Op Code Not Supported

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_RESULT_CODE_INVALID_PARAMETER 

Result Code Value for Invalid Parameter

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_RESULT_CODE_OPERATION_FAILED 

Result Code Value for Operation Failed

BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_RESULT_CODE_CONTROL_NOT_PERMITTED 

Result Code Value for Control Not Permitted

◆ e_ble_ftmc_fitness_machine_status_op_code_t

Op Code enumeration.

Enumerator
BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_RESERVED_FOR_FUTURE_USE 

Op Code Reserved for Future Use

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_RESET 

Op Code for Reset

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_FITNESS_MACHINE_STOPPED_OR_PAUSED_BY_THE_USER 

Op Code for Fitness Machine Stopped or Paused by the User

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_FITNESS_MACHINE_STOPPED_BY_SAFETY_KEY 

Op Code for Fitness Machine Stopped by Safety Key

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_FITNESS_MACHINE_STARTED_OR_RESUMED_BY_THE_USER 

Op Code for Fitness Machine Started or Resumed by the User

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGET_SPEED_CHANGED 

Op Code for Target Speed Changed

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGET_INCLINE_CHANGED 

Op Code for Target Incline Changed

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGET_RESISTANCE_LEVEL_CHANGED 

Op Code for Target Resistance Level Changed

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGET_POWER_CHANGED 

Op Code for Target Power Changed

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGET_HEART_RATE_CHANGED 

Op Code for Target Heart Rate Changed

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGETED_EXPENDED_ENERGY_CHANGED 

Op Code for Targeted Expended Energy Changed

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGETED_NUMBER_OF_STEPS_CHANGED 

Op Code for Targeted Number of Steps Changed

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGETED_NUMBER_OF_STRIDES_CHANGED 

Op Code for Targeted Number of Strides Changed

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGETED_DISTANCE_CHANGED 

Op Code for Targeted Distance Changed

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGETED_TRAINING_TIME_CHANGED 

Op Code for Targeted Training Time Changed

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGETED_TIME_IN_TWO_HEART_RATE_ZONES_CHANGED 

Op Code for Targeted Time in Two Heart Rate Zones Changed

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGETED_TIME_IN_THREE_HEART_RATE_ZONES_CHANGED 

Op Code for Targeted Time in Three Heart Rate Zones Changed

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGETED_TIME_IN_FIVE_HEART_RATE_ZONES_CHANGED 

Op Code for Targeted Time in Five Heart Rate Zones Changed

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_INDOOR_BIKE_SIMULATION_PARAMETERS_CHANGED 

Op Code for Indoor Bike Simulation Parameters Changed

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_WHEEL_CIRCUMFERENCE_CHANGED 

Op Code for Wheel Circumference Changed

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_SPIN_DOWN_STATUS 

Op Code for Spin Down Status

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_TARGETED_CADENCE_CHANGED 

Op Code for Targeted Cadence Changed

BLE_FTMC_FITNESS_MACHINE_STATUS_OP_CODE_CONTROL_PERMISSION_LOST 

Op Code for Control Permission Lost

◆ e_ble_ftmc_fitness_machine_status_control_information_t

Control Information enumeration.

Enumerator
BLE_FTMC_FITNESS_MACHINE_STATUS_CONTROL_POINT_CONTROL_INFORMATION_RESERVED_FOR_FUTURE_USE 

Control Information Value Reserved for Future Use

BLE_FTMC_FITNESS_MACHINE_STATUS_CONTROL_POINT_CONTROL_INFORMATION_STOP 

Control Information Value to Stop

BLE_FTMC_FITNESS_MACHINE_STATUS_CONTROL_POINT_CONTROL_INFORMATION_PAUSE 

Control Information Value to Pause

◆ e_ble_ftmc_fitness_machine_status_spindown_status_t

Spin Down Status enumeration.

Enumerator
BLE_FTMC_FITNESS_MACHINE_STATUS_SPIN_DOWN_STATUS_RESERVED_FOR_FUTURE_USE 

Spin Down Status Value Reserved for Future Use

BLE_FTMC_FITNESS_MACHINE_STATUS_SPIN_DOWN_STATUS_SPIN_DOWN_REQUESTED 

Spin Down Status Value for Spin Down Requested

BLE_FTMC_FITNESS_MACHINE_STATUS_SPIN_DOWN_STATUS_SUCCESS 

Spin Down Status Value for Success

BLE_FTMC_FITNESS_MACHINE_STATUS_SPIN_DOWN_STATUS_ERROR 

Spin Down Status Value for Error

BLE_FTMC_FITNESS_MACHINE_STATUS_SPIN_DOWN_STATUS_STOP_PEDALING 

Spin Down Status Value for Stop Pedaling

Function Documentation

◆ R_BLE_FTMC_Init()

ble_status_t R_BLE_FTMC_Init ( const st_ble_ftmc_init_param_t p_param)

Initialize Fitness Machine Service Client.

This function shall be called once at startup.

Parameters
[in]p_paramPointer to Fitness Machine Service Client initialization parameters.
Returns
ble_status_t

◆ R_BLE_FTMC_Connect()

ble_status_t R_BLE_FTMC_Connect ( uint16_t  conn_hdl,
const st_ble_ftmc_connect_param_t p_param 
)

Perform Fitness Machine Service Client connection settings.

This function shall be called on each connection establishment.

Parameters
[in]conn_hdlConnection handle.
[in]p_paramPointer to Connection parameters.
Returns
ble_status_t

◆ R_BLE_FTMC_Disconnect()

ble_status_t R_BLE_FTMC_Disconnect ( uint16_t  conn_hdl,
st_ble_ftmc_disconnect_param_t p_param 
)

Retrieve Fitness Machine Service Client connection specific settings before disconnection.

This function shall be called on each disconnection.

Parameters
[in]conn_hdlConnection handle.
[in]p_paramPointer to Disconnection parameters.
Returns
ble_status_t

◆ R_BLE_FTMC_ReadFitnessMachineFeature()

ble_status_t R_BLE_FTMC_ReadFitnessMachineFeature ( uint16_t  conn_hdl)

Read Fitness Machine Feature characteristic value from remote GATT database.

Parameters
[out]app_valueRetrieved Fitness Machine Feature characteristic value.
Returns
ble_status_t

◆ R_BLE_FTMC_SetTreadmillDataCliCnfg()

ble_status_t R_BLE_FTMC_SetTreadmillDataCliCnfg ( uint16_t  conn_hdl,
uint16_t  cli_cnfg 
)

Set Treadmill Data characteristic cli cnfg.

Parameters
[in]conn_hdlConnection handle.
[in]cli_cnfgTreadmill Data characteristic cli cnfg to set.
Returns
ble_status_t

◆ R_BLE_FTMC_SetCrossTrainerDataCliCnfg()

ble_status_t R_BLE_FTMC_SetCrossTrainerDataCliCnfg ( uint16_t  conn_hdl,
uint16_t  cli_cnfg 
)

Set Cross Trainer Data characteristic cli cnfg.

Parameters
[in]conn_hdlConnection handle.
[in]cli_cnfgCross Trainer Data characteristic cli cnfg to set.
Returns
ble_status_t

◆ R_BLE_FTMC_SetStepClimberDataCliCnfg()

ble_status_t R_BLE_FTMC_SetStepClimberDataCliCnfg ( uint16_t  conn_hdl,
uint16_t  cli_cnfg 
)

Set Step Climber Data characteristic cli cnfg.

Parameters
[in]conn_hdlConnection handle.
[in]cli_cnfgStep Climber Data characteristic cli cnfg to set.
Returns
ble_status_t

◆ R_BLE_FTMC_SetStairClimberDataCliCnfg()

ble_status_t R_BLE_FTMC_SetStairClimberDataCliCnfg ( uint16_t  conn_hdl,
uint16_t  cli_cnfg 
)

Set Stair Climber Data characteristic cli cnfg.

Parameters
[in]conn_hdlConnection handle.
[in]cli_cnfgStair Climber Data characteristic cli cnfg to set.
Returns
ble_status_t

◆ R_BLE_FTMC_SetRowerDataCliCnfg()

ble_status_t R_BLE_FTMC_SetRowerDataCliCnfg ( uint16_t  conn_hdl,
uint16_t  cli_cnfg 
)

Set Rower Data characteristic cli cnfg.

Parameters
[in]conn_hdlConnection handle.
[in]cli_cnfgRower Data characteristic cli cnfg to set.
Returns
ble_status_t

◆ R_BLE_FTMC_SetIndoorBikeDataCliCnfg()

ble_status_t R_BLE_FTMC_SetIndoorBikeDataCliCnfg ( uint16_t  conn_hdl,
uint16_t  cli_cnfg 
)

Set Indoor Bike Data characteristic cli cnfg.

Parameters
[in]conn_hdlConnection handle.
[in]cli_cnfgIndoor Bike Data characteristic cli cnfg to set.
Returns
ble_status_t

◆ R_BLE_FTMC_ReadTrainingStatus()

ble_status_t R_BLE_FTMC_ReadTrainingStatus ( uint16_t  conn_hdl)

Read Training Status characteristic value from remote GATT database.

Parameters
[out]app_valueRetrieved Training Status characteristic value.
Returns
ble_status_t

◆ R_BLE_FTMC_SetTrainingStatusCliCnfg()

ble_status_t R_BLE_FTMC_SetTrainingStatusCliCnfg ( uint16_t  conn_hdl,
uint16_t  cli_cnfg 
)

Set Training Status characteristic cli cnfg.

Parameters
[in]conn_hdlConnection handle.
[in]cli_cnfgTraining Status characteristic cli cnfg to set.
Returns
ble_status_t

◆ R_BLE_FTMC_ReadSupportedSpeedRange()

ble_status_t R_BLE_FTMC_ReadSupportedSpeedRange ( uint16_t  conn_hdl)

Read Supported Speed Range characteristic value from remote GATT database.

Parameters
[out]app_valueRetrieved Supported Speed Range characteristic value.
Returns
ble_status_t

◆ R_BLE_FTMC_ReadSupportedInclinationRange()

ble_status_t R_BLE_FTMC_ReadSupportedInclinationRange ( uint16_t  conn_hdl)

Read Supported Inclination Range characteristic value from remote GATT database.

Parameters
[out]app_valueRetrieved Supported Inclination Range characteristic value.
Returns
ble_status_t

◆ R_BLE_FTMC_ReadSupportedResistanceLevelRange()

ble_status_t R_BLE_FTMC_ReadSupportedResistanceLevelRange ( uint16_t  conn_hdl)

Read Supported Resistance Level Range characteristic value from remote GATT database.

Parameters
[out]app_valueRetrieved Supported Resistance Level Range characteristic value.
Returns
ble_status_t

◆ R_BLE_FTMC_ReadSupportedPowerRange()

ble_status_t R_BLE_FTMC_ReadSupportedPowerRange ( uint16_t  conn_hdl)

Read Supported Power Range characteristic value from remote GATT database.

Parameters
[out]app_valueRetrieved Supported Power Range characteristic value.
Returns
ble_status_t

◆ R_BLE_FTMC_ReadSupportedHeartRateRange()

ble_status_t R_BLE_FTMC_ReadSupportedHeartRateRange ( uint16_t  conn_hdl)

Read Supported Heart Rate Range characteristic value from remote GATT database.

Parameters
[out]app_valueRetrieved Supported Heart Rate Range characteristic value.
Returns
ble_status_t

◆ R_BLE_FTMC_WriteFitnessMachineControlPoint()

ble_status_t R_BLE_FTMC_WriteFitnessMachineControlPoint ( uint16_t  conn_hdl,
const st_ble_ftmc_fitness_machine_control_point_t p_app_value 
)

Write Fitness Machine Control Point characteristic value to remote GATT database.

Parameters
[in]conn_hdlConnection handle.
[in]p_app_valuePointer to Fitness Machine Control Point characteristic value to write.
Returns
ble_status_t

◆ R_BLE_FTMC_SetFitnessMachineControlPointCliCnfg()

ble_status_t R_BLE_FTMC_SetFitnessMachineControlPointCliCnfg ( uint16_t  conn_hdl,
uint16_t  cli_cnfg 
)

Set Fitness Machine Control Point characteristic cli cnfg.

Parameters
[in]conn_hdlConnection handle.
[in]cli_cnfgFitness Machine Control Point characteristic cli cnfg to set.
Returns
ble_status_t

◆ R_BLE_FTMC_SetFitnessMachineStatusCliCnfg()

ble_status_t R_BLE_FTMC_SetFitnessMachineStatusCliCnfg ( uint16_t  conn_hdl,
uint16_t  cli_cnfg 
)

Set Fitness Machine Status characteristic cli cnfg.

Parameters
[in]conn_hdlConnection handle.
[in]cli_cnfgFitness Machine Status characteristic cli cnfg to set.
Returns
ble_status_t

◆ R_BLE_FTMC_GetVersion()

uint32_t R_BLE_FTMC_GetVersion ( void  )

Return version of the FTMC service client.

Returns
version

Variable Documentation

◆ BLE_FTMC_UUID

const uint8_t BLE_FTMC_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Fitness Machine Service UUID.

◆ BLE_FTMC_FITNESS_MACHINE_FEATURE_UUID

const uint8_t BLE_FTMC_FITNESS_MACHINE_FEATURE_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Fitness Machine Feature characteristic UUID.

◆ BLE_FTMC_TREADMILL_DATA_UUID

const uint8_t BLE_FTMC_TREADMILL_DATA_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Treadmill Data characteristic UUID.

◆ BLE_FTMC_CROSS_TRAINER_DATA_UUID

const uint8_t BLE_FTMC_CROSS_TRAINER_DATA_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Cross Trainer Data characteristic UUID.

◆ BLE_FTMC_STEP_CLIMBER_DATA_UUID

const uint8_t BLE_FTMC_STEP_CLIMBER_DATA_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Step Climber Data characteristic UUID.

◆ BLE_FTMC_STAIR_CLIMBER_DATA_UUID

const uint8_t BLE_FTMC_STAIR_CLIMBER_DATA_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Stair Climber Data characteristic UUID.

◆ BLE_FTMC_ROWER_DATA_UUID

const uint8_t BLE_FTMC_ROWER_DATA_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Rower Data characteristic UUID.

◆ BLE_FTMC_INDOOR_BIKE_DATA_UUID

const uint8_t BLE_FTMC_INDOOR_BIKE_DATA_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Indoor Bike Data characteristic UUID.

◆ BLE_FTMC_TRAINING_STATUS_UUID

const uint8_t BLE_FTMC_TRAINING_STATUS_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Training Status characteristic UUID.

◆ BLE_FTMC_SUPPORTED_SPEED_RANGE_UUID

const uint8_t BLE_FTMC_SUPPORTED_SPEED_RANGE_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Supported Speed Range characteristic UUID.

◆ BLE_FTMC_SUPPORTED_INCLINATION_RANGE_UUID

const uint8_t BLE_FTMC_SUPPORTED_INCLINATION_RANGE_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Supported Inclination Range characteristic UUID.

◆ BLE_FTMC_SUPPORTED_RESISTANCE_LEVEL_RANGE_UUID

const uint8_t BLE_FTMC_SUPPORTED_RESISTANCE_LEVEL_RANGE_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Supported Resistance Level Range characteristic UUID.

◆ BLE_FTMC_SUPPORTED_POWER_RANGE_UUID

const uint8_t BLE_FTMC_SUPPORTED_POWER_RANGE_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Supported Power Range characteristic UUID.

◆ BLE_FTMC_SUPPORTED_HEART_RATE_RANGE_UUID

const uint8_t BLE_FTMC_SUPPORTED_HEART_RATE_RANGE_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Supported Heart Rate Range characteristic UUID.

◆ BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_UUID

const uint8_t BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Fitness Machine Control Point characteristic UUID.

◆ BLE_FTMC_FITNESS_MACHINE_STATUS_UUID

const uint8_t BLE_FTMC_FITNESS_MACHINE_STATUS_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Fitness Machine Status characteristic UUID.