Skip to content

Commit c9c449d

Browse files
author
Amanda Butler
authored
Merge pull request #339 from pan-/battery-service-reference
BLE: Add reference of Battery service.
2 parents f905ea2 + 3ad1b39 commit c9c449d

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed
Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
## BatteryService
22

3-
[Add description here.]
3+
It is often a requirement for devices operating on battery to report the battery charge level to the user.
4+
5+
The <a href="https://www.bluetooth.org/docman/handlers/downloaddoc.ashx?doc_id=245138" target="_blank">Bluetooth Battery Service</a> defines how to expose a battery charge level through a BLE link. It allows a client - usually a smartphone application - of a device to read the current battery charge level and follow its evolution.
6+
7+
The BatteryService class implements the Bluetooth Battery Service as defined by the Bluetooth SIG. Makers of BLE devices operating on battery can use the API to expose interoperably the charge level of their products.
48

59
### BatteryService class reference
610

7-
[![View code](http://os-doc-builder.test.mbed.com/docs/v5.7/mbed-os-api-doxy/class_battery_service.html)
11+
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/v5.7/mbed-os-api-doxy/class_battery_service.html)
812

913
### BatteryService example
1014

11-
[Add example here.]
15+
[![View code](https://www.mbed.com/embed/?url=https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-ble-BatteryLevel/)](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-ble-BatteryLevel/file/5d8484f69181/source/main.cpp/)
16+
17+
### Related content
18+
19+
- <a href="https://www.bluetooth.org/docman/handlers/downloaddoc.ashx?doc_id=245138" target="_blank">Bluetooth Battery Service</a> specification.

0 commit comments

Comments
 (0)