ble_nus_client.h

/*
 * Copyright (c) 2012 - 2026 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef BLE_NUS_CLIENT_H__
#define BLE_NUS_CLIENT_H__
 
#include <stdint.h>
#include <bm/bluetooth/ble_common.h>
#include <bm/bluetooth/ble_db_discovery.h>
#include <bm/bluetooth/ble_gq.h>
#include <bm/softdevice_handler/nrf_sdh_ble.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define BLE_NUS_CLIENT_DEF(_name)                                                                  \
        static struct ble_nus_client _name;                                                        \
        NRF_SDH_BLE_OBSERVER(_name##_obs, ble_nus_client_on_ble_evt, &_name, HIGH)
 
#define BLE_NUS_UUID_BASE { 0x9E, 0xCA, 0xDC, 0x24, 0x0E, 0xE5, 0xA9, 0xE0,                        \
                            0x93, 0xF3, 0xA3, 0xB5, 0x00, 0x00, 0x40, 0x6E }
 
#define BLE_UUID_NUS_SERVICE 0x0001
#define BLE_UUID_NUS_RX_CHARACTERISTIC 0x0002
#define BLE_UUID_NUS_TX_CHARACTERISTIC 0x0003
 
#define BLE_NUS_CLIENT_MAX_DATA_LEN_CALC(mtu_size) ((mtu_size) - ATT_OPCODE_LEN - ATT_HANDLE_LEN)
 
#ifndef BLE_NUS_CLIENT_MAX_DATA_LEN
#define BLE_NUS_CLIENT_MAX_DATA_LEN                                                                \
        (BLE_NUS_CLIENT_MAX_DATA_LEN_CALC(CONFIG_NRF_SDH_BLE_GATT_MAX_MTU_SIZE))
#endif
 
enum ble_nus_client_evt_type {
        BLE_NUS_CLIENT_EVT_DISCOVERY_COMPLETE,
        BLE_NUS_CLIENT_EVT_TX_DATA,
        BLE_NUS_CLIENT_EVT_DISCONNECTED,
        BLE_NUS_CLIENT_EVT_ERROR
};
 
struct ble_nus_client_handles {
        uint16_t nus_tx_handle;
        uint16_t nus_tx_cccd_handle;
        uint16_t nus_rx_handle;
};
 
struct ble_nus_client_evt {
        enum ble_nus_client_evt_type evt_type;
        uint16_t conn_handle;
        union {
                struct {
                        struct ble_nus_client_handles handles;
                } discovery_complete;
                struct {
                        uint8_t *data;
                        uint16_t length;
                } tx_data;
                struct {
                        uint32_t reason;
                } disconnected;
                struct {
                        uint32_t reason;
                } error;
        };
};
 
/* Forward declaration of the ble_nus_client type. */
struct ble_nus_client;
 
typedef void (*ble_nus_client_evt_handler_t)(struct ble_nus_client *ble_nus_c,
                                             const struct ble_nus_client_evt *evt);
 
/*
 * @brief Nordic UART Service Client configuration structure.
 *
 * @details This structure contains the initialization information for the service. The application
 *          must fill this structure and pass it to the service using the @ref ble_nus_client_init
 *          function.
 */
struct ble_nus_client_config {
        ble_nus_client_evt_handler_t evt_handler;
        const struct ble_gq *gatt_queue;
        struct ble_db_discovery *db_discovery;
};
 
struct ble_nus_client {
        uint8_t uuid_type;
        uint16_t conn_handle;
        struct ble_nus_client_handles handles;
        ble_nus_client_evt_handler_t evt_handler;
        const struct ble_gq *gatt_queue;
};
 
uint32_t ble_nus_client_init(struct ble_nus_client *nus_client,
                             const struct ble_nus_client_config *nus_client_config);
 
void ble_nus_client_on_db_disc_evt(struct ble_nus_client *nus_client,
                                   const struct ble_db_discovery_evt *evt);
 
void ble_nus_client_on_ble_evt(const ble_evt_t *ble_evt, void *ble_nus_client);
 
uint32_t ble_nus_client_tx_notif_enable(struct ble_nus_client *nus_client);
 
uint32_t ble_nus_client_tx_notif_disable(struct ble_nus_client *nus_client);
 
uint32_t ble_nus_client_string_send(struct ble_nus_client *nus_client, const uint8_t *string,
                                    uint16_t length);
 
uint32_t ble_nus_client_handles_assign(struct ble_nus_client *nus_client, uint16_t conn_handle,
                                      const struct ble_nus_client_handles *peer_handles);
 
#ifdef __cplusplus
}
#endif
 
#endif