Skip to content

Commit 2c06e66

Browse files
committed
BLE: Add reference of Battery service.
1 parent 376b6fc commit 2c06e66

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed
Lines changed: 10 additions & 2 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 a battery charge level should be exposed through a BLE link. It allows clients - usually 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 body. Makers of BLE devices operating on Battery can use it to expose interoperably the charge level of their products.
48

59
### BatteryService class reference
610

711
[![View code](https://os.mbed.com/docs/v5.6/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+
- [Bluetooth Battery Service](https://www.bluetooth.org/docman/handlers/downloaddoc.ashx?doc_id=245138) specification.

0 commit comments

Comments
 (0)