adaptation for book and plug demo
Fork of BLE_API by
Diff: DOXYGEN_FRONTPAGE.md
- Revision:
- 1053:ec4a5b9b254e
- Parent:
- 949:1902cbd0dd83
- Child:
- 1056:ce2fb3d09929
diff -r b55e1ad3e1b3 -r ec4a5b9b254e DOXYGEN_FRONTPAGE.md --- a/DOXYGEN_FRONTPAGE.md Mon Jan 11 08:51:31 2016 +0000 +++ b/DOXYGEN_FRONTPAGE.md Mon Jan 11 08:51:32 2016 +0000 @@ -1,16 +1,31 @@ -#BLE API +# BLE API {#mainpage} -The BLE module within mbed OS offers a high level abstraction for using +The BLE module within mbed OS offers a high abstraction level for using Bluetooth Low Energy on multiple platforms. -This documentation describes the internal structure of mbed -(BLE_API)[https://github.com/armmbed/ble]. It was automatically generated from -specially formatted comment blocks in BLE_API's source code using Doxygen. -(See http://www.stack.nl/~dimitri/doxygen/ for more information on Doxygen). +This documentation describes the internal structure of the mbed +[BLE API](https://github.com/armmbed/ble). It was automatically generated from +specially formatted comment blocks in BLE API's source code using Doxygen (see http://www.stack.nl/~dimitri/doxygen/ for more information on Doxygen). + +For getting started with BLE on mbed, check our [introduction +page](https://docs.mbed.com/docs/ble-intros/en/latest/). + +For mbed OS examples using BLE, check [this +repository](https://github.com/armmbed/ble-examples). For mbed-classic +examples, please refer to [code under mbed.org](https://developer.mbed.org/teams/Bluetooth-Low-Energy/code/). + +## Supported Services -For getting started with BLE on mbed, check our (introduction -page)[https://docs.mbed.com/docs/ble-intros/en/latest/]. +Currently supported reference services include: -For mbed OS examples using BLE, check (this -repository)[https://github.com/armmbed/ble-examples]. For mbed-classic -examples, refer to (code under mbed.org)[https://developer.mbed.org/teams/Bluetooth-Low-Energy/code/]. \ No newline at end of file +* [Battery](@ref BatteryService) +* [Device Firmware Update (DFU)](@ref DFUService) +* [Device Information](@ref DeviceInformationService) +* [Health Thermometer](@ref HealthThermometerService) +* [Heart Rate](@ref HeartRateService) +* [UART](@ref UARTService) +* [UriBeacon](@ref URIBeaconConfigService) +* [iBeacon](@ref iBeacon) + +The [documentation](https://docs.mbed.com/docs/ble-intros/en/latest/AdvSamples/Overview/) +contains an overview on how to create new, application-specific services. \ No newline at end of file