Apple Notification Center Service Client Module.
More...
|
#define | TX_BUFFER_MASK 0x07 |
| TX buffer mask. Must be a mask of contiguous zeroes followed by a contiguous sequence of ones: 000...111.
|
|
#define | TX_BUFFER_SIZE (TX_BUFFER_MASK + 1) |
| Size of the send buffer, which is 1 bigger than the mask.
|
|
#define | WRITE_MESSAGE_LENGTH 20 |
| Length of the write message for the CCCD/control point.
|
|
#define | BLE_ANCS_C_DEF(_name) |
| Macro for defining a ble_ancs_c instance. More...
|
|
#define | BLE_ANCS_ATTR_DATA_MAX 32 |
| Maximum data length of an iOS notification attribute.
|
|
#define | BLE_ANCS_NB_OF_CATEGORY_ID 12 |
| Number of iOS notification categories: Other, Incoming Call, Missed Call, Voice Mail, Social, Schedule, Email, News, Health And Fitness, Business And Finance, Location, Entertainment.
|
|
#define | BLE_ANCS_NB_OF_NOTIF_ATTR 8 |
| Number of iOS notification attributes: AppIdentifier, Title, Subtitle, Message, MessageSize, Date, PositiveActionLabel, NegativeActionLabel.
|
|
#define | BLE_ANCS_NB_OF_APP_ATTR 1 |
| Number of iOS application attributes: DisplayName.
|
|
#define | BLE_ANCS_NB_OF_EVT_ID 3 |
| Number of iOS notification events: Added, Modified, Removed.
|
|
#define | BLE_ANCS_NOTIFICATION_DATA_LENGTH 8 |
| Length of the iOS notification data. More...
|
|
#define | ANCS_UUID_SERVICE 0xF431 |
| 16-bit service UUID for the Apple Notification Center Service.
|
|
#define | ANCS_UUID_CHAR_CONTROL_POINT 0xD8F3 |
| 16-bit control point UUID.
|
|
#define | ANCS_UUID_CHAR_DATA_SOURCE 0xC6E9 |
| 16-bit data source UUID.
|
|
#define | ANCS_UUID_CHAR_NOTIFICATION_SOURCE 0x120D |
| 16-bit notification source UUID.
|
|
#define | BLE_ANCS_EVENT_FLAG_SILENT 0 |
| 0b.......1 Silent: First (LSB) bit is set. All flags can be active at the same time.
|
|
#define | BLE_ANCS_EVENT_FLAG_IMPORTANT 1 |
| 0b......1. Important: Second (LSB) bit is set. All flags can be active at the same time.
|
|
#define | BLE_ANCS_EVENT_FLAG_PREEXISTING 2 |
| 0b.....1.. Pre-existing: Third (LSB) bit is set. All flags can be active at the same time.
|
|
#define | BLE_ANCS_EVENT_FLAG_POSITIVE_ACTION 3 |
| 0b....1... Positive action: Fourth (LSB) bit is set. All flags can be active at the same time.
|
|
#define | BLE_ANCS_EVENT_FLAG_NEGATIVE_ACTION 4 |
| 0b...1.... Negative action: Fifth (LSB) bit is set. All flags can be active at the same time.
|
|
#define | TX_BUFFER_MASK 0x07 |
| TX buffer mask. Must be a mask of contiguous zeroes followed by a contiguous sequence of ones: 000...111.
|
|
#define | TX_BUFFER_SIZE (TX_BUFFER_MASK + 1) |
| Size of the send buffer, which is 1 bigger than the mask.
|
|
#define | WRITE_MESSAGE_LENGTH 20 |
| Length of the write message for the CCCD/control point.
|
|
|
enum | tx_request_t {
READ_REQ = 1,
WRITE_REQ,
READ_REQ = 1,
WRITE_REQ
} |
| ANCS request types. More...
|
|
enum | ble_ancs_c_evt_type_t {
BLE_ANCS_C_EVT_DISCOVERY_COMPLETE,
BLE_ANCS_C_EVT_DISCOVERY_FAILED,
BLE_ANCS_C_EVT_NOTIF,
BLE_ANCS_C_EVT_INVALID_NOTIF,
BLE_ANCS_C_EVT_NOTIF_ATTRIBUTE,
BLE_ANCS_C_EVT_APP_ATTRIBUTE,
BLE_ANCS_C_EVT_NP_ERROR
} |
| Event types that are passed from client to application on an event. More...
|
|
enum | ble_ancs_c_category_id_val_t {
BLE_ANCS_CATEGORY_ID_OTHER,
BLE_ANCS_CATEGORY_ID_INCOMING_CALL,
BLE_ANCS_CATEGORY_ID_MISSED_CALL,
BLE_ANCS_CATEGORY_ID_VOICE_MAIL,
BLE_ANCS_CATEGORY_ID_SOCIAL,
BLE_ANCS_CATEGORY_ID_SCHEDULE,
BLE_ANCS_CATEGORY_ID_EMAIL,
BLE_ANCS_CATEGORY_ID_NEWS,
BLE_ANCS_CATEGORY_ID_HEALTH_AND_FITNESS,
BLE_ANCS_CATEGORY_ID_BUSINESS_AND_FINANCE,
BLE_ANCS_CATEGORY_ID_LOCATION,
BLE_ANCS_CATEGORY_ID_ENTERTAINMENT
} |
| Category IDs for iOS notifications. More...
|
|
enum | ble_ancs_c_evt_id_values_t {
BLE_ANCS_EVENT_ID_NOTIFICATION_ADDED,
BLE_ANCS_EVENT_ID_NOTIFICATION_MODIFIED,
BLE_ANCS_EVENT_ID_NOTIFICATION_REMOVED
} |
| Event IDs for iOS notifications. More...
|
|
enum | ble_ancs_c_cmd_id_val_t {
BLE_ANCS_COMMAND_ID_GET_NOTIF_ATTRIBUTES,
BLE_ANCS_COMMAND_ID_GET_APP_ATTRIBUTES,
BLE_ANCS_COMMAND_ID_GET_PERFORM_NOTIF_ACTION
} |
| Control point command IDs that the Notification Consumer can send to the Notification Provider. More...
|
|
enum | ble_ancs_c_action_id_values_t {
ACTION_ID_POSITIVE = 0,
ACTION_ID_NEGATIVE
} |
| IDs for actions that can be performed for iOS notifications. More...
|
|
enum | ble_ancs_c_app_attr_id_val_t { BLE_ANCS_APP_ATTR_ID_DISPLAY_NAME = 0
} |
| App attribute ID values. More...
|
|
enum | ble_ancs_c_notif_attr_id_val_t {
BLE_ANCS_NOTIF_ATTR_ID_APP_IDENTIFIER = 0,
BLE_ANCS_NOTIF_ATTR_ID_TITLE,
BLE_ANCS_NOTIF_ATTR_ID_SUBTITLE,
BLE_ANCS_NOTIF_ATTR_ID_MESSAGE,
BLE_ANCS_NOTIF_ATTR_ID_MESSAGE_SIZE,
BLE_ANCS_NOTIF_ATTR_ID_DATE,
BLE_ANCS_NOTIF_ATTR_ID_POSITIVE_ACTION_LABEL,
BLE_ANCS_NOTIF_ATTR_ID_NEGATIVE_ACTION_LABEL
} |
| IDs for iOS notification attributes. More...
|
|
enum | ble_ancs_c_parse_state_t {
COMMAND_ID,
NOTIF_UID,
APP_ID,
ATTR_ID,
ATTR_LEN1,
ATTR_LEN2,
ATTR_DATA,
ATTR_SKIP,
DONE
} |
| Parsing states for received iOS notification and app attributes. More...
|
|
enum | tx_request_t {
READ_REQ = 1,
WRITE_REQ,
READ_REQ = 1,
WRITE_REQ
} |
| ANCS request types. More...
|
|
|
uint32_t | ancs_c_app_attr_request (ble_ancs_c_t *p_ancs, const uint8_t *app_id, uint32_t len) |
| Function for requesting attributes for an app. More...
|
|
void | ancs_parse_get_attrs_response (ble_ancs_c_t *p_ancs, const uint8_t *p_data_src, const uint16_t hvx_data_len) |
| Function for parsing notification or app attribute response data. More...
|
|
void | tx_buffer_init (void) |
| Function for clearing the TX buffer. More...
|
|
void | tx_buffer_insert (tx_message_t *p_msg) |
| Function for moving the pointer of the ring buffer to the next element.
|
|
void | tx_buffer_process (void) |
| Function for passing any pending request from the buffer to the stack.
|
|
void | ble_ancs_c_on_ble_evt (ble_evt_t const *p_ble_evt, void *p_context) |
| Function for handling the application's BLE stack events. More...
|
|
void | ble_ancs_c_on_db_disc_evt (ble_ancs_c_t *p_ancs, ble_db_discovery_evt_t *p_evt) |
| Function for handling events from the database discovery module. More...
|
|
ret_code_t | ble_ancs_c_init (ble_ancs_c_t *p_ancs, ble_ancs_c_init_t const *p_ancs_init) |
| Function for initializing the ANCS client. More...
|
|
ret_code_t | ble_ancs_c_notif_source_notif_enable (ble_ancs_c_t const *p_ancs) |
| Function for writing to the CCCD to enable notifications from the Apple Notification Service. More...
|
|
ret_code_t | ble_ancs_c_data_source_notif_enable (ble_ancs_c_t const *p_ancs) |
| Function for writing to the CCCD to enable data source notifications from the ANCS. More...
|
|
ret_code_t | ble_ancs_c_notif_source_notif_disable (ble_ancs_c_t const *p_ancs) |
| Function for writing to the CCCD to disable notifications from the ANCS. More...
|
|
ret_code_t | ble_ancs_c_data_source_notif_disable (ble_ancs_c_t const *p_ancs) |
| Function for writing to the CCCD to disable data source notifications from the ANCS. More...
|
|
ret_code_t | nrf_ble_ancs_c_attr_add (ble_ancs_c_t *p_ancs, ble_ancs_c_notif_attr_id_val_t const id, uint8_t *p_data, uint16_t const len) |
| Function for registering attributes that will be requested when nrf_ble_ancs_c_request_attrs is called. More...
|
|
ret_code_t | nrf_ble_ancs_c_attr_remove (ble_ancs_c_t *p_ancs, ble_ancs_c_notif_attr_id_val_t const id) |
| Function for removing attributes so that they will no longer be requested when nrf_ble_ancs_c_request_attrs is called. More...
|
|
ret_code_t | nrf_ble_ancs_c_app_attr_remove (ble_ancs_c_t *p_ancs, ble_ancs_c_app_attr_id_val_t const id) |
| Function for removing attributes so that they will no longer be requested when nrf_ble_ancs_c_app_attr_request is called. More...
|
|
ret_code_t | nrf_ble_ancs_c_app_attr_add (ble_ancs_c_t *p_ancs, ble_ancs_c_app_attr_id_val_t const id, uint8_t *p_data, uint16_t const len) |
| Function for registering attributes that will be requested when nrf_ble_ancs_c_app_attr_request is called. More...
|
|
ret_code_t | nrf_ble_ancs_c_attr_req_clear_all (ble_ancs_c_t *p_ancs) |
| Function for clearing the list of notification attributes and app attributes that would be requested from NP. More...
|
|
ret_code_t | nrf_ble_ancs_c_request_attrs (ble_ancs_c_t *p_ancs, ble_ancs_c_evt_notif_t const *p_notif) |
| Function for requesting attributes for a notification. More...
|
|
ret_code_t | nrf_ble_ancs_c_app_attr_request (ble_ancs_c_t *p_ancs, uint8_t const *p_app_id, uint32_t len) |
| Function for requesting attributes for a given app. More...
|
|
ret_code_t | nrf_ancs_perform_notif_action (ble_ancs_c_t *p_ancs, uint32_t uuid, ble_ancs_c_action_id_values_t action_id) |
| Function for performing a notification action. More...
|
|
ret_code_t | nrf_ble_ancs_c_handles_assign (ble_ancs_c_t *p_ancs, uint16_t const conn_handle, ble_ancs_c_service_t const *p_service) |
| Function for assigning a handle to this instance of ancs_c. More...
|
|
Apple Notification Center Service Client Module.
Disclaimer: This client implementation of the Apple Notification Center Service can be changed at any time by Nordic Semiconductor ASA. Server implementations such as the ones found in iOS can be changed at any time by Apple and may cause this client implementation to stop working.
This module implements the Apple Notification Center Service (ANCS) client. This client can be used as a Notification Consumer (NC) that receives data notifications from a Notification Provider (NP). The NP is typically an iOS device acting as a server. For terminology and up-to-date specs, see http://developer.apple.com.
The term "notification" is used in two different meanings:
- An iOS notification is the data received from the Notification Provider.
- A GATTC notification is a way to transfer data with Bluetooth Smart. In this module, we receive iOS notifications using GATTC notifications. We use the full term (iOS notification or GATTC notification) where required to avoid confusion.
Upon initializing the module, you must add the different iOS notification attributes you would like to receive for iOS notifications (see nrf_ble_ancs_c_attr_add).
Once a connection is established with a central device, the module does a service discovery to discover the ANCS server handles. If this succeeds (BLE_ANCS_C_EVT_DISCOVERY_COMPLETE), the handles for the ANCS server are part of the ble_ancs_c_evt_t structure and must be assigned to an ANCS_C instance using the nrf_ble_ancs_c_handles_assign function. For more information about service discovery, see the Database Discovery Module documentation.
The application can now subscribe to iOS notifications using ble_ancs_c_notif_source_notif_enable. They arrive in the BLE_ANCS_C_EVT_NOTIF event. nrf_ble_ancs_c_request_attrs can be used to request attributes for the notifications. They arrive in the BLE_ANCS_C_EVT_NOTIF_ATTRIBUTE event. nrf_ble_ancs_c_app_attr_request can be used to request attributes of the app that issued the notifications. They arrive in the BLE_ANCS_C_EVT_APP_ATTRIBUTE event. nrf_ancs_perform_notif_action can be used to make the Notification Provider perform an action based on the provided notification.
- Note
- The application must register this module as BLE event observer using the NRF_SDH_BLE_OBSERVER macro. Example:
#define BLE_ANCS_C_DEF |
( |
|
_name | ) |
|
Macro for defining a ble_ancs_c instance.
- Parameters
-
_name | Name of the instance. |
#define BLE_ANCS_NOTIFICATION_DATA_LENGTH 8 |
Length of the iOS notification data.
8 bytes:
Event ID | Event flags | Category ID | Category count | Notification UID |
1 byte | 1 byte | 1 byte | 1 byte | 4 bytes |
IDs for actions that can be performed for iOS notifications.
Enumerator |
---|
ACTION_ID_POSITIVE |
Positive action.
|
ACTION_ID_NEGATIVE |
Negative action.
|
App attribute ID values.
Currently, only one value is defined. However, the number of app attributes might increase. Therefore, they are stored in an enumeration.
Enumerator |
---|
BLE_ANCS_APP_ATTR_ID_DISPLAY_NAME |
Command used to get the display name for an app identifier.
|
Category IDs for iOS notifications.
Enumerator |
---|
BLE_ANCS_CATEGORY_ID_OTHER |
The iOS notification belongs to the "other" category.
|
BLE_ANCS_CATEGORY_ID_INCOMING_CALL |
The iOS notification belongs to the "Incoming Call" category.
|
BLE_ANCS_CATEGORY_ID_MISSED_CALL |
The iOS notification belongs to the "Missed Call" category.
|
BLE_ANCS_CATEGORY_ID_VOICE_MAIL |
The iOS notification belongs to the "Voice Mail" category.
|
BLE_ANCS_CATEGORY_ID_SOCIAL |
The iOS notification belongs to the "Social" category.
|
BLE_ANCS_CATEGORY_ID_SCHEDULE |
The iOS notification belongs to the "Schedule" category.
|
BLE_ANCS_CATEGORY_ID_EMAIL |
The iOS notification belongs to the "E-mail" category.
|
BLE_ANCS_CATEGORY_ID_NEWS |
The iOS notification belongs to the "News" category.
|
BLE_ANCS_CATEGORY_ID_HEALTH_AND_FITNESS |
The iOS notification belongs to the "Health and Fitness" category.
|
BLE_ANCS_CATEGORY_ID_BUSINESS_AND_FINANCE |
The iOS notification belongs to the "Buisness and Finance" category.
|
BLE_ANCS_CATEGORY_ID_LOCATION |
The iOS notification belongs to the "Location" category.
|
BLE_ANCS_CATEGORY_ID_ENTERTAINMENT |
The iOS notification belongs to the "Entertainment" category.
|
Control point command IDs that the Notification Consumer can send to the Notification Provider.
Enumerator |
---|
BLE_ANCS_COMMAND_ID_GET_NOTIF_ATTRIBUTES |
Requests attributes to be sent from the NP to the NC for a given notification.
|
BLE_ANCS_COMMAND_ID_GET_APP_ATTRIBUTES |
Requests attributes to be sent from the NP to the NC for a given iOS app.
|
BLE_ANCS_COMMAND_ID_GET_PERFORM_NOTIF_ACTION |
Requests an action to be performed on a given notification, for example, dismiss an alarm.
|
Event IDs for iOS notifications.
Enumerator |
---|
BLE_ANCS_EVENT_ID_NOTIFICATION_ADDED |
The iOS notification was added.
|
BLE_ANCS_EVENT_ID_NOTIFICATION_MODIFIED |
The iOS notification was modified.
|
BLE_ANCS_EVENT_ID_NOTIFICATION_REMOVED |
The iOS notification was removed.
|
Event types that are passed from client to application on an event.
Enumerator |
---|
BLE_ANCS_C_EVT_DISCOVERY_COMPLETE |
A successful connection has been established and the service was found on the connected peer.
|
BLE_ANCS_C_EVT_DISCOVERY_FAILED |
It was not possible to discover the service or characteristics of the connected peer.
|
BLE_ANCS_C_EVT_NOTIF |
An iOS notification was received on the notification source control point.
|
BLE_ANCS_C_EVT_INVALID_NOTIF |
An iOS notification was received on the notification source control point, but the format is invalid.
|
BLE_ANCS_C_EVT_NOTIF_ATTRIBUTE |
A received iOS notification attribute has been parsed.
|
BLE_ANCS_C_EVT_APP_ATTRIBUTE |
An iOS app attribute has been parsed.
|
BLE_ANCS_C_EVT_NP_ERROR |
An error has been sent on the ANCS Control Point from the iOS Notification Provider.
|
IDs for iOS notification attributes.
Enumerator |
---|
BLE_ANCS_NOTIF_ATTR_ID_APP_IDENTIFIER |
Identifies that the attribute data is of an "App Identifier" type.
|
BLE_ANCS_NOTIF_ATTR_ID_TITLE |
Identifies that the attribute data is a "Title".
|
BLE_ANCS_NOTIF_ATTR_ID_SUBTITLE |
Identifies that the attribute data is a "Subtitle".
|
BLE_ANCS_NOTIF_ATTR_ID_MESSAGE |
Identifies that the attribute data is a "Message".
|
BLE_ANCS_NOTIF_ATTR_ID_MESSAGE_SIZE |
Identifies that the attribute data is a "Message Size".
|
BLE_ANCS_NOTIF_ATTR_ID_DATE |
Identifies that the attribute data is a "Date".
|
BLE_ANCS_NOTIF_ATTR_ID_POSITIVE_ACTION_LABEL |
The notification has a "Positive action" that can be executed associated with it.
|
BLE_ANCS_NOTIF_ATTR_ID_NEGATIVE_ACTION_LABEL |
The notification has a "Negative action" that can be executed associated with it.
|
Parsing states for received iOS notification and app attributes.
Enumerator |
---|
COMMAND_ID |
Parsing the command ID.
|
NOTIF_UID |
Parsing the notification UID.
|
APP_ID |
Parsing app ID.
|
ATTR_ID |
Parsing attribute ID.
|
ATTR_LEN1 |
Parsing the LSB of the attribute length.
|
ATTR_LEN2 |
Parsing the MSB of the attribute length.
|
ATTR_DATA |
Parsing the attribute data.
|
ATTR_SKIP |
Parsing is skipped for the rest (or entire) of an attribute.
|
DONE |
Parsing for one attribute is done.
|
ANCS request types.
Enumerator |
---|
READ_REQ |
Type identifying that this TX message is a read request.
|
WRITE_REQ |
Type identifying that this TX message is a write request.
|
READ_REQ |
Type identifying that this TX message is a read request.
|
WRITE_REQ |
Type identifying that this TX message is a write request.
|
ANCS request types.
Enumerator |
---|
READ_REQ |
Type identifying that this TX message is a read request.
|
WRITE_REQ |
Type identifying that this TX message is a write request.
|
READ_REQ |
Type identifying that this TX message is a read request.
|
WRITE_REQ |
Type identifying that this TX message is a write request.
|
uint32_t ancs_c_app_attr_request |
( |
ble_ancs_c_t * |
p_ancs, |
|
|
const uint8_t * |
app_id, |
|
|
uint32_t |
len |
|
) |
| |
Function for requesting attributes for an app.
- Parameters
-
[in] | p_ancs | iOS notification structure. This structure must be supplied by the application. It identifies the particular client instance to use. |
[in] | app_id | App identifier of the app for which to request app attributes. |
[in] | len | Length of the app identifier. |
- Return values
-
NRF_SUCCESS | If all operations were successful. Otherwise, an error code is returned. |
void ancs_parse_get_attrs_response |
( |
ble_ancs_c_t * |
p_ancs, |
|
|
const uint8_t * |
p_data_src, |
|
|
const uint16_t |
hvx_data_len |
|
) |
| |
Function for parsing notification or app attribute response data.
The data that comes from the Notification Provider can be much longer than what would fit in a single GATTC notification. Therefore, this function relies on a state-oriented switch case. UID and command ID will be received only once at the beginning of the first GATTC notification of a new attribute request for a given iOS notification. After this, we can loop several ATTR_ID > LENGTH > DATA > ATTR_ID > LENGTH > DATA until we have received all attributes we wanted as a Notification Consumer. The Notification Provider can also simply stop sending attributes.
1 byte | 4 bytes | 1 byte | 2 bytes | ... X bytes ... | 1 bytes | 2 bytes | ... X bytes ... |
CMD_ID | NOTIF_UID | ATTR_ID | LENGTH | DATA | ATTR_ID | LENGTH | DATA |
- Parameters
-
[in] | p_ancs | Pointer to an ANCS instance to which the event belongs. |
[in] | p_data_src | Pointer to data that was received from the Notification Provider. |
[in] | hvx_data_len | Length of the data that was received from the Notification Provider. |
Function for writing to the CCCD to disable data source notifications from the ANCS.
- Parameters
-
[in] | p_ancs | iOS notification structure. This structure must be supplied by the application. It identifies the particular client instance to use. |
- Return values
-
NRF_SUCCESS | If writing to the CCCD was successful. Otherwise, an error code is returned. |
Function for writing to the CCCD to enable data source notifications from the ANCS.
- Parameters
-
[in] | p_ancs | iOS notification structure. This structure must be supplied by the application. It identifies the particular client instance to use. |
- Return values
-
NRF_SUCCESS | If writing to the CCCD was successful. Otherwise, an error code is returned. |
Function for initializing the ANCS client.
- Parameters
-
[out] | p_ancs | ANCS client structure. This structure must be supplied by the application. It is initialized by this function and will later be used to identify this particular client instance. |
[in] | p_ancs_init | Information needed to initialize the client. |
- Return values
-
NRF_SUCCESS | If the client was initialized successfully. Otherwise, an error code is returned. |
Function for writing to the CCCD to disable notifications from the ANCS.
- Parameters
-
[in] | p_ancs | iOS notification structure. This structure must be supplied by the application. It identifies the particular client instance to use. |
- Return values
-
NRF_SUCCESS | If writing to the CCCD was successful. Otherwise, an error code is returned. |
Function for writing to the CCCD to enable notifications from the Apple Notification Service.
- Parameters
-
[in] | p_ancs | iOS notification structure. This structure must be supplied by the application. It identifies the particular client instance to use. |
- Return values
-
NRF_SUCCESS | If writing to the CCCD was successful. Otherwise, an error code is returned. |
void ble_ancs_c_on_ble_evt |
( |
ble_evt_t const * |
p_ble_evt, |
|
|
void * |
p_context |
|
) |
| |
Function for handling the application's BLE stack events.
Handles all events from the BLE stack that are of interest to the ANCS client.
- Parameters
-
[in] | p_ble_evt | Event received from the BLE stack. |
[in] | p_context | ANCS client structure. |
Function for handling events from the database discovery module.
This function will handle an event from the database discovery module and determine if it relates to the discovery of ANCS at the peer. If so, it will call the application's event handler indicating that ANCS has been discovered at the peer. It also populates the event with the service related information before providing it to the application.
- Parameters
-
[in] | p_ancs | Pointer to the ANCS client structure. |
[in] | p_evt | Pointer to the event received from the database discovery module. |
Function for performing a notification action.
- Parameters
-
[in] | p_ancs | iOS notification structure. This structure must be supplied by the application. It identifies the particular client instance to use. |
[in] | uuid | The UUID of the notification for which to perform the action. |
[in] | action_id | Perform a positive or negative action. |
- Return values
-
NRF_SUCCESS | If the operation was successful. |
NRF_ERROR_NULL | If p_ancs was a NULL pointer. |
Function for registering attributes that will be requested when nrf_ble_ancs_c_app_attr_request is called.
- Parameters
-
[in] | p_ancs | ANCS client instance on which the attribute will be registered. |
[in] | id | ID of the attribute that will be added. |
[in] | p_data | Pointer to a buffer where the data of the attribute can be stored. |
[in] | len | Length of the buffer where the data of the attribute can be stored. |
- Return values
-
NRF_SUCCESS | If all operations were successful. Otherwise, an error code is returned. |
Function for removing attributes so that they will no longer be requested when nrf_ble_ancs_c_app_attr_request is called.
- Parameters
-
[in] | p_ancs | ANCS client instance on which the attribute will be removed. |
[in] | id | ID of the attribute that will be removed. |
- Return values
-
NRF_SUCCESS | If all operations were successful. Otherwise, an error code is returned. |
Function for requesting attributes for a given app.
- Parameters
-
[in] | p_ancs | iOS notification structure. This structure must be supplied by the application. It identifies the particular client instance to use. |
[in] | p_app_id | App identifier of the app for which the app attributes are requested. |
[in] | len | Length of the app identifier. |
- Return values
-
NRF_SUCCESS | If all operations were successful. Otherwise, an error code is returned. |
Function for registering attributes that will be requested when nrf_ble_ancs_c_request_attrs is called.
- Parameters
-
[in] | p_ancs | ANCS client instance on which the attribute will be registered. |
[in] | id | ID of the attribute that will be added. |
[in] | p_data | Pointer to a buffer where the data of the attribute can be stored. |
[in] | len | Length of the buffer where the data of the attribute can be stored. |
- Return values
-
NRF_SUCCESS | If all operations were successful. Otherwise, an error code is returned. |
Function for removing attributes so that they will no longer be requested when nrf_ble_ancs_c_request_attrs is called.
- Parameters
-
[in] | p_ancs | ANCS client instance on which the attribute will be removed. |
[in] | id | ID of the attribute that will be removed. |
- Return values
-
NRF_SUCCESS | If all operations were successful. Otherwise, an error code is returned. |
Function for clearing the list of notification attributes and app attributes that would be requested from NP.
- Parameters
-
[in] | p_ancs | iOS notification structure. This structure must be supplied by the application. It identifies the particular client instance to use. |
Function for assigning a handle to this instance of ancs_c.
Call this function when a link has been established with a peer to associate this link to this instance of the module. This makes it possible to handle several link and associate each link to a particular instance of this module. The connection handle and attribute handles will be provided from the discovery event BLE_ANCS_C_EVT_DISCOVERY_COMPLETE.
- Parameters
-
[in] | p_ancs | Pointer to the ANCS client structure instance to associate with these handles. |
[in] | conn_handle | Connection handle to associate with the given ANCS instance. |
[in] | p_service | Attribute handles on the ANCS server that you want this ANCS client to interact with. |
- Return values
-
NRF_SUCCESS | If the operation was successful. |
NRF_ERROR_NULL | If p_ancs was a NULL pointer. |
Function for requesting attributes for a notification.
- Parameters
-
[in] | p_ancs | iOS notification structure. This structure must be supplied by the application. It identifies the particular client instance to use. |
[in] | p_notif | Pointer to the notification whose attributes will be requested from the Notification Provider. |
- Return values
-
NRF_SUCCESS | If all operations were successful. Otherwise, an error code is returned. |
void tx_buffer_init |
( |
void |
| ) |
|
Function for clearing the TX buffer.
Always call this function before using the TX buffer.
Apple Notification Center Service UUIDs.
Service UUID.