123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280 |
- /**
- * 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_c Battery Service Client
- * @{
- * @ingroup ble_sdk_srv
- * @brief Battery Service Client module.
- *
- * @details This module contains APIs to read and interact with the Battery Service of a remote
- * device.
- *
- * @note The application must register this module as the BLE event observer by using the
- * NRF_SDH_BLE_OBSERVER macro. Example:
- * @code
- * ble_bas_c_t instance;
- * NRF_SDH_BLE_OBSERVER(anything, BLE_BAS_C_BLE_OBSERVER_PRIO,
- * ble_bas_c_on_ble_evt, &instance);
- * @endcode
- */
- #ifndef BLE_BAS_C_H__
- #define BLE_BAS_C_H__
- #include <stdint.h>
- #include "ble.h"
- #include "ble_db_discovery.h"
- #include "ble_srv_common.h"
- #include "nrf_ble_gq.h"
- #include "nrf_sdh_ble.h"
- #ifdef __cplusplus
- extern "C" {
- #endif
- /**@brief Macro for defining a ble_bas_c instance.
- *
- * @param _name Name of the instance.
- * @hideinitializer
- */
- #define BLE_BAS_C_DEF(_name) \
- static ble_bas_c_t _name; \
- NRF_SDH_BLE_OBSERVER(_name ## _obs, \
- BLE_BAS_C_BLE_OBSERVER_PRIO, \
- ble_bas_c_on_ble_evt, &_name)
- /** @brief Macro for defining multiple ble_bas_c instances.
- *
- * @param _name Name of the array of instances.
- * @param _cnt Number of instances to define.
- * @hideinitializer
- */
- #define BLE_BAS_C_ARRAY_DEF(_name, _cnt) \
- static ble_bas_c_t _name[_cnt]; \
- NRF_SDH_BLE_OBSERVERS(_name ## _obs, \
- BLE_BAS_C_BLE_OBSERVER_PRIO, \
- ble_bas_c_on_ble_evt, &_name, _cnt)
- /**
- * @defgroup bas_c_enums Enumerations
- * @{
- */
- /**@brief Battery Service Client event type. */
- typedef enum
- {
- BLE_BAS_C_EVT_DISCOVERY_COMPLETE, /**< Event indicating that the Battery Service was discovered at the peer. */
- BLE_BAS_C_EVT_BATT_NOTIFICATION, /**< Event indicating that a notification of the Battery Level characteristic was received from the peer. */
- BLE_BAS_C_EVT_BATT_READ_RESP /**< Event indicating that a read response on Battery Level characteristic was received from the peer. */
- } ble_bas_c_evt_type_t;
- /** @} */
- /**
- * @defgroup bas_c_structs Structures
- * @{
- */
- /**@brief Structure containing the handles related to the Battery Service found on the peer. */
- typedef struct
- {
- uint16_t bl_cccd_handle; /**< Handle of the CCCD of the Battery Level characteristic. */
- uint16_t bl_handle; /**< Handle of the Battery Level characteristic, as provided by the SoftDevice. */
- } ble_bas_c_db_t;
- /**@brief Battery Service Client Event structure. */
- typedef struct
- {
- ble_bas_c_evt_type_t evt_type; /**< Event Type. */
- uint16_t conn_handle; /**< Connection handle relevant to this event.*/
- union
- {
- ble_bas_c_db_t bas_db; /**< Handles related to the Battery Service, found on the peer device. This is filled if the evt_type is @ref BLE_BAS_C_EVT_DISCOVERY_COMPLETE.*/
- uint8_t battery_level; /**< Information about the battery level, received from peer. This field is used for the events @ref BLE_BAS_C_EVT_BATT_NOTIFICATION and @ref BLE_BAS_C_EVT_BATT_READ_RESP.*/
- } params;
- } ble_bas_c_evt_t;
- /** @} */
- /**
- * @defgroup bas_c_types Types
- * @{
- */
- // Forward declaration of the ble_bas_t type.
- typedef struct ble_bas_c_s ble_bas_c_t;
- /**@brief Event handler type.
- *
- * @details This is the type of the event handler that is to be provided by the application
- * of the BAS module to receive events.
- */
- typedef void (* ble_bas_c_evt_handler_t) (ble_bas_c_t * p_bas_bas_c, ble_bas_c_evt_t * p_evt);
- /** @} */
- /**
- * @addtogroup bas_c_structs
- * @{
- */
- /**@brief Battery Service Client structure. */
- struct ble_bas_c_s
- {
- uint16_t conn_handle; /**< Connection handle, as provided by the SoftDevice. */
- ble_bas_c_db_t peer_bas_db; /**< Handles related to BAS on the peer.*/
- ble_bas_c_evt_handler_t evt_handler; /**< Application event handler to be called when there is an event related to the Battery Service. */
- ble_srv_error_handler_t error_handler; /**< Function to be called in case of an error. */
- nrf_ble_gq_t * p_gatt_queue; /**< Pointer to the BLE GATT Queue instance. */
- };
- /**@brief Battery Service Client initialization structure. */
- typedef struct
- {
- ble_bas_c_evt_handler_t evt_handler; /**< Event handler to be called by the Battery Service Client module when there is an event related to the Battery Service. */
- ble_srv_error_handler_t error_handler; /**< Function to be called in case of an error. */
- nrf_ble_gq_t * p_gatt_queue; /**< Pointer to the BLE GATT Queue instance. */
- } ble_bas_c_init_t;
- /** @} */
- /**
- * @defgroup bas_c_functions Functions
- * @{
- */
- /**@brief Function for initializing the Battery Service Client module.
- *
- * @details This function initializes the module and sets up database discovery to discover
- * the Battery Service. After calling this function, call @ref ble_db_discovery_start
- * to start discovery once a link with a peer has been established.
- *
- * @param[out] p_ble_bas_c Pointer to the Battery Service Client structure.
- * @param[in] p_ble_bas_c_init Pointer to the Battery Service initialization structure that contains
- * the initialization information.
- *
- * @retval NRF_SUCCESS Operation success.
- * @retval NRF_ERROR_NULL A parameter is NULL.
- * @retval err_code Otherwise, an error code returned by @ref ble_db_discovery_evt_register.
- */
- uint32_t ble_bas_c_init(ble_bas_c_t * p_ble_bas_c, ble_bas_c_init_t * p_ble_bas_c_init);
- /**@brief Function for handling BLE events from the SoftDevice.
- *
- * @details This function handles the BLE events received from the SoftDevice. If a BLE
- * event is relevant to the Battery Service Client module, the function uses the event's data to update
- * interval variables and, if necessary, send events to the application.
- *
- * @note This function must be called by the application.
- *
- * @param[in] p_ble_evt Pointer to the BLE event.
- * @param[in] p_context Pointer to the Battery Service client structure.
- */
- void ble_bas_c_on_ble_evt(ble_evt_t const * p_ble_evt, void * p_context);
- /**@brief Function for enabling notifications on the Battery Level characteristic.
- *
- * @details This function enables the notification of the Battery Level characteristic at the
- * peer by writing to the CCCD of the Battery Level Characteristic.
- *
- * @param p_ble_bas_c Pointer to the Battery Service client structure.
- *
- * @retval NRF_SUCCESS If the SoftDevice has been requested to write to the CCCD of the peer.
- * @retval NRF_ERROR_NULL Parameter is NULL.
- * @retval err_code Otherwise, an error code returned by the SoftDevice API @ref
- * sd_ble_gattc_write.
- */
- uint32_t ble_bas_c_bl_notif_enable(ble_bas_c_t * p_ble_bas_c);
- /**@brief Function for reading the Battery Level characteristic.
- *
- * @param p_ble_bas_c Pointer to the Battery Service client structure.
- *
- * @retval NRF_SUCCESS If the read request was successfully queued to be sent to peer.
- */
- uint32_t ble_bas_c_bl_read(ble_bas_c_t * p_ble_bas_c);
- /**@brief Function for handling events from the Database Discovery module.
- *
- * @details Call this function when you get a callback event from the Database Discovery module.
- * This function handles an event from the Database Discovery module, and determines
- * whether it relates to the discovery of Battery Service at the peer. If it does, this function
- * calls the application's event handler to indicate that the Battery Service was
- * discovered at the peer. The function also populates the event with service-related
- * information before providing it to the application.
- *
- * @param p_ble_bas_c Pointer to the Battery Service client structure.
- * @param[in] p_evt Pointer to the event received from the Database Discovery module.
- *
- */
- void ble_bas_on_db_disc_evt(ble_bas_c_t * p_ble_bas_c, ble_db_discovery_evt_t const * p_evt);
- /**@brief Function for assigning handles to this instance of bas_c.
- *
- * @details Call this function when a link has been established with a peer to
- * associate the link to this instance of the module. This makes it
- * possible to handle several links and associate each link to a particular
- * instance of this module. The connection handle and attribute handles are
- * provided from the discovery event @ref BLE_BAS_C_EVT_DISCOVERY_COMPLETE.
- *
- * @param[in] p_ble_bas_c Pointer to the Battery client structure instance for associating the link.
- * @param[in] conn_handle Connection handle associated with the given Battery Client Instance.
- * @param[in] p_peer_handles Attribute handles on the BAS server you want this BAS client to
- * interact with.
- */
- uint32_t ble_bas_c_handles_assign(ble_bas_c_t * p_ble_bas_c,
- uint16_t conn_handle,
- ble_bas_c_db_t * p_peer_handles);
- /** @} */ // End tag for Function group.
- #ifdef __cplusplus
- }
- #endif
- #endif // BLE_BAS_C_H__
- /** @} */ // End tag for the file.
|