nRF51 SDK - S110 SoftDevice
|
Immediate Alert Service Client module. More...
Data Structures | |
struct | ble_ias_c_evt_t |
Immediate Alert Service client event. More... | |
struct | ble_ias_c_s |
IAS Client structure. This contains various status information for the client. More... | |
struct | ble_ias_c_init_t |
IAS Client init structure. This contains all options and data needed for initialization of the client. More... | |
Typedefs | |
typedef struct ble_ias_c_s | ble_ias_c_t |
IAS Client structure. This contains various status information for the client. | |
typedef void(* | ble_ias_c_evt_handler_t )(ble_ias_c_t *p_ias_c, ble_ias_c_evt_t *p_evt) |
Immediate Alert Service client event handler type. | |
Enumerations | |
enum | ble_ias_c_evt_type_t { BLE_IAS_C_EVT_SRV_DISCOVERED, BLE_IAS_C_EVT_SRV_NOT_FOUND, BLE_IAS_C_EVT_DISCONN_COMPLETE } |
Immediate Alert Service client event type. More... | |
Functions | |
uint32_t | ble_ias_c_init (ble_ias_c_t *p_ias_c, const ble_ias_c_init_t *p_ias_c_init) |
Function for initializing the Immediate Alert Service client. More... | |
uint32_t | ble_ias_c_send_alert_level (const ble_ias_c_t *p_ias_c, uint8_t alert_level) |
Function for sending alert level to the peer. More... | |
void | ble_ias_c_on_ble_evt (ble_ias_c_t *p_ias_c, const ble_evt_t *p_ble_evt) |
Function for handling the Application's BLE Stack events for Immediate Alert Service client. More... | |
static __INLINE bool | ble_ias_c_is_ias_discovered (const ble_ias_c_t *p_ias_c) |
Function for checking whether the peer's Immediate Alert Service instance and the alert level characteristic have been discovered. More... | |
Immediate Alert Service Client module.
This module implements the Immediate Alert Service client - locator role of the Find Me profile. On BLE_GAP_EVT_CONNECTED event, this module starts discovery of the Immediate Alert Service with Alert Level characteristic at the peer. This module will indicate the application about a successful service & characteristic discovery using BLE_IAS_C_EVT_SRV_DISCOVERED event. The application can use ble_ias_c_send_alert_level function to signal alerts to the peer.
enum ble_ias_c_evt_type_t |
Immediate Alert Service client event type.
uint32_t ble_ias_c_init | ( | ble_ias_c_t * | p_ias_c, |
const ble_ias_c_init_t * | p_ias_c_init | ||
) |
Function for initializing the Immediate Alert Service client.
This call allows the application to initialize the Immediate Alert Service client.
[out] | p_ias_c | Immediate Alert Service client structure. This structure will have to be supplied by the application. It will be initialized by this function, and will later be used to identify this particular client instance. |
[in] | p_ias_c_init | Information needed to initialize the Immediate Alert Service client. |
|
static |
Function for checking whether the peer's Immediate Alert Service instance and the alert level characteristic have been discovered.
[in] | p_ias_c | Immediate Alert Service client structure. |
void ble_ias_c_on_ble_evt | ( | ble_ias_c_t * | p_ias_c, |
const ble_evt_t * | p_ble_evt | ||
) |
Function for handling the Application's BLE Stack events for Immediate Alert Service client.
Handles all events from the BLE stack of interest to the Immediate Alert Service client.
[in] | p_ias_c | Immediate Alert Service client structure. |
[in] | p_ble_evt | Event received from the BLE stack. |
uint32_t ble_ias_c_send_alert_level | ( | const ble_ias_c_t * | p_ias_c, |
uint8_t | alert_level | ||
) |
Function for sending alert level to the peer.
This function allows the application to send an alert to the peer.
[in] | p_ias_c | Immediate Alert Service client structure. |
[in] | alert_level | Required alert level to be sent to the peer. |