Gymtrack / nRF51822_1

SG RFID nRF51822 fork

Fork of nRF51822 by Nordic Semiconductor

Embed: (wiki syntax)

« Back to documentation index

Immediate Alert Service
Data Structures | Typedefs | Enumerations | Functions

Immediate Alert Service

Immediate Alert Service module. More...

Data Structures

struct  ble_ias_evt_t
 Immediate Alert Service event. More...
struct  ble_ias_init_t
 Immediate Alert Service init structure. More...
struct  ble_ias_s
 Immediate Alert Service structure. More...

Typedefs

typedef struct ble_ias_s ble_ias_t
 Immediate Alert Service structure.
typedef void(* ble_ias_evt_handler_t )(ble_ias_t *p_ias, ble_ias_evt_t *p_evt)
 Immediate Alert Service event handler type.

Enumerations

enum  ble_ias_evt_type_t { BLE_IAS_EVT_ALERT_LEVEL_UPDATED }
 

Immediate Alert Service event type.

More...

Functions

uint32_t ble_ias_init (ble_ias_t *p_ias, const ble_ias_init_t *p_ias_init)
 Function for initializing the Immediate Alert Service.
void ble_ias_on_ble_evt (ble_ias_t *p_ias, ble_evt_t *p_ble_evt)
 Function for handling the Application's BLE Stack events.
uint32_t ble_ias_alert_level_get (ble_ias_t *p_ias, uint8_t *p_alert_level)
 Function for getting current value of the Alert Level characteristic.

Detailed Description

Immediate Alert Service module.

This module implements the Immediate Alert Service with the Alert Level characteristic. During initialization it adds the Immediate Alert Service and Alert Level characteristic to the BLE stack database.

The application must supply an event handler for receiving Immediate Alert Service events. Using this handler, the service will notify the application when the Alert Level characteristic value changes.

The service also provides a function for letting the application poll the current value of the Alert Level characteristic.

Note:
The application must propagate BLE stack events to the Immediate Alert Service module by calling ble_ias_on_ble_evt() from the ble_stack_handler callback.
Attention! To maintain compliance with Nordic Semiconductor ASA Bluetooth profile qualification listings, this section of source code must not be modified.

Typedef Documentation

typedef void(* ble_ias_evt_handler_t)(ble_ias_t *p_ias, ble_ias_evt_t *p_evt)

Immediate Alert Service event handler type.

Definition at line 65 of file ble_ias.h.

typedef struct ble_ias_s ble_ias_t

Immediate Alert Service structure.

This contains various status information for the service.

Definition at line 62 of file ble_ias.h.

Enumeration Type Documentation

enum ble_ias_evt_type_t

Immediate Alert Service event type.

Enumerator:
BLE_IAS_EVT_ALERT_LEVEL_UPDATED 

Alert Level Updated event.

Definition at line 46 of file ble_ias.h.

Function Documentation

uint32_t ble_ias_alert_level_get ( ble_ias_t *  p_ias,
uint8_t *  p_alert_level 
)

Function for getting current value of the Alert Level characteristic.

Parameters:
[in]p_iasImmediate Alert Service structure.
[out]p_alert_levelCurrent Alert Level value.
uint32_t ble_ias_init ( ble_ias_t *  p_ias,
const ble_ias_init_t *  p_ias_init 
)

Function for initializing the Immediate Alert Service.

Parameters:
[out]p_iasImmediate Alert Service 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 service instance.
[in]p_ias_initInformation needed to initialize the service.
Returns:
NRF_SUCCESS on successful initialization of service, otherwise an error code.
void ble_ias_on_ble_evt ( ble_ias_t *  p_ias,
ble_evt_t *  p_ble_evt 
)

Function for handling the Application's BLE Stack events.

Handles all events from the BLE stack of interest to the Immediate Alert Service.

Parameters:
[in]p_iasImmediate Alert Service structure.
[in]p_ble_evtEvent received from the BLE stack.
Generated on Tue Jul 12 2022 15:07:45 by  doxygen 1.7.2