Skip to content

Commit 3a86915

Browse files
Update README.md (#16)
* Update README.md * fix problem with mbed tools config behaviour
1 parent feacfdf commit 3a86915

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,41 @@
11
# Experimental services for Mbed OS BLE
22

33
This repository is an incubator for standard and common Bluetooth services development.
4+
5+
## Contents
6+
7+
The repo contains multiple BLE services designed to work with Mbed OS. They are not officially supported and are not
8+
part of Mbed OS itself. This is a community led effort and we welcome all contributions, which should follow the
9+
decisions published in the `doc/adr` directory.
10+
11+
Services are are in the `services` directory. Each BLE service is an Mbed OS library. The name of each library
12+
is in the `mbed_lib.json` file inside each of the service directories. They follow the pattern `ble-service-name`.
13+
14+
## How to use a service
15+
16+
Inside your Mbed OS project, include a file called 'mbed-os-experimental-ble-services.lib' with contents:
17+
18+
```
19+
https://github.com/ARMmbed/mbed-os-experimental-ble-services
20+
```
21+
22+
Call `mbed deploy`. This will check out this repository into your project.
23+
24+
To use a particular service you will need to now add the library that contains it into your application.
25+
26+
Inside your `mbed_app.json` you need to override the `requires` section for your platform.
27+
Add the name of the library containing the service.
28+
29+
For example, if you want to use the DFU service, add this to your `mbed_app.json`:
30+
31+
```
32+
"target_overrides": {
33+
"*": {
34+
"target.requires": [ "ble-service-DFU" ]
35+
},
36+
}
37+
```
38+
39+
### License and contributions
40+
41+
The software is provided under Apache-2.0 license. Contributions to this project are accepted under the same license.

0 commit comments

Comments
 (0)