aboutsummaryrefslogtreecommitdiff
path: root/thirdparty/nRF5_SDK_15.0.0_a53641a/components/ble/ble_services/ble_rscs_c
diff options
context:
space:
mode:
authorTrygve Laugstøl <trygvis@inamo.no>2018-08-23 17:08:59 +0200
committerTrygve Laugstøl <trygvis@inamo.no>2018-08-23 17:12:21 +0200
commit3061ecca3d0fdfb87dabbf5f63c9e06c2a30f53a (patch)
treeab49cc16ed0b853452c5c2ed2d3042416d628986 /thirdparty/nRF5_SDK_15.0.0_a53641a/components/ble/ble_services/ble_rscs_c
downloadiot-sensors-3061ecca3d0fdfb87dabbf5f63c9e06c2a30f53a.tar.gz
iot-sensors-3061ecca3d0fdfb87dabbf5f63c9e06c2a30f53a.tar.bz2
iot-sensors-3061ecca3d0fdfb87dabbf5f63c9e06c2a30f53a.tar.xz
iot-sensors-3061ecca3d0fdfb87dabbf5f63c9e06c2a30f53a.zip
o Initial import.HEADmaster
Diffstat (limited to 'thirdparty/nRF5_SDK_15.0.0_a53641a/components/ble/ble_services/ble_rscs_c')
-rw-r--r--thirdparty/nRF5_SDK_15.0.0_a53641a/components/ble/ble_services/ble_rscs_c/ble_rscs_c.c390
-rw-r--r--thirdparty/nRF5_SDK_15.0.0_a53641a/components/ble/ble_services/ble_rscs_c/ble_rscs_c.h231
2 files changed, 621 insertions, 0 deletions
diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/components/ble/ble_services/ble_rscs_c/ble_rscs_c.c b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/ble/ble_services/ble_rscs_c/ble_rscs_c.c
new file mode 100644
index 0000000..f9c16ad
--- /dev/null
+++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/ble/ble_services/ble_rscs_c/ble_rscs_c.c
@@ -0,0 +1,390 @@
+/**
+ * Copyright (c) 2012 - 2018, 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_RSCS_C)
+#include "ble_rscs_c.h"
+#include "ble_db_discovery.h"
+#include "ble_types.h"
+#include "ble_srv_common.h"
+#include "ble_gattc.h"
+
+#define NRF_LOG_MODULE_NAME ble_rscs_c
+#include "nrf_log.h"
+NRF_LOG_MODULE_REGISTER();
+
+#define TX_BUFFER_MASK 0x07 /**< TX Buffer mask, must be a mask of continuous zeroes, followed by continuous sequence of ones: 000...111. */
+#define TX_BUFFER_SIZE (TX_BUFFER_MASK + 1) /**< Size of send buffer, which is 1 higher than the mask. */
+
+#define WRITE_MESSAGE_LENGTH BLE_CCCD_VALUE_LEN /**< Length of the write message for CCCD. */
+
+typedef enum
+{
+ READ_REQ, /**< Type identifying that this tx_message is a read request. */
+ WRITE_REQ /**< Type identifying that this tx_message is a write request. */
+} tx_request_t;
+
+/**@brief Structure for writing a message to the peer, i.e. CCCD.
+ */
+typedef struct
+{
+ uint8_t gattc_value[WRITE_MESSAGE_LENGTH]; /**< The message to write. */
+ ble_gattc_write_params_t gattc_params; /**< GATTC parameters for this message. */
+} write_params_t;
+
+/**@brief Structure for holding data to be transmitted to the connected central.
+ */
+typedef struct
+{
+ uint16_t conn_handle; /**< Connection handle to be used when transmitting this message. */
+ tx_request_t type; /**< Type of this message, i.e. read or write message. */
+ union
+ {
+ uint16_t read_handle; /**< Read request message. */
+ write_params_t write_req; /**< Write request message. */
+ } req;
+} tx_message_t;
+
+
+static tx_message_t m_tx_buffer[TX_BUFFER_SIZE]; /**< Transmit buffer for messages to be transmitted to the central. */
+static uint32_t m_tx_insert_index = 0; /**< Current index in the transmit buffer where the next message should be inserted. */
+static uint32_t m_tx_index = 0; /**< Current index in the transmit buffer from where the next message to be transmitted resides. */
+
+
+/**@brief Function for passing any pending request from the buffer to the stack.
+ */
+static void tx_buffer_process(void)
+{
+ if (m_tx_index != m_tx_insert_index)
+ {
+ uint32_t err_code;
+
+ if (m_tx_buffer[m_tx_index].type == READ_REQ)
+ {
+ err_code = sd_ble_gattc_read(m_tx_buffer[m_tx_index].conn_handle,
+ m_tx_buffer[m_tx_index].req.read_handle,
+ 0);
+ }
+ else
+ {
+ err_code = sd_ble_gattc_write(m_tx_buffer[m_tx_index].conn_handle,
+ &m_tx_buffer[m_tx_index].req.write_req.gattc_params);
+ }
+ if (err_code == NRF_SUCCESS)
+ {
+ NRF_LOG_DEBUG("SD Read/Write API returns Success.");
+ m_tx_index++;
+ m_tx_index &= TX_BUFFER_MASK;
+ }
+ else
+ {
+ NRF_LOG_DEBUG("SD Read/Write API returns error. This message sending will be "
+ "attempted again..");
+ }
+ }
+}
+
+
+/**@brief Function for handling write response events.
+ *
+ * @param[in] p_ble_rscs_c Pointer to the Running Speed and Cadence Client structure.
+ * @param[in] p_ble_evt Pointer to the BLE event received.
+ */
+static void on_write_rsp(ble_rscs_c_t * p_ble_rscs_c, const ble_evt_t * p_ble_evt)
+{
+ // Check if the event if on the link for this instance
+ if (p_ble_rscs_c->conn_handle != p_ble_evt->evt.gattc_evt.conn_handle)
+ {
+ return;
+ }
+ // Check if there is any message to be sent across to the peer and send it.
+ tx_buffer_process();
+}
+
+
+/**@brief Function for handling Handle Value Notification received from the SoftDevice.
+ *
+ * @details This function will uses the Handle Value Notification received from the SoftDevice
+ * and checks if it is a notification of the Running Speed and Cadence measurement from
+ * the peer. If it is, this function will decode the Running Speed measurement and send it
+ * to the application.
+ *
+ * @param[in] p_ble_rscs_c Pointer to the Running Speed and Cadence Client structure.
+ * @param[in] p_ble_evt Pointer to the BLE event received.
+ */
+static void on_hvx(ble_rscs_c_t * p_ble_rscs_c, const ble_evt_t * p_ble_evt)
+{
+ const ble_gattc_evt_hvx_t * p_notif = &p_ble_evt->evt.gattc_evt.params.hvx;
+
+ // Check if the event if on the link for this instance
+ if (p_ble_rscs_c->conn_handle != p_ble_evt->evt.gattc_evt.conn_handle)
+ {
+ return;
+ }
+
+ // Check if this is a Running Speed and Cadence notification.
+ if (p_ble_evt->evt.gattc_evt.params.hvx.handle == p_ble_rscs_c->peer_db.rsc_handle)
+ {
+ uint32_t index = 0;
+ ble_rscs_c_evt_t ble_rscs_c_evt;
+ ble_rscs_c_evt.evt_type = BLE_RSCS_C_EVT_RSC_NOTIFICATION;
+ ble_rscs_c_evt.conn_handle = p_ble_evt->evt.gattc_evt.conn_handle;
+
+ //lint -save -e415 -e416 -e662 "Access of out of bounds pointer" "Creation of out of bounds pointer"
+
+ // Flags field
+ ble_rscs_c_evt.params.rsc.is_inst_stride_len_present = p_notif->data[index] >> BLE_RSCS_INSTANT_STRIDE_LEN_PRESENT & 0x01;
+ ble_rscs_c_evt.params.rsc.is_total_distance_present = p_notif->data[index] >> BLE_RSCS_TOTAL_DISTANCE_PRESENT & 0x01;
+ ble_rscs_c_evt.params.rsc.is_running = p_notif->data[index] >> BLE_RSCS_WALKING_OR_RUNNING_STATUS_BIT & 0x01;
+ index++;
+
+ // Instantaneous Speed
+ ble_rscs_c_evt.params.rsc.inst_speed = uint16_decode(&p_notif->data[index]);
+ index += sizeof(uint16_t);
+
+ // Instantaneous Cadence
+ ble_rscs_c_evt.params.rsc.inst_cadence = p_notif->data[index];
+ index++;
+
+ // Instantaneous Stride Length
+ if (ble_rscs_c_evt.params.rsc.is_inst_stride_len_present == true)
+ {
+ ble_rscs_c_evt.params.rsc.inst_stride_length = uint16_decode(&p_notif->data[index]);
+ index += sizeof(uint16_t);
+ }
+
+ // Total distance field
+ if (ble_rscs_c_evt.params.rsc.is_total_distance_present == true)
+ {
+ ble_rscs_c_evt.params.rsc.total_distance = uint32_decode(&p_notif->data[index]);
+ //index += sizeof(uint32_t);
+ }
+
+ p_ble_rscs_c->evt_handler(p_ble_rscs_c, &ble_rscs_c_evt);
+
+ //lint -restore
+ }
+}
+
+
+/**@brief Function for handling events from the database discovery module.
+ *
+ * @details This function will handle an event from the database discovery module, and determine
+ * if it relates to the discovery of heart rate service at the peer. If so, it will
+ * call the application's event handler indicating that the Running Speed and Cadence
+ * service has been discovered at the peer. It also populates the event with the service
+ * related information before providing it to the application.
+ *
+ * @param[in] p_evt Pointer to the event received from the database discovery module.
+ *
+ */
+void ble_rscs_on_db_disc_evt(ble_rscs_c_t * p_ble_rscs_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_RUNNING_SPEED_AND_CADENCE &&
+ p_evt->params.discovered_db.srv_uuid.type == BLE_UUID_TYPE_BLE)
+ {
+ ble_rscs_c_evt_t evt;
+ evt.conn_handle = p_evt->conn_handle;
+
+ // Find the CCCD Handle of the Running Speed and Cadence characteristic.
+ for (uint32_t i = 0; i < p_evt->params.discovered_db.char_count; i++)
+ {
+ if (p_evt->params.discovered_db.charateristics[i].characteristic.uuid.uuid ==
+ BLE_UUID_RSC_MEASUREMENT_CHAR)
+ {
+ // Found Running Speed and Cadence characteristic. Store CCCD handle and break.
+ evt.params.rscs_db.rsc_cccd_handle =
+ p_evt->params.discovered_db.charateristics[i].cccd_handle;
+ evt.params.rscs_db.rsc_handle =
+ p_evt->params.discovered_db.charateristics[i].characteristic.handle_value;
+ break;
+ }
+ }
+
+ NRF_LOG_DEBUG("Running Speed and Cadence Service discovered at peer.");
+
+ //If the instance has been assigned prior to db_discovery, assign the db_handles
+ if (p_ble_rscs_c->conn_handle != BLE_CONN_HANDLE_INVALID)
+ {
+ if ((p_ble_rscs_c->peer_db.rsc_cccd_handle == BLE_GATT_HANDLE_INVALID)&&
+ (p_ble_rscs_c->peer_db.rsc_handle == BLE_GATT_HANDLE_INVALID))
+ {
+ p_ble_rscs_c->peer_db = evt.params.rscs_db;
+ }
+ }
+
+ evt.evt_type = BLE_RSCS_C_EVT_DISCOVERY_COMPLETE;
+
+ p_ble_rscs_c->evt_handler(p_ble_rscs_c, &evt);
+ }
+}
+
+
+uint32_t ble_rscs_c_init(ble_rscs_c_t * p_ble_rscs_c, ble_rscs_c_init_t * p_ble_rscs_c_init)
+{
+ VERIFY_PARAM_NOT_NULL(p_ble_rscs_c);
+ VERIFY_PARAM_NOT_NULL(p_ble_rscs_c_init);
+
+ ble_uuid_t rscs_uuid;
+
+ rscs_uuid.type = BLE_UUID_TYPE_BLE;
+ rscs_uuid.uuid = BLE_UUID_RUNNING_SPEED_AND_CADENCE;
+
+ p_ble_rscs_c->evt_handler = p_ble_rscs_c_init->evt_handler;
+ p_ble_rscs_c->conn_handle = BLE_CONN_HANDLE_INVALID;
+ p_ble_rscs_c->peer_db.rsc_cccd_handle = BLE_GATT_HANDLE_INVALID;
+ p_ble_rscs_c->peer_db.rsc_handle = BLE_GATT_HANDLE_INVALID;
+
+ return ble_db_discovery_evt_register(&rscs_uuid);
+}
+
+
+uint32_t ble_rscs_c_handles_assign(ble_rscs_c_t * p_ble_rscs_c,
+ uint16_t conn_handle,
+ ble_rscs_c_db_t * p_peer_handles)
+{
+ VERIFY_PARAM_NOT_NULL(p_ble_rscs_c);
+ p_ble_rscs_c->conn_handle = conn_handle;
+ if (p_peer_handles != NULL)
+ {
+ p_ble_rscs_c->peer_db = *p_peer_handles;
+ }
+
+ return NRF_SUCCESS;
+}
+
+
+/**@brief Function for handling Disconnected event received from the SoftDevice.
+ *
+ * @details This function check if the disconnect event is happening on the link
+ * associated with the current instance of the module, if so it will set its
+ * conn_handle to invalid.
+ *
+ * @param[in] p_ble_rscs_c Pointer to the RSC Client structure.
+ * @param[in] p_ble_evt Pointer to the BLE event received.
+ */
+static void on_disconnected(ble_rscs_c_t * p_ble_rscs_c, const ble_evt_t * p_ble_evt)
+{
+ if (p_ble_rscs_c->conn_handle == p_ble_evt->evt.gap_evt.conn_handle)
+ {
+ p_ble_rscs_c->conn_handle = BLE_CONN_HANDLE_INVALID;
+ p_ble_rscs_c->peer_db.rsc_cccd_handle = BLE_GATT_HANDLE_INVALID;
+ p_ble_rscs_c->peer_db.rsc_handle = BLE_GATT_HANDLE_INVALID;
+ }
+}
+
+
+void ble_rscs_c_on_ble_evt(ble_evt_t const * p_ble_evt, void * p_context)
+{
+ if ((p_context == NULL) || (p_ble_evt == NULL))
+ {
+ return;
+ }
+
+ ble_rscs_c_t * p_ble_rscs_c = (ble_rscs_c_t *)p_context;
+
+ switch (p_ble_evt->header.evt_id)
+ {
+ case BLE_GATTC_EVT_HVX:
+ on_hvx(p_ble_rscs_c, p_ble_evt);
+ break;
+
+ case BLE_GATTC_EVT_WRITE_RSP:
+ on_write_rsp(p_ble_rscs_c, p_ble_evt);
+ break;
+
+ case BLE_GAP_EVT_DISCONNECTED:
+ on_disconnected(p_ble_rscs_c, p_ble_evt);
+ break;
+
+ default:
+ break;
+ }
+}
+
+
+/**@brief Function for creating a message for writing to the CCCD.
+ */
+static uint32_t cccd_configure(uint16_t conn_handle, uint16_t handle_cccd, bool enable)
+{
+ NRF_LOG_DEBUG("Configuring CCCD. CCCD Handle = %d, Connection Handle = %d",
+ handle_cccd, conn_handle);
+
+ tx_message_t * p_msg;
+ uint16_t cccd_val = enable ? BLE_GATT_HVX_NOTIFICATION : 0;
+
+ p_msg = &m_tx_buffer[m_tx_insert_index++];
+ m_tx_insert_index &= TX_BUFFER_MASK;
+
+ p_msg->req.write_req.gattc_params.handle = handle_cccd;
+ p_msg->req.write_req.gattc_params.len = WRITE_MESSAGE_LENGTH;
+ p_msg->req.write_req.gattc_params.p_value = p_msg->req.write_req.gattc_value;
+ p_msg->req.write_req.gattc_params.offset = 0;
+ p_msg->req.write_req.gattc_params.write_op = BLE_GATT_OP_WRITE_REQ;
+ p_msg->req.write_req.gattc_value[0] = LSB_16(cccd_val);
+ p_msg->req.write_req.gattc_value[1] = MSB_16(cccd_val);
+ p_msg->conn_handle = conn_handle;
+ p_msg->type = WRITE_REQ;
+
+ tx_buffer_process();
+ return NRF_SUCCESS;
+}
+
+
+uint32_t ble_rscs_c_rsc_notif_enable(ble_rscs_c_t * p_ble_rscs_c)
+{
+ VERIFY_PARAM_NOT_NULL(p_ble_rscs_c);
+
+ if (p_ble_rscs_c->conn_handle == BLE_CONN_HANDLE_INVALID)
+ {
+ return NRF_ERROR_INVALID_STATE;
+ }
+
+ return cccd_configure(p_ble_rscs_c->conn_handle, p_ble_rscs_c->peer_db.rsc_cccd_handle, true);
+}
+
+/** @}
+ * @endcond
+ */
+#endif // NRF_MODULE_ENABLED(BLE_RSCS_C)
diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/components/ble/ble_services/ble_rscs_c/ble_rscs_c.h b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/ble/ble_services/ble_rscs_c/ble_rscs_c.h
new file mode 100644
index 0000000..664d03b
--- /dev/null
+++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/ble/ble_services/ble_rscs_c/ble_rscs_c.h
@@ -0,0 +1,231 @@
+/**
+ * Copyright (c) 2012 - 2018, 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.
+ *
+ */
+/**
+ * @defgroup ble_rscs_c Running Speed and Cadence Service Client
+ * @{
+ * @ingroup ble_sdk_srv
+ *
+ * @details This module contains the APIs and types exposed by the Running Speed and Cadence
+ * Service Client module. These APIs and types can be used by the application to perform
+ * discovery of Running Speed and Cadence Service at the peer and interact with it.
+ *
+ * @note The application must register this module as BLE event observer using the
+ * NRF_SDH_BLE_OBSERVER macro. Example:
+ * @code
+ * ble_rscs_c_t instance;
+ * NRF_SDH_BLE_OBSERVER(anything, BLE_RSCS_C_BLE_OBSERVER_PRIO,
+ * ble_rscs_c_on_ble_evt, &instance);
+ * @endcode
+ */
+#ifndef BLE_RSCS_C_H__
+#define BLE_RSCS_C_H__
+
+#include <stdint.h>
+#include <stdbool.h>
+#include "ble.h"
+#include "ble_db_discovery.h"
+#include "nrf_sdh_ble.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**@brief Macro for defining a ble_rscs_c instance.
+ *
+ * @param _name Name of the instance.
+ * @hideinitializer
+ */
+#define BLE_RSCS_C_DEF(_name) \
+static ble_rscs_c_t _name; \
+NRF_SDH_BLE_OBSERVER(_name ## _obs, \
+ BLE_RSCS_C_BLE_OBSERVER_PRIO, \
+ ble_rscs_c_on_ble_evt, &_name)
+
+/** @brief Macro for defining multiple ble_rscs_c instances.
+ *
+ * @param _name Name of the array of instances.
+ * @param _cnt Number of instances to define.
+ * @hideinitializer
+ */
+#define BLE_RSCS_C_ARRAY_DEF(_name, _cnt) \
+static ble_rscs_c_t _name[_cnt]; \
+NRF_SDH_BLE_OBSERVERS(_name ## _obs, \
+ BLE_RSCS_C_BLE_OBSERVER_PRIO, \
+ ble_rscs_c_on_ble_evt, &_name, _cnt)
+
+#define BLE_RSCS_INSTANT_STRIDE_LEN_PRESENT 0x00 /**< Instantaneous Stride Length Measurement Supported bit. */
+#define BLE_RSCS_TOTAL_DISTANCE_PRESENT 0x01 /**< Total Distance Measurement Supported bit. */
+#define BLE_RSCS_WALKING_OR_RUNNING_STATUS_BIT 0x02 /**< Walking or Running Status Supported bit. */
+
+
+/**@brief Structure containing the handles related to the Running Speed and Cadence Service found on the peer. */
+typedef struct
+{
+ uint16_t rsc_cccd_handle; /**< Handle of the CCCD of the Running Speed and Cadence characteristic. */
+ uint16_t rsc_handle; /**< Handle of the Running Speed and Cadence characteristic as provided by the SoftDevice. */
+} ble_rscs_c_db_t;
+
+/**@brief RSCS Client event type. */
+typedef enum
+{
+ BLE_RSCS_C_EVT_DISCOVERY_COMPLETE = 1, /**< Event indicating that the Running Speed and Cadence Service has been discovered at the peer. */
+ BLE_RSCS_C_EVT_RSC_NOTIFICATION /**< Event indicating that a notification of the Running Speed and Cadence measurement characteristic has been received from the peer. */
+} ble_rscs_c_evt_type_t;
+
+/**@brief Structure containing the Running Speed and Cadence measurement received from the peer. */
+typedef struct
+{
+ bool is_inst_stride_len_present; /**< True if Instantaneous Stride Length is present in the measurement. */
+ bool is_total_distance_present; /**< True if Total Distance is present in the measurement. */
+ bool is_running; /**< True if running, False if walking. */
+ uint16_t inst_speed; /**< Instantaneous Speed. */
+ uint8_t inst_cadence; /**< Instantaneous Cadence. */
+ uint16_t inst_stride_length; /**< Instantaneous Stride Length. */
+ uint32_t total_distance; /**< Total Distance. */
+} ble_rsc_t;
+
+/**@brief Running Speed and Cadence Event structure. */
+typedef struct
+{
+ ble_rscs_c_evt_type_t evt_type; /**< Type of the event. */
+ uint16_t conn_handle; /**< Connection handle on which the rscs_c event occured.*/
+ union
+ {
+ ble_rscs_c_db_t rscs_db; /**< Running Speed and Cadence Service related handles found on the peer device. This will be filled if the evt_type is @ref BLE_RSCS_C_EVT_DISCOVERY_COMPLETE.*/
+ ble_rsc_t rsc; /**< Running Speed and Cadence measurement received. This will be filled if the evt_type is @ref BLE_RSCS_C_EVT_RSC_NOTIFICATION. */
+ } params;
+} ble_rscs_c_evt_t;
+
+// Forward declaration of the ble_rscs_c_t type.
+typedef struct ble_rscs_c_s ble_rscs_c_t;
+
+/**@brief Event handler type.
+ *
+ * @details This is the type of the event handler that should be provided by the application
+ * of this module in order to receive events.
+ */
+typedef void (* ble_rscs_c_evt_handler_t) (ble_rscs_c_t * p_ble_rscs_c, ble_rscs_c_evt_t * p_evt);
+
+/**@brief Running Speed and Cadence client structure. */
+struct ble_rscs_c_s
+{
+ uint16_t conn_handle; /**< Connection handle as provided by the SoftDevice. */
+ ble_rscs_c_db_t peer_db; /**< Handles related to RSCS on the peer*/
+ ble_rscs_c_evt_handler_t evt_handler; /**< Application event handler to be called when there is an event related to the Running Speed and Cadence service. */
+};
+
+/**@brief Running Speed and Cadence client initialization structure. */
+typedef struct
+{
+ ble_rscs_c_evt_handler_t evt_handler; /**< Event handler to be called by the Running Speed and Cadence Client module whenever there is an event related to the Running Speed and Cadence Service. */
+} ble_rscs_c_init_t;
+
+
+/**@brief Function for initializing the Running Speed and Cadence Service Client module.
+ *
+ * @details This function will initialize the module and set up Database Discovery to discover
+ * the Running Speed and Cadence Service. After calling this function, call @ref ble_db_discovery_start
+ * to start discovery once a link with a peer has been established.
+ *
+ * @param[out] p_ble_rscs_c Pointer to the RSC Service client structure.
+ * @param[in] p_ble_rscs_c_init Pointer to the RSC Service initialization structure containing
+ * the initialization information.
+ *
+ * @retval NRF_SUCCESS Operation success.
+ * @retval NRF_ERROR_NULL A parameter is NULL.
+ * Otherwise, an error code returned by @ref ble_db_discovery_evt_register.
+ */
+uint32_t ble_rscs_c_init(ble_rscs_c_t * p_ble_rscs_c, ble_rscs_c_init_t * p_ble_rscs_c_init);
+
+
+/**@brief Function for handling the Application's BLE Stack events.
+ *
+ * @details Handles all events from the BLE stack of interest to the Running Speed and Cadence
+ * Service client.
+ *
+ * @param[in] p_ble_evt Event received from the BLE stack.
+ * @param[in] p_context Running Speed and Cadence Service client structure.
+ */
+void ble_rscs_c_on_ble_evt(ble_evt_t const * p_ble_evt, void * p_context);
+
+
+uint32_t ble_rscs_c_rsc_notif_enable(ble_rscs_c_t * p_ble_rscs_c);
+
+
+/**@brief Function for handling events from the database discovery module.
+ *
+ * @details Call this function when getting a callback event from the DB discovery modue.
+ * This function will handle an event from the database discovery module, and determine
+ * if it relates to the discovery of Running Speed and Cadence service at the peer.
+ * If so, it will call the application's event handler indicating that the RSC service has
+ * been discovered at the peer. It also populates the event with the service related
+ * information before providing it to the application.
+ *
+ * @param p_ble_rscs_c Pointer to the Runnind Speed and Cadence Service client structure.
+ * @param[in] p_evt Pointer to the event received from the database discovery module.
+ */
+void ble_rscs_on_db_disc_evt(ble_rscs_c_t * p_ble_rscs_c, ble_db_discovery_evt_t const * p_evt);
+
+
+/**@brief Function for assigning handles to a this instance of rscs_c.
+ *
+ * @details 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 @ref BLE_RSCS_C_EVT_DISCOVERY_COMPLETE.
+ *
+ * @param[in] p_ble_rscs_c Pointer to the RSC client structure instance to associate.
+ * @param[in] conn_handle Connection handle to associated with the given RSCS Client Instance.
+ * @param[in] p_peer_handles Attribute handles on the RSCS server that you want this RSCS client
+ * to interact with.
+ */
+uint32_t ble_rscs_c_handles_assign(ble_rscs_c_t * p_ble_rscs_c,
+ uint16_t conn_handle,
+ ble_rscs_c_db_t * p_peer_handles);
+
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // BLE_RSCS_C_H__
+
+/** @} */ // End tag for the file.