![]() |
Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
|
This service exposes the phone alert status when in a connection. More...
This service exposes the phone alert status when in a connection.
Data Structures | |
struct | st_ble_pass_alert_status_t |
Alert Status value structure. More... | |
Enumerations | |
enum | e_ble_pass_ringer_setting_ringer_setting_t { BLE_PASS_RINGER_SETTING_RINGER_SETTING_RINGER_SILENT = 0, BLE_PASS_RINGER_SETTING_RINGER_SETTING_RINGER_NORMAL = 1 } |
Ringer Setting Ringer Setting enumeration. More... | |
enum | e_ble_pass_ringer_control_point_ringer_control_point_t { BLE_PASS_RINGER_CONTROL_POINT_RINGER_CONTROL_POINT_SILENT_MODE = 1, BLE_PASS_RINGER_CONTROL_POINT_RINGER_CONTROL_POINT_MUTE_ONCE = 2, BLE_PASS_RINGER_CONTROL_POINT_RINGER_CONTROL_POINT_CANCEL_SILENT_MODE = 3 } |
Ringer Control point Ringer Control Point enumeration. More... | |
enum | e_ble_pass_char_idx_t { BLE_PASS_ALERT_STATUS_IDX, BLE_PASS_ALERT_STATUS_CLI_CNFG_IDX, BLE_PASS_RINGER_SETTING_IDX, BLE_PASS_RINGER_SETTING_CLI_CNFG_IDX, BLE_PASS_RINGER_CONTROL_POINT_IDX } |
Phone Alert Status Service characteristic Index. More... | |
enum | e_ble_pass_event_t { BLE_PASS_EVENT_ALERT_STATUS_READ_REQ = BLE_SERVS_ATTR_EVENT(BLE_PASS_ALERT_STATUS_IDX, BLE_SERVS_READ_REQ), BLE_PASS_EVENT_ALERT_STATUS_CLI_CNFG_WRITE_REQ = BLE_SERVS_ATTR_EVENT(BLE_PASS_ALERT_STATUS_CLI_CNFG_IDX, BLE_SERVS_WRITE_REQ), BLE_PASS_EVENT_ALERT_STATUS_CLI_CNFG_WRITE_COMP = BLE_SERVS_ATTR_EVENT(BLE_PASS_ALERT_STATUS_CLI_CNFG_IDX, BLE_SERVS_WRITE_COMP), BLE_PASS_EVENT_ALERT_STATUS_CLI_CNFG_READ_REQ = BLE_SERVS_ATTR_EVENT(BLE_PASS_ALERT_STATUS_CLI_CNFG_IDX, BLE_SERVS_READ_REQ), BLE_PASS_EVENT_RINGER_SETTING_READ_REQ = BLE_SERVS_ATTR_EVENT(BLE_PASS_RINGER_SETTING_IDX, BLE_SERVS_READ_REQ), BLE_PASS_EVENT_RINGER_SETTING_CLI_CNFG_WRITE_REQ = BLE_SERVS_ATTR_EVENT(BLE_PASS_RINGER_SETTING_CLI_CNFG_IDX, BLE_SERVS_WRITE_REQ), BLE_PASS_EVENT_RINGER_SETTING_CLI_CNFG_WRITE_COMP = BLE_SERVS_ATTR_EVENT(BLE_PASS_RINGER_SETTING_CLI_CNFG_IDX, BLE_SERVS_WRITE_COMP), BLE_PASS_EVENT_RINGER_SETTING_CLI_CNFG_READ_REQ = BLE_SERVS_ATTR_EVENT(BLE_PASS_RINGER_SETTING_CLI_CNFG_IDX, BLE_SERVS_READ_REQ), BLE_PASS_EVENT_RINGER_CONTROL_POINT_WRITE_CMD = BLE_SERVS_ATTR_EVENT(BLE_PASS_RINGER_CONTROL_POINT_IDX, BLE_SERVS_WRITE_CMD) } |
Phone Alert Status Service event type. More... | |
Functions | |
ble_status_t | R_BLE_PASS_SetAlertStatus (const st_ble_pass_alert_status_t *p_value) |
Set Alert Status characteristic value to the local GATT database. More... | |
ble_status_t | R_BLE_PASS_GetAlertStatus (st_ble_pass_alert_status_t *p_value) |
Get Alert Status characteristic value from the local GATT database. More... | |
ble_status_t | R_BLE_PASS_NotifyAlertStatus (uint16_t conn_hdl, const st_ble_pass_alert_status_t *p_value) |
Send notification of Alert Status characteristic value to the remote device. More... | |
ble_status_t | R_BLE_PASS_SetAlertStatusCliCnfg (uint16_t conn_hdl, const uint16_t *p_value) |
Set Alert Status cli cnfg descriptor value to the local GATT database. More... | |
ble_status_t | R_BLE_PASS_GetAlertStatusCliCnfg (uint16_t conn_hdl, uint16_t *p_value) |
Get Alert Status cli cnfg descriptor value from the local GATT database. More... | |
ble_status_t | R_BLE_PASS_SetRingerSetting (const uint8_t *p_value) |
Set Ringer Setting characteristic value to the local GATT database. More... | |
ble_status_t | R_BLE_PASS_GetRingerSetting (uint8_t *p_value) |
Get Ringer Setting characteristic value from the local GATT database. More... | |
ble_status_t | R_BLE_PASS_NotifyRingerSetting (uint16_t conn_hdl, const uint8_t *p_value) |
Send notification of Ringer Setting characteristic value to the remote device. More... | |
ble_status_t | R_BLE_PASS_SetRingerSettingCliCnfg (uint16_t conn_hdl, const uint16_t *p_value) |
Set Ringer Setting cli cnfg descriptor value to the local GATT database. More... | |
ble_status_t | R_BLE_PASS_GetRingerSettingCliCnfg (uint16_t conn_hdl, uint16_t *p_value) |
Get Ringer Setting cli cnfg descriptor value from the local GATT database. More... | |
ble_status_t | R_BLE_PASS_Init (ble_servs_app_cb_t cb) |
Initialize Phone Alert Status Service service. More... | |
Phone Alert Status Service characteristic Index.
enum e_ble_pass_event_t |
Phone Alert Status Service event type.
ble_status_t R_BLE_PASS_SetAlertStatus | ( | const st_ble_pass_alert_status_t * | p_value | ) |
Set Alert Status characteristic value to the local GATT database.
[in] | p_value | Characteristic value to set. |
ble_status_t R_BLE_PASS_GetAlertStatus | ( | st_ble_pass_alert_status_t * | p_value | ) |
Get Alert Status characteristic value from the local GATT database.
[in] | p_value | Output location for the acquired descriptor value. |
ble_status_t R_BLE_PASS_NotifyAlertStatus | ( | uint16_t | conn_hdl, |
const st_ble_pass_alert_status_t * | p_value | ||
) |
Send notification of Alert Status characteristic value to the remote device.
[in] | conn_hdl | Connection handle. |
[in] | p_value | Characteristic value to send. |
ble_status_t R_BLE_PASS_SetAlertStatusCliCnfg | ( | uint16_t | conn_hdl, |
const uint16_t * | p_value | ||
) |
Set Alert Status 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_PASS_GetAlertStatusCliCnfg | ( | uint16_t | conn_hdl, |
uint16_t * | p_value | ||
) |
Get Alert Status cli cnfg descriptor value from the local GATT database.
[in] | conn_hdl | Connection handle. |
[in] | p_value | Output location for the acquired descriptor value. |
ble_status_t R_BLE_PASS_SetRingerSetting | ( | const uint8_t * | p_value | ) |
Set Ringer Setting characteristic value to the local GATT database.
[in] | p_value | Characteristic value to set. |
ble_status_t R_BLE_PASS_GetRingerSetting | ( | uint8_t * | p_value | ) |
Get Ringer Setting characteristic value from the local GATT database.
[in] | p_value | Output location for the acquired descriptor value. |
ble_status_t R_BLE_PASS_NotifyRingerSetting | ( | uint16_t | conn_hdl, |
const uint8_t * | p_value | ||
) |
Send notification of Ringer Setting characteristic value to the remote device.
[in] | conn_hdl | Connection handle. |
[in] | p_value | Characteristic value to send. |
ble_status_t R_BLE_PASS_SetRingerSettingCliCnfg | ( | uint16_t | conn_hdl, |
const uint16_t * | p_value | ||
) |
Set Ringer Setting 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_PASS_GetRingerSettingCliCnfg | ( | uint16_t | conn_hdl, |
uint16_t * | p_value | ||
) |
Get Ringer Setting cli cnfg descriptor value from the local GATT database.
[in] | conn_hdl | Connection handle. |
[in] | p_value | Output location for the acquired descriptor value. |
ble_status_t R_BLE_PASS_Init | ( | ble_servs_app_cb_t | cb | ) |
Initialize Phone Alert Status Service service.
[in] | cb | Service callback. |