Junichi Katsu / Mbed 2 deprecated BLE_MPU6050_test6_challenge_sb

テスト用です。

Dependencies:   mbed

nRF51822_wallbot/nordic/nrf-sdk/ble/ble_services/ble_cscs.h@0:8468a4403fea, 2016-10-11 (annotated)

Committer:
jksoft
Date:
Tue Oct 11 11:09:42 2016 +0000
Revision:
0:8468a4403fea
SB??ver;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jksoft 0:8468a4403fea 1 /* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved.
jksoft 0:8468a4403fea 2 *
jksoft 0:8468a4403fea 3 * The information contained herein is property of Nordic Semiconductor ASA.
jksoft 0:8468a4403fea 4 * Terms and conditions of usage are described in detail in NORDIC
jksoft 0:8468a4403fea 5 * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.
jksoft 0:8468a4403fea 6 *
jksoft 0:8468a4403fea 7 * Licensees are granted free, non-transferable use of the information. NO
jksoft 0:8468a4403fea 8 * WARRANTY of ANY KIND is provided. This heading must NOT be removed from
jksoft 0:8468a4403fea 9 * the file.
jksoft 0:8468a4403fea 10 *
jksoft 0:8468a4403fea 11 */
jksoft 0:8468a4403fea 12
jksoft 0:8468a4403fea 13 /** @file
jksoft 0:8468a4403fea 14 *
jksoft 0:8468a4403fea 15 * @defgroup ble_sdk_srv_csc Cycling Speed and Cadence Service
jksoft 0:8468a4403fea 16 * @{
jksoft 0:8468a4403fea 17 * @ingroup ble_sdk_srv
jksoft 0:8468a4403fea 18 * @brief Cycling Speed and Cadence Service module.
jksoft 0:8468a4403fea 19 *
jksoft 0:8468a4403fea 20 * @details This module implements the Cycling Speed and Cadence Service. If enabled, notification
jksoft 0:8468a4403fea 21 * of the Cycling Speead and Candence Measurement is performed when the application
jksoft 0:8468a4403fea 22 * calls ble_cscs_measurement_send().
jksoft 0:8468a4403fea 23 *
jksoft 0:8468a4403fea 24 * To use this service, you need to provide the the supported features (@ref BLE_CSCS_FEATURES).
jksoft 0:8468a4403fea 25 * If you choose to support Wheel revolution data (feature bit @ref BLE_CSCS_FEATURE_WHEEL_REV_BIT),
jksoft 0:8468a4403fea 26 * you then need to support the 'setting of cumulative value' operation by the supporting the
jksoft 0:8468a4403fea 27 * Speed and Cadence Control Point (@ref ble_sdk_srv_sc_ctrlpt) by setting the @ref BLE_SRV_SC_CTRLPT_CUM_VAL_OP_SUPPORTED
jksoft 0:8468a4403fea 28 * bit of the ctrplt_supported_functions in the @ref ble_cscs_init_t structure.
jksoft 0:8468a4403fea 29 * If you want to support the 'start autocalibration' control point feature, you need, after the @ref BLE_SC_CTRLPT_EVT_START_CALIBRATION
jksoft 0:8468a4403fea 30 * 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
jksoft 0:8468a4403fea 31 * and thus be able to receive new control point operations.
jksoft 0:8468a4403fea 32 * If you want to support the 'sensor location' related operation, you need to provide a list of supported location in the
jksoft 0:8468a4403fea 33 * @ref ble_cscs_init_t structure.
jksoft 0:8468a4403fea 34 *
jksoft 0:8468a4403fea 35 *
jksoft 0:8468a4403fea 36 * @note The application or the service using this module must propagate BLE stack events to the
jksoft 0:8468a4403fea 37 * Cycling Speead and Candence Service module by calling ble_cscs_on_ble_evt() from the
jksoft 0:8468a4403fea 38 * from the @ref ble_stack_handler function. This service will forward the event to the @ref ble_sdk_srv_sc_ctrlpt module.
jksoft 0:8468a4403fea 39 *
jksoft 0:8468a4403fea 40 * @note Attention!
jksoft 0:8468a4403fea 41 * To maintain compliance with Nordic Semiconductor ASA Bluetooth profile
jksoft 0:8468a4403fea 42 * qualification listings, this section of source code must not be modified.
jksoft 0:8468a4403fea 43 */
jksoft 0:8468a4403fea 44
jksoft 0:8468a4403fea 45 #ifndef BLE_CSCS_H__
jksoft 0:8468a4403fea 46 #define BLE_CSCS_H__
jksoft 0:8468a4403fea 47
jksoft 0:8468a4403fea 48 #include <stdint.h>
jksoft 0:8468a4403fea 49 #include <stdbool.h>
jksoft 0:8468a4403fea 50 #include "ble.h"
jksoft 0:8468a4403fea 51 #include "ble_srv_common.h"
jksoft 0:8468a4403fea 52 #include "ble_sc_ctrlpt.h"
jksoft 0:8468a4403fea 53 #include "ble_sensor_location.h"
jksoft 0:8468a4403fea 54
jksoft 0:8468a4403fea 55 /** @defgroup BLE_CSCS_FEATURES Cycling Speed and Cadence Service feature bits
jksoft 0:8468a4403fea 56 * @{ */
jksoft 0:8468a4403fea 57 #define BLE_CSCS_FEATURE_WHEEL_REV_BIT (0x01 << 0) /**< Wheel Revolution Data Supported bit. */
jksoft 0:8468a4403fea 58 #define BLE_CSCS_FEATURE_CRANK_REV_BIT (0x01 << 1) /**< Crank Revolution Data Supported bit. */
jksoft 0:8468a4403fea 59 #define BLE_CSCS_FEATURE_MULTIPLE_SENSORS_BIT (0x01 << 2) /**< Multiple Sensor Locations Supported bit. */
jksoft 0:8468a4403fea 60 /** @} */
jksoft 0:8468a4403fea 61
jksoft 0:8468a4403fea 62 /**@brief Cycling Speed and Cadence Service event type. */
jksoft 0:8468a4403fea 63 typedef enum
jksoft 0:8468a4403fea 64 {
jksoft 0:8468a4403fea 65 BLE_CSCS_EVT_NOTIFICATION_ENABLED, /**< Cycling Speed and Cadence value notification enabled event. */
jksoft 0:8468a4403fea 66 BLE_CSCS_EVT_NOTIFICATION_DISABLED /**< Cycling Speed and Cadence value notification disabled event. */
jksoft 0:8468a4403fea 67 } ble_cscs_evt_type_t;
jksoft 0:8468a4403fea 68
jksoft 0:8468a4403fea 69 /**@brief Cycling Speed and Cadence Service event. */
jksoft 0:8468a4403fea 70 typedef struct
jksoft 0:8468a4403fea 71 {
jksoft 0:8468a4403fea 72 ble_cscs_evt_type_t evt_type; /**< Type of event. */
jksoft 0:8468a4403fea 73 } ble_cscs_evt_t;
jksoft 0:8468a4403fea 74
jksoft 0:8468a4403fea 75 // Forward declaration of the ble_csc_t type.
jksoft 0:8468a4403fea 76 typedef struct ble_cscs_s ble_cscs_t;
jksoft 0:8468a4403fea 77
jksoft 0:8468a4403fea 78 /**@brief Cycling Speed and Cadence Service event handler type. */
jksoft 0:8468a4403fea 79 typedef void (*ble_cscs_evt_handler_t) (ble_cscs_t * p_cscs, ble_cscs_evt_t * p_evt);
jksoft 0:8468a4403fea 80
jksoft 0:8468a4403fea 81 /**@brief Cycling Speed and Cadence Service init structure. This contains all options and data
jksoft 0:8468a4403fea 82 * needed for initialization of the service. */
jksoft 0:8468a4403fea 83 typedef struct
jksoft 0:8468a4403fea 84 {
jksoft 0:8468a4403fea 85 ble_cscs_evt_handler_t evt_handler; /**< Event handler to be called for handling events in the Cycling Speed and Cadence Service. */
jksoft 0:8468a4403fea 86 ble_srv_cccd_security_mode_t csc_meas_attr_md; /**< Initial security level for cycling speed and cadence measurement attribute */
jksoft 0:8468a4403fea 87 ble_srv_cccd_security_mode_t csc_ctrlpt_attr_md; /**< Initial security level for cycling speed and cadence control point attribute */
jksoft 0:8468a4403fea 88 ble_srv_security_mode_t csc_feature_attr_md; /**< Initial security level for feature attribute */
jksoft 0:8468a4403fea 89 uint16_t feature; /**< Initial value for features of sensor @ref BLE_CSCS_FEATURES. */
jksoft 0:8468a4403fea 90 uint8_t ctrplt_supported_functions; /**< Supported control point functionnalities see @ref BLE_SRV_SC_CTRLPT_SUPP_FUNC. */
jksoft 0:8468a4403fea 91 ble_sc_ctrlpt_evt_handler_t ctrlpt_evt_handler; /**< Event handler */
jksoft 0:8468a4403fea 92 ble_sensor_location_t *list_supported_locations; /**< List of supported sensor locations.*/
jksoft 0:8468a4403fea 93 uint8_t size_list_supported_locations; /**< Number of supported sensor locations in the list.*/
jksoft 0:8468a4403fea 94 ble_srv_error_handler_t error_handler; /**< Function to be called in case of an error. */
jksoft 0:8468a4403fea 95 ble_sensor_location_t *sensor_location; /**< Initial Sensor Location, if NULL, sensor_location characteristic is not added*/
jksoft 0:8468a4403fea 96 ble_srv_cccd_security_mode_t csc_sensor_loc_attr_md; /**< Initial security level for sensor location attribute */
jksoft 0:8468a4403fea 97 } ble_cscs_init_t;
jksoft 0:8468a4403fea 98
jksoft 0:8468a4403fea 99 /**@brief Cycling Speed and Cadence Service structure. This contains various status information for
jksoft 0:8468a4403fea 100 * the service. */
jksoft 0:8468a4403fea 101 typedef struct ble_cscs_s
jksoft 0:8468a4403fea 102 {
jksoft 0:8468a4403fea 103 ble_cscs_evt_handler_t evt_handler; /**< Event handler to be called for handling events in the Cycling Speed and Cadence Service. */
jksoft 0:8468a4403fea 104 uint16_t service_handle; /**< Handle of Cycling Speed and Cadence Service (as provided by the BLE stack). */
jksoft 0:8468a4403fea 105 ble_gatts_char_handles_t meas_handles; /**< Handles related to the Cycling Speed and Cadence Measurement characteristic. */
jksoft 0:8468a4403fea 106 ble_gatts_char_handles_t feature_handles; /**< Handles related to the Cycling Speed and Cadence feature characteristic. */
jksoft 0:8468a4403fea 107 ble_gatts_char_handles_t sensor_loc_handles; /**< Handles related to the Cycling Speed and Cadence Sensor Location characteristic. */
jksoft 0:8468a4403fea 108 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). */
jksoft 0:8468a4403fea 109 uint16_t feature; /**< Bit mask of features available on sensor. */
jksoft 0:8468a4403fea 110 ble_sc_ctrlpt_t ctrl_pt; /**< data for speed and cadence control point */
jksoft 0:8468a4403fea 111 } ble_cscs_t;
jksoft 0:8468a4403fea 112
jksoft 0:8468a4403fea 113 /**@brief Cycling Speed and Cadence Service measurement structure. This contains a Cycling Speed and
jksoft 0:8468a4403fea 114 * Cadence Service measurement. */
jksoft 0:8468a4403fea 115 typedef struct ble_cscs_meas_s
jksoft 0:8468a4403fea 116 {
jksoft 0:8468a4403fea 117 bool is_wheel_rev_data_present; /**< True if Wheel Revolution Data is present in the measurement. */
jksoft 0:8468a4403fea 118 bool is_crank_rev_data_present; /**< True if Crank Revolution Data is present in the measurement. */
jksoft 0:8468a4403fea 119 uint32_t cumulative_wheel_revs; /**< Cumulative Wheel Revolutions. */
jksoft 0:8468a4403fea 120 uint16_t last_wheel_event_time; /**< Last Wheel Event Time. */
jksoft 0:8468a4403fea 121 uint16_t cumulative_crank_revs; /**< Cumulative Crank Revolutions. */
jksoft 0:8468a4403fea 122 uint16_t last_crank_event_time; /**< Last Crank Event Time. */
jksoft 0:8468a4403fea 123 } ble_cscs_meas_t;
jksoft 0:8468a4403fea 124
jksoft 0:8468a4403fea 125 /**@brief Function for initializing the Cycling Speed and Cadence Service.
jksoft 0:8468a4403fea 126 *
jksoft 0:8468a4403fea 127 * @param[out] p_cscs Cycling Speed and Cadence Service structure. This structure will have to
jksoft 0:8468a4403fea 128 * be supplied by the application. It will be initialized by this function,
jksoft 0:8468a4403fea 129 * and will later be used to identify this particular service instance.
jksoft 0:8468a4403fea 130 * @param[in] p_cscs_init Information needed to initialize the service.
jksoft 0:8468a4403fea 131 *
jksoft 0:8468a4403fea 132 * @return NRF_SUCCESS on successful initialization of service, otherwise an error code.
jksoft 0:8468a4403fea 133 */
jksoft 0:8468a4403fea 134 uint32_t ble_cscs_init(ble_cscs_t * p_cscs, const ble_cscs_init_t * p_cscs_init);
jksoft 0:8468a4403fea 135
jksoft 0:8468a4403fea 136 /**@brief Function for handling the Application's BLE Stack events.
jksoft 0:8468a4403fea 137 *
jksoft 0:8468a4403fea 138 * @details Handles all events from the BLE stack of interest to the Cycling Speed and Cadence
jksoft 0:8468a4403fea 139 * Service.
jksoft 0:8468a4403fea 140 *
jksoft 0:8468a4403fea 141 * @param[in] p_cscs Cycling Speed and Cadence Service structure.
jksoft 0:8468a4403fea 142 * @param[in] p_ble_evt Event received from the BLE stack.
jksoft 0:8468a4403fea 143 */
jksoft 0:8468a4403fea 144 void ble_cscs_on_ble_evt(ble_cscs_t * p_cscs, ble_evt_t * p_ble_evt);
jksoft 0:8468a4403fea 145
jksoft 0:8468a4403fea 146 /**@brief Function for sending cycling speed and cadence measurement if notification has been enabled.
jksoft 0:8468a4403fea 147 *
jksoft 0:8468a4403fea 148 * @details The application calls this function after having performed a Cycling Speed and Cadence
jksoft 0:8468a4403fea 149 * Service measurement. If notification has been enabled, the measurement data is encoded
jksoft 0:8468a4403fea 150 * and sent to the client.
jksoft 0:8468a4403fea 151 *
jksoft 0:8468a4403fea 152 * @param[in] p_cscs Cycling Speed and Cadence Service structure.
jksoft 0:8468a4403fea 153 * @param[in] p_measurement Pointer to new cycling speed and cadence measurement.
jksoft 0:8468a4403fea 154 *
jksoft 0:8468a4403fea 155 * @return NRF_SUCCESS on success, otherwise an error code.
jksoft 0:8468a4403fea 156 */
jksoft 0:8468a4403fea 157 uint32_t ble_cscs_measurement_send(ble_cscs_t * p_cscs, ble_cscs_meas_t * p_measurement);
jksoft 0:8468a4403fea 158
jksoft 0:8468a4403fea 159 #endif // BLE_CSCS_H__
jksoft 0:8468a4403fea 160
jksoft 0:8468a4403fea 161 /** @} */