Nordic stack and drivers for the mbed BLE API

Dependents:   idd_hw5_bleFanProto

Fork of nRF51822 by Nordic Semiconductor

Embed: (wiki syntax)

« Back to documentation index

ble_ans_c.h File Reference

ble_ans_c.h File Reference

Go to the source code of this file.

Data Structures

struct  ble_ans_control_point_t
 Alert Notification Control Point structure. More...
struct  ble_ans_alert_settings_t
 Alert Notification Setting structure containing the supported alerts in the service. More...
struct  ble_ans_alert_notification_t
 Alert Notification structure. More...
struct  ble_ans_c_evt_t
 Alert Notification Event structure. More...
struct  ble_ans_c_s
 Alert Notification structure. More...
struct  ble_ans_c_init_t
 Alert Notification init structure. More...

Typedefs

typedef struct ble_ans_c_s ble_ans_c_t
 Alert Notification structure.
typedef void(* ble_ans_c_evt_handler_t )(ble_ans_c_evt_t *p_evt)
 Alert Notification event handler type.

Enumerations

enum  ble_ans_category_id_t {
  ANS_TYPE_SIMPLE_ALERT = 0, ANS_TYPE_EMAIL = 1, ANS_TYPE_NEWS = 2, ANS_TYPE_NOTIFICATION_CALL = 3,
  ANS_TYPE_MISSED_CALL = 4, ANS_TYPE_SMS_MMS = 5, ANS_TYPE_VOICE_MAIL = 6, ANS_TYPE_SCHEDULE = 7,
  ANS_TYPE_HIGH_PRIORITIZED_ALERT = 8, ANS_TYPE_INSTANT_MESSAGE = 9, ANS_TYPE_ALL_ALERTS = 0xFF
}
 

Alerts types as defined in the alert category id; UUID: 0x2A43.

More...
enum  ble_ans_command_id_t {
  ANS_ENABLE_NEW_INCOMING_ALERT_NOTIFICATION = 0, ANS_ENABLE_UNREAD_CATEGORY_STATUS_NOTIFICATION = 1, ANS_DISABLE_NEW_INCOMING_ALERT_NOTIFICATION = 2, ANS_DISABLE_UNREAD_CATEGORY_STATUS_NOTIFICATION = 3,
  ANS_NOTIFY_NEW_INCOMING_ALERT_IMMEDIATELY = 4, ANS_NOTIFY_UNREAD_CATEGORY_STATUS_IMMEDIATELY = 5
}
 

Alerts notification control point commands as defined in the Alert Notification Specification; UUID: 0x2A44.

More...
enum  ble_ans_c_evt_type_t {
  BLE_ANS_C_EVT_DISCOVER_COMPLETE, BLE_ANS_C_EVT_DISCOVER_FAILED, BLE_ANS_C_EVT_RECONNECT, BLE_ANS_C_EVT_DISCONN_COMPLETE,
  BLE_ANS_C_EVT_NOTIFICATION, BLE_ANS_C_EVT_READ_RESP, BLE_ANS_C_EVT_WRITE_RESP
}
 

Alert Notification Event types that are passed from client to application on an event.

More...

Functions

void ble_ans_c_on_ble_evt (ble_ans_c_t *p_ans, const ble_evt_t *p_ble_evt)
 Function for handling the Application's BLE Stack events.
void ble_ans_c_on_device_manager_evt (ble_ans_c_t *p_ans, dm_handle_t const *p_handle, dm_event_t const *p_dm_evt)
 Function for handling the Alert Notification Client - Device Manager Event.
uint32_t ble_ans_c_init (ble_ans_c_t *p_ans, const ble_ans_c_init_t *p_ans_init)
 Function for initializing the Alert Notification Client.
uint32_t ble_ans_c_enable_notif_new_alert (const ble_ans_c_t *p_ans)
 Function for writing the to CCCD to enable new alert notifications from the Alert Notification Service.
uint32_t ble_ans_c_enable_notif_unread_alert (const ble_ans_c_t *p_ans)
 Function for writing to the CCCD to enable unread alert notifications from the Alert Notification Service.
uint32_t ble_ans_c_disable_notif_new_alert (const ble_ans_c_t *p_ans)
 Function for writing to the CCCD to disable new alert notifications from the Alert Notification Service.
uint32_t ble_ans_c_disable_notif_unread_alert (const ble_ans_c_t *p_ans)
 Function for writing to the CCCD to disable unread alert notifications from the Alert Notification Service.
uint32_t ble_ans_c_control_point_write (const ble_ans_c_t *p_ans, const ble_ans_control_point_t *p_control_point)
 Function for writing to the Alert Notification Control Point to specify alert notification behavior in the Alert Notification Service on the Central.
uint32_t ble_ans_c_new_alert_read (const ble_ans_c_t *p_ans)
 Function for reading the Supported New Alert characteristic value of the service.
uint32_t ble_ans_c_unread_alert_read (const ble_ans_c_t *p_ans)
 Function for reading the Supported Unread Alert characteristic value of the service.
uint32_t ble_ans_c_new_alert_notify (const ble_ans_c_t *p_ans, ble_ans_category_id_t category)
 Function for requesting the peer to notify the New Alert characteristics immediately.
uint32_t ble_ans_c_unread_alert_notify (const ble_ans_c_t *p_ans, ble_ans_category_id_t category)
 Function for requesting the peer to notify the Unread Alert characteristics immediately.
uint32_t ble_ans_c_service_load (const ble_ans_c_t *p_ans)
 Function for loading previous discovered service and characteristic handles for bonded centrals from flash into RAM.
uint32_t ble_ans_c_service_store (void)
 Function for storing discovered service and characteristic handles for bonded centrals into flash memory.
uint32_t ble_ans_c_service_delete (void)
 Function for deleting the Alert Notification Client database from flash.

Detailed Description

Definition in file ble_ans_c.h.