
This example creates and updates a standard Battery Level service containing a single GATT characteristic. The battery service transmits a device's battery level in percentage, with 100% being a fully charged battery and 0% being a fully drained battery. The canonical source for this example lives at https://github.com/ARMmbed/mbed-os-example-ble/tree/master/BLE_BatteryLevel
This example creates and updates a standard Battery Level service containing a single GATT characteristic.
The battery service transmits a device's battery level in percentage, with 100% being a fully charged battery and 0% being a fully drained battery.
Although the sample application runs on a BLE device, it doesn't show the device's real battery level (because that changes very slowly and will make for a dull example). Instead, it transmits a fake battery level that starts at 50% (half charged). Every half second, it increments the battery level, going in single increments until reaching 100% (as if the battery is charging). It then drops down to 20% to start incrementing again.
Running the application
Requirements
The sample application can be seen on any BLE scanner on a smartphone. If you don't have a scanner on your phone, please install :
- nRF Master Control Panel for Android.
- LightBlue for iPhone.
Hardware requirements are in the main readme.
Building instructions
Building with mbed CLI
If you'd like to use mbed CLI to build this, then you should refer to the main readme. The instructions here relate to using the developer.mbed.org Online Compiler
In order to build this example in the mbed Online Compiler, first import the example using the ‘Import’ button on the right hand side.
Next, select a platform to build for. This must either be a platform that supports BLE, for example the NRF51-DK, or one of the following:
List of platforms supporting Bluetooth Low Energy
Or you must also add a piece of hardware and the supporting library that includes a Bluetooth Low Energy driver for that hardware, for example the K64F or NUCLEO_F401RE with the X-NUCLEO-IDB05A1
List of components supporting Bluetooth Low Energy.
Once you have selected your platform, compile the example and drag and drop the resulting binary onto your board.
For general instructions on using the mbed Online Compiler, please see the mbed Handbook
Checking for success
Note: Screens captures depicted below show what is expected from this example if the scanner used is nRF Master Control Panel version 4.0.5. If you encounter any difficulties consider trying another scanner or another version of nRF Master Control Panel. Alternative scanners may require reference to their manuals.
- Build the application and install it on your board as explained in the building instructions.
- Open the BLE scanner on your phone.
- Start a scan.
figure 1 How to start scan using nRF Master Control Panel 4.0.5
- Find your device; it should be named `BATTERY`.
figure 2 Scan results using nRF Master Control Panel 4.0.5
- Establish a connection with your device.
figure 3 How to establish a connection using Master Control Panel 4.0.5
- Discover the services and the characteristics on the device. The *Battery service* has the UUID 0x180F and includes the *Battery level* characteristic which has the UUID 0x2A19.
figure 4 Representation of the Battery service using Master Control Panel 4.0.5
- Register for the notifications sent by the *Battery level* characteristic.
figure 5 How to register to notifications using Master Control Panel 4.0.5
- You should see the battery level value change every half second. It begins at 50, goes up to 100 (in steps of 1), resets to 20 and so on.
figure 6 Notifications view using Master Control Panel 4.0.5
If you can see the characteristic, and if its value is incrementing correctly, the application is working properly.
Revision 76:e489712bcbcf, committed 2019-01-14
- Comitter:
- mbed_official
- Date:
- Mon Jan 14 10:45:14 2019 +0000
- Parent:
- 75:a91805e80107
- Child:
- 77:634599d24f93
- Commit message:
- Merge pull request #208 from ARMmbed/mbed-os-5.11.0-oob
Mbed OS 5.11.0
.
Commit copied from https://github.com/ARMmbed/mbed-os-example-ble
Changed in this revision
--- a/mbed-os.lib Fri Dec 14 13:15:11 2018 +0000 +++ b/mbed-os.lib Mon Jan 14 10:45:14 2019 +0000 @@ -1,1 +1,1 @@ -https://github.com/ARMmbed/mbed-os/#2fd0c5cfbd83fce62da6308f9d64c0ab64e1f0d6 +https://github.com/ARMmbed/mbed-os/#6a0a86538c0b9b2bfcc4583b1e2b7fea8f4e71e9
--- a/mbed_app.json Fri Dec 14 13:15:11 2018 +0000 +++ b/mbed_app.json Mon Jan 14 10:45:14 2019 +0000 @@ -11,6 +11,16 @@ "DISCO_L475VG_IOT01A": { "target.features_add": ["BLE"], "target.extra_labels_add": ["CORDIO", "CORDIO_BLUENRG"] + }, + "NRF52840_DK": { + "target.features_add": ["BLE"], + "target.extra_labels_add": ["CORDIO", "CORDIO_LL", "SOFTDEVICE_NONE", "NORDIC_CORDIO"], + "target.extra_labels_remove": ["SOFTDEVICE_COMMON", "SOFTDEVICE_S140_FULL", "NORDIC_SOFTDEVICE"] + }, + "NRF52_DK": { + "target.features_add": ["BLE"], + "target.extra_labels_add": ["CORDIO", "CORDIO_LL", "SOFTDEVICE_NONE", "NORDIC_CORDIO"], + "target.extra_labels_remove": ["SOFTDEVICE_COMMON", "SOFTDEVICE_S132_FULL", "NORDIC_SOFTDEVICE"] } } }
--- a/shields/TARGET_CORDIO_BLUENRG.lib Fri Dec 14 13:15:11 2018 +0000 +++ b/shields/TARGET_CORDIO_BLUENRG.lib Mon Jan 14 10:45:14 2019 +0000 @@ -1,1 +1,1 @@ -https://github.com/ARMmbed/cordio-ble-x-nucleo-idb0xa1/#51f60dfea514e35e5aa13c8e24005ecadc24a9f5 +https://github.com/ARMmbed/cordio-ble-x-nucleo-idb0xa1/#811f3fea7aa8083c0bbf378e1b51a8b131d7efcc
--- a/source/main.cpp Fri Dec 14 13:15:11 2018 +0000 +++ b/source/main.cpp Mon Jan 14 10:45:14 2019 +0000 @@ -19,111 +19,139 @@ #include "ble/BLE.h" #include "ble/Gap.h" #include "ble/services/BatteryService.h" +#include "pretty_printer.h" -DigitalOut led1(LED1, 1); +static DigitalOut led1(LED1, 1); + +const static char DEVICE_NAME[] = "BATTERY"; + +static events::EventQueue event_queue(/* event count */ 16 * EVENTS_EVENT_SIZE); -const static char DEVICE_NAME[] = "BATTERY"; -static const uint16_t uuid16_list[] = {GattService::UUID_BATTERY_SERVICE}; - -static uint8_t batteryLevel = 50; -static BatteryService* batteryServicePtr; +class BatteryDemo : ble::Gap::EventHandler { +public: + BatteryDemo(BLE &ble, events::EventQueue &event_queue) : + _ble(ble), + _event_queue(event_queue), + _battery_uuid(GattService::UUID_BATTERY_SERVICE), + _battery_level(50), + _battery_service(ble, _battery_level), + _adv_data_builder(_adv_buffer) { } -static EventQueue eventQueue(/* event count */ 16 * EVENTS_EVENT_SIZE); + void start() { + _ble.gap().setEventHandler(this); + + _ble.init(this, &BatteryDemo::on_init_complete); + + _event_queue.call_every(500, this, &BatteryDemo::blink); + _event_queue.call_every(1000, this, &BatteryDemo::update_sensor_value); + + _event_queue.dispatch_forever(); + } -void disconnectionCallback(const Gap::DisconnectionCallbackParams_t *params) -{ - BLE::Instance().gap().startAdvertising(); -} +private: + /** Callback triggered when the ble initialization process has finished */ + void on_init_complete(BLE::InitializationCompleteCallbackContext *params) { + if (params->error != BLE_ERROR_NONE) { + print_error(params->error, "Ble initialization failed."); + return; + } -void updateSensorValue() { - batteryLevel++; - if (batteryLevel > 100) { - batteryLevel = 20; + print_mac_address(); + + start_advertising(); } - batteryServicePtr->updateBatteryLevel(batteryLevel); -} + void start_advertising() { + /* Create advertising parameters and payload */ -void blinkCallback(void) -{ - led1 = !led1; /* Do blinky on LED1 while we're waiting for BLE events */ + ble::AdvertisingParameters adv_parameters( + ble::advertising_type_t::CONNECTABLE_UNDIRECTED, + ble::adv_interval_t(ble::millisecond_t(1000)) + ); - BLE &ble = BLE::Instance(); - if (ble.gap().getState().connected) { - eventQueue.call(updateSensorValue); - } -} + _adv_data_builder.setFlags(); + _adv_data_builder.setLocalServiceList(mbed::make_Span(&_battery_uuid, 1)); + _adv_data_builder.setName(DEVICE_NAME); -/** - * This function is called when the ble initialization process has failled - */ -void onBleInitError(BLE &ble, ble_error_t error) -{ - /* Initialization error handling should go here */ -} + /* Setup advertising */ + + ble_error_t error = _ble.gap().setAdvertisingParameters( + ble::LEGACY_ADVERTISING_HANDLE, + adv_parameters + ); -void printMacAddress() -{ - /* Print out device MAC address to the console*/ - Gap::AddressType_t addr_type; - Gap::Address_t address; - BLE::Instance().gap().getAddress(&addr_type, address); - printf("DEVICE MAC ADDRESS: "); - for (int i = 5; i >= 1; i--){ - printf("%02x:", address[i]); - } - printf("%02x\r\n", address[0]); -} + if (error) { + print_error(error, "_ble.gap().setAdvertisingParameters() failed"); + return; + } + + error = _ble.gap().setAdvertisingPayload( + ble::LEGACY_ADVERTISING_HANDLE, + _adv_data_builder.getAdvertisingData() + ); -/** - * Callback triggered when the ble initialization process has finished - */ -void bleInitComplete(BLE::InitializationCompleteCallbackContext *params) -{ - BLE& ble = params->ble; - ble_error_t error = params->error; + if (error) { + print_error(error, "_ble.gap().setAdvertisingPayload() failed"); + return; + } + + /* Start advertising */ - if (error != BLE_ERROR_NONE) { - /* In case of error, forward the error handling to onBleInitError */ - onBleInitError(ble, error); - return; + error = _ble.gap().startAdvertising(ble::LEGACY_ADVERTISING_HANDLE); + + if (error) { + print_error(error, "_ble.gap().startAdvertising() failed"); + return; + } } - /* Ensure that it is the default instance of BLE */ - if(ble.getInstanceID() != BLE::DEFAULT_INSTANCE) { - return; + void update_sensor_value() { + if (_ble.gap().getState().connected) { + _battery_level++; + if (_battery_level > 100) { + _battery_level = 20; + } + + _battery_service.updateBatteryLevel(_battery_level); + } + } + + void blink(void) { + led1 = !led1; } - ble.gap().onDisconnection(disconnectionCallback); +private: + /* Event handler */ - /* Setup primary service */ - batteryServicePtr = new BatteryService(ble, batteryLevel); + void onDisconnectionComplete(const ble::DisconnectionCompleteEvent&) { + _ble.gap().startAdvertising(ble::LEGACY_ADVERTISING_HANDLE); + } + +private: + BLE &_ble; + events::EventQueue &_event_queue; - /* Setup advertising */ - ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::BREDR_NOT_SUPPORTED | GapAdvertisingData::LE_GENERAL_DISCOVERABLE); - ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LIST_16BIT_SERVICE_IDS, (uint8_t *) uuid16_list, sizeof(uuid16_list)); - ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LOCAL_NAME, (uint8_t *) DEVICE_NAME, sizeof(DEVICE_NAME)); - ble.gap().setAdvertisingType(GapAdvertisingParams::ADV_CONNECTABLE_UNDIRECTED); - ble.gap().setAdvertisingInterval(1000); /* 1000ms */ - ble.gap().startAdvertising(); + UUID _battery_uuid; + + uint8_t _battery_level; + BatteryService _battery_service; - printMacAddress(); -} + uint8_t _adv_buffer[ble::LEGACY_ADVERTISING_MAX_SIZE]; + ble::AdvertisingDataBuilder _adv_data_builder; +}; -void scheduleBleEventsProcessing(BLE::OnEventsToProcessCallbackContext* context) { - BLE &ble = BLE::Instance(); - eventQueue.call(Callback<void()>(&ble, &BLE::processEvents)); +/** Schedule processing of events from the BLE middleware in the event queue. */ +void schedule_ble_events(BLE::OnEventsToProcessCallbackContext *context) { + event_queue.call(Callback<void()>(&context->ble, &BLE::processEvents)); } int main() { - eventQueue.call_every(500, blinkCallback); + BLE &ble = BLE::Instance(); + ble.onEventsToProcess(schedule_ble_events); - BLE &ble = BLE::Instance(); - ble.onEventsToProcess(scheduleBleEventsProcessing); - ble.init(bleInitComplete); - - eventQueue.dispatch_forever(); + BatteryDemo demo(ble, event_queue); + demo.start(); return 0; }
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/source/pretty_printer.h Mon Jan 14 10:45:14 2019 +0000 @@ -0,0 +1,95 @@ +/* mbed Microcontroller Library + * Copyright (c) 2018 ARM Limited + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#include <mbed.h> +#include "ble/BLE.h" + +inline void print_error(ble_error_t error, const char* msg) +{ + printf("%s: ", msg); + switch(error) { + case BLE_ERROR_NONE: + printf("BLE_ERROR_NONE: No error"); + break; + case BLE_ERROR_BUFFER_OVERFLOW: + printf("BLE_ERROR_BUFFER_OVERFLOW: The requested action would cause a buffer overflow and has been aborted"); + break; + case BLE_ERROR_NOT_IMPLEMENTED: + printf("BLE_ERROR_NOT_IMPLEMENTED: Requested a feature that isn't yet implement or isn't supported by the target HW"); + break; + case BLE_ERROR_PARAM_OUT_OF_RANGE: + printf("BLE_ERROR_PARAM_OUT_OF_RANGE: One of the supplied parameters is outside the valid range"); + break; + case BLE_ERROR_INVALID_PARAM: + printf("BLE_ERROR_INVALID_PARAM: One of the supplied parameters is invalid"); + break; + case BLE_STACK_BUSY: + printf("BLE_STACK_BUSY: The stack is busy"); + break; + case BLE_ERROR_INVALID_STATE: + printf("BLE_ERROR_INVALID_STATE: Invalid state"); + break; + case BLE_ERROR_NO_MEM: + printf("BLE_ERROR_NO_MEM: Out of Memory"); + break; + case BLE_ERROR_OPERATION_NOT_PERMITTED: + printf("BLE_ERROR_OPERATION_NOT_PERMITTED"); + break; + case BLE_ERROR_INITIALIZATION_INCOMPLETE: + printf("BLE_ERROR_INITIALIZATION_INCOMPLETE"); + break; + case BLE_ERROR_ALREADY_INITIALIZED: + printf("BLE_ERROR_ALREADY_INITIALIZED"); + break; + case BLE_ERROR_UNSPECIFIED: + printf("BLE_ERROR_UNSPECIFIED: Unknown error"); + break; + case BLE_ERROR_INTERNAL_STACK_FAILURE: + printf("BLE_ERROR_INTERNAL_STACK_FAILURE: internal stack faillure"); + break; + } + printf("\r\n"); +} + +/** print device address to the terminal */ +inline void print_address(const Gap::Address_t &addr) +{ + printf("%02x:%02x:%02x:%02x:%02x:%02x\r\n", + addr[5], addr[4], addr[3], addr[2], addr[1], addr[0]); +} + +inline void print_mac_address() +{ + /* Print out device MAC address to the console*/ + Gap::AddressType_t addr_type; + Gap::Address_t address; + BLE::Instance().gap().getAddress(&addr_type, address); + printf("DEVICE MAC ADDRESS: "); + print_address(address); +} + +inline const char* phy_to_string(Gap::Phy_t phy) { + switch(phy.value()) { + case Gap::Phy_t::LE_1M: + return "LE 1M"; + case Gap::Phy_t::LE_2M: + return "LE 2M"; + case Gap::Phy_t::LE_CODED: + return "LE coded"; + default: + return "invalid PHY"; + } +}