Junichi Katsu / Mbed 2 deprecated BLE_RCBController2

iOSのBLEコントローラアプリ「RCBController」と接続し、コントローラの操作を取得するサンプルプログラムです。 mbed HRM1017で動作を確認しています。 2014.08.20時点でのBLEライブラリに対応しました。

Dependencies:   BLE_API mbed

Fork of BLE_RCBController by Junichi Katsu

HRM1017/nordic/nrf-sdk/ble/ble_services/ble_cscs.h@4:ebda47d22091, 2014-08-20 (annotated)

Committer:
jksoft
Date:
Wed Aug 20 13:41:01 2014 +0000
Revision:
4:ebda47d22091
Parent:
nRF51822/nordic/nrf-sdk/ble/ble_services/ble_cscs.h@1:48f6e08a3ac2 
?????????

Who changed what in which revision?

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