Matthew Lister
BLE_API
README.md@1028:9dc2ab644517, 2015-12-10 (annotated)
- Committer:
- rgrover1
- Date:
- Thu Dec 10 09:15:03 2015 +0000
- Revision:
- 1028:9dc2ab644517
- Parent:
- 1019:575852ad31a2
- Child:
- 1029:a5d0fec3b17c
Synchronized with git rev 632d44b8
Author: Brendan Moran
Add a doxyfile that warns for undocumented elements
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| rgrover1 | 125:aae3f50670c9 | 1 | # mbed Bluetooth Low Energy Stack |
| rgrover1 | 993:4d62b7967c11 | 2 | This is the Github repo for the `BLE_API` used by developer.mbed.org. Please see the [mbed BLE Homepage](https://developer.mbed.org/teams/Bluetooth-Low-Energy/) for all documentation, code examples and general help. |
| rgrover1 | 125:aae3f50670c9 | 3 | |
| rgrover1 | 125:aae3f50670c9 | 4 | # Supported Services |
| rgrover1 | 993:4d62b7967c11 | 5 | Supported GATT services and constantly being added and can be found in the [ble/services/](https://github.com/ARMmbed/ble/tree/master/ble/services) folder. |
| rgrover1 | 993:4d62b7967c11 | 6 | |
| rgrover1 | 993:4d62b7967c11 | 7 | Currently supported services include: |
| rgrover1 | 993:4d62b7967c11 | 8 | * Battery |
| rgrover1 | 125:aae3f50670c9 | 9 | * Device Firmware Update (DFU) |
| rgrover1 | 993:4d62b7967c11 | 10 | * Device Information |
| rgrover1 | 993:4d62b7967c11 | 11 | * Eddystone Configuration Service |
| rgrover1 | 125:aae3f50670c9 | 12 | * Health Thermometer |
| rgrover1 | 125:aae3f50670c9 | 13 | * Heart Rate |
| rgrover1 | 993:4d62b7967c11 | 14 | * Link Loss |
| rgrover1 | 125:aae3f50670c9 | 15 | * UART |
| Rohit Grover |
241:00f2410ad9cc | 16 | * UriBeacon |
| Rohit Grover |
241:00f2410ad9cc | 17 | * iBeacon |
| rgrover1 | 125:aae3f50670c9 | 18 | |
| rgrover1 | 993:4d62b7967c11 | 19 | # Getting Started |
| rgrover1 | 993:4d62b7967c11 | 20 | The mbed BLE API is meant to be used in projects on developer.mbed.org. Please see examples and sample project files there. |
| rgrover1 | 125:aae3f50670c9 | 21 | A good starting point are these pages: |
| rgrover1 | 993:4d62b7967c11 | 22 | * [mbed BLE Homepage](https://developer.mbed.org/teams/Bluetooth-Low-Energy/) for all things BLE |
| rgrover1 | 993:4d62b7967c11 | 23 | * [mbed BLE Getting Started Guide](https://developer.mbed.org/forum/team-63-Bluetooth-Low-Energy-community/topic/5262/) a wonderful primer on using BLE with mbed |
| rgrover1 | 993:4d62b7967c11 | 24 | * [mbed BLE doc](https://docs.mbed.com/docs/ble-intros/en/latest/) for an introduction to mbed BLE |
| rgrover1 | 1028:9dc2ab644517 | 25 | * [mbed BLE API page](https://developer.mbed.org/teams/Bluetooth-Low-Energy/code/BLE_API/docs/tip/) for the API in generated by doxygen |