![]() |
Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
|
This is the client for the Fitness Machine Service. More...
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... | |
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... | |
#define BLE_FTMC_TRAINING_STATUS_STRING_LEN (18) |
Training Status String Length.
#define BLE_FTMC_FITNESS_MACHINE_FEATURE_LEN (8) |
Fitness Machine Feature characteristic value length.
#define BLE_FTMC_TREADMILL_DATA_LEN (34) |
Treadmill Data characteristic value length.
#define BLE_FTMC_CROSS_TRAINER_DATA_LEN (41) |
Cross Trainer Data characteristic value length.
#define BLE_FTMC_STEP_CLIMBER_DATA_LEN (23) |
Step Climber Data characteristic value length.
#define BLE_FTMC_STAIR_CLIMBER_DATA_LEN (23) |
Stair Climber Data characteristic value length.
#define BLE_FTMC_ROWER_DATA_LEN (30) |
Rower Data characteristic value length.
#define BLE_FTMC_INDOOR_BIKE_DATA_LEN (30) |
Indoor Bike Data characteristic value length.
#define BLE_FTMC_TRAINING_STATUS_LEN (20) |
Training Status characteristic value length.
#define BLE_FTMC_SUPPORTED_SPEED_RANGE_LEN (6) |
Supported Speed Range characteristic value length.
#define BLE_FTMC_SUPPORTED_INCLINATION_RANGE_LEN (6) |
Supported Inclination Range characteristic value length.
#define BLE_FTMC_SUPPORTED_RESISTANCE_LEVEL_RANGE_LEN (6) |
Supported Resistance Level Range characteristic value length.
#define BLE_FTMC_SUPPORTED_POWER_RANGE_LEN (6) |
Supported Power Range characteristic value length.
#define BLE_FTMC_SUPPORTED_HEART_RATE_RANGE_LEN (3) |
Supported Heart Rate Range characteristic value length.
#define BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_LEN (11) |
Fitness Machine Control Point characteristic value length.
#define BLE_FTMC_FITNESS_MACHINE_STATUS_LEN (11) |
Fitness Machine Status characteristic value length.
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.
enum e_ble_ftmc_event_t |
Fitness Machine Service Client event type.
Training Status enumeration.
Op Code enumeration.
Control Information enumeration.
Control Parameter enumeration.
Result Code enumeration.
Op Code enumeration.
Control Information enumeration.
Spin Down Status enumeration.
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.
[in] | p_param | Pointer to Fitness Machine Service Client initialization parameters. |
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.
[in] | conn_hdl | Connection handle. |
[in] | p_param | Pointer to Connection parameters. |
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.
[in] | conn_hdl | Connection handle. |
[in] | p_param | Pointer to Disconnection parameters. |
ble_status_t R_BLE_FTMC_ReadFitnessMachineFeature | ( | uint16_t | conn_hdl | ) |
Read Fitness Machine Feature characteristic value from remote GATT database.
[out] | app_value | Retrieved Fitness Machine Feature characteristic value. |
ble_status_t R_BLE_FTMC_SetTreadmillDataCliCnfg | ( | uint16_t | conn_hdl, |
uint16_t | cli_cnfg | ||
) |
Set Treadmill Data characteristic cli cnfg.
[in] | conn_hdl | Connection handle. |
[in] | cli_cnfg | Treadmill Data characteristic cli cnfg to set. |
ble_status_t R_BLE_FTMC_SetCrossTrainerDataCliCnfg | ( | uint16_t | conn_hdl, |
uint16_t | cli_cnfg | ||
) |
Set Cross Trainer Data characteristic cli cnfg.
[in] | conn_hdl | Connection handle. |
[in] | cli_cnfg | Cross Trainer Data characteristic cli cnfg to set. |
ble_status_t R_BLE_FTMC_SetStepClimberDataCliCnfg | ( | uint16_t | conn_hdl, |
uint16_t | cli_cnfg | ||
) |
Set Step Climber Data characteristic cli cnfg.
[in] | conn_hdl | Connection handle. |
[in] | cli_cnfg | Step Climber Data characteristic cli cnfg to set. |
ble_status_t R_BLE_FTMC_SetStairClimberDataCliCnfg | ( | uint16_t | conn_hdl, |
uint16_t | cli_cnfg | ||
) |
Set Stair Climber Data characteristic cli cnfg.
[in] | conn_hdl | Connection handle. |
[in] | cli_cnfg | Stair Climber Data characteristic cli cnfg to set. |
ble_status_t R_BLE_FTMC_SetRowerDataCliCnfg | ( | uint16_t | conn_hdl, |
uint16_t | cli_cnfg | ||
) |
Set Rower Data characteristic cli cnfg.
[in] | conn_hdl | Connection handle. |
[in] | cli_cnfg | Rower Data characteristic cli cnfg to set. |
ble_status_t R_BLE_FTMC_SetIndoorBikeDataCliCnfg | ( | uint16_t | conn_hdl, |
uint16_t | cli_cnfg | ||
) |
Set Indoor Bike Data characteristic cli cnfg.
[in] | conn_hdl | Connection handle. |
[in] | cli_cnfg | Indoor Bike Data characteristic cli cnfg to set. |
ble_status_t R_BLE_FTMC_ReadTrainingStatus | ( | uint16_t | conn_hdl | ) |
Read Training Status characteristic value from remote GATT database.
[out] | app_value | Retrieved Training Status characteristic value. |
ble_status_t R_BLE_FTMC_SetTrainingStatusCliCnfg | ( | uint16_t | conn_hdl, |
uint16_t | cli_cnfg | ||
) |
Set Training Status characteristic cli cnfg.
[in] | conn_hdl | Connection handle. |
[in] | cli_cnfg | Training Status characteristic cli cnfg to set. |
ble_status_t R_BLE_FTMC_ReadSupportedSpeedRange | ( | uint16_t | conn_hdl | ) |
Read Supported Speed Range characteristic value from remote GATT database.
[out] | app_value | Retrieved Supported Speed Range characteristic value. |
ble_status_t R_BLE_FTMC_ReadSupportedInclinationRange | ( | uint16_t | conn_hdl | ) |
Read Supported Inclination Range characteristic value from remote GATT database.
[out] | app_value | Retrieved Supported Inclination Range characteristic value. |
ble_status_t R_BLE_FTMC_ReadSupportedResistanceLevelRange | ( | uint16_t | conn_hdl | ) |
Read Supported Resistance Level Range characteristic value from remote GATT database.
[out] | app_value | Retrieved Supported Resistance Level Range characteristic value. |
ble_status_t R_BLE_FTMC_ReadSupportedPowerRange | ( | uint16_t | conn_hdl | ) |
Read Supported Power Range characteristic value from remote GATT database.
[out] | app_value | Retrieved Supported Power Range characteristic value. |
ble_status_t R_BLE_FTMC_ReadSupportedHeartRateRange | ( | uint16_t | conn_hdl | ) |
Read Supported Heart Rate Range characteristic value from remote GATT database.
[out] | app_value | Retrieved Supported Heart Rate Range characteristic value. |
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.
[in] | conn_hdl | Connection handle. |
[in] | p_app_value | Pointer to Fitness Machine Control Point characteristic value to write. |
ble_status_t R_BLE_FTMC_SetFitnessMachineControlPointCliCnfg | ( | uint16_t | conn_hdl, |
uint16_t | cli_cnfg | ||
) |
Set Fitness Machine Control Point characteristic cli cnfg.
[in] | conn_hdl | Connection handle. |
[in] | cli_cnfg | Fitness Machine Control Point characteristic cli cnfg to set. |
ble_status_t R_BLE_FTMC_SetFitnessMachineStatusCliCnfg | ( | uint16_t | conn_hdl, |
uint16_t | cli_cnfg | ||
) |
Set Fitness Machine Status characteristic cli cnfg.
[in] | conn_hdl | Connection handle. |
[in] | cli_cnfg | Fitness Machine Status characteristic cli cnfg to set. |
uint32_t R_BLE_FTMC_GetVersion | ( | void | ) |
Return version of the FTMC service client.
const uint8_t BLE_FTMC_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Fitness Machine Service UUID.
const uint8_t BLE_FTMC_FITNESS_MACHINE_FEATURE_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Fitness Machine Feature characteristic UUID.
const uint8_t BLE_FTMC_TREADMILL_DATA_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Treadmill Data characteristic UUID.
const uint8_t BLE_FTMC_CROSS_TRAINER_DATA_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Cross Trainer Data characteristic UUID.
const uint8_t BLE_FTMC_STEP_CLIMBER_DATA_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Step Climber Data characteristic UUID.
const uint8_t BLE_FTMC_STAIR_CLIMBER_DATA_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Stair Climber Data characteristic UUID.
const uint8_t BLE_FTMC_ROWER_DATA_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Rower Data characteristic UUID.
const uint8_t BLE_FTMC_INDOOR_BIKE_DATA_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Indoor Bike Data characteristic UUID.
const uint8_t BLE_FTMC_TRAINING_STATUS_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Training Status characteristic UUID.
const uint8_t BLE_FTMC_SUPPORTED_SPEED_RANGE_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Supported Speed Range characteristic UUID.
const uint8_t BLE_FTMC_SUPPORTED_INCLINATION_RANGE_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Supported Inclination Range characteristic UUID.
const uint8_t BLE_FTMC_SUPPORTED_RESISTANCE_LEVEL_RANGE_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Supported Resistance Level Range characteristic UUID.
const uint8_t BLE_FTMC_SUPPORTED_POWER_RANGE_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Supported Power Range characteristic UUID.
const uint8_t BLE_FTMC_SUPPORTED_HEART_RATE_RANGE_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Supported Heart Rate Range characteristic UUID.
const uint8_t BLE_FTMC_FITNESS_MACHINE_CONTROL_POINT_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Fitness Machine Control Point characteristic UUID.
const uint8_t BLE_FTMC_FITNESS_MACHINE_STATUS_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Fitness Machine Status characteristic UUID.