Yihui Xiong / Mbed 2 deprecated BLE_Default_APP

BLE FOTA APP

Dependencies:   BLE_API mbed

It doesn't work with the default FOTA bootloader. It use NVIC_SystemReset() to enter a bootloader.

nRF51822/nordic/nrf-sdk/ble/ble_services/ble_cscs.h@1:a607cd9655d7, 2014-10-10 (annotated)

Committer:
yihui
Date:
Fri Oct 10 03:36:28 2014 +0000
Revision:
1:a607cd9655d7
use NVIC_SystemReset() to run bootloader

Who changed what in which revision?

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