ancs_client.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef BT_ANCS_CLIENT_H_
#define BT_ANCS_CLIENT_H_
 
#include <zephyr/bluetooth/gatt.h>
#include <zephyr/bluetooth/conn.h>
#include <bluetooth/gatt_dm.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define BT_UUID_ANCS_VAL                                                      \
        BT_UUID_128_ENCODE(0x7905f431, 0xb5ce, 0x4e99, 0xa40f, 0x4b1e122d00d0)
 
#define BT_UUID_ANCS_NOTIFICATION_SOURCE_VAL                                     \
        BT_UUID_128_ENCODE(0x9fbf120d, 0x6301, 0x42d9, 0x8c58, 0x25e699a21dbd)
 
#define BT_UUID_ANCS_CONTROL_POINT_VAL                                           \
        BT_UUID_128_ENCODE(0x69d1d8f3, 0x45e1, 0x49a8, 0x9821, 0x9bbdfdaad9d9)
 
#define BT_UUID_ANCS_DATA_SOURCE_VAL                                             \
        BT_UUID_128_ENCODE(0x22eac6e9, 0x24d6, 0x4bb5, 0xbe44, 0xb36ace7c7bfb)
 
#define BT_UUID_ANCS BT_UUID_DECLARE_128(BT_UUID_ANCS_VAL)
#define BT_UUID_ANCS_NOTIFICATION_SOURCE                                       \
        BT_UUID_DECLARE_128(BT_UUID_ANCS_NOTIFICATION_SOURCE_VAL)
#define BT_UUID_ANCS_CONTROL_POINT                                             \
        BT_UUID_DECLARE_128(BT_UUID_ANCS_CONTROL_POINT_VAL)
#define BT_UUID_ANCS_DATA_SOURCE BT_UUID_DECLARE_128(BT_UUID_ANCS_DATA_SOURCE_VAL)
 
#define BT_ANCS_ATTR_DATA_MAX 32
#define BT_ANCS_CATEGORY_ID_COUNT 12
#define BT_ANCS_NOTIF_ATTR_COUNT 8
#define BT_ANCS_APP_ATTR_COUNT 1
#define BT_ANCS_EVT_ID_COUNT 3
 
#define BT_ANCS_NOTIF_DATA_LENGTH 8
 
#define BT_ANCS_EVENT_FLAG_SILENT 0
#define BT_ANCS_EVENT_FLAG_IMPORTANT 1
#define BT_ANCS_EVENT_FLAG_PREEXISTING 2
#define BT_ANCS_EVENT_FLAG_POSITIVE_ACTION 3
#define BT_ANCS_EVENT_FLAG_NEGATIVE_ACTION 4
 
#define BT_ATT_ERR_ANCS_NP_UNKNOWN_COMMAND 0xA0
#define BT_ATT_ERR_ANCS_NP_INVALID_COMMAND 0xA1
#define BT_ATT_ERR_ANCS_NP_INVALID_PARAMETER 0xA2
#define BT_ATT_ERR_ANCS_NP_ACTION_FAILED 0xA3
enum bt_ancs_category_id_val {
        BT_ANCS_CATEGORY_ID_OTHER,
        BT_ANCS_CATEGORY_ID_INCOMING_CALL,
        BT_ANCS_CATEGORY_ID_MISSED_CALL,
        BT_ANCS_CATEGORY_ID_VOICE_MAIL,
        BT_ANCS_CATEGORY_ID_SOCIAL,
        BT_ANCS_CATEGORY_ID_SCHEDULE,
        BT_ANCS_CATEGORY_ID_EMAIL,
        BT_ANCS_CATEGORY_ID_NEWS,
        BT_ANCS_CATEGORY_ID_HEALTH_AND_FITNESS,
        BT_ANCS_CATEGORY_ID_BUSINESS_AND_FINANCE,
        BT_ANCS_CATEGORY_ID_LOCATION,
        BT_ANCS_CATEGORY_ID_ENTERTAINMENT
};
 
enum bt_ancs_evt_id_values {
        BT_ANCS_EVENT_ID_NOTIFICATION_ADDED,
        BT_ANCS_EVENT_ID_NOTIFICATION_MODIFIED,
        BT_ANCS_EVENT_ID_NOTIFICATION_REMOVED
};
 
enum bt_ancs_cmd_id_val {
        BT_ANCS_COMMAND_ID_GET_NOTIF_ATTRIBUTES,
        BT_ANCS_COMMAND_ID_GET_APP_ATTRIBUTES,
        BT_ANCS_COMMAND_ID_PERFORM_NOTIF_ACTION
};
 
enum bt_ancs_action_id_values {
        BT_ANCS_ACTION_ID_POSITIVE = 0,
        BT_ANCS_ACTION_ID_NEGATIVE
};
 
enum bt_ancs_app_attr_id_val {
        BT_ANCS_APP_ATTR_ID_DISPLAY_NAME = 0
};
 
enum bt_ancs_notif_attr_id_val {
        BT_ANCS_NOTIF_ATTR_ID_APP_IDENTIFIER = 0,
        BT_ANCS_NOTIF_ATTR_ID_TITLE,
        BT_ANCS_NOTIF_ATTR_ID_SUBTITLE,
        BT_ANCS_NOTIF_ATTR_ID_MESSAGE,
        BT_ANCS_NOTIF_ATTR_ID_MESSAGE_SIZE,
        BT_ANCS_NOTIF_ATTR_ID_DATE,
        BT_ANCS_NOTIF_ATTR_ID_POSITIVE_ACTION_LABEL,
        BT_ANCS_NOTIF_ATTR_ID_NEGATIVE_ACTION_LABEL
};
 
