Desmond Chen / Mbed OS mbed-os-example-ble-BatteryLevel_copy_copy

copy2

readme.md@81:ccae21d0eb2e, 2019-09-17 (annotated)

Committer:
sayhuthut
Date:
Tue Sep 17 03:57:45 2019 +0000
Revision:
81:ccae21d0eb2e
Parent:
4:52bffaff7f0b 
test clone

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 4:52bffaff7f0b 1 This example creates and updates a standard Battery Level service containing a single
mbed_official 4:52bffaff7f0b 2 GATT characteristic.
mbed_official 4:52bffaff7f0b 3
mbed_official 4:52bffaff7f0b 4 The [battery service transmits](https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.battery_service.xml) a device's battery level in percentage, with 100% being a fully charged battery and 0% being a fully drained battery.
mbed_official 4:52bffaff7f0b 5
mbed_official 4:52bffaff7f0b 6 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.
mbed_official 4:52bffaff7f0b 7
mbed_official 4:52bffaff7f0b 8 # Running the application
mbed_official 4:52bffaff7f0b 9
mbed_official 4:52bffaff7f0b 10 ## Requirements
mbed_official 4:52bffaff7f0b 11
mbed_official 4:52bffaff7f0b 12 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 :
mbed_official 4:52bffaff7f0b 13
mbed_official 4:52bffaff7f0b 14 - [nRF Master Control Panel](https://play.google.com/store/apps/details?id=no.nordicsemi.android.mcp) for Android.
mbed_official 4:52bffaff7f0b 15
mbed_official 4:52bffaff7f0b 16 - [LightBlue](https://itunes.apple.com/gb/app/lightblue-bluetooth-low-energy/id557428110?mt=8) for iPhone.
mbed_official 4:52bffaff7f0b 17
mbed_official 4:52bffaff7f0b 18 Hardware requirements are in the [main readme](https://github.com/ARMmbed/mbed-os-example-ble/blob/master/README.md).
mbed_official 4:52bffaff7f0b 19
mbed_official 4:52bffaff7f0b 20 ## Building instructions
mbed_official 4:52bffaff7f0b 21
mbed_official 4:52bffaff7f0b 22 Building instructions for all samples are in the [main readme](https://github.com/ARMmbed/mbed-os-example-ble/blob/master/README.md).
mbed_official 4:52bffaff7f0b 23
mbed_official 4:52bffaff7f0b 24 ## Checking for success
mbed_official 4:52bffaff7f0b 25
mbed_official 4:52bffaff7f0b 26 **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.
mbed_official 4:52bffaff7f0b 27
mbed_official 4:52bffaff7f0b 28 1. Build the application and install it on your board as explained in the building instructions.
mbed_official 4:52bffaff7f0b 29 1. Open the BLE scanner on your phone.
mbed_official 4:52bffaff7f0b 30 1. Start a scan.
mbed_official 4:52bffaff7f0b 31
mbed_official 4:52bffaff7f0b 32 ![](img/start_scan.png)
mbed_official 4:52bffaff7f0b 33
mbed_official 4:52bffaff7f0b 34 **figure 1** How to start scan using nRF Master Control Panel 4.0.5
mbed_official 4:52bffaff7f0b 35
mbed_official 4:52bffaff7f0b 36 1. Find your device; it should be named `BATTERY`.
mbed_official 4:52bffaff7f0b 37
mbed_official 4:52bffaff7f0b 38 ![](img/scan_result.png)
mbed_official 4:52bffaff7f0b 39
mbed_official 4:52bffaff7f0b 40 **figure 2** Scan results using nRF Master Control Panel 4.0.5
mbed_official 4:52bffaff7f0b 41
mbed_official 4:52bffaff7f0b 42 1. Establish a connection with your device.
mbed_official 4:52bffaff7f0b 43
mbed_official 4:52bffaff7f0b 44 ![](img/connection.png)
mbed_official 4:52bffaff7f0b 45
mbed_official 4:52bffaff7f0b 46 **figure 3** How to establish a connection using Master Control Panel 4.0.5
mbed_official 4:52bffaff7f0b 47
mbed_official 4:52bffaff7f0b 48 1. 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.
mbed_official 4:52bffaff7f0b 49
mbed_official 4:52bffaff7f0b 50 ![](img/discovery.png)
mbed_official 4:52bffaff7f0b 51
mbed_official 4:52bffaff7f0b 52 **figure 4** Representation of the Battery service using Master Control Panel 4.0.5
mbed_official 4:52bffaff7f0b 53
mbed_official 4:52bffaff7f0b 54 1. Register for the notifications sent by the *Battery level* characteristic.
mbed_official 4:52bffaff7f0b 55
mbed_official 4:52bffaff7f0b 56 ![](img/register_to_notifications.png)
mbed_official 4:52bffaff7f0b 57
mbed_official 4:52bffaff7f0b 58 **figure 5** How to register to notifications using Master Control Panel 4.0.5
mbed_official 4:52bffaff7f0b 59
mbed_official 4:52bffaff7f0b 60
mbed_official 4:52bffaff7f0b 61 1. 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.
mbed_official 4:52bffaff7f0b 62
mbed_official 4:52bffaff7f0b 63 ![](img/notifications.png)
mbed_official 4:52bffaff7f0b 64
mbed_official 4:52bffaff7f0b 65 **figure 6** Notifications view using Master Control Panel 4.0.5
mbed_official 4:52bffaff7f0b 66
mbed_official 4:52bffaff7f0b 67 If you can see the characteristic, and if its value is incrementing correctly, the application is working properly.
mbed_official 4:52bffaff7f0b 68