Update BLE documentation #1458
Update BLE documentation #1458
Conversation
| "sources": [{ | ||
| "path": "docs/api/connectivity/bluetooth/BatteryService.md" | ||
| }, | ||
| "sources": [ |
There was a problem hiding this comment.
Maybe we can adopt a more logical organization:
- BLE
- Gap
- GattServer
- SecurityManager
- Services
- GattClient (which is the least used)
What do you think ?
|
|
||
| ## Inside `BLE_API` | ||
| ### BLE stacks |
There was a problem hiding this comment.
I think this section can go at the bottom, that's important but maybe not the most useful information for common users/
| ## Tracing | ||
|
|
||
| To debug issues (or to understand what the stack is doing) it may be helpful to enable tracing. | ||
|
|
||
| Traces can be turned on by overriding configuration options in you mbed_app.json: | ||
| To enable traces override configuration options in you mbed_app.json: |
There was a problem hiding this comment.
Can we add a note about debugging ?
| @@ -0,0 +1,9 @@ | |||
| # BLE Services | |||
|
|
|||
| Mbed OS BLE implementation isn't bundled with any BLE services. Services are in an external repository. Please got to: | |||
There was a problem hiding this comment.
| Mbed OS BLE implementation isn't bundled with any BLE services. Services are in an external repository. Please got to: | |
| Mbed OS BLE implementation isn't bundled with any BLE services. Services are in an external repository. Please go to: |
|
added requested changes |
|
@pan- again just sanity checking - do we want to merge this change in time for 6.13? (removes battery services etc. and adds short "BLE services" section instead, as well as moving the BLE topic in the table of contents). Is the order still correct now I've merged the other edit to docs.json? (which added the new SecurityManager.md topic to the end of the Bluetooth section) |
|
Yes it makes sense to add these for 6.13 as the battery service has been deprecated for quite a long time on Mbed OS for example. |
… deprecated/removed but some links remained
* update intro section to refer to new BLE optimiztion section, correct spelling (optimise/optimize etc.) in various places for consitency (including a filename change), and minor improvements to wording in new BLE topics. * correct filepath * correct link / link text * further edits relating to #1458 - battry and heart rate services were deprecated/removed but some links remained * remove another outdated link to battery service
* update intro section to refer to new BLE optimiztion section, correct spelling (optimise/optimize etc.) in various places for consitency (including a filename change), and minor improvements to wording in new BLE topics. * correct filepath * correct link / link text * further edits relating to #1458 - battry and heart rate services were deprecated/removed but some links remained * remove another outdated link to battery service
Replace docs for removed services with a section about services repo. Remove fluff from BLE docs. Add sections about thread safety, event handlers, examples, services and generally tidy things up.