struct bt_ancs_notif_flags {
        uint8_t silent : 1;
        uint8_t important : 1;
        uint8_t pre_existing : 1;
        uint8_t positive_action : 1;
        uint8_t negative_action : 1;
};
 
enum bt_ancs_parse_state {
        BT_ANCS_PARSE_STATE_COMMAND_ID,
        BT_ANCS_PARSE_STATE_NOTIF_UID,
        BT_ANCS_PARSE_STATE_APP_ID,
        BT_ANCS_PARSE_STATE_ATTR_ID,
        BT_ANCS_PARSE_STATE_ATTR_LEN1,
        BT_ANCS_PARSE_STATE_ATTR_LEN2,
        BT_ANCS_PARSE_STATE_ATTR_DATA,
        BT_ANCS_PARSE_STATE_ATTR_SKIP,
        BT_ANCS_PARSE_STATE_DONE
};
 
struct bt_ancs_evt_notif {
        uint32_t notif_uid;
        enum bt_ancs_evt_id_values evt_id;
        struct bt_ancs_notif_flags evt_flags;
        enum bt_ancs_category_id_val category_id;
        uint8_t category_count;
};
 
struct bt_ancs_attr {
        uint16_t attr_len;
        uint32_t attr_id;
        uint8_t *attr_data;
};
 
struct bt_ancs_attr_list {
        bool get;
        uint32_t attr_id;
        uint16_t attr_len;
        uint8_t *attr_data;
};
 
struct bt_ancs_client;
 
struct bt_ancs_attr_response {
        enum bt_ancs_cmd_id_val command_id;
        struct bt_ancs_attr attr;
        uint32_t notif_uid;
        uint8_t app_id[BT_ANCS_ATTR_DATA_MAX];
};
 
typedef void (*bt_ancs_ns_notif_cb)(struct bt_ancs_client *ancs_c, int err,
                                    const struct bt_ancs_evt_notif *notif);
 
typedef void (*bt_ancs_ds_notif_cb)(struct bt_ancs_client *ancs_c,
                                    const struct bt_ancs_attr_response *response);
 
typedef void (*bt_ancs_write_cb)(struct bt_ancs_client *ancs_c,
                                 uint8_t err);
 
struct bt_ancs_parse_sm {
        struct bt_ancs_attr_list *attr_list;
        uint32_t attr_count;
        uint32_t expected_number_of_attrs;
        enum bt_ancs_parse_state parse_state;
        enum bt_ancs_cmd_id_val command_id;
        uint8_t *data_dest;
        uint16_t current_attr_index;
        uint32_t current_app_id_index;
};
 
struct bt_ancs_client {
        struct bt_conn *conn;
 
        atomic_t state;
 
        uint16_t handle_cp;
 
        uint16_t handle_ns;
 
        uint16_t handle_ns_ccc;
 
        uint16_t handle_ds;
 
        uint16_t handle_ds_ccc;
 
        struct bt_gatt_write_params cp_write_params;
 
        bt_ancs_write_cb cp_write_cb;
 
        uint8_t cp_data[CONFIG_BT_ANCS_CLIENT_CP_BUFF_SIZE];
 
        struct bt_gatt_subscribe_params ns_notif_params;
 
        bt_ancs_ns_notif_cb ns_notif_cb;
 
        struct bt_gatt_subscribe_params ds_notif_params;
 
        bt_ancs_ds_notif_cb ds_notif_cb;
 
        struct bt_ancs_attr_list
                ancs_notif_attr_list[BT_ANCS_NOTIF_ATTR_COUNT];
 
        struct bt_ancs_attr_list
                ancs_app_attr_list[BT_ANCS_APP_ATTR_COUNT];
 
        uint32_t number_of_requested_attr;
 
        struct bt_ancs_parse_sm parse_info;
 
        struct bt_ancs_attr_response attr_response;
};
 
int bt_ancs_client_init(struct bt_ancs_client *ancs_c);
 
int bt_ancs_subscribe_notification_source(struct bt_ancs_client *ancs_c,
                                          bt_ancs_ns_notif_cb func);
 
int bt_ancs_subscribe_data_source(struct bt_ancs_client *ancs_c,
                                  bt_ancs_ds_notif_cb func);
 
int bt_ancs_unsubscribe_notification_source(struct bt_ancs_client *ancs_c);
 
int bt_ancs_unsubscribe_data_source(struct bt_ancs_client *ancs_c);
 
int bt_ancs_register_attr(struct bt_ancs_client *ancs_c,
                          const enum bt_ancs_notif_attr_id_val id,
                          uint8_t *data, const uint16_t len);
 
int bt_ancs_register_app_attr(struct bt_ancs_client *ancs_c,
                              const enum bt_ancs_app_attr_id_val id,
                              uint8_t *data, const uint16_t len);
 
int bt_ancs_request_attrs(struct bt_ancs_client *ancs_c,
                          const struct bt_ancs_evt_notif *notif,
                          bt_ancs_write_cb func);
 
int bt_ancs_request_app_attr(struct bt_ancs_client *ancs_c,
                             const uint8_t *app_id, uint32_t len,
                             bt_ancs_write_cb func);
 
int bt_ancs_notification_action(struct bt_ancs_client *ancs_c, uint32_t uuid,
                                enum bt_ancs_action_id_values action_id,
                                bt_ancs_write_cb func);
 
int bt_ancs_handles_assign(struct bt_gatt_dm *dm,
                           struct bt_ancs_client *ancs_c);
 
#ifdef __cplusplus
}
#endif
 
#endif /* BT_ANCS_CLIENT_H_ */