ble_cscs.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219
  1. /**
  2. * Copyright (c) 2012 - 2020, Nordic Semiconductor ASA
  3. *
  4. * All rights reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without modification,
  7. * are permitted provided that the following conditions are met:
  8. *
  9. * 1. Redistributions of source code must retain the above copyright notice, this
  10. * list of conditions and the following disclaimer.
  11. *
  12. * 2. Redistributions in binary form, except as embedded into a Nordic
  13. * Semiconductor ASA integrated circuit in a product or a software update for
  14. * such product, must reproduce the above copyright notice, this list of
  15. * conditions and the following disclaimer in the documentation and/or other
  16. * materials provided with the distribution.
  17. *
  18. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  19. * contributors may be used to endorse or promote products derived from this
  20. * software without specific prior written permission.
  21. *
  22. * 4. This software, with or without modification, must only be used with a
  23. * Nordic Semiconductor ASA integrated circuit.
  24. *
  25. * 5. Any software provided in binary form under this license must not be reverse
  26. * engineered, decompiled, modified and/or disassembled.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  29. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  30. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  31. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  32. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  34. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  37. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38. *
  39. */
  40. /** @file
  41. *
  42. * @defgroup ble_cscs Cycling Speed and Cadence Service
  43. * @{
  44. * @ingroup ble_sdk_srv
  45. * @brief Cycling Speed and Cadence Service module.
  46. *
  47. * @details This module implements the Cycling Speed and Cadence Service. If enabled, notification
  48. * of the Cycling Speead and Candence Measurement is performed when the application
  49. * calls ble_cscs_measurement_send().
  50. *
  51. * To use this service, you need to provide the the supported features (@ref BLE_CSCS_FEATURES).
  52. * If you choose to support Wheel revolution data (feature bit @ref BLE_CSCS_FEATURE_WHEEL_REV_BIT),
  53. * you then need to support the 'setting of cumulative value' operation by the supporting the
  54. * Speed and Cadence Control Point (@ref ble_sdk_srv_sc_ctrlpt) by setting the @ref BLE_SRV_SC_CTRLPT_CUM_VAL_OP_SUPPORTED
  55. * bit of the ctrplt_supported_functions in the @ref ble_cscs_init_t structure.
  56. * If you want to support the 'start autocalibration' control point feature, you need, after the @ref BLE_SC_CTRLPT_EVT_START_CALIBRATION
  57. * has been received and the auto calibration is finished, to call the @ref ble_sc_ctrlpt_rsp_send to indicate that the operation is finished
  58. * and thus be able to receive new control point operations.
  59. * If you want to support the 'sensor location' related operation, you need to provide a list of supported location in the
  60. * @ref ble_cscs_init_t structure.
  61. *
  62. *
  63. * @note The application must register this module as BLE event observer using the
  64. * NRF_SDH_BLE_OBSERVER macro. Example:
  65. * @code
  66. * ble_cscs_t instance;
  67. * NRF_SDH_BLE_OBSERVER(anything, BLE_CSCS_BLE_OBSERVER_PRIO,
  68. * ble_cscs_on_ble_evt, &instance);
  69. * @endcode
  70. *
  71. * @note Attention!
  72. * To maintain compliance with Nordic Semiconductor ASA Bluetooth profile
  73. * qualification listings, this section of source code must not be modified.
  74. */
  75. #ifndef BLE_CSCS_H__
  76. #define BLE_CSCS_H__
  77. #include <stdint.h>
  78. #include <stdbool.h>
  79. #include "ble.h"
  80. #include "ble_srv_common.h"
  81. #include "ble_sc_ctrlpt.h"
  82. #include "ble_sensor_location.h"
  83. #include "nrf_sdh_ble.h"
  84. #ifdef __cplusplus
  85. extern "C" {
  86. #endif
  87. /**@brief Macro for defining a ble_cscs instance.
  88. *
  89. * @param _name Name of the instance.
  90. * @hideinitializer
  91. */
  92. #define BLE_CSCS_DEF(_name) \
  93. static ble_cscs_t _name; \
  94. NRF_SDH_BLE_OBSERVER(_name ## _obs, \
  95. BLE_CSCS_BLE_OBSERVER_PRIO, \
  96. ble_cscs_on_ble_evt, &_name)
  97. /** @defgroup BLE_CSCS_FEATURES Cycling Speed and Cadence Service feature bits
  98. * @{ */
  99. #define BLE_CSCS_FEATURE_WHEEL_REV_BIT (0x01 << 0) /**< Wheel Revolution Data Supported bit. */
  100. #define BLE_CSCS_FEATURE_CRANK_REV_BIT (0x01 << 1) /**< Crank Revolution Data Supported bit. */
  101. #define BLE_CSCS_FEATURE_MULTIPLE_SENSORS_BIT (0x01 << 2) /**< Multiple Sensor Locations Supported bit. */
  102. /** @} */
  103. /**@brief Cycling Speed and Cadence Service event type. */
  104. typedef enum
  105. {
  106. BLE_CSCS_EVT_NOTIFICATION_ENABLED, /**< Cycling Speed and Cadence value notification enabled event. */
  107. BLE_CSCS_EVT_NOTIFICATION_DISABLED /**< Cycling Speed and Cadence value notification disabled event. */
  108. } ble_cscs_evt_type_t;
  109. /**@brief Cycling Speed and Cadence Service event. */
  110. typedef struct
  111. {
  112. ble_cscs_evt_type_t evt_type; /**< Type of event. */
  113. } ble_cscs_evt_t;
  114. // Forward declaration of the ble_csc_t type.
  115. typedef struct ble_cscs_s ble_cscs_t;
  116. /**@brief Cycling Speed and Cadence Service event handler type. */
  117. typedef void (*ble_cscs_evt_handler_t) (ble_cscs_t * p_cscs, ble_cscs_evt_t * p_evt);
  118. /**@brief Cycling Speed and Cadence Service init structure. This contains all options and data
  119. * needed for initialization of the service. */
  120. typedef struct
  121. {
  122. ble_cscs_evt_handler_t evt_handler; /**< Event handler to be called for handling events in the Cycling Speed and Cadence Service. */
  123. security_req_t csc_meas_cccd_wr_sec; /**< Security requirement for writing cycling speed and cadence measurement characteristic CCCD. */
  124. security_req_t csc_feature_rd_sec; /**< Security requirement for reading cycling speed and cadence feature characteristic. */
  125. security_req_t csc_location_rd_sec; /**< Security requirement for reading cycling speed and cadence location characteristic. */
  126. security_req_t sc_ctrlpt_cccd_wr_sec; /**< Security requirement for writing speed and cadence control point characteristic CCCD. */
  127. security_req_t sc_ctrlpt_wr_sec; /**< Security requirement for writing speed and cadence control point characteristic. */
  128. uint16_t feature; /**< Initial value for features of sensor @ref BLE_CSCS_FEATURES. */
  129. uint8_t ctrplt_supported_functions; /**< Supported control point functionalities see @ref BLE_SRV_SC_CTRLPT_SUPP_FUNC. */
  130. ble_sc_ctrlpt_evt_handler_t ctrlpt_evt_handler; /**< Event handler */
  131. ble_sensor_location_t *list_supported_locations; /**< List of supported sensor locations.*/
  132. uint8_t size_list_supported_locations; /**< Number of supported sensor locations in the list.*/
  133. ble_srv_error_handler_t error_handler; /**< Function to be called in case of an error. */
  134. ble_sensor_location_t *sensor_location; /**< Initial Sensor Location, if NULL, sensor_location characteristic is not added*/
  135. } ble_cscs_init_t;
  136. /**@brief Cycling Speed and Cadence Service structure. This contains various status information for
  137. * the service. */
  138. struct ble_cscs_s
  139. {
  140. ble_cscs_evt_handler_t evt_handler; /**< Event handler to be called for handling events in the Cycling Speed and Cadence Service. */
  141. uint16_t service_handle; /**< Handle of Cycling Speed and Cadence Service (as provided by the BLE stack). */
  142. ble_gatts_char_handles_t meas_handles; /**< Handles related to the Cycling Speed and Cadence Measurement characteristic. */
  143. ble_gatts_char_handles_t feature_handles; /**< Handles related to the Cycling Speed and Cadence feature characteristic. */
  144. ble_gatts_char_handles_t sensor_loc_handles; /**< Handles related to the Cycling Speed and Cadence Sensor Location characteristic. */
  145. uint16_t conn_handle; /**< Handle of the current connection (as provided by the BLE stack, is BLE_CONN_HANDLE_INVALID if not in a connection). */
  146. uint16_t feature; /**< Bit mask of features available on sensor. */
  147. ble_sc_ctrlpt_t ctrl_pt; /**< data for speed and cadence control point */
  148. };
  149. /**@brief Cycling Speed and Cadence Service measurement structure. This contains a Cycling Speed and
  150. * Cadence Service measurement. */
  151. typedef struct ble_cscs_meas_s
  152. {
  153. bool is_wheel_rev_data_present; /**< True if Wheel Revolution Data is present in the measurement. */
  154. bool is_crank_rev_data_present; /**< True if Crank Revolution Data is present in the measurement. */
  155. uint32_t cumulative_wheel_revs; /**< Cumulative Wheel Revolutions. */
  156. uint16_t last_wheel_event_time; /**< Last Wheel Event Time. */
  157. uint16_t cumulative_crank_revs; /**< Cumulative Crank Revolutions. */
  158. uint16_t last_crank_event_time; /**< Last Crank Event Time. */
  159. } ble_cscs_meas_t;
  160. /**@brief Function for initializing the Cycling Speed and Cadence Service.
  161. *
  162. * @param[out] p_cscs Cycling Speed and Cadence Service structure. This structure will have to
  163. * be supplied by the application. It will be initialized by this function,
  164. * and will later be used to identify this particular service instance.
  165. * @param[in] p_cscs_init Information needed to initialize the service.
  166. *
  167. * @return NRF_SUCCESS on successful initialization of service, otherwise an error code.
  168. */
  169. uint32_t ble_cscs_init(ble_cscs_t * p_cscs, ble_cscs_init_t const * p_cscs_init);
  170. /**@brief Function for handling the Application's BLE Stack events.
  171. *
  172. * @details Handles all events from the BLE stack of interest to the Cycling Speed and Cadence
  173. * Service.
  174. *
  175. * @param[in] p_ble_evt Event received from the BLE stack.
  176. * @param[in] p_context Cycling Speed and Cadence Service structure.
  177. */
  178. void ble_cscs_on_ble_evt(ble_evt_t const * p_ble_evt, void * p_context);
  179. /**@brief Function for sending cycling speed and cadence measurement if notification has been enabled.
  180. *
  181. * @details The application calls this function after having performed a Cycling Speed and Cadence
  182. * Service measurement. If notification has been enabled, the measurement data is encoded
  183. * and sent to the client.
  184. *
  185. * @param[in] p_cscs Cycling Speed and Cadence Service structure.
  186. * @param[in] p_measurement Pointer to new cycling speed and cadence measurement.
  187. *
  188. * @return NRF_SUCCESS on success, otherwise an error code.
  189. */
  190. uint32_t ble_cscs_measurement_send(ble_cscs_t * p_cscs, ble_cscs_meas_t * p_measurement);
  191. #ifdef __cplusplus
  192. }
  193. #endif
  194. #endif // BLE_CSCS_H__
  195. /** @} */