![]() |
Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
|
This is the client for the Pulse Oximeter Service Service. More...
This is the client for the Pulse Oximeter Service Service.
Data Structures | |
struct | st_ble_plx_spot_check_measurement_flags_t |
PLX Spot-Check Measurement Flags value structure. More... | |
struct | st_ble_plx_spot_check_measurement_measurement_status_t |
PLX Spot-Check Measurement Measurement Status value structure. More... | |
struct | st_ble_plx_spot_check_measurement_device_and_sensor_status_t |
PLX Spot-Check Measurement Device and Sensor Status value structure. More... | |
struct | st_ble_plxc_plx_spot_check_measurement_t |
PLX Spot-Check Measurement value structure. More... | |
struct | st_ble_plxc_plx_spot_check_measurement_attr_hdl_t |
PLX Spot-Check Measurement attribute handle value. More... | |
struct | st_ble_plx_continuous_measurement_flags_t |
PLX Continuous Measurement Flags value structure. More... | |
struct | st_ble_plx_continuous_measurement_measurement_status_t |
PLX Continuous Measurement Measurement Status value structure. More... | |
struct | st_ble_plx_continuous_measurement_device_and_sensor_status_t |
PLX Continuous Measurement Device and Sensor Status value structure. More... | |
struct | st_ble_plxc_plx_continuous_measurement_t |
PLX Continuous Measurement value structure. More... | |
struct | st_ble_plxc_plx_continuous_measurement_attr_hdl_t |
PLX Continuous Measurement attribute handle value. More... | |
struct | st_ble_plx_features_supported_features_t |
PLX Features Supported Features value structure. More... | |
struct | st_ble_plx_features_measurement_status_support_t |
PLX Features Measurement Status Support value structure. More... | |
struct | st_ble_plx_features_device_and_sensor_status_support_t |
PLX Features Device and Sensor Status Support value structure. More... | |
struct | st_ble_plxc_plx_features_t |
PLX Features value structure. More... | |
struct | st_ble_plxc_plx_features_attr_hdl_t |
PLX Features attribute handle value. More... | |
struct | st_ble_plxc_record_access_control_point_t |
Record Access Control Point value structure. More... | |
struct | st_ble_plxc_record_access_control_point_attr_hdl_t |
Record Access Control Point attribute handle value. More... | |
struct | st_ble_plxc_evt_data_t |
Pulse Oximeter Service client event data. More... | |
Enumerations | |
enum | e_ble_record_access_control_point_op_code_t { BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OP_CODE_RESERVED_FOR_FUTURE_USE = 0, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OP_CODE_REPORT_STORED_RECORDS = 1, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OP_CODE_DELETE_STORED_RECORDS = 2, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OP_CODE_ABORT_OPERATION = 3, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OP_CODE_REPORT_NUMBER_OF_STORED_RECORDS = 4, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OP_CODE_NUMBER_OF_STORED_RECORDS_RESPONSE = 5, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OP_CODE_RESPONSE_CODE = 6 } |
Record Access Control Point Op Code enumeration. More... | |
enum | e_ble_record_access_control_point_operator_t { BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OPERATOR_NULL = 0, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OPERATOR_ALL_RECORDS = 1, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OPERATOR_LESS_THAN_OR_EQUAL_TO = 2, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OPERATOR_GREATER_THAN_OR_EQUAL_TO = 3, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OPERATOR_WITHIN_RANGE_OF = 4, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OPERATOR_FIRST_RECORD = 5, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OPERATOR_LAST_RECORD = 6 } |
Record Access Control Point Operator enumeration. More... | |
enum | e_ble_record_access_control_point_operand_t { BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OPERAND_N_A = 0, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OPERAND_FILTER_PARAMETERS_1 = 1, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OPERAND_FILTER_PARAMETERS_2 = 2, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OPERAND_NOT_INCLUDED = 3, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OPERAND_FILTER_PARAMETERS_4 = 4, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OPERAND_NUMBER_OF_RECORDS = 5, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_OPERAND_REQUEST_OP_CODE_RESPONSE_CODE_VALUE = 6 } |
Record Access Control Point Operand enumeration. More... | |
enum | e_ble_plxc_char_idx_t { BLE_PLXC_PLX_SPOT_CHECK_MEASUREMENT_IDX, BLE_PLXC_PLX_SPOT_CHECK_MEASUREMENT_CLI_CNFG_IDX, BLE_PLXC_PLX_CONTINUOUS_MEASUREMENT_IDX, BLE_PLXC_PLX_CONTINUOUS_MEASUREMENT_CLI_CNFG_IDX, BLE_PLXC_PLX_FEATURES_IDX, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_IDX, BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_CLI_CNFG_IDX } |
Pulse Oximeter Service characteristic ID. More... | |
enum | e_ble_plxc_event_t { BLE_PLXC_EVENT_PLX_SPOT_CHECK_MEASUREMENT_HDL_VAL_IND = BLE_SERVC_ATTR_EVENT(BLE_PLXC_PLX_SPOT_CHECK_MEASUREMENT_IDX, BLE_SERVC_HDL_VAL_IND), BLE_PLXC_EVENT_PLX_SPOT_CHECK_MEASUREMENT_CLI_CNFG_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_PLXC_PLX_SPOT_CHECK_MEASUREMENT_CLI_CNFG_IDX, BLE_SERVC_READ_RSP), BLE_PLXC_EVENT_PLX_SPOT_CHECK_MEASUREMENT_CLI_CNFG_WRITE_RSP = BLE_SERVC_ATTR_EVENT(BLE_PLXC_PLX_SPOT_CHECK_MEASUREMENT_CLI_CNFG_IDX, BLE_SERVC_WRITE_RSP), BLE_PLXC_EVENT_PLX_CONTINUOUS_MEASUREMENT_HDL_VAL_NTF = BLE_SERVC_ATTR_EVENT(BLE_PLXC_PLX_CONTINUOUS_MEASUREMENT_IDX, BLE_SERVC_HDL_VAL_NTF), BLE_PLXC_EVENT_PLX_CONTINUOUS_MEASUREMENT_CLI_CNFG_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_PLXC_PLX_CONTINUOUS_MEASUREMENT_CLI_CNFG_IDX, BLE_SERVC_READ_RSP), BLE_PLXC_EVENT_PLX_CONTINUOUS_MEASUREMENT_CLI_CNFG_WRITE_RSP = BLE_SERVC_ATTR_EVENT(BLE_PLXC_PLX_CONTINUOUS_MEASUREMENT_CLI_CNFG_IDX, BLE_SERVC_WRITE_RSP), BLE_PLXC_EVENT_PLX_FEATURES_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_PLXC_PLX_FEATURES_IDX, BLE_SERVC_READ_RSP), BLE_PLXC_EVENT_RECORD_ACCESS_CONTROL_POINT_WRITE_RSP = BLE_SERVC_ATTR_EVENT(BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_IDX, BLE_SERVC_WRITE_RSP), BLE_PLXC_EVENT_RECORD_ACCESS_CONTROL_POINT_HDL_VAL_IND = BLE_SERVC_ATTR_EVENT(BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_IDX, BLE_SERVC_HDL_VAL_IND), BLE_PLXC_EVENT_RECORD_ACCESS_CONTROL_POINT_CLI_CNFG_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_CLI_CNFG_IDX, BLE_SERVC_READ_RSP), BLE_PLXC_EVENT_RECORD_ACCESS_CONTROL_POINT_CLI_CNFG_WRITE_RSP = BLE_SERVC_ATTR_EVENT(BLE_PLXC_RECORD_ACCESS_CONTROL_POINT_CLI_CNFG_IDX, BLE_SERVC_WRITE_RSP) } |
Pulse Oximeter Service client event type. More... | |
Functions | |
ble_status_t | R_BLE_PLXC_ReadPlxSpotCheckMeasurementCliCnfg (uint16_t conn_hdl) |
Read PLX Spot-Check Measurement characteristic Client Characteristic Configuration descriptor value from the remote GATT database. More... | |
ble_status_t | R_BLE_PLXC_WritePlxSpotCheckMeasurementCliCnfg (uint16_t conn_hdl, const uint16_t *p_value) |
Write PLX Spot-Check Measurement characteristic Client Characteristic Configuration descriptor value to remote GATT database. More... | |
void | R_BLE_PLXC_GetPlxSpotCheckMeasurementAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_plxc_plx_spot_check_measurement_attr_hdl_t *p_hdl) |
Get PLX Spot-Check Measurement attribute handles. More... | |
ble_status_t | R_BLE_PLXC_ReadPlxContinuousMeasurementCliCnfg (uint16_t conn_hdl) |
Read PLX Continuous Measurement characteristic Client Characteristic Configuration descriptor value from the remote GATT database. More... | |
ble_status_t | R_BLE_PLXC_WritePlxContinuousMeasurementCliCnfg (uint16_t conn_hdl, const uint16_t *p_value) |
Write PLX Continuous Measurement characteristic Client Characteristic Configuration descriptor value to remote GATT database. More... | |
void | R_BLE_PLXC_GetPlxContinuousMeasurementAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_plxc_plx_continuous_measurement_attr_hdl_t *p_hdl) |
Get PLX Continuous Measurement attribute handles. More... | |
ble_status_t | R_BLE_PLXC_ReadPlxFeatures (uint16_t conn_hdl) |
Read PLX Features characteristic value from the remote GATT database. More... | |
void | R_BLE_PLXC_GetPlxFeaturesAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_plxc_plx_features_attr_hdl_t *p_hdl) |
Get PLX Features attribute handles. More... | |
ble_status_t | R_BLE_PLXC_ReadRecordAccessControlPointCliCnfg (uint16_t conn_hdl) |
Read Record Access Control Point characteristic Client Characteristic Configuration descriptor value from the remote GATT database. More... | |
ble_status_t | R_BLE_PLXC_WriteRecordAccessControlPointCliCnfg (uint16_t conn_hdl, const uint16_t *p_value) |
Write Record Access Control Point characteristic Client Characteristic Configuration descriptor value to remote GATT database. More... | |
ble_status_t | R_BLE_PLXC_WriteRecordAccessControlPoint (uint16_t conn_hdl, const st_ble_plxc_record_access_control_point_t *p_value) |
Write Record Access Control Point characteristic value to remote GATT database. More... | |
void | R_BLE_PLXC_GetRecordAccessControlPointAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_plxc_record_access_control_point_attr_hdl_t *p_hdl) |
Get Record Access Control Point attribute handles. More... | |
ble_status_t | R_BLE_PLXC_Init (ble_servc_app_cb_t cb) |
Initialize Pulse Oximeter Service client. More... | |
void | R_BLE_PLXC_ServDiscCb (uint16_t conn_hdl, uint8_t serv_idx, uint16_t type, void *p_param) |
Pulse Oximeter Service client discovery callback. More... | |
void | R_BLE_PLXC_GetServAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_gatt_hdl_range_t *p_hdl) |
Get Pulse Oximeter Service client attribute handle. More... | |
Record Access Control Point Op Code enumeration.
Record Access Control Point Operator enumeration.
Record Access Control Point Operand enumeration.
Pulse Oximeter Service characteristic ID.
enum e_ble_plxc_event_t |
Pulse Oximeter Service client event type.
ble_status_t R_BLE_PLXC_ReadPlxSpotCheckMeasurementCliCnfg | ( | uint16_t | conn_hdl | ) |
Read PLX Spot-Check Measurement characteristic Client Characteristic Configuration descriptor value from the remote GATT database.
[in] | conn_hdl | Connection handle. |
ble_status_t R_BLE_PLXC_WritePlxSpotCheckMeasurementCliCnfg | ( | uint16_t | conn_hdl, |
const uint16_t * | p_value | ||
) |
Write PLX Spot-Check Measurement characteristic Client Characteristic Configuration descriptor value to remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | p_value | PLX Spot-Check Measurement characteristic Client Characteristic Configuration descriptor value to write. |
void R_BLE_PLXC_GetPlxSpotCheckMeasurementAttrHdl | ( | const st_ble_dev_addr_t * | p_addr, |
st_ble_plxc_plx_spot_check_measurement_attr_hdl_t * | p_hdl | ||
) |
Get PLX Spot-Check Measurement attribute handles.
[in] | p_addr | Bluetooth device address for the attribute handles. |
[out] | p_hdl | The pointer to store the retrieved attribute handles. |
ble_status_t R_BLE_PLXC_ReadPlxContinuousMeasurementCliCnfg | ( | uint16_t | conn_hdl | ) |
Read PLX Continuous Measurement characteristic Client Characteristic Configuration descriptor value from the remote GATT database.
[in] | conn_hdl | Connection handle. |
ble_status_t R_BLE_PLXC_WritePlxContinuousMeasurementCliCnfg | ( | uint16_t | conn_hdl, |
const uint16_t * | p_value | ||
) |
Write PLX Continuous Measurement characteristic Client Characteristic Configuration descriptor value to remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | p_value | PLX Continuous Measurement characteristic Client Characteristic Configuration descriptor value to write. |
void R_BLE_PLXC_GetPlxContinuousMeasurementAttrHdl | ( | const st_ble_dev_addr_t * | p_addr, |
st_ble_plxc_plx_continuous_measurement_attr_hdl_t * | p_hdl | ||
) |
Get PLX Continuous Measurement attribute handles.
[in] | p_addr | Bluetooth device address for the attribute handles. |
[out] | p_hdl | The pointer to store the retrieved attribute handles. |
ble_status_t R_BLE_PLXC_ReadPlxFeatures | ( | uint16_t | conn_hdl | ) |
Read PLX Features characteristic value from the remote GATT database.
[in] | conn_hdl | Connection handle. |
void R_BLE_PLXC_GetPlxFeaturesAttrHdl | ( | const st_ble_dev_addr_t * | p_addr, |
st_ble_plxc_plx_features_attr_hdl_t * | p_hdl | ||
) |
Get PLX Features attribute handles.
[in] | p_addr | Bluetooth device address for the attribute handles. |
[out] | p_hdl | The pointer to store the retrieved attribute handles. |
ble_status_t R_BLE_PLXC_ReadRecordAccessControlPointCliCnfg | ( | uint16_t | conn_hdl | ) |
Read Record Access Control Point characteristic Client Characteristic Configuration descriptor value from the remote GATT database.
[in] | conn_hdl | Connection handle. |
ble_status_t R_BLE_PLXC_WriteRecordAccessControlPointCliCnfg | ( | uint16_t | conn_hdl, |
const uint16_t * | p_value | ||
) |
Write Record Access Control Point characteristic Client Characteristic Configuration descriptor value to remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | p_value | Record Access Control Point characteristic Client Characteristic Configuration descriptor value to write. |
ble_status_t R_BLE_PLXC_WriteRecordAccessControlPoint | ( | uint16_t | conn_hdl, |
const st_ble_plxc_record_access_control_point_t * | p_value | ||
) |
Write Record Access Control Point characteristic value to remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | p_value | Record Access Control Point characteristic value to write. |
void R_BLE_PLXC_GetRecordAccessControlPointAttrHdl | ( | const st_ble_dev_addr_t * | p_addr, |
st_ble_plxc_record_access_control_point_attr_hdl_t * | p_hdl | ||
) |
Get Record Access Control Point attribute handles.
[in] | p_addr | Bluetooth device address for the attribute handles. |
[out] | p_hdl | The pointer to store the retrieved attribute handles. |
ble_status_t R_BLE_PLXC_Init | ( | ble_servc_app_cb_t | cb | ) |
void R_BLE_PLXC_ServDiscCb | ( | uint16_t | conn_hdl, |
uint8_t | serv_idx, | ||
uint16_t | type, | ||
void * | p_param | ||
) |
Pulse Oximeter Service client discovery callback.
[in] | conn_hdl | Connection handle |
[in] | serv_idx | Service instance index. |
[in] | type | Service discovery event type. |
[out] | p_param | Service discovery event parameter. |
void R_BLE_PLXC_GetServAttrHdl | ( | const st_ble_dev_addr_t * | p_addr, |
st_ble_gatt_hdl_range_t * | p_hdl | ||
) |
Get Pulse Oximeter Service client attribute handle.
[in] | p_addr | Bluetooth device address for the attribute handles. |
[out] | p_hdl | The pointer to store the retrieved attribute handles. |