/** * Copyright (c) 2012 - 2018, 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 #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_gatts_char_md_t char_md; ble_gatts_attr_md_t cccd_md; ble_gatts_attr_t attr_char_value; ble_uuid_t ble_uuid; ble_gatts_attr_md_t attr_md; uint8_t initial_battery_level; uint8_t encoded_report_ref[BLE_SRV_ENCODED_REPORT_REF_LEN]; uint8_t init_len; // Add Battery Level characteristic if (p_bas->is_notification_supported) { memset(&cccd_md, 0, sizeof(cccd_md)); // According to BAS_SPEC_V10, the read operation on cccd should be possible without // authentication. BLE_GAP_CONN_SEC_MODE_SET_OPEN(&cccd_md.read_perm); cccd_md.write_perm = p_bas_init->battery_level_char_attr_md.cccd_write_perm; cccd_md.vloc = BLE_GATTS_VLOC_STACK; } memset(&char_md, 0, sizeof(char_md)); char_md.char_props.read = 1; char_md.char_props.notify = (p_bas->is_notification_supported) ? 1 : 0; char_md.p_char_user_desc = NULL; char_md.p_char_pf = NULL; char_md.p_user_desc_md = NULL; char_md.p_cccd_md = (p_bas->is_notification_supported) ? &cccd_md : NULL; char_md.p_sccd_md = NULL; BLE_UUID_BLE_ASSIGN(ble_uuid, BLE_UUID_BATTERY_LEVEL_CHAR); memset(&attr_md, 0, sizeof(attr_md)); attr_md.read_perm = p_bas_init->battery_level_char_attr_md.read_perm; attr_md.write_perm = p_bas_init->battery_level_char_attr_md.write_perm; attr_md.vloc = BLE_GATTS_VLOC_STACK; attr_md.rd_auth = 0; attr_md.wr_auth = 0; attr_md.vlen = 0; initial_battery_level = p_bas_init->initial_batt_level; memset(&attr_char_value, 0, sizeof(attr_char_value)); attr_char_value.p_uuid = &ble_uuid; attr_char_value.p_attr_md = &attr_md; attr_char_value.init_len = sizeof(uint8_t); attr_char_value.init_offs = 0; attr_char_value.max_len = sizeof(uint8_t); attr_char_value.p_value = &initial_battery_level; err_code = sd_ble_gatts_characteristic_add(p_bas->service_handle, &char_md, &attr_char_value, &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 BLE_UUID_BLE_ASSIGN(ble_uuid, BLE_UUID_REPORT_REF_DESCR); memset(&attr_md, 0, sizeof(attr_md)); attr_md.read_perm = p_bas_init->battery_level_report_read_perm; BLE_GAP_CONN_SEC_MODE_SET_NO_ACCESS(&attr_md.write_perm); attr_md.vloc = BLE_GATTS_VLOC_STACK; attr_md.rd_auth = 0; attr_md.wr_auth = 0; attr_md.vlen = 0; init_len = ble_srv_report_ref_encode(encoded_report_ref, p_bas_init->p_report_ref); memset(&attr_char_value, 0, sizeof(attr_char_value)); attr_char_value.p_uuid = &ble_uuid; attr_char_value.p_attr_md = &attr_md; attr_char_value.init_len = init_len; attr_char_value.init_offs = 0; attr_char_value.max_len = attr_char_value.init_len; attr_char_value.p_value = encoded_report_ref; err_code = sd_ble_gatts_descriptor_add(p_bas->battery_level_handles.value_handle, &attr_char_value, &p_bas->report_ref_handle); if (err_code != NRF_SUCCESS) { 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; } #endif // NRF_MODULE_ENABLED(BLE_BAS)