Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
Phone Alert Status Service Client

This is the client for the Phone Alert Status Service Service. More...

Detailed Description

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...
 

Macro Definition Documentation

◆ BLE_PRV_PASC_ALERT_STATUS_ALERT_STATUS_RINGER_STATE

#define BLE_PRV_PASC_ALERT_STATUS_ALERT_STATUS_RINGER_STATE   (1 << 0)

Ringer State bit.

◆ BLE_PRV_PASC_ALERT_STATUS_ALERT_STATUS_VIBRATE_STATE

#define BLE_PRV_PASC_ALERT_STATUS_ALERT_STATUS_VIBRATE_STATE   (1 << 1)

Vibrate State bit.

◆ BLE_PRV_PASC_ALERT_STATUS_ALERT_STATUS_DISPLAY_ALERT_STATUS

#define BLE_PRV_PASC_ALERT_STATUS_ALERT_STATUS_DISPLAY_ALERT_STATUS   (1 << 2)

Display Alert Status bit.

Enumeration Type Documentation

◆ e_ble_pasc_ringer_setting_ringer_setting_t

Ringer Setting Ringer Setting enumeration.

Enumerator
BLE_PASC_RINGER_SETTING_RINGER_SETTING_RINGER_SILENT 

Ringer Silent

BLE_PASC_RINGER_SETTING_RINGER_SETTING_RINGER_NORMAL 

Ringer Normal

◆ e_ble_pasc_ringer_control_point_ringer_control_point_t

Ringer Control point Ringer Control Point enumeration.

Enumerator
BLE_PASC_RINGER_CONTROL_POINT_RINGER_CONTROL_POINT_SILENT_MODE 

Silent Mode

BLE_PASC_RINGER_CONTROL_POINT_RINGER_CONTROL_POINT_MUTE_ONCE 

Mute Once

BLE_PASC_RINGER_CONTROL_POINT_RINGER_CONTROL_POINT_CANCEL_SILENT_MODE 

Cancel Silent Mode

◆ e_ble_pasc_char_idx_t

Phone Alert Status Service characteristic ID.

◆ e_ble_pasc_event_t

Phone Alert Status Service client event type.

Function Documentation

◆ R_BLE_PASC_ReadAlertStatusCliCnfg()

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.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_PASC_WriteAlertStatusCliCnfg()

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.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueAlert Status characteristic Client Characteristic Configuration descriptor value to write.
Returns
ble_status_t

◆ R_BLE_PASC_ReadAlertStatus()

ble_status_t R_BLE_PASC_ReadAlertStatus ( uint16_t  conn_hdl)

Read Alert Status characteristic value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_PASC_GetAlertStatusAttrHdl()

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.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_PASC_ReadRingerSettingCliCnfg()

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.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_PASC_WriteRingerSettingCliCnfg()

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.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueRinger Setting characteristic Client Characteristic Configuration descriptor value to write.
Returns
ble_status_t

◆ R_BLE_PASC_ReadRingerSetting()

ble_status_t R_BLE_PASC_ReadRingerSetting ( uint16_t  conn_hdl)

Read Ringer Setting characteristic value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_PASC_GetRingerSettingAttrHdl()

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.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_PASC_GetRingerControlPointAttrHdl()

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.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_PASC_WriteWithoutRspRingerControlPoint()

ble_status_t R_BLE_PASC_WriteWithoutRspRingerControlPoint ( uint16_t  conn_hdl,
const uint16_t *  p_value 
)

Get Ringer Control Point attribute handles.

Parameters
[in]p_addrThe pointer to Bluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved control point attribute handles.
Returns
ble_status_t

◆ R_BLE_PASC_Init()

ble_status_t R_BLE_PASC_Init ( ble_servc_app_cb_t  cb)

Initialize Phone Alert Status Service client.

Parameters
[in]cbClient callback.
Returns
ble_status_t

◆ R_BLE_PASC_ServDiscCb()

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.

Parameters
[in]conn_hdlConnection handle
[in]serv_idxService instance index.
[in]typeService discovery event type.
[in]p_paramService discovery event parameter.
Returns
ble_status_t

◆ R_BLE_PASC_GetServAttrHdl()

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.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.