mirror of https://github.com/ARMmbed/mbed-os.git
784fa91294
Make the following changes to doxyfile_options: -Change CASE_SENSE_NAMES so names of files generated match mbed-os docs -Change DISABLE_INDEX so navigation bar shows -Change CLASS_DIAGRAMS so inheritance diagram gets generated -Change USE_MDFILE_AS_MAINPAGE and add DOXYGEN_FRONTPAGE.md to FILE_PATTERNS so the correct main page is found and used -Remove DEVICE_ETH from PREDEFINED since this is no longer relevent -Change GENERATE_XML and XML_OUTPUT so no xml is generated -Change SEARCHENGINE to match the docs Make the following changes in doxygen_options.json: -Add all non-default values in doxyfile_options to the json -Break json into 3 groups 1. Values that are the same as doxyfile_options 2. Values that must be different from doxyfile_options 3. Values the are overriden by the docs builder -Make the doxyegn search directory "INPUT" start in mbed-os rather than one level above mbed-os. Finally, rename the BLE doxygen front page so it is not confused with the mbed-os front page. |
||
---|---|---|
.. | ||
ble | ||
source | ||
targets | ||
.gitignore | ||
.mbedignore | ||
CHANGELOG.md | ||
CONTRIBUTING.md | ||
DOXYGEN_FRONTPAGE_BLE.md | ||
LICENSE | ||
README.md | ||
apache-2.0.txt | ||
ble.doxyfile | ||
module.json |
README.md
mbed Bluetooth Low Energy Stack
This is the Github repo for the BLE_API
used by developer.mbed.org. Please see the mbed BLE Homepage for all documentation, code examples and general help.
Supported Services
Supported GATT services and constantly being added and can be found in the ble/services/ folder.
Currently supported services include:
- Battery
- Device Firmware Update (DFU)
- Device Information
- Eddystone Configuration Service
- Health Thermometer
- Heart Rate
- Link Loss
- UART
- UriBeacon
- iBeacon
The documentation contains an overview on how to create new, application-specific services.
Getting Started
The mbed BLE API is meant to be used in projects on developer.mbed.org. Please see examples and sample project files there. A good starting point are these pages:
- mbed BLE Homepage for all things BLE
- mbed BLE Getting Started Guide a wonderful primer on using BLE with mbed
- mbed BLE doc for an introduction to mbed BLE
- mbed BLE API page for the Doxygen API documentation