Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
Weight Scale Service Server

This service exposes weight and related data from a weight scale intended for consumer healthcare and sports/fitness applications. More...

Detailed Description

This service exposes weight and related data from a weight scale intended for consumer healthcare and sports/fitness applications.

Data Structures

struct  st_ble_wss_evt_data_t
 Weight Scale Service event data. More...
 
struct  st_ble_wss_init_param_t
 Weight Scale Service initialization parameters. More...
 
struct  st_ble_wss_connect_param_t
 Weight Scale Service connection parameters. More...
 
struct  st_ble_wss_disconnect_param_t
 Weight Scale Service disconnection parameters. More...
 
struct  st_ble_wss_weight_scale_feature_t
 Weight Scale Feature characteristic parameters. More...
 
struct  st_ble_wss_weight_measurement_t
 Weight Measurement characteristic parameters. More...
 

Typedefs

typedef void(* ble_wss_app_cb_t) (uint16_t type, ble_status_t result, st_ble_wss_evt_data_t *p_data)
 Weight Scale Service event callback. More...
 

Enumerations

enum  e_ble_wss_event_t {
  BLE_WSS_EVENT_WEIGHT_MEASUREMENT_CLI_CNFG_ENABLED,
  BLE_WSS_EVENT_WEIGHT_MEASUREMENT_CLI_CNFG_DISABLED,
  BLE_WSS_EVENT_WEIGHT_MEASUREMENT_HDL_VAL_CNF,
  BLE_WSS_EVENT_WEIGHT_SCALE_FEATURE_READ_REQ
}
 Weight Scale Service event type. More...
 
enum  e_ble_wss_weight_measurement_t { BLE_WSS_WEIGHT_MEASUREMENT_USER_ID_UNKNOWN_USER = 255 }
 User ID enumeration. More...
 
enum  e_ble_wss_weight_scale_feature_mass_measurement_resolution_t {
  BLE_WSS_WEIGHT_SCALE_FEATURE_MASS_MEASUREMENT_RESOLUTION_UNSPECIFIED,
  BLE_WSS_WEIGHT_SCALE_FEATURE_MASS_MEASUREMENT_RESOLUTION_1_LB,
  BLE_WSS_WEIGHT_SCALE_FEATURE_MASS_MEASUREMENT_RESOLUTION_0_5_LB,
  BLE_WSS_WEIGHT_SCALE_FEATURE_FEATURE_MASS_MEASUREMENT_RESOLUTION_0_2_LB,
  BLE_WSS_WEIGHT_SCALE_FEATURE_MASS_MEASUREMENT_RESOLUTION_0_1_LB,
  BLE_WSS_WEIGHT_SCALE_FEATURE_MASS_MEASUREMENT_RESOLUTION_0_05_LB,
  BLE_WSS_WEIGHT_SCALE_FEATURE_MASS_MEASUREMENT_RESOLUTION_0_02_LB,
  BLE_WSS_WEIGHT_SCALE_FEATURE_MASS_MEASUREMENT_RESOLUTION_0_01_LB
}
 Mass Measurement Resolution enumeration. More...
 
enum  e_ble_wss_weight_scale_feature_height_measurement_resolution_t {
  BLE_WSS_WEIGHT_SCALE_FEATURE_HEIGHT_MEASUREMENT_RESOLUTION_UNSPECIFIED,
  BLE_WSS_WEIGHT_SCALE_FEATURE_HEIGHT_MEASUREMENT_RESOLUTION_1_INCH,
  BLE_WSS_WEIGHT_SCALE_FEATURE_HEIGHT_MEASUREMENT_RESOLUTION_0_5_INCH,
  BLE_WSS_WEIGHT_SCALE_FEATURE_HEIGHT_MEASUREMENT_RESOLUTION_0_1_INCH
}
 Height Measurement Resolution enumeration. More...
 

Functions

ble_status_t R_BLE_WSS_Init (const st_ble_wss_init_param_t *p_param)
 Initialize Weight Scale Service. More...
 
ble_status_t R_BLE_WSS_Connect (uint16_t conn_hdl, const st_ble_wss_connect_param_t *p_param)
 Perform Weight Scale Service connection settings. More...
 
ble_status_t R_BLE_WSS_Disconnect (uint16_t conn_hdl, st_ble_wss_disconnect_param_t *p_param)
 Retrieve Weight Scale Service connection specific settings before disconnection. More...
 
ble_status_t R_BLE_WSS_GetWeightScaleFeature (st_ble_wss_weight_scale_feature_t *p_app_value)
 Get Weight Scale Feature characteristic value from local GATT database. More...
 
ble_status_t R_BLE_WSS_SetWeightScaleFeature (const st_ble_wss_weight_scale_feature_t *p_app_value)
 Set Weight Scale Feature characteristic value to local GATT database. More...
 
ble_status_t R_BLE_WSS_IndicateWeightMeasurement (uint16_t conn_hdl, const st_ble_wss_weight_measurement_t *p_app_value)
 Send Weight Measurement indication. More...
 
uint32_t R_BLE_WSS_GetVersion (void)
 Return version of the WSC service server. More...
 

Typedef Documentation

◆ ble_wss_app_cb_t

typedef void(* ble_wss_app_cb_t) (uint16_t type, ble_status_t result, st_ble_wss_evt_data_t *p_data)

Weight Scale Service event callback.

Enumeration Type Documentation

◆ e_ble_wss_event_t

Weight Scale Service event type.

