![]() |
Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
|
This is the client for the Phone Alert Status Service Service. More...
This is the client for the Phone Alert Status Service Service.
Data Structures | |
struct | st_ble_pasc_alert_status_t |
Alert Status value structure. More... | |
struct | st_ble_pasc_alert_status_attr_hdl_t |
Alert Status attribute handle value. More... | |
struct | st_ble_pasc_ringer_setting_attr_hdl_t |
Ringer Setting attribute handle value. More... | |
struct | st_ble_pasc_ringer_control_point_attr_hdl_t |
Ringer Control point attribute handle value. More... | |
struct | st_ble_pasc_evt_data_t |
Phone Alert Status Service client event data. More... | |
Macros | |
#define | BLE_PASC_ALERT_STATUS_UUID (0x2A3F) |
#define | BLE_PASC_ALERT_STATUS_LEN (1) |
#define | BLE_PASC_ALERT_STATUS_CLI_CNFG_UUID (0x2902) |
#define | BLE_PASC_ALERT_STATUS_CLI_CNFG_LEN (2) |
#define | BLE_PRV_PASC_ALERT_STATUS_ALERT_STATUS_RINGER_STATE (1 << 0) |
Ringer State bit. More... | |
#define | BLE_PRV_PASC_ALERT_STATUS_ALERT_STATUS_VIBRATE_STATE (1 << 1) |
Vibrate State bit. More... | |
#define | BLE_PRV_PASC_ALERT_STATUS_ALERT_STATUS_DISPLAY_ALERT_STATUS (1 << 2) |
Display Alert Status bit. More... | |
#define | BLE_PASC_RINGER_SETTING_UUID (0x2A41) |
#define | BLE_PASC_RINGER_SETTING_LEN (1) |
#define | BLE_PASC_RINGER_SETTING_CLI_CNFG_UUID (0x2902) |
#define | BLE_PASC_RINGER_SETTING_CLI_CNFG_LEN (2) |
#define | BLE_PASC_RINGER_CONTROL_POINT_UUID (0x2A40) |
#define | BLE_PASC_RINGER_CONTROL_POINT_LEN (1) |
Enumerations | |
enum | e_ble_pasc_ringer_setting_ringer_setting_t { BLE_PASC_RINGER_SETTING_RINGER_SETTING_RINGER_SILENT = 0, BLE_PASC_RINGER_SETTING_RINGER_SETTING_RINGER_NORMAL = 1 } |
Ringer Setting Ringer Setting enumeration. More... | |
enum | e_ble_pasc_ringer_control_point_ringer_control_point_t { BLE_PASC_RINGER_CONTROL_POINT_RINGER_CONTROL_POINT_SILENT_MODE = 1, BLE_PASC_RINGER_CONTROL_POINT_RINGER_CONTROL_POINT_MUTE_ONCE = 2, BLE_PASC_RINGER_CONTROL_POINT_RINGER_CONTROL_POINT_CANCEL_SILENT_MODE = 3 } |
Ringer Control point Ringer Control Point enumeration. More... | |
enum | e_ble_pasc_char_idx_t { BLE_PASC_ALERT_STATUS_IDX, BLE_PASC_ALERT_STATUS_CLI_CNFG_IDX, BLE_PASC_RINGER_SETTING_IDX, BLE_PASC_RINGER_SETTING_CLI_CNFG_IDX, BLE_PASC_RINGER_CONTROL_POINT_IDX } |
Phone Alert Status Service characteristic ID. More... | |
enum | e_ble_pasc_event_t { BLE_PASC_EVENT_ALERT_STATUS_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_PASC_ALERT_STATUS_IDX, BLE_SERVC_READ_RSP), BLE_PASC_EVENT_ALERT_STATUS_HDL_VAL_NTF = BLE_SERVC_ATTR_EVENT(BLE_PASC_ALERT_STATUS_IDX, BLE_SERVC_HDL_VAL_NTF), BLE_PASC_EVENT_ALERT_STATUS_CLI_CNFG_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_PASC_ALERT_STATUS_CLI_CNFG_IDX, BLE_SERVC_READ_RSP), BLE_PASC_EVENT_ALERT_STATUS_CLI_CNFG_WRITE_RSP = BLE_SERVC_ATTR_EVENT(BLE_PASC_ALERT_STATUS_CLI_CNFG_IDX, BLE_SERVC_WRITE_RSP), BLE_PASC_EVENT_RINGER_SETTING_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_PASC_RINGER_SETTING_IDX, BLE_SERVC_READ_RSP), BLE_PASC_EVENT_RINGER_SETTING_HDL_VAL_NTF = BLE_SERVC_ATTR_EVENT(BLE_PASC_RINGER_SETTING_IDX, BLE_SERVC_HDL_VAL_NTF), BLE_PASC_EVENT_RINGER_SETTING_CLI_CNFG_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_PASC_RINGER_SETTING_CLI_CNFG_IDX, BLE_SERVC_READ_RSP), BLE_PASC_EVENT_RINGER_SETTING_CLI_CNFG_WRITE_RSP = BLE_SERVC_ATTR_EVENT(BLE_PASC_RINGER_SETTING_CLI_CNFG_IDX, BLE_SERVC_WRITE_RSP) } |
Phone Alert Status Service client event type. More... | |
Functions | |
ble_status_t | R_BLE_PASC_ReadAlertStatusCliCnfg (uint16_t conn_hdl) |
Read Alert Status characteristic Client Characteristic Configuration descriptor value from the remote GATT database. More... | |
ble_status_t | R_BLE_PASC_WriteAlertStatusCliCnfg (uint16_t conn_hdl, const uint16_t *p_value) |
Write Alert Status characteristic Client Characteristic Configuration descriptor value to remote GATT database. More... | |
ble_status_t | R_BLE_PASC_ReadAlertStatus (uint16_t conn_hdl) |
Read Alert Status characteristic value from the remote GATT database. More... | |
void | R_BLE_PASC_GetAlertStatusAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_pasc_alert_status_attr_hdl_t *p_hdl) |
Get Alert Status attribute handles. More... | |
ble_status_t | R_BLE_PASC_ReadRingerSettingCliCnfg (uint16_t conn_hdl) |
Read Ringer Setting characteristic Client Characteristic Configuration descriptor value from the remote GATT database. More... | |
ble_status_t | R_BLE_PASC_WriteRingerSettingCliCnfg (uint16_t conn_hdl, const uint16_t *p_value) |
Write Ringer Setting characteristic Client Characteristic Configuration descriptor value to remote GATT database. More... | |
ble_status_t | R_BLE_PASC_ReadRingerSetting (uint16_t conn_hdl) |
Read Ringer Setting characteristic value from the remote GATT database. More... | |
void | R_BLE_PASC_GetRingerSettingAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_pasc_ringer_setting_attr_hdl_t *p_hdl) |
Get Ringer Setting attribute handles. More... | |
void | R_BLE_PASC_GetRingerControlPointAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_pasc_ringer_control_point_attr_hdl_t *p_hdl) |
Get Ringer Control point attribute handles. More... | |
ble_status_t | R_BLE_PASC_WriteWithoutRspRingerControlPoint (uint16_t conn_hdl, const uint16_t *p_value) |
Get Ringer Control Point attribute handles. More... | |
ble_status_t | R_BLE_PASC_Init (ble_servc_app_cb_t cb) |
Initialize Phone Alert Status Service client. More... | |
void | R_BLE_PASC_ServDiscCb (uint16_t conn_hdl, uint8_t serv_idx, uint16_t type, void *p_param) |
Phone Alert Status Service client discovery callback. More... | |
void | R_BLE_PASC_GetServAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_gatt_hdl_range_t *p_hdl) |
Get Phone Alert Status Service client attribute handle. More... | |
#define BLE_PRV_PASC_ALERT_STATUS_ALERT_STATUS_RINGER_STATE (1 << 0) |
Ringer State bit.
#define BLE_PRV_PASC_ALERT_STATUS_ALERT_STATUS_VIBRATE_STATE (1 << 1) |
Vibrate State bit.
#define BLE_PRV_PASC_ALERT_STATUS_ALERT_STATUS_DISPLAY_ALERT_STATUS (1 << 2) |
Display Alert Status bit.
Phone Alert Status Service characteristic ID.
enum e_ble_pasc_event_t |
Phone Alert Status Service client event type.
ble_status_t R_BLE_PASC_ReadAlertStatusCliCnfg | ( | uint16_t | conn_hdl | ) |
Read Alert Status characteristic Client Characteristic Configuration descriptor value from the remote GATT database.
[in] | conn_hdl | Connection handle. |
ble_status_t R_BLE_PASC_WriteAlertStatusCliCnfg | ( | uint16_t | conn_hdl, |
const uint16_t * | p_value | ||
) |
Write Alert Status characteristic Client Characteristic Configuration descriptor value to remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | p_value | Alert Status characteristic Client Characteristic Configuration descriptor value to write. |
ble_status_t R_BLE_PASC_ReadAlertStatus | ( | uint16_t | conn_hdl | ) |
Read Alert Status characteristic value from the remote GATT database.
[in] | conn_hdl | Connection handle. |
void R_BLE_PASC_GetAlertStatusAttrHdl | ( | const st_ble_dev_addr_t * | p_addr, |
st_ble_pasc_alert_status_attr_hdl_t * | p_hdl | ||
) |
Get Alert Status 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_PASC_ReadRingerSettingCliCnfg | ( | uint16_t | conn_hdl | ) |
Read Ringer Setting characteristic Client Characteristic Configuration descriptor value from the remote GATT database.
[in] | conn_hdl | Connection handle. |
ble_status_t R_BLE_PASC_WriteRingerSettingCliCnfg | ( | uint16_t | conn_hdl, |
const uint16_t * | p_value | ||
) |
Write Ringer Setting characteristic Client Characteristic Configuration descriptor value to remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | p_value | Ringer Setting characteristic Client Characteristic Configuration descriptor value to write. |
ble_status_t R_BLE_PASC_ReadRingerSetting | ( | uint16_t | conn_hdl | ) |
Read Ringer Setting characteristic value from the remote GATT database.
[in] | conn_hdl | Connection handle. |
void R_BLE_PASC_GetRingerSettingAttrHdl | ( | const st_ble_dev_addr_t * | p_addr, |
st_ble_pasc_ringer_setting_attr_hdl_t * | p_hdl | ||
) |
Get Ringer Setting attribute handles.
[in] | p_addr | Bluetooth device address for the attribute handles. |
[out] | p_hdl | The pointer to store the retrieved attribute handles. |
void R_BLE_PASC_GetRingerControlPointAttrHdl | ( | const st_ble_dev_addr_t * | p_addr, |
st_ble_pasc_ringer_control_point_attr_hdl_t * | p_hdl | ||
) |
Get Ringer 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_PASC_WriteWithoutRspRingerControlPoint | ( | uint16_t | conn_hdl, |
const uint16_t * | p_value | ||
) |
Get Ringer Control Point attribute handles.
[in] | p_addr | The pointer to Bluetooth device address for the attribute handles. |
[out] | p_hdl | The pointer to store the retrieved control point attribute handles. |
ble_status_t R_BLE_PASC_Init | ( | ble_servc_app_cb_t | cb | ) |
void R_BLE_PASC_ServDiscCb | ( | uint16_t | conn_hdl, |
uint8_t | serv_idx, | ||
uint16_t | type, | ||
void * | p_param | ||
) |
Phone Alert Status Service client discovery callback.
[in] | conn_hdl | Connection handle |
[in] | serv_idx | Service instance index. |
[in] | type | Service discovery event type. |
[in] | p_param | Service discovery event parameter. |
void R_BLE_PASC_GetServAttrHdl | ( | const st_ble_dev_addr_t * | p_addr, |
st_ble_gatt_hdl_range_t * | p_hdl | ||
) |
Get Phone Alert Status 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. |