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

copy2

readme.md@3:488ecd009a27, 2016-07-28 (annotated)

Committer:
Vincent Coubard
Date:
Thu Jul 28 23:34:10 2016 +0100
Revision:
3:488ecd009a27
Parent:
2:18b05b3173a8
Child:
4:52bffaff7f0b
Sync with mbed-os-5.1.0-rc3

Who changed what in which revision?

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