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

This service exposes the phone alert status when in a connection. More...

Detailed Description

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

Enumeration Type Documentation

◆ e_ble_pass_ringer_setting_ringer_setting_t

Ringer Setting Ringer Setting enumeration.

Enumerator
BLE_PASS_RINGER_SETTING_RINGER_SETTING_RINGER_SILENT 

Ringer Silent

BLE_PASS_RINGER_SETTING_RINGER_SETTING_RINGER_NORMAL 

Ringer Normal

◆ e_ble_pass_ringer_control_point_ringer_control_point_t

Ringer Control point Ringer Control Point enumeration.

Enumerator
BLE_PASS_RINGER_CONTROL_POINT_RINGER_CONTROL_POINT_SILENT_MODE 

Silent Mode

BLE_PASS_RINGER_CONTROL_POINT_RINGER_CONTROL_POINT_MUTE_ONCE 

Mute Once

BLE_PASS_RINGER_CONTROL_POINT_RINGER_CONTROL_POINT_CANCEL_SILENT_MODE 

Cancel Silent Mode

◆ e_ble_pass_char_idx_t

Phone Alert Status Service characteristic Index.

◆ e_ble_pass_event_t

Phone Alert Status Service event type.

Function Documentation

◆ R_BLE_PASS_SetAlertStatus()

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.

Parameters
[in]p_valueCharacteristic value to set.
Returns
ble_status_t

◆ R_BLE_PASS_GetAlertStatus()

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.

Parameters
[in]p_valueOutput location for the acquired descriptor value.
Returns
ble_status_t

◆ R_BLE_PASS_NotifyAlertStatus()

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.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueCharacteristic value to send.
Returns
ble_status_t

◆ R_BLE_PASS_SetAlertStatusCliCnfg()

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.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueDescriptor value to set.
Returns
ble_status_t

◆ R_BLE_PASS_GetAlertStatusCliCnfg()

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.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueOutput location for the acquired descriptor value.
Returns
ble_status_t

◆ R_BLE_PASS_SetRingerSetting()

ble_status_t R_BLE_PASS_SetRingerSetting ( const uint8_t *  p_value)

Set Ringer Setting characteristic value to the local GATT database.

Parameters
[in]p_valueCharacteristic value to set.
Returns
ble_status_t

◆ R_BLE_PASS_GetRingerSetting()

ble_status_t R_BLE_PASS_GetRingerSetting ( uint8_t *  p_value)

Get Ringer Setting characteristic value from the local GATT database.

Parameters
[in]p_valueOutput location for the acquired descriptor value.
Returns
ble_status_t

◆ R_BLE_PASS_NotifyRingerSetting()

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.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueCharacteristic value to send.
Returns
ble_status_t

◆ R_BLE_PASS_SetRingerSettingCliCnfg()

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.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueDescriptor value to set.
Returns
ble_status_t

◆ R_BLE_PASS_GetRingerSettingCliCnfg()

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.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueOutput location for the acquired descriptor value.
Returns
ble_status_t

◆ R_BLE_PASS_Init()

ble_status_t R_BLE_PASS_Init ( ble_servs_app_cb_t  cb)

Initialize Phone Alert Status Service service.

Parameters
[in]cbService callback.
Returns
ble_status_t