Enumerator
BLE_WSS_EVENT_WEIGHT_MEASUREMENT_CLI_CNFG_ENABLED 

Weight Measurement characteristic cli cnfg enabled event

BLE_WSS_EVENT_WEIGHT_MEASUREMENT_CLI_CNFG_DISABLED 

Weight Measurement characteristic cli cnfg disabled event

BLE_WSS_EVENT_WEIGHT_MEASUREMENT_HDL_VAL_CNF 

Weight Measurement characteristic handle value confiration event

BLE_WSS_EVENT_WEIGHT_SCALE_FEATURE_READ_REQ 

Weight Scale Feature characteristic read request event

◆ e_ble_wss_weight_measurement_t

User ID enumeration.

Enumerator
BLE_WSS_WEIGHT_MEASUREMENT_USER_ID_UNKNOWN_USER 

Unknown user

◆ e_ble_wss_weight_scale_feature_mass_measurement_resolution_t

Mass Measurement Resolution enumeration.

Enumerator
BLE_WSS_WEIGHT_SCALE_FEATURE_MASS_MEASUREMENT_RESOLUTION_UNSPECIFIED 

Not Specified

BLE_WSS_WEIGHT_SCALE_FEATURE_MASS_MEASUREMENT_RESOLUTION_1_LB 

Resolution of 0.5 kg or 1 lb

BLE_WSS_WEIGHT_SCALE_FEATURE_MASS_MEASUREMENT_RESOLUTION_0_5_LB 

Resolution of 0.2 kg or 0.5 lb

BLE_WSS_WEIGHT_SCALE_FEATURE_FEATURE_MASS_MEASUREMENT_RESOLUTION_0_2_LB 

Resolution of 0.1 kg or 0.2 lb

BLE_WSS_WEIGHT_SCALE_FEATURE_MASS_MEASUREMENT_RESOLUTION_0_1_LB 

Resolution of 0.05 kg or 0.1 lb

BLE_WSS_WEIGHT_SCALE_FEATURE_MASS_MEASUREMENT_RESOLUTION_0_05_LB 

Resolution of 0.02 kg or 0.05 lb

BLE_WSS_WEIGHT_SCALE_FEATURE_MASS_MEASUREMENT_RESOLUTION_0_02_LB 

Resolution of 0.01 kg or 0.02 lb

BLE_WSS_WEIGHT_SCALE_FEATURE_MASS_MEASUREMENT_RESOLUTION_0_01_LB 

Resolution of 0.005 kg or 0.01 lb

◆ e_ble_wss_weight_scale_feature_height_measurement_resolution_t

Height Measurement Resolution enumeration.

Enumerator
BLE_WSS_WEIGHT_SCALE_FEATURE_HEIGHT_MEASUREMENT_RESOLUTION_UNSPECIFIED 

Resolution Not Specified

BLE_WSS_WEIGHT_SCALE_FEATURE_HEIGHT_MEASUREMENT_RESOLUTION_1_INCH 

Resolution of 0.01 meter or 1 inch

BLE_WSS_WEIGHT_SCALE_FEATURE_HEIGHT_MEASUREMENT_RESOLUTION_0_5_INCH 

Resolution of 0.005 meter or 0.5 inch

BLE_WSS_WEIGHT_SCALE_FEATURE_HEIGHT_MEASUREMENT_RESOLUTION_0_1_INCH 

Resolution of 0.001 meter or 0.1 inch

Function Documentation

◆ R_BLE_WSS_Init()

ble_status_t R_BLE_WSS_Init ( const st_ble_wss_init_param_t p_param)

Initialize Weight Scale Service.

This function shall be called once at startup.

Parameters
[in]p_paramPointer to Weight Scale Service initialization parameters.
Returns

◆ R_BLE_WSS_Connect()

ble_status_t R_BLE_WSS_Connect ( uint16_t  conn_hdl,
const st_ble_wss_connect_param_t p_param 
)

Perform Weight Scale Service 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_WSS_Disconnect()

ble_status_t R_BLE_WSS_Disconnect ( uint16_t  conn_hdl,
st_ble_wss_disconnect_param_t p_param 
)

Retrieve Weight Scale Service 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_WSS_GetWeightScaleFeature()

ble_status_t R_BLE_WSS_GetWeightScaleFeature ( st_ble_wss_weight_scale_feature_t p_app_value)

Get Weight Scale Feature characteristic value from local GATT database.

Parameters
[out]p_app_valuePointer to retrieved Weight Scale Feature characteristic value.
Returns
ble_status_t

◆ R_BLE_WSS_SetWeightScaleFeature()

ble_status_t R_BLE_WSS_SetWeightScaleFeature ( const st_ble_wss_weight_scale_feature_t p_app_value)

Set Weight Scale Feature characteristic value to local GATT database.

Parameters
[in]p_app_valuePointer to Weight Scale Feature characteristic value to set.
Returns
ble_status_t

◆ R_BLE_WSS_IndicateWeightMeasurement()

ble_status_t R_BLE_WSS_IndicateWeightMeasurement ( uint16_t  conn_hdl,
const st_ble_wss_weight_measurement_t p_app_value 
)

Send Weight Measurement indication.

Parameters
[in]conn_hdlConnection handle.
[in]p_app_valuePointer to Weight Measurement value to send.
Returns
ble_status_t

◆ R_BLE_WSS_GetVersion()

uint32_t R_BLE_WSS_GetVersion ( void  )

Return version of the WSC service server.

Returns
version