![]() |
Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
|
This Service specification proposes a pulse oximetry server for use in consumer and professional healthcare applications. More...
This Service specification proposes a pulse oximetry server for use in consumer and professional healthcare applications.
Data Structures | |
struct | st_ble_plxs_measurement_status_t |
PLXS Measurement Status value Field structure. More... | |
struct | st_ble_plxs_device_and_sensor_status_t |
PLXS Device and Sensor Status value Field structure. More... | |
struct | st_ble_plxs_plx_spot_check_measurement_flags_t |
PLX Spot-Check Measurement Flags value structure. More... | |
struct | st_ble_plxs_plx_spot_check_measurement_t |
PLX Spot-Check Measurement value structure. More... | |
struct | st_ble_plxs_plx_continuous_measurement_flags_t |
PLX Continuous Measurement Flags value structure. More... | |
struct | st_ble_plxs_plx_continuous_measurement_t |
PLX Continuous Measurement value structure. More... | |
struct | st_ble_plxs_plx_features_supported_features_t |
PLX Features Supported Features value structure. More... | |
struct | st_ble_plxs_plx_features_t |
PLX Features value structure. More... | |
union | u_ble_plxs_racp_operand_t |
Record Access Control Point characteristic Operand field. More... | |
struct | st_ble_plxs_record_access_control_point_t |
Record Access Control Point value structure. More... | |
Enumerations | |
enum | e_ble_plxs_record_access_control_point_op_code_t { BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OP_CODE_RESERVED_FOR_FUTURE_USE = 0, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OP_CODE_REPORT_STORED_RECORDS = 1, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OP_CODE_DELETE_STORED_RECORDS = 2, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OP_CODE_ABORT_OPERATION = 3, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OP_CODE_REPORT_NUMBER_OF_STORED_RECORDS = 4, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OP_CODE_NUMBER_OF_STORED_RECORDS_RESPONSE = 5, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OP_CODE_RESPONSE_CODE = 6 } |
Record Access Control Point Op Code enumeration. More... | |
enum | e_ble_plxs_record_access_control_point_operator_t { BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OPERATOR_NULL = 0, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OPERATOR_ALL_RECORDS = 1, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OPERATOR_LESS_THAN_OR_EQUAL_TO = 2, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OPERATOR_GREATER_THAN_OR_EQUAL_TO = 3, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OPERATOR_WITHIN_RANGE_OF = 4, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OPERATOR_FIRST_RECORD = 5, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OPERATOR_LAST_RECORD = 6 } |
Record Access Control Point Operator enumeration. More... | |
enum | e_ble_Plxs_record_access_control_point_operand_t { BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OPERAND_N_A = 0, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OPERAND_FILTER_PARAMETERS_1 = 1, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OPERAND_FILTER_PARAMETERS_2 = 2, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OPERAND_NOT_INCLUDED = 3, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OPERAND_FILTER_PARAMETERS_4 = 4, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OPERAND_NUMBER_OF_RECORDS = 5, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OPERAND_REQUEST_OP_CODE_RESPONSE_CODE_VALUE = 6, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_OPERAND_NOT_STATED = 0xFF } |
Record Access Control Point Operand enumeration. More... | |
enum | e_ble_record_access_control_point_response_value_t { BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_RESPONSE_VALUE_RESERVED_FOR_FUTURE_USE = 0, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_RESPONSE_VALUE_SUCCESS = 1, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_RESPONSE_VALUE_OP_CODE_NOT_SUPPORTED = 2, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_RESPONSE_VALUE_INVALID_OPERATOR = 3, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_RESPONSE_VALUE_OPERATOR_NOT_SUPPORTED = 4, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_RESPONSE_VALUE_INVALID_OPERAND = 5, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_RESPONSE_VALUE_NO_RECORDS_FOUND = 6, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_RESPONSE_VALUE_ABORT_UNSUCCESSFUL = 7, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_RESPONSE_VALUE_PROCEDURE_NOT_COMPLETED = 8, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_RESPONSE_VALUE_OPERAND_NOT_SUPPORTED = 9 } |
Record Access Control Point Response Value enumeration. More... | |
enum | e_ble_plxs_char_idx_t { BLE_PLXS_PLX_SPOT_CHECK_MEASUREMENT_IDX, BLE_PLXS_PLX_SPOT_CHECK_MEASUREMENT_CLI_CNFG_IDX, BLE_PLXS_PLX_CONTINUOUS_MEASUREMENT_IDX, BLE_PLXS_PLX_CONTINUOUS_MEASUREMENT_CLI_CNFG_IDX, BLE_PLXS_PLX_FEATURES_IDX, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_IDX, BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_CLI_CNFG_IDX } |
Pulse Oximeter Service characteristic Index. More... | |
enum | e_ble_plxs_event_t { BLE_PLXS_EVENT_PLX_SPOT_CHECK_MEASUREMENT_HDL_VAL_CNF = BLE_SERVS_ATTR_EVENT(BLE_PLXS_PLX_SPOT_CHECK_MEASUREMENT_IDX, BLE_SERVS_HDL_VAL_CNF), BLE_PLXS_EVENT_PLX_SPOT_CHECK_MEASUREMENT_CLI_CNFG_WRITE_REQ = BLE_SERVS_ATTR_EVENT(BLE_PLXS_PLX_SPOT_CHECK_MEASUREMENT_CLI_CNFG_IDX, BLE_SERVS_WRITE_REQ), BLE_PLXS_EVENT_PLX_SPOT_CHECK_MEASUREMENT_CLI_CNFG_WRITE_COMP = BLE_SERVS_ATTR_EVENT(BLE_PLXS_PLX_SPOT_CHECK_MEASUREMENT_CLI_CNFG_IDX, BLE_SERVS_WRITE_COMP), BLE_PLXS_EVENT_PLX_SPOT_CHECK_MEASUREMENT_CLI_CNFG_READ_REQ = BLE_SERVS_ATTR_EVENT(BLE_PLXS_PLX_SPOT_CHECK_MEASUREMENT_CLI_CNFG_IDX, BLE_SERVS_READ_REQ), BLE_PLXS_EVENT_PLX_CONTINUOUS_MEASUREMENT_CLI_CNFG_WRITE_REQ = BLE_SERVS_ATTR_EVENT(BLE_PLXS_PLX_CONTINUOUS_MEASUREMENT_CLI_CNFG_IDX, BLE_SERVS_WRITE_REQ), BLE_PLXS_EVENT_PLX_CONTINUOUS_MEASUREMENT_CLI_CNFG_WRITE_COMP = BLE_SERVS_ATTR_EVENT(BLE_PLXS_PLX_CONTINUOUS_MEASUREMENT_CLI_CNFG_IDX, BLE_SERVS_WRITE_COMP), BLE_PLXS_EVENT_PLX_CONTINUOUS_MEASUREMENT_CLI_CNFG_READ_REQ = BLE_SERVS_ATTR_EVENT(BLE_PLXS_PLX_CONTINUOUS_MEASUREMENT_CLI_CNFG_IDX, BLE_SERVS_READ_REQ), BLE_PLXS_EVENT_PLX_FEATURES_READ_REQ = BLE_SERVS_ATTR_EVENT(BLE_PLXS_PLX_FEATURES_IDX, BLE_SERVS_READ_REQ), BLE_PLXS_EVENT_RECORD_ACCESS_CONTROL_POINT_WRITE_REQ = BLE_SERVS_ATTR_EVENT(BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_IDX, BLE_SERVS_WRITE_REQ), BLE_PLXS_EVENT_RECORD_ACCESS_CONTROL_POINT_WRITE_COMP = BLE_SERVS_ATTR_EVENT(BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_IDX, BLE_SERVS_WRITE_COMP), BLE_PLXS_EVENT_RECORD_ACCESS_CONTROL_POINT_HDL_VAL_CNF = BLE_SERVS_ATTR_EVENT(BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_IDX, BLE_SERVS_HDL_VAL_CNF), BLE_PLXS_EVENT_RECORD_ACCESS_CONTROL_POINT_CLI_CNFG_WRITE_REQ = BLE_SERVS_ATTR_EVENT(BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_CLI_CNFG_IDX, BLE_SERVS_WRITE_REQ), BLE_PLXS_EVENT_RECORD_ACCESS_CONTROL_POINT_CLI_CNFG_WRITE_COMP = BLE_SERVS_ATTR_EVENT(BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_CLI_CNFG_IDX, BLE_SERVS_WRITE_COMP), BLE_PLXS_EVENT_RECORD_ACCESS_CONTROL_POINT_CLI_CNFG_READ_REQ = BLE_SERVS_ATTR_EVENT(BLE_PLXS_RECORD_ACCESS_CONTROL_POINT_CLI_CNFG_IDX, BLE_SERVS_READ_REQ) } |
Pulse Oximeter Service event type. More... | |
Functions | |
ble_status_t | R_BLE_PLXS_IndicatePlxSpotCheckMeasurement (uint16_t conn_hdl, const st_ble_plxs_plx_spot_check_measurement_t *p_value) |
Send indication of PLX Spot-Check Measurement characteristic value to the remote device. More... | |
ble_status_t | R_BLE_PLXS_SetPlxSpotCheckMeasurementCliCnfg (uint16_t conn_hdl, const uint16_t *p_value) |
Set PLX Spot-Check Measurement cli cnfg descriptor value to the local GATT database. More... | |
ble_status_t | R_BLE_PLXS_GetPlxSpotCheckMeasurementCliCnfg (uint16_t conn_hdl, uint16_t *p_value) |
Get PLX Spot-Check Measurement cli cnfg descriptor value from the local GATT database. More... | |
ble_status_t | R_BLE_PLXS_NotifyPlxContinuousMeasurement (uint16_t conn_hdl, const st_ble_plxs_plx_continuous_measurement_t *p_value) |
Send notification of PLX Continuous Measurement characteristic value to the remote device. More... | |
ble_status_t | R_BLE_PLXS_SetPlxContinuousMeasurementCliCnfg (uint16_t conn_hdl, const uint16_t *p_value) |
Set PLX Continuous Measurement cli cnfg descriptor value to the local GATT database. More... | |
ble_status_t | R_BLE_PLXS_GetPlxContinuousMeasurementCliCnfg (uint16_t conn_hdl, uint16_t *p_value) |
Get PLX Continuous Measurement cli cnfg descriptor value from the local GATT database. More... | |
ble_status_t | R_BLE_PLXS_SetPlxFeatures (const st_ble_plxs_plx_features_t *p_value) |
Set PLX Features characteristic value to the local GATT database. More... | |
ble_status_t | R_BLE_PLXS_GetPlxFeatures (st_ble_plxs_plx_features_t *p_value) |
Get PLX Features characteristic value from the local GATT database. More... | |
ble_status_t | R_BLE_PLXS_IndicateRecordAccessControlPoint (uint16_t conn_hdl, const st_ble_plxs_record_access_control_point_t *p_value) |
Send indication of Record Access Control Point characteristic value to the remote device. More... | |
ble_status_t | R_BLE_PLXS_SetRecordAccessControlPointCliCnfg (uint16_t conn_hdl, const uint16_t *p_value) |
Set Record Access Control Point cli cnfg descriptor value to the local GATT database. More... | |
ble_status_t | R_BLE_PLXS_GetRecordAccessControlPointCliCnfg (uint16_t conn_hdl, uint16_t *p_value) |
Get Record Access Control Point cli cnfg descriptor value from the local GATT database. More... | |
ble_status_t | R_BLE_PLXS_Init (ble_servs_app_cb_t cb) |
Initialize Pulse Oximeter Service service. More... | |
Record Access Control Point Op Code enumeration.
Record Access Control Point Operator enumeration.
Record Access Control Point Operand enumeration.
Record Access Control Point Response Value enumeration.
Pulse Oximeter Service characteristic Index.
enum e_ble_plxs_event_t |
Pulse Oximeter Service event type.
ble_status_t R_BLE_PLXS_IndicatePlxSpotCheckMeasurement | ( | uint16_t | conn_hdl, |
const st_ble_plxs_plx_spot_check_measurement_t * | p_value | ||
) |
Send indication of PLX Spot-Check Measurement characteristic value to the remote device.
[in] | conn_hdl | Connection handle. |
[in] | p_value | Characteristic value to send. |
ble_status_t R_BLE_PLXS_SetPlxSpotCheckMeasurementCliCnfg | ( | uint16_t | conn_hdl, |
const uint16_t * | p_value | ||
) |
Set PLX Spot-Check Measurement cli cnfg descriptor value to the local GATT database.
[in] | conn_hdl | Connection handle. |
[in] | p_value | Descriptor value to set. |
ble_status_t R_BLE_PLXS_GetPlxSpotCheckMeasurementCliCnfg | ( | uint16_t | conn_hdl, |
uint16_t * | p_value | ||
) |
Get PLX Spot-Check Measurement cli cnfg descriptor value from the local GATT database.
[in] | conn_hdl | Connection handle. |
[out] | p_value | Output location for the acquired descriptor value. |
ble_status_t R_BLE_PLXS_NotifyPlxContinuousMeasurement | ( | uint16_t | conn_hdl, |
const st_ble_plxs_plx_continuous_measurement_t * | p_value | ||
) |
Send notification of PLX Continuous Measurement characteristic value to the remote device.
[in] | conn_hdl | Connection handle. |
[in] | p_value | Characteristic value to send. |
ble_status_t R_BLE_PLXS_SetPlxContinuousMeasurementCliCnfg | ( | uint16_t | conn_hdl, |
const uint16_t * | p_value | ||
) |
Set PLX Continuous Measurement cli cnfg descriptor value to the local GATT database.
[in] | conn_hdl | Connection handle. |
[in] | p_value | Descriptor value to set. |
ble_status_t R_BLE_PLXS_GetPlxContinuousMeasurementCliCnfg | ( | uint16_t | conn_hdl, |
uint16_t * | p_value | ||
) |
Get PLX Continuous Measurement cli cnfg descriptor value from the local GATT database.
[in] | conn_hdl | Connection handle. |
[out] | p_value | Output location for the acquired descriptor value. |
ble_status_t R_BLE_PLXS_SetPlxFeatures | ( | const st_ble_plxs_plx_features_t * | p_value | ) |
Set PLX Features characteristic value to the local GATT database.
[in] | p_value | Characteristic value to set. |
ble_status_t R_BLE_PLXS_GetPlxFeatures | ( | st_ble_plxs_plx_features_t * | p_value | ) |
Get PLX Features characteristic value from the local GATT database.
[out] | p_value | Output location for the acquired descriptor value. |
ble_status_t R_BLE_PLXS_IndicateRecordAccessControlPoint | ( | uint16_t | conn_hdl, |
const st_ble_plxs_record_access_control_point_t * | p_value | ||
) |
Send indication of Record Access Control Point characteristic value to the remote device.
[in] | conn_hdl | Connection handle. |
[in] | p_value | Characteristic value to send. |
ble_status_t R_BLE_PLXS_SetRecordAccessControlPointCliCnfg | ( | uint16_t | conn_hdl, |
const uint16_t * | p_value | ||
) |
Set Record Access Control Point cli cnfg descriptor value to the local GATT database.
[in] | conn_hdl | Connection handle. |
[in] | p_value | Descriptor value to set. |
ble_status_t R_BLE_PLXS_GetRecordAccessControlPointCliCnfg | ( | uint16_t | conn_hdl, |
uint16_t * | p_value | ||
) |
Get Record Access Control Point cli cnfg descriptor value from the local GATT database.
[in] | conn_hdl | Connection handle. |
[out] | p_value | Output location for the acquired descriptor value. |
ble_status_t R_BLE_PLXS_Init | ( | ble_servs_app_cb_t | cb | ) |