Bkap / BLE_API

adaptation for book and plug demo

Dependents:   BookAndPlug

Fork of BLE_API by Bluetooth Low Energy

DOXYGEN_FRONTPAGE.md@1028:9dc2ab644517, 2015-12-10 (annotated)

Committer:
rgrover1
Date:
Thu Dec 10 09:15:03 2015 +0000
Revision:
1028:9dc2ab644517
Parent:
1027:49ec5900eab7
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?

UserRevisionLine numberNew contents of line
rgrover1 980:07ce7d9ed5ff 1 # BLE API {#mainpage}
rgrover1 980:07ce7d9ed5ff 2
rgrover1 980:07ce7d9ed5ff 3 The BLE module within mbed OS offers a high abstraction level for using
rgrover1 980:07ce7d9ed5ff 4 Bluetooth Low Energy on multiple platforms.
rgrover1 980:07ce7d9ed5ff 5
rgrover1 980:07ce7d9ed5ff 6 This documentation describes the internal structure of the mbed
rgrover1 1028:9dc2ab644517 7 [BLE API](https://github.com/armmbed/ble). It was automatically generated from
rgrover1 1028:9dc2ab644517 8 specially formatted comment blocks in BLE API's source code using Doxygen (see http://www.stack.nl/~dimitri/doxygen/ for more information on Doxygen).
rgrover1 980:07ce7d9ed5ff 9
rgrover1 980:07ce7d9ed5ff 10 For getting started with BLE on mbed, check our [introduction
rgrover1 980:07ce7d9ed5ff 11 page](https://docs.mbed.com/docs/ble-intros/en/latest/).
rgrover1 980:07ce7d9ed5ff 12
rgrover1 980:07ce7d9ed5ff 13 For mbed OS examples using BLE, check [this
rgrover1 980:07ce7d9ed5ff 14 repository](https://github.com/armmbed/ble-examples). For mbed-classic
rgrover1 980:07ce7d9ed5ff 15 examples, please refer to [code under mbed.org](https://developer.mbed.org/teams/Bluetooth-Low-Energy/code/).
rgrover1 980:07ce7d9ed5ff 16
rgrover1 980:07ce7d9ed5ff 17 ## Supported Services
rgrover1 980:07ce7d9ed5ff 18
rgrover1 980:07ce7d9ed5ff 19 Currently supported reference services include:
rgrover1 980:07ce7d9ed5ff 20
rgrover1 980:07ce7d9ed5ff 21 * [Battery](@ref BatteryService)
rgrover1 980:07ce7d9ed5ff 22 * [Device Firmware Update (DFU)](@ref DFUService)
rgrover1 980:07ce7d9ed5ff 23 * [Device Information](@ref DeviceInformationService)
rgrover1 980:07ce7d9ed5ff 24 * [Health Thermometer](@ref HealthThermometerService)
rgrover1 980:07ce7d9ed5ff 25 * [Heart Rate](@ref HeartRateService)
rgrover1 980:07ce7d9ed5ff 26 * [UART](@ref UARTService)
rgrover1 980:07ce7d9ed5ff 27 * [UriBeacon](@ref URIBeaconConfigService)
rgrover1 980:07ce7d9ed5ff 28 * [iBeacon](@ref iBeacon)
rgrover1 980:07ce7d9ed5ff 29
rgrover1 980:07ce7d9ed5ff 30 The [documentation](https://docs.mbed.com/docs/ble-intros/en/latest/AdvSamples/Overview/)
rgrover1 980:07ce7d9ed5ff 31 contains an overview on how to create new, application-specific services.