/* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved. * * The information contained herein is property of Nordic Semiconductor ASA. * Terms and conditions of usage are described in detail in NORDIC * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT. * * Licensees are granted free, non-transferable use of the information. NO * WARRANTY of ANY KIND is provided. This heading must NOT be removed from * the file. * */ /** @file * * @defgroup ble_sdk_srv_cp Cycling Power Service * @{ * @ingroup ble_sdk_srv * @brief Cycling Power Service module. * * @details This module implements the Cycling Power Service. If enabled, notification * of the Cycling Speead and Candence Measurement is performed when the application * calls ble_cps_measurement_send(). * * To use this service, you need to provide the the supported features (@ref BLE_cpS_FEATURES). * If you choose to support Wheel revolution data (feature bit @ref BLE_cpS_FEATURE_WHEEL_REV_BIT), * you then need to support the 'setting of cumulative value' operation by the supporting the * Speed and Cadence Control Point (@ref ble_sdk_srv_sc_ctrlpt) by setting the @ref BLE_SRV_SC_CTRLPT_CUM_VAL_OP_SUPPORTED * bit of the ctrplt_supported_functions in the @ref ble_cps_init_t structure. * If you want to support the 'start autocalibration' control point feature, you need, after the @ref BLE_SC_CTRLPT_EVT_START_CALIBRATION * 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 * and thus be able to receive new control point operations. * If you want to support the 'sensor location' related operation, you need to provide a list of supported location in the * @ref ble_cps_init_t structure. * * * @note The application or the service using this module must propagate BLE stack events to the * Cycling Speead and Candence Service module by calling ble_cps_on_ble_evt() from the * from the @ref ble_stack_handler function. This service will forward the event to the @ref ble_sdk_srv_sc_ctrlpt module. * * @note Attention! * To maintain compliance with Nordic Semiconductor ASA Bluetooth profile * qualification listings, this section of source code must not be modified. */ #ifndef BLE_CP_H__ #define BLE_CP_H__ #include #include #include "ble.h" #include "ble_srv_common.h" #include "ble_sc_ctrlpt.h" #include "ble_sensor_location.h" /**@brief Macro for defining a ble_cscs instance. * * @param _name Name of the instance. * @hideinitializer */ #define BLE_CPS_DEF(_name) \ static ble_cscs_t _name; \ NRF_SDH_BLE_OBSERVER(_name ## _obs, \ BLE_CSCS_BLE_OBSERVER_PRIO, /**/ \ ble_cps_on_ble_evt, &_name) /** @defgroup BLE_cpS_FEATURES Cycling Power Service feature bits * @{ */ #define BLE_CPS_FEATURE_WHEEL_REV_BIT (0x01 << 0) /**< Wheel Revolution Data Supported bit. */ #define BLE_CPS_FEATURE_CRANK_REV_BIT (0x01 << 1) /**< Crank Revolution Data Supported bit. */ #define BLE_CPS_FEATURE_MULTIPLE_SENSORS_BIT (0x01 << 2) /**< Multiple Sensor Locations Supported bit. */ /** @} */ /**@brief Cycling Power Service event type. */ typedef enum { BLE_cpS_EVT_NOTIFICATION_ENABLED, /**< Cycling Power value notification enabled event. */ BLE_cpS_EVT_NOTIFICATION_DISABLED /**< Cycling Power value notification disabled event. */ } ble_cps_evt_type_t; /**@brief Cycling Power Service event. */ typedef struct { ble_cps_evt_type_t evt_type; /**< Type of event. */ } ble_cps_evt_t; // Forward declaration of the ble_cp_t type. typedef struct ble_cps_s ble_cps_t; /**@brief Cycling Power Service event handler type. */ typedef void (*ble_cps_evt_handler_t) (ble_cps_t * p_cps, ble_cps_evt_t * p_evt); /**@brief Cycling Power Service init structure. This contains all options and data * needed for initialization of the service. */ typedef struct { ble_cps_evt_handler_t evt_handler; /**< Event handler to be called for handling events in the Cycling Power Service. */ ble_srv_cccd_security_mode_t cp_meas_attr_md; /**< Initial security level for Cycling Power measurement attribute */ //ble_srv_cccd_security_mode_t cp_ctrlpt_attr_md; /**< Initial security level for Cycling Power control point attribute */ ble_srv_security_mode_t cp_feature_attr_md; /**< Initial security level for feature attribute */ //uint8_t ctrplt_supported_functions; /**< Supported control point functionnalities see @ref BLE_SRV_SC_CTRLPT_SUPP_FUNC. */ //ble_sc_ctrlpt_evt_handler_t ctrlpt_evt_handler; /**< Event handler */ uint32_t feature; /**< Initial value for features of sensor @ref BLE_cpS_FEATURES. */ ble_sensor_location_t *list_supported_locations; /**< List of supported sensor locations.*/ uint8_t size_list_supported_locations; /**< Number of supported sensor locations in the list.*/ //ble_sc_ctrlpt_evt_handler_t ctrlpt_evt_handler; /**< Event handler */ ble_srv_error_handler_t error_handler; /**< Function to be called in case of an error. */ ble_sensor_location_t *sensor_location; /**< Initial Sensor Location, if NULL, sensor_location characteristic is not added*/ ble_srv_cccd_security_mode_t cp_sensor_loc_attr_md; /**< Initial security level for sensor location attribute */ } ble_cps_init_t; /**@brief Cycling Power Service structure. This contains various status information for * the service. */ typedef struct ble_cps_s { ble_cps_evt_handler_t evt_handler; /**< Event handler to be called for handling events in the Cycling Power Service. */ uint16_t service_handle; /**< Handle of Cycling Power Service (as provided by the BLE stack). */ ble_gatts_char_handles_t meas_handles; /**< Handles related to the Cycling Power Measurement characteristic. */ ble_gatts_char_handles_t feature_handles; /**< Handles related to the Cycling Power feature characteristic. */ ble_gatts_char_handles_t sensor_loc_handles; /**< Handles related to the Cycling Power Sensor Location characteristic. */ 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). */ ble_sc_ctrlpt_t ctrl_pt; /**< data for speed and cadence control point */ uint32_t feature; /**< Bit mask of features available on sensor. */ }; //ble_cps_t; //todo debug /**@brief Cycling Power Service measurement structure. This contains a Cycling Speed and * Cadence Service measurement. */ typedef struct ble_cps_meas_s { int16_t power_measurement; } ble_cps_meas_t; /**@brief Function for initializing the Cycling Power Service. * * @param[out] p_cps Cycling Power Service structure. This structure will have to * be supplied by the application. It will be initialized by this function, * and will later be used to identify this particular service instance. * @param[in] p_cps_init Information needed to initialize the service. * * @return NRF_SUCCESS on successful initialization of service, otherwise an error code. */ uint32_t ble_cps_init(ble_cps_t * p_cps, const ble_cps_init_t * p_cps_init); /**@brief Function for handling the Application's BLE Stack events. * * @details Handles all events from the BLE stack of interest to the Cycling Power * Service. * * @param[in] p_cps Cycling Power Service structure. * @param[in] p_ble_evt Event received from the BLE stack. */ void ble_cps_on_ble_evt(ble_cps_t * p_cps, ble_evt_t * p_ble_evt); /**@brief Function for sending Cycling Power measurement if notification has been enabled. * * @details The application calls this function after having performed a Cycling Power * Service measurement. If notification has been enabled, the measurement data is encoded * and sent to the client. * * @param[in] p_cps Cycling Power Service structure. * @param[in] p_measurement Pointer to new Cycling Power measurement. * * @return NRF_SUCCESS on success, otherwise an error code. */ uint32_t ble_cps_measurement_send(ble_cps_t * p_cps, ble_cps_meas_t * p_measurement); #endif // BLE_CPS_H_ /** @} */