123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212 |
- /**
- * Copyright (c) 2012 - 2020, Nordic Semiconductor ASA
- *
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- *
- * 1. Redistributions of source code must retain the above copyright notice, this
- * list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form, except as embedded into a Nordic
- * Semiconductor ASA integrated circuit in a product or a software update for
- * such product, must reproduce the above copyright notice, this list of
- * conditions and the following disclaimer in the documentation and/or other
- * materials provided with the distribution.
- *
- * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
- * contributors may be used to endorse or promote products derived from this
- * software without specific prior written permission.
- *
- * 4. This software, with or without modification, must only be used with a
- * Nordic Semiconductor ASA integrated circuit.
- *
- * 5. Any software provided in binary form under this license must not be reverse
- * engineered, decompiled, modified and/or disassembled.
- *
- * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
- * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
- * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
- * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- */
- /** @file
- *
- * @defgroup ble_bas Battery Service
- * @{
- * @ingroup ble_sdk_srv
- * @brief Battery Service module.
- *
- * @details This module implements the Battery Service with the Battery Level characteristic.
- * During initialization it adds the Battery Service and Battery Level characteristic
- * to the BLE stack database. Optionally it can also add a Report Reference descriptor
- * to the Battery Level characteristic (used when including the Battery Service in
- * the HID service).
- *
- * If specified, the module will support notification of the Battery Level characteristic
- * through the ble_bas_battery_level_update() function.
- * If an event handler is supplied by the application, the Battery Service will
- * generate Battery Service events to the application.
- *
- * @note The application must register this module as BLE event observer using the
- * NRF_SDH_BLE_OBSERVER macro. Example:
- * @code
- * ble_bas_t instance;
- * NRF_SDH_BLE_OBSERVER(anything, BLE_BAS_BLE_OBSERVER_PRIO,
- * ble_bas_on_ble_evt, &instance);
- * @endcode
- *
- * @note Attention!
- * To maintain compliance with Nordic Semiconductor ASA Bluetooth profile
- * qualification listings, this section of source code must not be modified.
- */
- #ifndef BLE_BAS_H__
- #define BLE_BAS_H__
- #include <stdint.h>
- #include <stdbool.h>
- #include "ble.h"
- #include "ble_srv_common.h"
- #include "nrf_sdh_ble.h"
- #ifdef __cplusplus
- extern "C" {
- #endif
- /**@brief Macro for defining a ble_bas instance.
- *
- * @param _name Name of the instance.
- * @hideinitializer
- */
- #define BLE_BAS_DEF(_name) \
- static ble_bas_t _name; \
- NRF_SDH_BLE_OBSERVER(_name ## _obs, \
- BLE_BAS_BLE_OBSERVER_PRIO, \
- ble_bas_on_ble_evt, \
- &_name)
- /**@brief Battery Service event type. */
- typedef enum
- {
- BLE_BAS_EVT_NOTIFICATION_ENABLED, /**< Battery value notification enabled event. */
- BLE_BAS_EVT_NOTIFICATION_DISABLED /**< Battery value notification disabled event. */
- } ble_bas_evt_type_t;
- /**@brief Battery Service event. */
- typedef struct
- {
- ble_bas_evt_type_t evt_type; /**< Type of event. */
- uint16_t conn_handle; /**< Connection handle. */
- } ble_bas_evt_t;
- // Forward declaration of the ble_bas_t type.
- typedef struct ble_bas_s ble_bas_t;
- /**@brief Battery Service event handler type. */
- typedef void (* ble_bas_evt_handler_t) (ble_bas_t * p_bas, ble_bas_evt_t * p_evt);
- /**@brief Battery Service init structure. This contains all options and data needed for
- * initialization of the service.*/
- typedef struct
- {
- ble_bas_evt_handler_t evt_handler; /**< Event handler to be called for handling events in the Battery Service. */
- bool support_notification; /**< TRUE if notification of Battery Level measurement is supported. */
- ble_srv_report_ref_t * p_report_ref; /**< If not NULL, a Report Reference descriptor with the specified value will be added to the Battery Level characteristic */
- uint8_t initial_batt_level; /**< Initial battery level */
- security_req_t bl_rd_sec; /**< Security requirement for reading the BL characteristic value. */
- security_req_t bl_cccd_wr_sec; /**< Security requirement for writing the BL characteristic CCCD. */
- security_req_t bl_report_rd_sec; /**< Security requirement for reading the BL characteristic descriptor. */
- } ble_bas_init_t;
- /**@brief Battery Service structure. This contains various status information for the service. */
- struct ble_bas_s
- {
- ble_bas_evt_handler_t evt_handler; /**< Event handler to be called for handling events in the Battery Service. */
- uint16_t service_handle; /**< Handle of Battery Service (as provided by the BLE stack). */
- ble_gatts_char_handles_t battery_level_handles; /**< Handles related to the Battery Level characteristic. */
- uint16_t report_ref_handle; /**< Handle of the Report Reference descriptor. */
- uint8_t battery_level_last; /**< Last Battery Level measurement passed to the Battery Service. */
- bool is_notification_supported; /**< TRUE if notification of Battery Level is supported. */
- };
- /**@brief Function for initializing the Battery Service.
- *
- * @param[out] p_bas Battery 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_bas_init Information needed to initialize the service.
- *
- * @return NRF_SUCCESS on successful initialization of service, otherwise an error code.
- */
- ret_code_t ble_bas_init(ble_bas_t * p_bas, const ble_bas_init_t * p_bas_init);
- /**@brief Function for handling the Application's BLE Stack events.
- *
- * @details Handles all events from the BLE stack of interest to the Battery Service.
- *
- * @note For the requirements in the BAS specification to be fulfilled,
- * ble_bas_battery_level_update() must be called upon reconnection if the
- * battery level has changed while the service has been disconnected from a bonded
- * client.
- *
- * @param[in] p_ble_evt Event received from the BLE stack.
- * @param[in] p_context Battery Service structure.
- */
- void ble_bas_on_ble_evt(ble_evt_t const * p_ble_evt, void * p_context);
- /**@brief Function for updating the battery level.
- *
- * @details The application calls this function after having performed a battery measurement.
- * The battery level characteristic will only be sent to the clients which have
- * enabled notifications. \ref BLE_CONN_HANDLE_ALL can be used as a connection handle
- * to send notifications to all connected devices.
- *
- * @param[in] p_bas Battery Service structure.
- * @param[in] battery_level New battery measurement value (in percent of full capacity).
- * @param[in] conn_handle Connection handle.
- *
- * @return NRF_SUCCESS on success, otherwise an error code.
- */
- ret_code_t ble_bas_battery_level_update(ble_bas_t * p_bas,
- uint8_t battery_level,
- uint16_t conn_handle);
- /**@brief Function for sending the last battery level when bonded client reconnects.
- *
- * @details The application calls this function, in the case of a reconnection of
- * a bonded client if the value of the battery has changed since
- * its disconnection.
- *
- * @note For the requirements in the BAS specification to be fulfilled,
- * this function must be called upon reconnection if the battery level has changed
- * while the service has been disconnected from a bonded client.
- *
- * @param[in] p_bas Battery Service structure.
- * @param[in] conn_handle Connection handle.
- *
- * @return NRF_SUCCESS on success,
- * NRF_ERROR_INVALID_STATE when notification is not supported,
- * otherwise an error code returned by @ref sd_ble_gatts_hvx.
- */
- ret_code_t ble_bas_battery_lvl_on_reconnection_update(ble_bas_t * p_bas,
- uint16_t conn_handle);
- #ifdef __cplusplus
- }
- #endif
- #endif // BLE_BAS_H__
- /** @} */
|