初始版本
This commit is contained in:
365
components/ble/ble_services/ble_bas/ble_bas.c
Normal file
365
components/ble/ble_services/ble_bas/ble_bas.c
Normal file
@@ -0,0 +1,365 @@
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
/* Attention!
|
||||
* To maintain compliance with Nordic Semiconductor ASA's Bluetooth profile
|
||||
* qualification listings, this section of source code must not be modified.
|
||||
*/
|
||||
#include "sdk_common.h"
|
||||
#if NRF_MODULE_ENABLED(BLE_BAS)
|
||||
#include "ble_bas.h"
|
||||
#include <string.h>
|
||||
#include "ble_srv_common.h"
|
||||
#include "ble_conn_state.h"
|
||||
|
||||
#define NRF_LOG_MODULE_NAME ble_bas
|
||||
#if BLE_BAS_CONFIG_LOG_ENABLED
|
||||
#define NRF_LOG_LEVEL BLE_BAS_CONFIG_LOG_LEVEL
|
||||
#define NRF_LOG_INFO_COLOR BLE_BAS_CONFIG_INFO_COLOR
|
||||
#define NRF_LOG_DEBUG_COLOR BLE_BAS_CONFIG_DEBUG_COLOR
|
||||
#else // BLE_BAS_CONFIG_LOG_ENABLED
|
||||
#define NRF_LOG_LEVEL 0
|
||||
#endif // BLE_BAS_CONFIG_LOG_ENABLED
|
||||
#include "nrf_log.h"
|
||||
NRF_LOG_MODULE_REGISTER();
|
||||
|
||||
|
||||
#define INVALID_BATTERY_LEVEL 255
|
||||
|
||||
|
||||
/**@brief Function for handling the Write event.
|
||||
*
|
||||
* @param[in] p_bas Battery Service structure.
|
||||
* @param[in] p_ble_evt Event received from the BLE stack.
|
||||
*/
|
||||
static void on_write(ble_bas_t * p_bas, ble_evt_t const * p_ble_evt)
|
||||
{
|
||||
if (!p_bas->is_notification_supported)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
ble_gatts_evt_write_t const * p_evt_write = &p_ble_evt->evt.gatts_evt.params.write;
|
||||
|
||||
if ( (p_evt_write->handle == p_bas->battery_level_handles.cccd_handle)
|
||||
&& (p_evt_write->len == 2))
|
||||
{
|
||||
if (p_bas->evt_handler == NULL)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
ble_bas_evt_t evt;
|
||||
|
||||
if (ble_srv_is_notification_enabled(p_evt_write->data))
|
||||
{
|
||||
evt.evt_type = BLE_BAS_EVT_NOTIFICATION_ENABLED;
|
||||
}
|
||||
else
|
||||
{
|
||||
evt.evt_type = BLE_BAS_EVT_NOTIFICATION_DISABLED;
|
||||
}
|
||||
evt.conn_handle = p_ble_evt->evt.gatts_evt.conn_handle;
|
||||
|
||||
// CCCD written, call application event handler.
|
||||
p_bas->evt_handler(p_bas, &evt);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void ble_bas_on_ble_evt(ble_evt_t const * p_ble_evt, void * p_context)
|
||||
{
|
||||
if ((p_context == NULL) || (p_ble_evt == NULL))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
ble_bas_t * p_bas = (ble_bas_t *)p_context;
|
||||
|
||||
switch (p_ble_evt->header.evt_id)
|
||||
{
|
||||
case BLE_GATTS_EVT_WRITE:
|
||||
on_write(p_bas, p_ble_evt);
|
||||
break;
|
||||
|
||||
default:
|
||||
// No implementation needed.
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**@brief Function for adding the Battery Level characteristic.
|
||||
*
|
||||
* @param[in] p_bas Battery Service structure.
|
||||
* @param[in] p_bas_init Information needed to initialize the service.
|
||||
*
|
||||
* @return NRF_SUCCESS on success, otherwise an error code.
|
||||
*/
|
||||
static ret_code_t battery_level_char_add(ble_bas_t * p_bas, const ble_bas_init_t * p_bas_init)
|
||||
{
|
||||
ret_code_t err_code;
|
||||
ble_add_char_params_t add_char_params;
|
||||
ble_add_descr_params_t add_descr_params;
|
||||
uint8_t initial_battery_level;
|
||||
uint8_t init_len;
|
||||
uint8_t encoded_report_ref[BLE_SRV_ENCODED_REPORT_REF_LEN];
|
||||
|
||||
// Add battery level characteristic
|
||||
initial_battery_level = p_bas_init->initial_batt_level;
|
||||
|
||||
memset(&add_char_params, 0, sizeof(add_char_params));
|
||||
add_char_params.uuid = BLE_UUID_BATTERY_LEVEL_CHAR;
|
||||
add_char_params.max_len = sizeof(uint8_t);
|
||||
add_char_params.init_len = sizeof(uint8_t);
|
||||
add_char_params.p_init_value = &initial_battery_level;
|
||||
add_char_params.char_props.notify = p_bas->is_notification_supported;
|
||||
add_char_params.char_props.read = 1;
|
||||
add_char_params.cccd_write_access = p_bas_init->bl_cccd_wr_sec;
|
||||
add_char_params.read_access = p_bas_init->bl_rd_sec;
|
||||
|
||||
err_code = characteristic_add(p_bas->service_handle,
|
||||
&add_char_params,
|
||||
&(p_bas->battery_level_handles));
|
||||
if (err_code != NRF_SUCCESS)
|
||||
{
|
||||
return err_code;
|
||||
}
|
||||
|
||||
if (p_bas_init->p_report_ref != NULL)
|
||||
{
|
||||
// Add Report Reference descriptor
|
||||
init_len = ble_srv_report_ref_encode(encoded_report_ref, p_bas_init->p_report_ref);
|
||||
|
||||
memset(&add_descr_params, 0, sizeof(add_descr_params));
|
||||
add_descr_params.uuid = BLE_UUID_REPORT_REF_DESCR;
|
||||
add_descr_params.read_access = p_bas_init->bl_report_rd_sec;
|
||||
add_descr_params.init_len = init_len;
|
||||
add_descr_params.max_len = add_descr_params.init_len;
|
||||
add_descr_params.p_value = encoded_report_ref;
|
||||
|
||||
err_code = descriptor_add(p_bas->battery_level_handles.value_handle,
|
||||
&add_descr_params,
|
||||
&p_bas->report_ref_handle);
|
||||
return err_code;
|
||||
}
|
||||
else
|
||||
{
|
||||
p_bas->report_ref_handle = BLE_GATT_HANDLE_INVALID;
|
||||
}
|
||||
|
||||
return NRF_SUCCESS;
|
||||
}
|
||||
|
||||
|
||||
ret_code_t ble_bas_init(ble_bas_t * p_bas, const ble_bas_init_t * p_bas_init)
|
||||
{
|
||||
if (p_bas == NULL || p_bas_init == NULL)
|
||||
{
|
||||
return NRF_ERROR_NULL;
|
||||
}
|
||||
|
||||
ret_code_t err_code;
|
||||
ble_uuid_t ble_uuid;
|
||||
|
||||
// Initialize service structure
|
||||
p_bas->evt_handler = p_bas_init->evt_handler;
|
||||
p_bas->is_notification_supported = p_bas_init->support_notification;
|
||||
p_bas->battery_level_last = INVALID_BATTERY_LEVEL;
|
||||
|
||||
// Add service
|
||||
BLE_UUID_BLE_ASSIGN(ble_uuid, BLE_UUID_BATTERY_SERVICE);
|
||||
|
||||
err_code = sd_ble_gatts_service_add(BLE_GATTS_SRVC_TYPE_PRIMARY, &ble_uuid, &p_bas->service_handle);
|
||||
VERIFY_SUCCESS(err_code);
|
||||
|
||||
// Add battery level characteristic
|
||||
err_code = battery_level_char_add(p_bas, p_bas_init);
|
||||
return err_code;
|
||||
}
|
||||
|
||||
|
||||
/**@brief Function for sending notifications with the Battery Level characteristic.
|
||||
*
|
||||
* @param[in] p_hvx_params Pointer to structure with notification data.
|
||||
* @param[in] conn_handle Connection handle.
|
||||
*
|
||||
* @return NRF_SUCCESS on success, otherwise an error code.
|
||||
*/
|
||||
static ret_code_t battery_notification_send(ble_gatts_hvx_params_t * const p_hvx_params,
|
||||
uint16_t conn_handle)
|
||||
{
|
||||
ret_code_t err_code = sd_ble_gatts_hvx(conn_handle, p_hvx_params);
|
||||
if (err_code == NRF_SUCCESS)
|
||||
{
|
||||
NRF_LOG_INFO("Battery notification has been sent using conn_handle: 0x%04X", conn_handle);
|
||||
}
|
||||
else
|
||||
{
|
||||
NRF_LOG_DEBUG("Error: 0x%08X while sending notification with conn_handle: 0x%04X",
|
||||
err_code,
|
||||
conn_handle);
|
||||
}
|
||||
return err_code;
|
||||
}
|
||||
|
||||
|
||||
ret_code_t ble_bas_battery_level_update(ble_bas_t * p_bas,
|
||||
uint8_t battery_level,
|
||||
uint16_t conn_handle)
|
||||
{
|
||||
if (p_bas == NULL)
|
||||
{
|
||||
return NRF_ERROR_NULL;
|
||||
}
|
||||
|
||||
ret_code_t err_code = NRF_SUCCESS;
|
||||
ble_gatts_value_t gatts_value;
|
||||
|
||||
if (battery_level != p_bas->battery_level_last)
|
||||
{
|
||||
// Initialize value struct.
|
||||
memset(&gatts_value, 0, sizeof(gatts_value));
|
||||
|
||||
gatts_value.len = sizeof(uint8_t);
|
||||
gatts_value.offset = 0;
|
||||
gatts_value.p_value = &battery_level;
|
||||
|
||||
// Update database.
|
||||
err_code = sd_ble_gatts_value_set(BLE_CONN_HANDLE_INVALID,
|
||||
p_bas->battery_level_handles.value_handle,
|
||||
&gatts_value);
|
||||
if (err_code == NRF_SUCCESS)
|
||||
{
|
||||
NRF_LOG_INFO("Battery level has been updated: %d%%", battery_level)
|
||||
|
||||
// Save new battery value.
|
||||
p_bas->battery_level_last = battery_level;
|
||||
}
|
||||
else
|
||||
{
|
||||
NRF_LOG_DEBUG("Error during battery level update: 0x%08X", err_code)
|
||||
|
||||
return err_code;
|
||||
}
|
||||
|
||||
// Send value if connected and notifying.
|
||||
if (p_bas->is_notification_supported)
|
||||
{
|
||||
ble_gatts_hvx_params_t hvx_params;
|
||||
|
||||
memset(&hvx_params, 0, sizeof(hvx_params));
|
||||
|
||||
hvx_params.handle = p_bas->battery_level_handles.value_handle;
|
||||
hvx_params.type = BLE_GATT_HVX_NOTIFICATION;
|
||||
hvx_params.offset = gatts_value.offset;
|
||||
hvx_params.p_len = &gatts_value.len;
|
||||
hvx_params.p_data = gatts_value.p_value;
|
||||
|
||||
if (conn_handle == BLE_CONN_HANDLE_ALL)
|
||||
{
|
||||
ble_conn_state_conn_handle_list_t conn_handles = ble_conn_state_conn_handles();
|
||||
|
||||
// Try sending notifications to all valid connection handles.
|
||||
for (uint32_t i = 0; i < conn_handles.len; i++)
|
||||
{
|
||||
if (ble_conn_state_status(conn_handles.conn_handles[i]) == BLE_CONN_STATUS_CONNECTED)
|
||||
{
|
||||
if (err_code == NRF_SUCCESS)
|
||||
{
|
||||
err_code = battery_notification_send(&hvx_params,
|
||||
conn_handles.conn_handles[i]);
|
||||
}
|
||||
else
|
||||
{
|
||||
// Preserve the first non-zero error code
|
||||
UNUSED_RETURN_VALUE(battery_notification_send(&hvx_params,
|
||||
conn_handles.conn_handles[i]));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
err_code = battery_notification_send(&hvx_params, conn_handle);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
err_code = NRF_ERROR_INVALID_STATE;
|
||||
}
|
||||
}
|
||||
|
||||
return err_code;
|
||||
}
|
||||
|
||||
|
||||
ret_code_t ble_bas_battery_lvl_on_reconnection_update(ble_bas_t * p_bas,
|
||||
uint16_t conn_handle)
|
||||
{
|
||||
if (p_bas == NULL)
|
||||
{
|
||||
return NRF_ERROR_NULL;
|
||||
}
|
||||
|
||||
ret_code_t err_code;
|
||||
|
||||
if (p_bas->is_notification_supported)
|
||||
{
|
||||
ble_gatts_hvx_params_t hvx_params;
|
||||
uint16_t len = sizeof(uint8_t);
|
||||
|
||||
memset(&hvx_params, 0, sizeof(hvx_params));
|
||||
|
||||
hvx_params.handle = p_bas->battery_level_handles.value_handle;
|
||||
hvx_params.type = BLE_GATT_HVX_NOTIFICATION;
|
||||
hvx_params.offset = 0;
|
||||
hvx_params.p_len = &len;
|
||||
hvx_params.p_data = &p_bas->battery_level_last;
|
||||
|
||||
err_code = battery_notification_send(&hvx_params, conn_handle);
|
||||
|
||||
return err_code;
|
||||
}
|
||||
|
||||
return NRF_ERROR_INVALID_STATE;
|
||||
}
|
||||
|
||||
|
||||
#endif // NRF_MODULE_ENABLED(BLE_BAS)
|
||||
212
components/ble/ble_services/ble_bas/ble_bas.h
Normal file
212
components/ble/ble_services/ble_bas/ble_bas.h
Normal file
@@ -0,0 +1,212 @@
|
||||
/**
|
||||
* 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__
|
||||
|
||||
/** @} */
|
||||
Reference in New Issue
Block a user