初始版本
This commit is contained in:
313
components/ble/ble_services/ble_hrs_c/ble_hrs_c.c
Normal file
313
components/ble/ble_services/ble_hrs_c/ble_hrs_c.c
Normal file
@@ -0,0 +1,313 @@
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
/**@cond To Make Doxygen skip documentation generation for this file.
|
||||
* @{
|
||||
*/
|
||||
#include "sdk_common.h"
|
||||
#if NRF_MODULE_ENABLED(BLE_HRS_C)
|
||||
#include "ble_hrs_c.h"
|
||||
#include "ble_db_discovery.h"
|
||||
#include "ble_types.h"
|
||||
#include "ble_gattc.h"
|
||||
|
||||
#define NRF_LOG_MODULE_NAME ble_hrs_c
|
||||
#include "nrf_log.h"
|
||||
NRF_LOG_MODULE_REGISTER();
|
||||
|
||||
#define HRM_FLAG_MASK_HR_16BIT (0x01 << 0) /**< Bit mask used to extract the type of heart rate value. This is used to find if the received heart rate is a 16 bit value or an 8 bit value. */
|
||||
#define HRM_FLAG_MASK_HR_RR_INT (0x01 << 4) /**< Bit mask used to extract the presence of RR_INTERVALS. This is used to find if the received measurement includes RR_INTERVALS. */
|
||||
|
||||
|
||||
/**@brief Function for interception of 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_hrs_c_t * p_ble_hrs_c = (ble_hrs_c_t *)p_ctx;
|
||||
|
||||
NRF_LOG_DEBUG("A GATT Client error has occurred on conn_handle: 0X%X", conn_handle);
|
||||
|
||||
if (p_ble_hrs_c->error_handler != NULL)
|
||||
{
|
||||
p_ble_hrs_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 the heart rate measurement from the peer. If
|
||||
* it is, this function decodes the heart rate measurement and sends it to the
|
||||
* application.
|
||||
*
|
||||
* @param[in] p_ble_hrs_c Pointer to the Heart Rate Client structure.
|
||||
* @param[in] p_ble_evt Pointer to the BLE event received.
|
||||
*/
|
||||
static void on_hvx(ble_hrs_c_t * p_ble_hrs_c, const ble_evt_t * p_ble_evt)
|
||||
{
|
||||
// Check if the event is on the link for this instance.
|
||||
if (p_ble_hrs_c->conn_handle != p_ble_evt->evt.gattc_evt.conn_handle)
|
||||
{
|
||||
NRF_LOG_DEBUG("Received HVX on link 0x%x, not associated to this instance. Ignore.",
|
||||
p_ble_evt->evt.gattc_evt.conn_handle);
|
||||
return;
|
||||
}
|
||||
|
||||
NRF_LOG_DEBUG("Received HVX on link 0x%x, hrm_handle 0x%x",
|
||||
p_ble_evt->evt.gattc_evt.params.hvx.handle,
|
||||
p_ble_hrs_c->peer_hrs_db.hrm_handle);
|
||||
|
||||
// Check if this is a heart rate notification.
|
||||
if (p_ble_evt->evt.gattc_evt.params.hvx.handle == p_ble_hrs_c->peer_hrs_db.hrm_handle)
|
||||
{
|
||||
ble_hrs_c_evt_t ble_hrs_c_evt;
|
||||
uint32_t index = 0;
|
||||
|
||||
ble_hrs_c_evt.evt_type = BLE_HRS_C_EVT_HRM_NOTIFICATION;
|
||||
ble_hrs_c_evt.conn_handle = p_ble_hrs_c->conn_handle;
|
||||
ble_hrs_c_evt.params.hrm.rr_intervals_cnt = 0;
|
||||
|
||||
if (!(p_ble_evt->evt.gattc_evt.params.hvx.data[index++] & HRM_FLAG_MASK_HR_16BIT))
|
||||
{
|
||||
// 8-bit heart rate value received.
|
||||
ble_hrs_c_evt.params.hrm.hr_value = p_ble_evt->evt.gattc_evt.params.hvx.data[index++]; //lint !e415 suppress Lint Warning 415: Likely access out of bond
|
||||
}
|
||||
else
|
||||
{
|
||||
// 16-bit heart rate value received.
|
||||
ble_hrs_c_evt.params.hrm.hr_value =
|
||||
uint16_decode(&(p_ble_evt->evt.gattc_evt.params.hvx.data[index]));
|
||||
index += sizeof(uint16_t);
|
||||
}
|
||||
|
||||
if ((p_ble_evt->evt.gattc_evt.params.hvx.data[0] & HRM_FLAG_MASK_HR_RR_INT))
|
||||
{
|
||||
uint32_t i;
|
||||
/*lint --e{415} --e{416} --e{662} --e{661} -save suppress Warning 415: possible access out of bond */
|
||||
for (i = 0; i < BLE_HRS_C_RR_INTERVALS_MAX_CNT; i ++)
|
||||
{
|
||||
if (index >= p_ble_evt->evt.gattc_evt.params.hvx.len)
|
||||
{
|
||||
break;
|
||||
}
|
||||
ble_hrs_c_evt.params.hrm.rr_intervals[i] =
|
||||
uint16_decode(&(p_ble_evt->evt.gattc_evt.params.hvx.data[index]));
|
||||
index += sizeof(uint16_t);
|
||||
}
|
||||
/*lint -restore*/
|
||||
ble_hrs_c_evt.params.hrm.rr_intervals_cnt = (uint8_t)i;
|
||||
}
|
||||
p_ble_hrs_c->evt_handler(p_ble_hrs_c, &ble_hrs_c_evt);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**@brief Function for handling 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_hrs_c Pointer to the Heart Rate Client structure.
|
||||
* @param[in] p_ble_evt Pointer to the BLE event received.
|
||||
*/
|
||||
static void on_disconnected(ble_hrs_c_t * p_ble_hrs_c, const ble_evt_t * p_ble_evt)
|
||||
{
|
||||
if (p_ble_hrs_c->conn_handle == p_ble_evt->evt.gap_evt.conn_handle)
|
||||
{
|
||||
p_ble_hrs_c->conn_handle = BLE_CONN_HANDLE_INVALID;
|
||||
p_ble_hrs_c->peer_hrs_db.hrm_cccd_handle = BLE_GATT_HANDLE_INVALID;
|
||||
p_ble_hrs_c->peer_hrs_db.hrm_handle = BLE_GATT_HANDLE_INVALID;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void ble_hrs_on_db_disc_evt(ble_hrs_c_t * p_ble_hrs_c, const ble_db_discovery_evt_t * p_evt)
|
||||
{
|
||||
// Check if the Heart Rate Service was discovered.
|
||||
if (p_evt->evt_type == BLE_DB_DISCOVERY_COMPLETE &&
|
||||
p_evt->params.discovered_db.srv_uuid.uuid == BLE_UUID_HEART_RATE_SERVICE &&
|
||||
p_evt->params.discovered_db.srv_uuid.type == BLE_UUID_TYPE_BLE)
|
||||
{
|
||||
// Find the CCCD Handle of the Heart Rate Measurement characteristic.
|
||||
uint32_t i;
|
||||
|
||||
ble_hrs_c_evt_t evt;
|
||||
|
||||
evt.evt_type = BLE_HRS_C_EVT_DISCOVERY_COMPLETE;
|
||||
evt.conn_handle = p_evt->conn_handle;
|
||||
|
||||
for (i = 0; i < p_evt->params.discovered_db.char_count; i++)
|
||||
{
|
||||
if (p_evt->params.discovered_db.charateristics[i].characteristic.uuid.uuid ==
|
||||
BLE_UUID_HEART_RATE_MEASUREMENT_CHAR)
|
||||
{
|
||||
// Found Heart Rate characteristic. Store CCCD handle and break.
|
||||
evt.params.peer_db.hrm_cccd_handle =
|
||||
p_evt->params.discovered_db.charateristics[i].cccd_handle;
|
||||
evt.params.peer_db.hrm_handle =
|
||||
p_evt->params.discovered_db.charateristics[i].characteristic.handle_value;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
NRF_LOG_DEBUG("Heart Rate Service discovered at peer.");
|
||||
//If the instance has been assigned prior to db_discovery, assign the db_handles.
|
||||
if (p_ble_hrs_c->conn_handle != BLE_CONN_HANDLE_INVALID)
|
||||
{
|
||||
if ((p_ble_hrs_c->peer_hrs_db.hrm_cccd_handle == BLE_GATT_HANDLE_INVALID)&&
|
||||
(p_ble_hrs_c->peer_hrs_db.hrm_handle == BLE_GATT_HANDLE_INVALID))
|
||||
{
|
||||
p_ble_hrs_c->peer_hrs_db = evt.params.peer_db;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
p_ble_hrs_c->evt_handler(p_ble_hrs_c, &evt);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
uint32_t ble_hrs_c_init(ble_hrs_c_t * p_ble_hrs_c, ble_hrs_c_init_t * p_ble_hrs_c_init)
|
||||
{
|
||||
VERIFY_PARAM_NOT_NULL(p_ble_hrs_c);
|
||||
VERIFY_PARAM_NOT_NULL(p_ble_hrs_c_init);
|
||||
|
||||
ble_uuid_t hrs_uuid;
|
||||
|
||||
hrs_uuid.type = BLE_UUID_TYPE_BLE;
|
||||
hrs_uuid.uuid = BLE_UUID_HEART_RATE_SERVICE;
|
||||
|
||||
p_ble_hrs_c->evt_handler = p_ble_hrs_c_init->evt_handler;
|
||||
p_ble_hrs_c->error_handler = p_ble_hrs_c_init->error_handler;
|
||||
p_ble_hrs_c->p_gatt_queue = p_ble_hrs_c_init->p_gatt_queue;
|
||||
p_ble_hrs_c->conn_handle = BLE_CONN_HANDLE_INVALID;
|
||||
p_ble_hrs_c->peer_hrs_db.hrm_cccd_handle = BLE_GATT_HANDLE_INVALID;
|
||||
p_ble_hrs_c->peer_hrs_db.hrm_handle = BLE_GATT_HANDLE_INVALID;
|
||||
|
||||
return ble_db_discovery_evt_register(&hrs_uuid);
|
||||
}
|
||||
|
||||
void ble_hrs_c_on_ble_evt(ble_evt_t const * p_ble_evt, void * p_context)
|
||||
{
|
||||
ble_hrs_c_t * p_ble_hrs_c = (ble_hrs_c_t *)p_context;
|
||||
|
||||
if ((p_ble_hrs_c == NULL) || (p_ble_evt == NULL))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
switch (p_ble_evt->header.evt_id)
|
||||
{
|
||||
case BLE_GATTC_EVT_HVX:
|
||||
on_hvx(p_ble_hrs_c, p_ble_evt);
|
||||
break;
|
||||
|
||||
case BLE_GAP_EVT_DISCONNECTED:
|
||||
on_disconnected(p_ble_hrs_c, p_ble_evt);
|
||||
break;
|
||||
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**@brief Function for creating a message for writing to the CCCD.
|
||||
*/
|
||||
static uint32_t cccd_configure(ble_hrs_c_t * p_ble_hrs_c, bool enable)
|
||||
{
|
||||
NRF_LOG_DEBUG("Configuring CCCD. CCCD Handle = %d, Connection Handle = %d",
|
||||
p_ble_hrs_c->peer_hrs_db.hrm_cccd_handle,
|
||||
p_ble_hrs_c->conn_handle);
|
||||
|
||||
nrf_ble_gq_req_t hrs_c_req;
|
||||
uint8_t cccd[BLE_CCCD_VALUE_LEN];
|
||||
uint16_t cccd_val = enable ? BLE_GATT_HVX_NOTIFICATION : 0;
|
||||
|
||||
cccd[0] = LSB_16(cccd_val);
|
||||
cccd[1] = MSB_16(cccd_val);
|
||||
|
||||
memset(&hrs_c_req, 0, sizeof(hrs_c_req));
|
||||
|
||||
hrs_c_req.type = NRF_BLE_GQ_REQ_GATTC_WRITE;
|
||||
hrs_c_req.error_handler.cb = gatt_error_handler;
|
||||
hrs_c_req.error_handler.p_ctx = p_ble_hrs_c;
|
||||
hrs_c_req.params.gattc_write.handle = p_ble_hrs_c->peer_hrs_db.hrm_cccd_handle;
|
||||
hrs_c_req.params.gattc_write.len = BLE_CCCD_VALUE_LEN;
|
||||
hrs_c_req.params.gattc_write.p_value = cccd;
|
||||
hrs_c_req.params.gattc_write.write_op = BLE_GATT_OP_WRITE_REQ;
|
||||
|
||||
return nrf_ble_gq_item_add(p_ble_hrs_c->p_gatt_queue, &hrs_c_req, p_ble_hrs_c->conn_handle);
|
||||
}
|
||||
|
||||
|
||||
uint32_t ble_hrs_c_hrm_notif_enable(ble_hrs_c_t * p_ble_hrs_c)
|
||||
{
|
||||
VERIFY_PARAM_NOT_NULL(p_ble_hrs_c);
|
||||
|
||||
return cccd_configure(p_ble_hrs_c, true);
|
||||
}
|
||||
|
||||
|
||||
uint32_t ble_hrs_c_handles_assign(ble_hrs_c_t * p_ble_hrs_c,
|
||||
uint16_t conn_handle,
|
||||
const hrs_db_t * p_peer_hrs_handles)
|
||||
{
|
||||
VERIFY_PARAM_NOT_NULL(p_ble_hrs_c);
|
||||
|
||||
p_ble_hrs_c->conn_handle = conn_handle;
|
||||
if (p_peer_hrs_handles != NULL)
|
||||
{
|
||||
p_ble_hrs_c->peer_hrs_db = *p_peer_hrs_handles;
|
||||
}
|
||||
|
||||
return nrf_ble_gq_conn_handle_register(p_ble_hrs_c->p_gatt_queue, conn_handle);
|
||||
}
|
||||
/** @}
|
||||
* @endcond
|
||||
*/
|
||||
#endif // NRF_MODULE_ENABLED(BLE_HRS_C)
|
||||
300
components/ble/ble_services/ble_hrs_c/ble_hrs_c.h
Normal file
300
components/ble/ble_services/ble_hrs_c/ble_hrs_c.h
Normal file
@@ -0,0 +1,300 @@
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
/**@file
|
||||
*
|
||||
* @defgroup ble_hrs_c Heart Rate Service Client
|
||||
* @{
|
||||
* @ingroup ble_sdk_srv
|
||||
* @brief Heart Rate Service Client module.
|
||||
*
|
||||
* @details This module contains the APIs and types exposed by the Heart Rate Service Client
|
||||
* module. The application can use these APIs and types to perform the discovery of
|
||||
* Heart Rate Service at the peer and to interact with it.
|
||||
*
|
||||
* @warning Currently, this module only supports the Heart Rate Measurement characteristic. This
|
||||
* means that it is able to enable notification of the characteristic at the peer and
|
||||
* is able to receive Heart Rate Measurement notifications from the peer. It does not
|
||||
* support the Body Sensor Location and the Heart Rate Control Point characteristics.
|
||||
* When a Heart Rate Measurement is received, this module decodes only the
|
||||
* Heart Rate Measurement value field (both 8-bit and 16-bit) and provides it to
|
||||
* the application.
|
||||
*
|
||||
* @note The application must register this module as the BLE event observer by using the
|
||||
* NRF_SDH_BLE_OBSERVER macro. Example:
|
||||
* @code
|
||||
* ble_hrs_c_t instance;
|
||||
* NRF_SDH_BLE_OBSERVER(anything, BLE_HRS_C_BLE_OBSERVER_PRIO,
|
||||
* ble_hrs_c_on_ble_evt, &instance);
|
||||
* @endcode
|
||||
*/
|
||||
|
||||
#ifndef BLE_HRS_C_H__
|
||||
#define BLE_HRS_C_H__
|
||||
|
||||
#include <stdint.h>
|
||||
#include "ble.h"
|
||||
#include "ble_db_discovery.h"
|
||||
#include "ble_srv_common.h"
|
||||
#include "sdk_config.h"
|
||||
#include "nrf_ble_gq.h"
|
||||
#include "nrf_sdh_ble.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**@brief Macro for defining a ble_hrs_c instance.
|
||||
*
|
||||
* @param _name Name of the instance.
|
||||
* @hideinitializer
|
||||
*/
|
||||
#define BLE_HRS_C_DEF(_name) \
|
||||
static ble_hrs_c_t _name; \
|
||||
NRF_SDH_BLE_OBSERVER(_name ## _obs, \
|
||||
BLE_HRS_C_BLE_OBSERVER_PRIO, \
|
||||
ble_hrs_c_on_ble_evt, &_name)
|
||||
|
||||
/** @brief Macro for defining multiple ble_hrs_c instances.
|
||||
*
|
||||
* @param _name Name of the array of instances.
|
||||
* @param _cnt Number of instances to define.
|
||||
* @hideinitializer
|
||||
*/
|
||||
#define BLE_HRS_C_ARRAY_DEF(_name, _cnt) \
|
||||
static ble_hrs_c_t _name[_cnt]; \
|
||||
NRF_SDH_BLE_OBSERVERS(_name ## _obs, \
|
||||
BLE_HRS_C_BLE_OBSERVER_PRIO, \
|
||||
ble_hrs_c_on_ble_evt, &_name, _cnt)
|
||||
|
||||
|
||||
/** @brief Maximum number of RR intervals to be decoded for each HRM notifications (any extra RR intervals are ignored).
|
||||
*
|
||||
* This define should be defined in the sdk_config.h file to override the default.
|
||||
*/
|
||||
#ifndef BLE_HRS_C_RR_INTERVALS_MAX_CNT
|
||||
#define BLE_HRS_C_RR_INTERVALS_MAX_CNT 20
|
||||
#endif
|
||||
|
||||
|
||||
/**
|
||||
* @defgroup hrs_c_enums Enumerations
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**@brief HRS Client event type. */
|
||||
typedef enum
|
||||
{
|
||||
BLE_HRS_C_EVT_DISCOVERY_COMPLETE = 1, /**< Event indicating that the Heart Rate Service was discovered at the peer. */
|
||||
BLE_HRS_C_EVT_HRM_NOTIFICATION /**< Event indicating that a notification of the Heart Rate Measurement characteristic was received from the peer. */
|
||||
} ble_hrs_c_evt_type_t;
|
||||
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup hrs_c_structs Structures
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**@brief Structure containing the Heart Rate Measurement received from the peer. */
|
||||
typedef struct
|
||||
{
|
||||
uint16_t hr_value; /**< Heart Rate Value. */
|
||||
uint8_t rr_intervals_cnt; /**< Number of RR intervals. */
|
||||
uint16_t rr_intervals[BLE_HRS_C_RR_INTERVALS_MAX_CNT]; /**< RR intervals. */
|
||||
} ble_hrm_t;
|
||||
|
||||
/**@brief Structure containing the handles related to the Heart Rate Service found on the peer. */
|
||||
typedef struct
|
||||
{
|
||||
uint16_t hrm_cccd_handle; /**< Handle of the CCCD of the Heart Rate Measurement characteristic. */
|
||||
uint16_t hrm_handle; /**< Handle of the Heart Rate Measurement characteristic, as provided by the SoftDevice. */
|
||||
} hrs_db_t;
|
||||
|
||||
/**@brief Heart Rate Event structure. */
|
||||
typedef struct
|
||||
{
|
||||
ble_hrs_c_evt_type_t evt_type; /**< Type of the event. */
|
||||
uint16_t conn_handle; /**< Connection handle on which the Heart Rate service was discovered on the peer device..*/
|
||||
union
|
||||
{
|
||||
hrs_db_t peer_db; /**< Handles related to the Heart Rate, found on the peer device. This is filled if the evt_type is @ref BLE_HRS_C_EVT_DISCOVERY_COMPLETE.*/
|
||||
ble_hrm_t hrm; /**< Heart Rate Measurement received. This is filled if the evt_type is @ref BLE_HRS_C_EVT_HRM_NOTIFICATION. */
|
||||
} params;
|
||||
} ble_hrs_c_evt_t;
|
||||
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup hrs_c_types Types
|
||||
* @{
|
||||
*/
|
||||
|
||||
// Forward declaration of the ble_bas_t type.
|
||||
typedef struct ble_hrs_c_s ble_hrs_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 to receive events.
|
||||
*/
|
||||
typedef void (* ble_hrs_c_evt_handler_t) (ble_hrs_c_t * p_ble_hrs_c, ble_hrs_c_evt_t * p_evt);
|
||||
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @addtogroup hrs_c_structs
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**@brief Heart Rate Client structure.
|
||||
*/
|
||||
struct ble_hrs_c_s
|
||||
{
|
||||
uint16_t conn_handle; /**< Connection handle, as provided by the SoftDevice. */
|
||||
hrs_db_t peer_hrs_db; /**< Handles related to HRS on the peer. */
|
||||
ble_hrs_c_evt_handler_t evt_handler; /**< Application event handler to be called when there is an event related to the Heart Rate Service. */
|
||||
ble_srv_error_handler_t error_handler; /**< Function to be called in case of an error. */
|
||||
nrf_ble_gq_t * p_gatt_queue; /**< Pointer to the BLE GATT Queue instance. */
|
||||
};
|
||||
|
||||
/**@brief Heart Rate Client initialization structure.
|
||||
*/
|
||||
typedef struct
|
||||
{
|
||||
ble_hrs_c_evt_handler_t evt_handler; /**< Event handler to be called by the Heart Rate Client module when there is an event related to the Heart Rate Service. */
|
||||
ble_srv_error_handler_t error_handler; /**< Function to be called in case of an error. */
|
||||
nrf_ble_gq_t * p_gatt_queue; /**< Pointer to the BLE GATT Queue instance. */
|
||||
} ble_hrs_c_init_t;
|
||||
|
||||
/** @} */
|
||||
|
||||
|
||||
/**
|
||||
* @defgroup hrs_c_functions Functions
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**@brief Function for initializing the Heart Rate Client module.
|
||||
*
|
||||
* @details This function registers with the Database Discovery module for the Heart Rate Service.
|
||||
* The module looks for the presence of a Heart Rate Service instance at the peer
|
||||
* when a discovery is started.
|
||||
*
|
||||
* @param[in] p_ble_hrs_c Pointer to the Heart Rate Client structure.
|
||||
* @param[in] p_ble_hrs_c_init Pointer to the Heart Rate 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_hrs_c_init(ble_hrs_c_t * p_ble_hrs_c, ble_hrs_c_init_t * p_ble_hrs_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 Heart Rate 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 Heart Rate Client structure.
|
||||
*/
|
||||
void ble_hrs_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 Heart Rate
|
||||
* Measurement.
|
||||
*
|
||||
* @details This function enables notification of the Heart Rate Measurement at the peer
|
||||
* by writing to the CCCD of the Heart Rate Measurement characteristic.
|
||||
*
|
||||
* @param p_ble_hrs_c Pointer to the Heart Rate Client structure.
|
||||
*
|
||||
* @retval NRF_SUCCESS If the SoftDevice is requested to write to the CCCD of the peer.
|
||||
* @retval err_code Otherwise, this function propagates the error code returned
|
||||
* by the SoftDevice API @ref sd_ble_gattc_write.
|
||||
*/
|
||||
uint32_t ble_hrs_c_hrm_notif_enable(ble_hrs_c_t * p_ble_hrs_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 Heart Rate Service at the peer. If it does, the function
|
||||
* calls the application's event handler to indicate that the Heart Rate 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_hrs_c Pointer to the Heart Rate Client structure instance for associating the link.
|
||||
* @param[in] p_evt Pointer to the event received from the Database Discovery module.
|
||||
*
|
||||
*/
|
||||
void ble_hrs_on_db_disc_evt(ble_hrs_c_t * p_ble_hrs_c, const ble_db_discovery_evt_t * p_evt);
|
||||
|
||||
|
||||
/**@brief Function for assigning handles to an instance of hrs_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 association makes it
|
||||
* possible to handle several links and associate each link to a particular
|
||||
* instance of this module. The connection handle and attribute handles are
|
||||
* provided from the discovery event @ref BLE_HRS_C_EVT_DISCOVERY_COMPLETE.
|
||||
*
|
||||
* @param[in] p_ble_hrs_c Pointer to the Heart Rate Client structure instance for associating the link.
|
||||
* @param[in] conn_handle Connection handle to associate with the given Heart Rate Client Instance.
|
||||
* @param[in] p_peer_hrs_handles Attribute handles for the HRS server you want this HRS_C client to
|
||||
* interact with.
|
||||
*/
|
||||
uint32_t ble_hrs_c_handles_assign(ble_hrs_c_t * p_ble_hrs_c,
|
||||
uint16_t conn_handle,
|
||||
const hrs_db_t * p_peer_hrs_handles);
|
||||
|
||||
/** @} */ // End tag for Function group.
|
||||
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif // BLE_HRS_C_H__
|
||||
|
||||
/** @} */ // End tag for the file.
|
||||
Reference in New Issue
Block a user