Lancaster University / BLE_API

Lancaster University's fork of the mbed BLE API. Lives on github, https://github.com/lancaster-university/BLE_API

Dependents:   microbit-dal microbit-dal microbit-ble-open microbit-dal ... more

Fork of BLE_API by Bluetooth Low Energy

DOXYGEN_FRONTPAGE.md@1131:73c11a85c6d6, 2016-04-06 (annotated)

Committer:
LancasterUniversity
Date:
Wed Apr 06 18:40:26 2016 +0100
Revision:
1131:73c11a85c6d6
Parent:
1056:ce2fb3d09929
Child:
1134:faa0160c87ff
Synchronized with git rev 13bf70b6

Author: Rohit Grover

Release 2.1.5

=============



A minor release to separate the concept of minlen and len in

GattCharacteristic. Also contains some improvements to documentation.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
vcoubard 1053:ec4a5b9b254e 1 # BLE API {#mainpage}
rgrover1 949:1902cbd0dd83 2
vcoubard 1053:ec4a5b9b254e 3 The BLE module within mbed OS offers a high abstraction level for using
rgrover1 949:1902cbd0dd83 4 Bluetooth Low Energy on multiple platforms.
rgrover1 949:1902cbd0dd83 5
vcoubard 1053:ec4a5b9b254e 6 This documentation describes the internal structure of the mbed
LancasterUniversity 1131:73c11a85c6d6 7 [BLE API](https://github.com/armmbed/ble). It was automatically generated from
LancasterUniversity 1131:73c11a85c6d6 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).
vcoubard 1053:ec4a5b9b254e 9
vcoubard 1053:ec4a5b9b254e 10 For getting started with BLE on mbed, check our [introduction
vcoubard 1053:ec4a5b9b254e 11 page](https://docs.mbed.com/docs/ble-intros/en/latest/).
vcoubard 1053:ec4a5b9b254e 12
vcoubard 1053:ec4a5b9b254e 13 For mbed OS examples using BLE, check [this
vcoubard 1053:ec4a5b9b254e 14 repository](https://github.com/armmbed/ble-examples). For mbed-classic
vcoubard 1053:ec4a5b9b254e 15 examples, please refer to [code under mbed.org](https://developer.mbed.org/teams/Bluetooth-Low-Energy/code/).
vcoubard 1053:ec4a5b9b254e 16
vcoubard 1053:ec4a5b9b254e 17 ## Supported Services
rgrover1 949:1902cbd0dd83 18
vcoubard 1053:ec4a5b9b254e 19 Currently supported reference services include:
rgrover1 949:1902cbd0dd83 20
vcoubard 1053:ec4a5b9b254e 21 * [Battery](@ref BatteryService)
vcoubard 1053:ec4a5b9b254e 22 * [Device Firmware Update (DFU)](@ref DFUService)
vcoubard 1053:ec4a5b9b254e 23 * [Device Information](@ref DeviceInformationService)
vcoubard 1053:ec4a5b9b254e 24 * [Health Thermometer](@ref HealthThermometerService)
vcoubard 1053:ec4a5b9b254e 25 * [Heart Rate](@ref HeartRateService)
vcoubard 1053:ec4a5b9b254e 26 * [UART](@ref UARTService)
vcoubard 1053:ec4a5b9b254e 27 * [UriBeacon](@ref URIBeaconConfigService)
vcoubard 1053:ec4a5b9b254e 28 * [iBeacon](@ref iBeacon)
vcoubard 1053:ec4a5b9b254e 29
vcoubard 1053:ec4a5b9b254e 30 The [documentation](https://docs.mbed.com/docs/ble-intros/en/latest/AdvSamples/Overview/)
vcoubard 1053:ec4a5b9b254e 31 contains an overview on how to create new, application-specific services.