初始版本
This commit is contained in:
322
components/ble/ble_services/ble_lbs_c/ble_lbs_c.c
Normal file
322
components/ble/ble_services/ble_lbs_c/ble_lbs_c.c
Normal file
@@ -0,0 +1,322 @@
|
||||
/**
|
||||
* Copyright (c) 2012 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
#include "sdk_common.h"
|
||||
#if NRF_MODULE_ENABLED(BLE_LBS_C)
|
||||
|
||||
#include "ble_lbs_c.h"
|
||||
#include "ble_db_discovery.h"
|
||||
#include "ble_types.h"
|
||||
#include "ble_gattc.h"
|
||||
#define NRF_LOG_MODULE_NAME ble_lbs_c
|
||||
#include "nrf_log.h"
|
||||
NRF_LOG_MODULE_REGISTER();
|
||||
|
||||
#define WRITE_MESSAGE_LENGTH BLE_CCCD_VALUE_LEN /**< Length of the write message for CCCD. */
|
||||
|
||||
|
||||
/**@brief Function for intercepting the errors of GATTC and the BLE GATT Queue.
|
||||
*
|
||||
* @param[in] nrf_error Error code.
|
||||
* @param[in] p_ctx Parameter from the event handler.
|
||||
* @param[in] conn_handle Connection handle.
|
||||
*/
|
||||
static void gatt_error_handler(uint32_t nrf_error,
|
||||
void * p_ctx,
|
||||
uint16_t conn_handle)
|
||||
{
|
||||
ble_lbs_c_t * p_ble_lbs_c = (ble_lbs_c_t *)p_ctx;
|
||||
|
||||
NRF_LOG_DEBUG("A GATT Client error has occurred on conn_handle: 0X%X", conn_handle);
|
||||
|
||||
if (p_ble_lbs_c->error_handler != NULL)
|
||||
{
|
||||
p_ble_lbs_c->error_handler(nrf_error);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**@brief Function for handling Handle Value Notification received from the SoftDevice.
|
||||
*
|
||||
* @details This function uses the Handle Value Notification received from the SoftDevice
|
||||
* and checks whether it is a notification of Button state from the peer. If
|
||||
* it is, this function decodes the state of the button and sends it to the
|
||||
* application.
|
||||
*
|
||||
* @param[in] p_ble_lbs_c Pointer to the Led Button Client structure.
|
||||
* @param[in] p_ble_evt Pointer to the BLE event received.
|
||||
*/
|
||||
static void on_hvx(ble_lbs_c_t * p_ble_lbs_c, ble_evt_t const * p_ble_evt)
|
||||
{
|
||||
// Check if the event is on the link for this instance.
|
||||
if (p_ble_lbs_c->conn_handle != p_ble_evt->evt.gattc_evt.conn_handle)
|
||||
{
|
||||
return;
|
||||
}
|
||||
// Check if this is a Button notification.
|
||||
if (p_ble_evt->evt.gattc_evt.params.hvx.handle == p_ble_lbs_c->peer_lbs_db.button_handle)
|
||||
{
|
||||
if (p_ble_evt->evt.gattc_evt.params.hvx.len == 1)
|
||||
{
|
||||
ble_lbs_c_evt_t ble_lbs_c_evt;
|
||||
|
||||
ble_lbs_c_evt.evt_type = BLE_LBS_C_EVT_BUTTON_NOTIFICATION;
|
||||
ble_lbs_c_evt.conn_handle = p_ble_lbs_c->conn_handle;
|
||||
ble_lbs_c_evt.params.button.button_state = p_ble_evt->evt.gattc_evt.params.hvx.data[0];
|
||||
p_ble_lbs_c->evt_handler(p_ble_lbs_c, &ble_lbs_c_evt);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**@brief Function for handling the Disconnected event received from the SoftDevice.
|
||||
*
|
||||
* @details This function checks whether the disconnect event is happening on the link
|
||||
* associated with the current instance of the module. If the event is happening, the function sets the instance's
|
||||
* conn_handle to invalid.
|
||||
*
|
||||
* @param[in] p_ble_lbs_c Pointer to the Led Button Client structure.
|
||||
* @param[in] p_ble_evt Pointer to the BLE event received.
|
||||
*/
|
||||
static void on_disconnected(ble_lbs_c_t * p_ble_lbs_c, ble_evt_t const * p_ble_evt)
|
||||
{
|
||||
if (p_ble_lbs_c->conn_handle == p_ble_evt->evt.gap_evt.conn_handle)
|
||||
{
|
||||
p_ble_lbs_c->conn_handle = BLE_CONN_HANDLE_INVALID;
|
||||
p_ble_lbs_c->peer_lbs_db.button_cccd_handle = BLE_GATT_HANDLE_INVALID;
|
||||
p_ble_lbs_c->peer_lbs_db.button_handle = BLE_GATT_HANDLE_INVALID;
|
||||
p_ble_lbs_c->peer_lbs_db.led_handle = BLE_GATT_HANDLE_INVALID;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void ble_lbs_on_db_disc_evt(ble_lbs_c_t * p_ble_lbs_c, ble_db_discovery_evt_t const * p_evt)
|
||||
{
|
||||
// Check if the LED Button Service was discovered.
|
||||
if (p_evt->evt_type == BLE_DB_DISCOVERY_COMPLETE &&
|
||||
p_evt->params.discovered_db.srv_uuid.uuid == LBS_UUID_SERVICE &&
|
||||
p_evt->params.discovered_db.srv_uuid.type == p_ble_lbs_c->uuid_type)
|
||||
{
|
||||
ble_lbs_c_evt_t evt;
|
||||
|
||||
evt.evt_type = BLE_LBS_C_EVT_DISCOVERY_COMPLETE;
|
||||
evt.conn_handle = p_evt->conn_handle;
|
||||
|
||||
for (uint32_t i = 0; i < p_evt->params.discovered_db.char_count; i++)
|
||||
{
|
||||
const ble_gatt_db_char_t * p_char = &(p_evt->params.discovered_db.charateristics[i]);
|
||||
switch (p_char->characteristic.uuid.uuid)
|
||||
{
|
||||
case LBS_UUID_LED_CHAR:
|
||||
evt.params.peer_db.led_handle = p_char->characteristic.handle_value;
|
||||
break;
|
||||
case LBS_UUID_BUTTON_CHAR:
|
||||
evt.params.peer_db.button_handle = p_char->characteristic.handle_value;
|
||||
evt.params.peer_db.button_cccd_handle = p_char->cccd_handle;
|
||||
break;
|
||||
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
NRF_LOG_DEBUG("LED Button Service discovered at peer.");
|
||||
//If the instance was assigned prior to db_discovery, assign the db_handles
|
||||
if (p_ble_lbs_c->conn_handle != BLE_CONN_HANDLE_INVALID)
|
||||
{
|
||||
if ((p_ble_lbs_c->peer_lbs_db.led_handle == BLE_GATT_HANDLE_INVALID)&&
|
||||
(p_ble_lbs_c->peer_lbs_db.button_handle == BLE_GATT_HANDLE_INVALID)&&
|
||||
(p_ble_lbs_c->peer_lbs_db.button_cccd_handle == BLE_GATT_HANDLE_INVALID))
|
||||
{
|
||||
p_ble_lbs_c->peer_lbs_db = evt.params.peer_db;
|
||||
}
|
||||
}
|
||||
|
||||
p_ble_lbs_c->evt_handler(p_ble_lbs_c, &evt);
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
uint32_t ble_lbs_c_init(ble_lbs_c_t * p_ble_lbs_c, ble_lbs_c_init_t * p_ble_lbs_c_init)
|
||||
{
|
||||
uint32_t err_code;
|
||||
ble_uuid_t lbs_uuid;
|
||||
ble_uuid128_t lbs_base_uuid = {LBS_UUID_BASE};
|
||||
|
||||
VERIFY_PARAM_NOT_NULL(p_ble_lbs_c);
|
||||
VERIFY_PARAM_NOT_NULL(p_ble_lbs_c_init);
|
||||
VERIFY_PARAM_NOT_NULL(p_ble_lbs_c_init->evt_handler);
|
||||
VERIFY_PARAM_NOT_NULL(p_ble_lbs_c_init->p_gatt_queue);
|
||||
|
||||
p_ble_lbs_c->peer_lbs_db.button_cccd_handle = BLE_GATT_HANDLE_INVALID;
|
||||
p_ble_lbs_c->peer_lbs_db.button_handle = BLE_GATT_HANDLE_INVALID;
|
||||
p_ble_lbs_c->peer_lbs_db.led_handle = BLE_GATT_HANDLE_INVALID;
|
||||
p_ble_lbs_c->conn_handle = BLE_CONN_HANDLE_INVALID;
|
||||
p_ble_lbs_c->evt_handler = p_ble_lbs_c_init->evt_handler;
|
||||
p_ble_lbs_c->p_gatt_queue = p_ble_lbs_c_init->p_gatt_queue;
|
||||
p_ble_lbs_c->error_handler = p_ble_lbs_c_init->error_handler;
|
||||
|
||||
err_code = sd_ble_uuid_vs_add(&lbs_base_uuid, &p_ble_lbs_c->uuid_type);
|
||||
if (err_code != NRF_SUCCESS)
|
||||
{
|
||||
return err_code;
|
||||
}
|
||||
VERIFY_SUCCESS(err_code);
|
||||
|
||||
lbs_uuid.type = p_ble_lbs_c->uuid_type;
|
||||
lbs_uuid.uuid = LBS_UUID_SERVICE;
|
||||
|
||||
return ble_db_discovery_evt_register(&lbs_uuid);
|
||||
}
|
||||
|
||||
void ble_lbs_c_on_ble_evt(ble_evt_t const * p_ble_evt, void * p_context)
|
||||
{
|
||||
if ((p_context == NULL) || (p_ble_evt == NULL))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
ble_lbs_c_t * p_ble_lbs_c = (ble_lbs_c_t *)p_context;
|
||||
|
||||
switch (p_ble_evt->header.evt_id)
|
||||
{
|
||||
case BLE_GATTC_EVT_HVX:
|
||||
on_hvx(p_ble_lbs_c, p_ble_evt);
|
||||
break;
|
||||
|
||||
case BLE_GAP_EVT_DISCONNECTED:
|
||||
on_disconnected(p_ble_lbs_c, p_ble_evt);
|
||||
break;
|
||||
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**@brief Function for configuring the CCCD.
|
||||
*
|
||||
* @param[in] p_ble_lbs_c Pointer to the LED Button Client structure.
|
||||
* @param[in] enable Whether to enable or disable the CCCD.
|
||||
*
|
||||
* @return NRF_SUCCESS if the CCCD configure was successfully sent to the peer.
|
||||
*/
|
||||
static uint32_t cccd_configure(ble_lbs_c_t * p_ble_lbs_c, bool enable)
|
||||
{
|
||||
NRF_LOG_DEBUG("Configuring CCCD. CCCD Handle = %d, Connection Handle = %d",
|
||||
p_ble_lbs_c->peer_lbs_db.button_cccd_handle,
|
||||
p_ble_lbs_c->conn_handle);
|
||||
|
||||
nrf_ble_gq_req_t cccd_req;
|
||||
uint16_t cccd_val = enable ? BLE_GATT_HVX_NOTIFICATION : 0;
|
||||
uint8_t cccd[WRITE_MESSAGE_LENGTH];
|
||||
|
||||
cccd[0] = LSB_16(cccd_val);
|
||||
cccd[1] = MSB_16(cccd_val);
|
||||
|
||||
cccd_req.type = NRF_BLE_GQ_REQ_GATTC_WRITE;
|
||||
cccd_req.error_handler.cb = gatt_error_handler;
|
||||
cccd_req.error_handler.p_ctx = p_ble_lbs_c;
|
||||
cccd_req.params.gattc_write.handle = p_ble_lbs_c->peer_lbs_db.button_cccd_handle;
|
||||
cccd_req.params.gattc_write.len = WRITE_MESSAGE_LENGTH;
|
||||
cccd_req.params.gattc_write.offset = 0;
|
||||
cccd_req.params.gattc_write.p_value = cccd;
|
||||
cccd_req.params.gattc_write.write_op = BLE_GATT_OP_WRITE_REQ;
|
||||
|
||||
return nrf_ble_gq_item_add(p_ble_lbs_c->p_gatt_queue, &cccd_req, p_ble_lbs_c->conn_handle);
|
||||
}
|
||||
|
||||
|
||||
uint32_t ble_lbs_c_button_notif_enable(ble_lbs_c_t * p_ble_lbs_c)
|
||||
{
|
||||
VERIFY_PARAM_NOT_NULL(p_ble_lbs_c);
|
||||
|
||||
if (p_ble_lbs_c->conn_handle == BLE_CONN_HANDLE_INVALID)
|
||||
{
|
||||
return NRF_ERROR_INVALID_STATE;
|
||||
}
|
||||
|
||||
return cccd_configure(p_ble_lbs_c,
|
||||
true);
|
||||
}
|
||||
|
||||
|
||||
uint32_t ble_lbs_led_status_send(ble_lbs_c_t * p_ble_lbs_c, uint8_t status)
|
||||
{
|
||||
VERIFY_PARAM_NOT_NULL(p_ble_lbs_c);
|
||||
|
||||
if (p_ble_lbs_c->conn_handle == BLE_CONN_HANDLE_INVALID)
|
||||
{
|
||||
return NRF_ERROR_INVALID_STATE;
|
||||
}
|
||||
|
||||
NRF_LOG_DEBUG("Writing LED status 0x%x", status);
|
||||
|
||||
nrf_ble_gq_req_t write_req;
|
||||
|
||||
memset(&write_req, 0, sizeof(nrf_ble_gq_req_t));
|
||||
|
||||
write_req.type = NRF_BLE_GQ_REQ_GATTC_WRITE;
|
||||
write_req.error_handler.cb = gatt_error_handler;
|
||||
write_req.error_handler.p_ctx = p_ble_lbs_c;
|
||||
write_req.params.gattc_write.handle = p_ble_lbs_c->peer_lbs_db.led_handle;
|
||||
write_req.params.gattc_write.len = sizeof(status);
|
||||
write_req.params.gattc_write.p_value = &status;
|
||||
write_req.params.gattc_write.offset = 0;
|
||||
write_req.params.gattc_write.write_op = BLE_GATT_OP_WRITE_CMD;
|
||||
|
||||
return nrf_ble_gq_item_add(p_ble_lbs_c->p_gatt_queue, &write_req, p_ble_lbs_c->conn_handle);
|
||||
}
|
||||
|
||||
uint32_t ble_lbs_c_handles_assign(ble_lbs_c_t * p_ble_lbs_c,
|
||||
uint16_t conn_handle,
|
||||
const lbs_db_t * p_peer_handles)
|
||||
{
|
||||
VERIFY_PARAM_NOT_NULL(p_ble_lbs_c);
|
||||
|
||||
p_ble_lbs_c->conn_handle = conn_handle;
|
||||
if (p_peer_handles != NULL)
|
||||
{
|
||||
p_ble_lbs_c->peer_lbs_db = *p_peer_handles;
|
||||
}
|
||||
return nrf_ble_gq_conn_handle_register(p_ble_lbs_c->p_gatt_queue, conn_handle);
|
||||
}
|
||||
|
||||
#endif // NRF_MODULE_ENABLED(BLE_LBS_C)
|
||||
266
components/ble/ble_services/ble_lbs_c/ble_lbs_c.h
Normal file
266
components/ble/ble_services/ble_lbs_c/ble_lbs_c.h
Normal file
@@ -0,0 +1,266 @@
|
||||
/**
|
||||
* Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
/**@file
|
||||
*
|
||||
* @defgroup ble_lbs_c LED Button Service Client
|
||||
* @{
|
||||
* @ingroup ble_sdk_srv
|
||||
* @brief The LED Button Service client can be used to set up a LED and read a button state on a
|
||||
* LED button service server.
|
||||
*
|
||||
* @details This module contains the APIs and types exposed by the LED Button Service Client
|
||||
* module. The application can use these APIs and types to perform the discovery of
|
||||
* LED Button Service at the peer and to interact with it.
|
||||
*
|
||||
* @note The application must register this module as the BLE event observer by using the
|
||||
* NRF_SDH_BLE_OBSERVER macro. Example:
|
||||
* @code
|
||||
* ble_lbs_c_t instance;
|
||||
* NRF_SDH_BLE_OBSERVER(anything, BLE_LBS_C_BLE_OBSERVER_PRIO,
|
||||
* ble_lbs_c_on_ble_evt, &instance);
|
||||
* @endcode
|
||||
*/
|
||||
|
||||
#ifndef BLE_LBS_C_H__
|
||||
#define BLE_LBS_C_H__
|
||||
|
||||
#include <stdint.h>
|
||||
#include "ble.h"
|
||||
#include "ble_db_discovery.h"
|
||||
#include "ble_srv_common.h"
|
||||
#include "nrf_ble_gq.h"
|
||||
#include "nrf_sdh_ble.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**@brief Macro for defining a ble_lbs_c instance.
|
||||
*
|
||||
* @param _name Name of the instance.
|
||||
* @hideinitializer
|
||||
*/
|
||||
#define BLE_LBS_C_DEF(_name) \
|
||||
static ble_lbs_c_t _name; \
|
||||
NRF_SDH_BLE_OBSERVER(_name ## _obs, \
|
||||
BLE_LBS_C_BLE_OBSERVER_PRIO, \
|
||||
ble_lbs_c_on_ble_evt, &_name)
|
||||
|
||||
/**@brief Macro for defining multiple ble_lbs_c instances.
|
||||
*
|
||||
* @param _name Name of the array of instances.
|
||||
* @param _cnt Number of instances to define.
|
||||
*/
|
||||
#define BLE_LBS_C_ARRAY_DEF(_name, _cnt) \
|
||||
static ble_lbs_c_t _name[_cnt]; \
|
||||
NRF_SDH_BLE_OBSERVERS(_name ## _obs, \
|
||||
BLE_LBS_C_BLE_OBSERVER_PRIO, \
|
||||
ble_lbs_c_on_ble_evt, &_name, _cnt)
|
||||
|
||||
|
||||
#define LBS_UUID_BASE {0x23, 0xD1, 0xBC, 0xEA, 0x5F, 0x78, 0x23, 0x15, \
|
||||
0xDE, 0xEF, 0x12, 0x12, 0x00, 0x00, 0x00, 0x00}
|
||||
#define LBS_UUID_SERVICE 0x1523
|
||||
#define LBS_UUID_BUTTON_CHAR 0x1524
|
||||
#define LBS_UUID_LED_CHAR 0x1525
|
||||
|
||||
/**@brief LBS Client event type. */
|
||||
typedef enum
|
||||
{
|
||||
BLE_LBS_C_EVT_DISCOVERY_COMPLETE = 1, /**< Event indicating that the LED Button Service was discovered at the peer. */
|
||||
BLE_LBS_C_EVT_BUTTON_NOTIFICATION /**< Event indicating that a notification of the LED Button Button characteristic was received from the peer. */
|
||||
} ble_lbs_c_evt_type_t;
|
||||
|
||||
/**@brief Structure containing the Button value received from the peer. */
|
||||
typedef struct
|
||||
{
|
||||
uint8_t button_state; /**< Button Value. */
|
||||
} ble_button_t;
|
||||
|
||||
/**@brief Structure containing the handles related to the LED Button Service found on the peer. */
|
||||
typedef struct
|
||||
{
|
||||
uint16_t button_cccd_handle; /**< Handle of the CCCD of the Button characteristic. */
|
||||
uint16_t button_handle; /**< Handle of the Button characteristic as provided by the SoftDevice. */
|
||||
uint16_t led_handle; /**< Handle of the LED characteristic as provided by the SoftDevice. */
|
||||
} lbs_db_t;
|
||||
|
||||
/**@brief LED Button Event structure. */
|
||||
typedef struct
|
||||
{
|
||||
ble_lbs_c_evt_type_t evt_type; /**< Type of the event. */
|
||||
uint16_t conn_handle; /**< Connection handle on which the event occured.*/
|
||||
union
|
||||
{
|
||||
ble_button_t button; /**< Button value received. This is filled if the evt_type is @ref BLE_LBS_C_EVT_BUTTON_NOTIFICATION. */
|
||||
lbs_db_t peer_db; /**< Handles related to the LED Button Service found on the peer device. This is filled if the evt_type is @ref BLE_LBS_C_EVT_DISCOVERY_COMPLETE.*/
|
||||
} params;
|
||||
} ble_lbs_c_evt_t;
|
||||
|
||||
// Forward declaration of the ble_lbs_c_t type.
|
||||
typedef struct ble_lbs_c_s ble_lbs_c_t;
|
||||
|
||||
/**@brief Event handler type.
|
||||
*
|
||||
* @details This is the type of the event handler that is to be provided by the application
|
||||
* of this module in order to receive events.
|
||||
*/
|
||||
typedef void (* ble_lbs_c_evt_handler_t) (ble_lbs_c_t * p_ble_lbs_c, ble_lbs_c_evt_t * p_evt);
|
||||
|
||||
/**@brief LED Button Client structure. */
|
||||
struct ble_lbs_c_s
|
||||
{
|
||||
uint16_t conn_handle; /**< Connection handle as provided by the SoftDevice. */
|
||||
lbs_db_t peer_lbs_db; /**< Handles related to LBS on the peer. */
|
||||
ble_lbs_c_evt_handler_t evt_handler; /**< Application event handler to be called when there is an event related to the LED Button service. */
|
||||
ble_srv_error_handler_t error_handler; /**< Function to be called in case of an error. */
|
||||
uint8_t uuid_type; /**< UUID type. */
|
||||
nrf_ble_gq_t * p_gatt_queue; /**< Pointer to the BLE GATT Queue instance. */
|
||||
};
|
||||
|
||||
/**@brief LED Button Client initialization structure. */
|
||||
typedef struct
|
||||
{
|
||||
ble_lbs_c_evt_handler_t evt_handler; /**< Event handler to be called by the LED Button Client module when there is an event related to the LED Button Service. */
|
||||
nrf_ble_gq_t * p_gatt_queue; /**< Pointer to the BLE GATT Queue instance. */
|
||||
ble_srv_error_handler_t error_handler; /**< Function to be called in case of an error. */
|
||||
} ble_lbs_c_init_t;
|
||||
|
||||
|
||||
/**@brief Function for initializing the LED Button client module.
|
||||
*
|
||||
* @details This function registers with the Database Discovery module for the
|
||||
* LED Button Service. The module looks for the presence of a LED Button Service instance
|
||||
* at the peer when a discovery is started.
|
||||
*
|
||||
* @param[in] p_ble_lbs_c Pointer to the LED Button client structure.
|
||||
* @param[in] p_ble_lbs_c_init Pointer to the LED Button initialization structure that contains the
|
||||
* initialization information.
|
||||
*
|
||||
* @retval NRF_SUCCESS On successful initialization.
|
||||
* @retval err_code Otherwise, this function propagates the error code returned by the Database Discovery module API
|
||||
* @ref ble_db_discovery_evt_register.
|
||||
*/
|
||||
uint32_t ble_lbs_c_init(ble_lbs_c_t * p_ble_lbs_c, ble_lbs_c_init_t * p_ble_lbs_c_init);
|
||||
|
||||
|
||||
/**@brief Function for handling BLE events from the SoftDevice.
|
||||
*
|
||||
* @details This function handles the BLE events received from the SoftDevice. If a BLE event
|
||||
* is relevant to the LED Button Client module, the function uses the event's data to update interval
|
||||
* variables and, if necessary, send events to the application.
|
||||
*
|
||||
* @param[in] p_ble_evt Pointer to the BLE event.
|
||||
* @param[in] p_context Pointer to the LED button client structure.
|
||||
*/
|
||||
void ble_lbs_c_on_ble_evt(ble_evt_t const * p_ble_evt, void * p_context);
|
||||
|
||||
|
||||
/**@brief Function for requesting the peer to start sending notification of the Button
|
||||
* Characteristic.
|
||||
*
|
||||
* @details This function enables to notification of the Button at the peer
|
||||
* by writing to the CCCD of the Button characteristic.
|
||||
*
|
||||
* @param[in] p_ble_lbs_c Pointer to the LED Button Client structure.
|
||||
*
|
||||
* @retval NRF_SUCCESS If the SoftDevice has been requested to write to the CCCD of the peer.
|
||||
* @retval NRF_ERROR_INVALID_STATE If no connection handle has been assigned (@ref ble_lbs_c_handles_assign).
|
||||
* @retval NRF_ERROR_NULL If the given parameter is NULL.
|
||||
* @retval err_code Otherwise, this API propagates the error code returned by function
|
||||
* @ref nrf_ble_gq_item_add.
|
||||
*/
|
||||
uint32_t ble_lbs_c_button_notif_enable(ble_lbs_c_t * p_ble_lbs_c);
|
||||
|
||||
|
||||
/**@brief Function for handling events from the Database Discovery module.
|
||||
*
|
||||
* @details Call this function when you get a callback event from the Database Discovery module. This
|
||||
* function handles an event from the Database Discovery module, and determines whether it
|
||||
* relates to the discovery of LED Button service at the peer. If it does, this function calls the
|
||||
* application's event handler to indicate that the LED Button service was discovered
|
||||
* at the peer. The function also populates the event with service-related information before
|
||||
* providing it to the application.
|
||||
*
|
||||
* @param[in] p_ble_lbs_c Pointer to the LED Button client structure.
|
||||
* @param[in] p_evt Pointer to the event received from the Database Discovery module.
|
||||
*/
|
||||
void ble_lbs_on_db_disc_evt(ble_lbs_c_t * p_ble_lbs_c, const ble_db_discovery_evt_t * p_evt);
|
||||
|
||||
|
||||
/**@brief Function for assigning handles to this instance of lbs_c.
|
||||
*
|
||||
* @details Call this function when a link has been established with a peer to associate the link
|
||||
* to this instance of the module. This makes it possible to handle several links and
|
||||
* associate each link to a particular instance of this module.
|
||||
*
|
||||
* @param[in] p_ble_lbs_c Pointer to the LED Button client structure instance for associating the link.
|
||||
* @param[in] conn_handle Connection handle to associate with the given LED Button Client Instance.
|
||||
* @param[in] p_peer_handles LED Button Service handles found on the peer (from @ref BLE_LBS_C_EVT_DISCOVERY_COMPLETE event).
|
||||
*
|
||||
* @retval NRF_SUCCESS If the status was sent successfully.
|
||||
* @retval err_code Otherwise, this API propagates the error code returned by function
|
||||
* @ref nrf_ble_gq_item_add.
|
||||
*
|
||||
*/
|
||||
uint32_t ble_lbs_c_handles_assign(ble_lbs_c_t * p_ble_lbs_c,
|
||||
uint16_t conn_handle,
|
||||
const lbs_db_t * p_peer_handles);
|
||||
|
||||
|
||||
/**@brief Function for writing the LED status to the connected server.
|
||||
*
|
||||
* @param[in] p_ble_lbs_c Pointer to the LED Button client structure.
|
||||
* @param[in] status LED status to send.
|
||||
*
|
||||
* @retval NRF_SUCCESS If the status was sent successfully.
|
||||
* @retval err_code Otherwise, this API propagates the error code returned by function
|
||||
* @ref nrf_ble_gq_conn_handle_register.
|
||||
*/
|
||||
uint32_t ble_lbs_led_status_send(ble_lbs_c_t * p_ble_lbs_c, uint8_t status);
|
||||
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif // BLE_LBS_C_H__
|
||||
|
||||
/** @} */
|
||||
Reference in New Issue
Block a user