SF BLE Alert Notification Profile Framework Interface

RTOS-integrated SF BLE Alert Notification Profile Framework Interface. More...

Data Structures
struct	sf_ble_anp_ancp_t
struct	sf_ble_anp_ancp_change_t
struct	sf_ble_anp_api_new_alert_t
struct	sf_ble_anp_api_new_alert_ntf_t
struct	sf_ble_anp_api_unread_alert_t
struct	sf_ble_anp_api_unread_alert_ntf_t

Macros
#define	SF_BLE_ANP_ALT_TEXT_MAX   (18U)

Enumerations
enum	sf_ble_prf_anpc_event_t { SF_BLE_PRF_ANPC_EVENT_NONE, SF_BLE_PRF_ANPC_EVENT_NEW_ALT_NTF, SF_BLE_PRF_ANPC_EVENT_UNREAD_ALT_NTF, SF_BLE_PRF_ANPC_EVENT_READ_CHAR_RES }
enum	sf_ble_prf_anps_event_t { SF_BLE_PRF_ANPS_EVENT_NONE, SF_BLE_PRF_ANPS_EVENT_ALT_NF_CP_IND, SF_BLE_PRF_ANPS_EVENT_CCCD_NTF_IND }
enum	sf_ble_prf_anp_category_id {   SF_BLE_PRF_ANP_CATEGORY_ID_SIMPLE_ALERT, SF_BLE_PRF_ANP_CATEGORY_ID_EMAIL, SF_BLE_PRF_ANP_CATEGORY_ID_NEWS, SF_BLE_PRF_ANP_CATEGORY_ID_CALL,   SF_BLE_PRF_ANP_CATEGORY_ID_MISSED_CALL, SF_BLE_PRF_ANP_CATEGORY_ID_SMS_MMS, SF_BLE_PRF_ANP_CATEGORY_ID_VOICE_MAIL, SF_BLE_PRF_ANP_CATEGORY_ID_SCHEDULE,   SF_BLE_PRF_ANP_CATEGORY_ID_HIGH_PRIORITY_ALERT, SF_BLE_PRF_ANP_CATEGORY_ID_INSTANT_MESSAGE, SF_BLE_PRF_ANP_CATEGORY_ID_ALL }
enum	sf_ble_prf_anp_cmd_id_t {   SF_BLE_PRF_ANP_CMD_ID_NEW_ALERT_ENABLE, SF_BLE_PRF_ANP_CMD_ID_UNREAD_ALERT_ENABLE, SF_BLE_PRF_ANP_CMD_ID_NEW_ALERT_DISABLE, SF_BLE_PRF_ANP_CMD_ID_UNREAD_ALERT_DISABLE,   SF_BLE_PRF_ANP_CMD_ID_NEW_ALERT_NTF_REQ, SF_BLE_PRF_ANP_CMD_ID_UNREAD_ALERT_NTF_REQ }

Detailed Description

RTOS-integrated SF BLE Alert Notification Profile Framework Interface.

Summary

This SSP Interface provides access to the ThreadX-aware SF BLE Alert Notification Profile Framework.

Macro Definition Documentation

SF_BLE_ANP_ALT_TEXT_MAX

#define SF_BLE_ANP_ALT_TEXT_MAX   (18U)

Buffer size of data for Alert Notification

Enumeration Type Documentation

sf_ble_prf_anp_category_id

enum sf_ble_prf_anp_category_id

Alert Notification Control Point Category ID

Enumerator
SF_BLE_PRF_ANP_CATEGORY_ID_SIMPLE_ALERT	Simple Alert: General text alert or non-text alert.
SF_BLE_PRF_ANP_CATEGORY_ID_EMAIL	Email Alert.
SF_BLE_PRF_ANP_CATEGORY_ID_NEWS	News feeds Alert.
SF_BLE_PRF_ANP_CATEGORY_ID_CALL	Incoming Call Alert.
SF_BLE_PRF_ANP_CATEGORY_ID_MISSED_CALL	Missed Call Alert.
SF_BLE_PRF_ANP_CATEGORY_ID_SMS_MMS	SMS/MMS Message Alert.
SF_BLE_PRF_ANP_CATEGORY_ID_VOICE_MAIL	Voice Mail Alert.
SF_BLE_PRF_ANP_CATEGORY_ID_SCHEDULE	Alert occurred on calendar, planner.
SF_BLE_PRF_ANP_CATEGORY_ID_HIGH_PRIORITY_ALERT	High Prioritized Alert.
SF_BLE_PRF_ANP_CATEGORY_ID_INSTANT_MESSAGE	Incoming Instant Messages.
SF_BLE_PRF_ANP_CATEGORY_ID_ALL	All Supported Categories.

sf_ble_prf_anp_cmd_id_t

enum sf_ble_prf_anp_cmd_id_t

Alert Notification Control Point Command ID

Enumerator
SF_BLE_PRF_ANP_CMD_ID_NEW_ALERT_ENABLE	Enable New Incoming Alert Notification.
SF_BLE_PRF_ANP_CMD_ID_UNREAD_ALERT_ENABLE	Enable Unread Category Status Notification.
SF_BLE_PRF_ANP_CMD_ID_NEW_ALERT_DISABLE	Disable New Incoming Alert Notification.
SF_BLE_PRF_ANP_CMD_ID_UNREAD_ALERT_DISABLE	Disable Unread Category Status Notification.
SF_BLE_PRF_ANP_CMD_ID_NEW_ALERT_NTF_REQ	Notify New Incoming Alert immediately.
SF_BLE_PRF_ANP_CMD_ID_UNREAD_ALERT_NTF_REQ	Notify Unread Category Status immediately.

sf_ble_prf_anpc_event_t

enum sf_ble_prf_anpc_event_t

Profile Client user events

Enumerator
SF_BLE_PRF_ANPC_EVENT_NONE	Event not supported.
SF_BLE_PRF_ANPC_EVENT_NEW_ALT_NTF	New Alert Data received event, Refer sf_ble_anp_api_new_alert_ntf_t.
SF_BLE_PRF_ANPC_EVENT_UNREAD_ALT_NTF	Unread Alert Data received event, Refer sf_ble_anp_api_unread_alert_ntf_t.
SF_BLE_PRF_ANPC_EVENT_READ_CHAR_RES	Read Char Complete Event.

sf_ble_prf_anps_event_t

enum sf_ble_prf_anps_event_t

Alert notification server profile user events

Enumerator
SF_BLE_PRF_ANPS_EVENT_NONE	Event not supported.
SF_BLE_PRF_ANPS_EVENT_ALT_NF_CP_IND	Alert Notification Control Point Changed indication, Refer sf_ble_anp_ancp_change_t.
SF_BLE_PRF_ANPS_EVENT_CCCD_NTF_IND	CCCD Notification Setting change event.