Skip to content

BLE: Add reference of Battery service. #339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 20, 2017
Merged

BLE: Add reference of Battery service. #339

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2c06e66
BLE: Add reference of Battery service.
pan- Nov 16, 2017
cc9c02d
Update BatteryService.md
Nov 21, 2017
13f3fba
Replace Bluetooth body by Bluetooth SIG
pan- Dec 7, 2017
bc3288b
Update API reference link in BatteryService.md
Dec 8, 2017
3ad1b39
Merge branch 'new_engine' into battery-service-reference
Dec 20, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions docs/reference/api/connectivity/bluetooth/BatteryService.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
## BatteryService

[Add description here.]
It is often a requirement for devices operating on battery to report the battery charge level to the user.

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.

The BatteryService class implements the Bluetooth Battery Service as defined by the Bluetooth body. Makers of BLE devices operating on battery can use the API to expose interoperably the charge level of their products.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bluetooth body or SIG (special interest group) as they refer to themselves as?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've replaced Bluetooth body by Bluetooth SIG.


### BatteryService class reference

[![View code](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_battery_service.html)
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_battery_service.html)

### BatteryService example

[Add example here.]
[![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/)

### Related content

- <a href="https://www.bluetooth.org/docman/handlers/downloaddoc.ashx?doc_id=245138" target="_blank">Bluetooth Battery Service</a> specification.