Lancaster University / BLE_API

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

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

Fork of BLE_API by Bluetooth Low Energy

DOXYGEN_FRONTPAGE.md@1139:9af191d14c05, 2016-04-06 (annotated)

Committer:
LancasterUniversity
Date:
Wed Apr 06 18:40:39 2016 +0100
Revision:
1139:9af191d14c05
Parent:
1134:faa0160c87ff 
Synchronized with git rev 1b78b7bb

Author: Joe Finney

microbit: Added 'bonds' field to Gap::Whitelist_t structure



It is common for application to need to know the number of bonds stored at any

time, for the purposes of bond management. This simple addition allows

applicaitons to discover the number of bonds present using the existing API.

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 1134:faa0160c87ff 7 [BLE API](https://github.com/armmbed/ble).
vcoubard 1053:ec4a5b9b254e 8
vcoubard 1053:ec4a5b9b254e 9 For getting started with BLE on mbed, check our [introduction
vcoubard 1053:ec4a5b9b254e 10 page](https://docs.mbed.com/docs/ble-intros/en/latest/).
vcoubard 1053:ec4a5b9b254e 11
vcoubard 1053:ec4a5b9b254e 12 For mbed OS examples using BLE, check [this
vcoubard 1053:ec4a5b9b254e 13 repository](https://github.com/armmbed/ble-examples). For mbed-classic
vcoubard 1053:ec4a5b9b254e 14 examples, please refer to [code under mbed.org](https://developer.mbed.org/teams/Bluetooth-Low-Energy/code/).
vcoubard 1053:ec4a5b9b254e 15
vcoubard 1053:ec4a5b9b254e 16 ## Supported Services
rgrover1 949:1902cbd0dd83 17
vcoubard 1053:ec4a5b9b254e 18 Currently supported reference services include:
rgrover1 949:1902cbd0dd83 19
vcoubard 1053:ec4a5b9b254e 20 * [Battery](@ref BatteryService)
vcoubard 1053:ec4a5b9b254e 21 * [Device Firmware Update (DFU)](@ref DFUService)
vcoubard 1053:ec4a5b9b254e 22 * [Device Information](@ref DeviceInformationService)
vcoubard 1053:ec4a5b9b254e 23 * [Health Thermometer](@ref HealthThermometerService)
vcoubard 1053:ec4a5b9b254e 24 * [Heart Rate](@ref HeartRateService)
vcoubard 1053:ec4a5b9b254e 25 * [UART](@ref UARTService)
vcoubard 1053:ec4a5b9b254e 26 * [UriBeacon](@ref URIBeaconConfigService)
vcoubard 1053:ec4a5b9b254e 27 * [iBeacon](@ref iBeacon)
vcoubard 1053:ec4a5b9b254e 28
vcoubard 1053:ec4a5b9b254e 29 The [documentation](https://docs.mbed.com/docs/ble-intros/en/latest/AdvSamples/Overview/)
vcoubard 1053:ec4a5b9b254e 30 contains an overview on how to create new, application-specific services.