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

This service exposes a control point to allow a peer device to cause the device to immediately alert. More...

Detailed Description

This service exposes a control point to allow a peer device to cause the device to immediately alert.

Data Structures

struct  st_ble_ias_evt_data_t
 Immediate Alert Service event data. More...
 
struct  st_ble_ias_init_param_t
 Immediate Alert Service initialization parameters. More...
 
struct  st_ble_ias_connect_param_t
 Immediate Alert Service connection parameters. More...
 
struct  st_ble_ias_disconnect_param_t
 Immediate Alert Service disconnection parameters. More...
 

Typedefs

typedef void(* ble_ias_app_cb_t) (uint16_t type, ble_status_t result, st_ble_ias_evt_data_t *p_data)
 Immediate Alert Service event callback. More...
 

Enumerations

enum  e_ble_ias_event_t { BLE_IAS_EVENT_ALERT_LEVEL_WRITE_CMD }
 Immediate Alert Service event type. More...
 
enum  e_ble_ias_alert_level_t {
  BLE_IAS_ALERT_LEVEL_ALERT_LEVEL_NO_ALERT = 0,
  BLE_IAS_ALERT_LEVEL_ALERT_LEVEL_MILD_ALERT = 1,
  BLE_IAS_ALERT_LEVEL_ALERT_LEVEL_HIGH_ALERT = 2
}
 Alert Level enumeration. More...
 

Functions

ble_status_t R_BLE_IAS_Init (const st_ble_ias_init_param_t *p_param)
 Initialize Immediate Alert Service. More...
 
ble_status_t R_BLE_IAS_Connect (uint16_t conn_hdl, const st_ble_ias_connect_param_t *p_param)
 Perform Immediate Alert Service connection settings. More...
 
ble_status_t R_BLE_IAS_Disconnect (uint16_t conn_hdl, st_ble_ias_disconnect_param_t *p_param)
 Retrieve Immediate Alert Service connection specific settings before disconnection. More...
 
uint32_t R_BLE_IAS_GetVersion (void)
 Return version of the IAC service server. More...
 

Typedef Documentation

◆ ble_ias_app_cb_t

typedef void(* ble_ias_app_cb_t) (uint16_t type, ble_status_t result, st_ble_ias_evt_data_t *p_data)

Immediate Alert Service event callback.

Enumeration Type Documentation

◆ e_ble_ias_event_t

Immediate Alert Service event type.

Enumerator
BLE_IAS_EVENT_ALERT_LEVEL_WRITE_CMD 

Alert Level characteristic write command event

◆ e_ble_ias_alert_level_t

Alert Level enumeration.

Enumerator
BLE_IAS_ALERT_LEVEL_ALERT_LEVEL_NO_ALERT 

Alert level no alert shall be done on the device

BLE_IAS_ALERT_LEVEL_ALERT_LEVEL_MILD_ALERT 

Alert level mild alert the device shall alert

BLE_IAS_ALERT_LEVEL_ALERT_LEVEL_HIGH_ALERT 

Alert level high alert the device shall alert the strongest possible

Function Documentation

◆ R_BLE_IAS_Init()

ble_status_t R_BLE_IAS_Init ( const st_ble_ias_init_param_t p_param)

Initialize Immediate Alert Service.

This function shall be called once at startup.

Parameters
[in]p_paramPointer to Immediate Alert Service initialization parameters.
Returns

◆ R_BLE_IAS_Connect()

ble_status_t R_BLE_IAS_Connect ( uint16_t  conn_hdl,
const st_ble_ias_connect_param_t p_param 
)

Perform Immediate Alert Service connection settings.

This function shall be called on each connection establishment.

Parameters
[in]conn_hdlConnection handle.
[in]p_paramPointer to Connection parameters.
Returns
ble_status_t

◆ R_BLE_IAS_Disconnect()

ble_status_t R_BLE_IAS_Disconnect ( uint16_t  conn_hdl,
st_ble_ias_disconnect_param_t p_param 
)

Retrieve Immediate Alert Service connection specific settings before disconnection.

This function shall be called on each disconnection.

Parameters
[in]conn_hdlConnection handle.
[in]p_paramPointer to Disconnection parameters.
Returns
ble_status_t

◆ R_BLE_IAS_GetVersion()

uint32_t R_BLE_IAS_GetVersion ( void  )

Return version of the IAC service server.

Returns
version