Skip to content

Commit db60d6a

Browse files
authored
Merge pull request #2200 from pan-/ble_integration_from_mbed_os
Move ARMmbed/feature/FEATURE_BLE into mbedmicro/mbed.
2 parents dd01009 + 2259e0d commit db60d6a

File tree

241 files changed

+67434
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

241 files changed

+67434
-0
lines changed

features/FEATURE_BLE/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Ignore the generated Doxygen output
2+
apidoc/

features/FEATURE_BLE/CHANGELOG.md

Lines changed: 393 additions & 0 deletions
Large diffs are not rendered by default.

features/FEATURE_BLE/CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Hello!
2+
We are an open source project of [ARM mbed](https://www.mbed.com). Contributions via [pull request](https://github.com/ARMmbed/ble/pulls), and [bug reports](https://github.com/ARMmbed/ble/issues) are welcome!
3+
4+
Please submit your pull request to the `develop` branch of [this module](https://github.com/ARMmbed/ble/tree/develop). Commits to develop will be merge into the master branch at the time of the next release.
5+
6+
# Contributor agreement
7+
For your pull request to be accepted, we will need you to agree to our [contributor agreement](https://developer.mbed.org/contributor_agreement/) to give us the necessary rights to use and distribute your contributions. (To click through the agreement create an account on mbed.com and log in.)
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# BLE API {#mainpage}
2+
3+
The BLE module within mbed OS offers a high abstraction level for using
4+
Bluetooth Low Energy on multiple platforms.
5+
6+
This documentation describes the internal structure of the mbed
7+
[BLE API](https://github.com/armmbed/ble).
8+
9+
For getting started with BLE on mbed, check our [introduction
10+
page](https://docs.mbed.com/docs/ble-intros/en/latest/).
11+
12+
For mbed OS examples using BLE, check [this
13+
repository](https://github.com/armmbed/ble-examples). For mbed-classic
14+
examples, please refer to [code under mbed.org](https://developer.mbed.org/teams/Bluetooth-Low-Energy/code/).
15+
16+
## Supported Services
17+
18+
Currently supported reference services include:
19+
20+
* [Battery](@ref BatteryService)
21+
* [Device Firmware Update (DFU)](@ref DFUService)
22+
* [Device Information](@ref DeviceInformationService)
23+
* [Health Thermometer](@ref HealthThermometerService)
24+
* [Heart Rate](@ref HeartRateService)
25+
* [UART](@ref UARTService)
26+
* [UriBeacon](@ref URIBeaconConfigService)
27+
* [iBeacon](@ref iBeacon)
28+
29+
The [documentation](https://docs.mbed.com/docs/ble-intros/en/latest/AdvSamples/Overview/)
30+
contains an overview on how to create new, application-specific services.

features/FEATURE_BLE/LICENSE

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Unless specifically indicated otherwise in a file, files are licensed
2+
under the Apache 2.0 license, as can be found in: apache-2.0.txt

features/FEATURE_BLE/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# mbed Bluetooth Low Energy Stack
2+
This is the Github repo for the `BLE_API` used by developer.mbed.org. Please see the [mbed BLE Homepage](https://developer.mbed.org/teams/Bluetooth-Low-Energy/) for all documentation, code examples and general help.
3+
4+
# Supported Services
5+
Supported GATT services and constantly being added and can be found in the [ble/services/](https://github.com/ARMmbed/ble/tree/master/ble/services) folder.
6+
7+
Currently supported services include:
8+
* Battery
9+
* Device Firmware Update (DFU)
10+
* Device Information
11+
* Eddystone Configuration Service
12+
* Health Thermometer
13+
* Heart Rate
14+
* Link Loss
15+
* UART
16+
* UriBeacon
17+
* iBeacon
18+
19+
The [documentation](https://docs.mbed.com/docs/ble-intros/en/latest/AdvSamples/Overview/)
20+
contains an overview on how to create new, application-specific services.
21+
22+
# Getting Started
23+
The mbed BLE API is meant to be used in projects on developer.mbed.org. Please see examples and sample project files there.
24+
A good starting point are these pages:
25+
* [mbed BLE Homepage](https://developer.mbed.org/teams/Bluetooth-Low-Energy/) for all things BLE
26+
* [mbed BLE Getting Started Guide](https://developer.mbed.org/forum/team-63-Bluetooth-Low-Energy-community/topic/5262/) a wonderful primer on using BLE with mbed
27+
* [mbed BLE doc](https://docs.mbed.com/docs/ble-intros/en/latest/) for an introduction to mbed BLE
28+
* [mbed BLE API page](https://docs.mbed.com/docs/ble-api/en/latest/api/index.html) for the Doxygen API documentation

features/FEATURE_BLE/apache-2.0.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Copyright (c) 2015 ARM Limited
2+
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at
6+
7+
http://www.apache.org/licenses/LICENSE-2.0
8+
9+
Unless required by applicable law or agreed to in writing, software
10+
distributed under the License is distributed on an "AS IS" BASIS,
11+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
See the License for the specific language governing permissions and
13+
limitations under the License.

0 commit comments

Comments
 (0)