Add Wi-SUN introduction #969
Conversation
|
@mikter , @AnotherButler , this is first version of Wi-SUN introduction and probably requires a lot of changes. This PR is created to open discussion how do we want to document Wi-SUN for Mbed OS 5.12. |
|
Are there any relevant code PRs waiting to go into master? |
|
The code PR is ARMmbed/mbed-os#9838, it is already merged to master. |
Edit file, mostly for formatting and minor rearranging of some content.
|
|
||
| Mbed OS provides the [Mesh C++ API](../apis/mesh-api.html) for building Wi-SUN applications. | ||
|
|
||
| - To connect to the Wi-SUN network, use the [Wi-SUN interface API](https://github.com/ARMmbed/mbed-os/blob/master/features/nanostack/mbed-mesh-api/mbed-mesh-api/WisunInterface.h). |
There was a problem hiding this comment.
Query: Should we add a WisunInterface user API page? Or is this a background API that users don't really use?
There was a problem hiding this comment.
Isn't Wi-SUN API user API documented in #981?
There was a problem hiding this comment.
That has config and reference information. It's not a user API for WisunInterface. Our user APIs live here: https://github.com/ARMmbed/mbed-os-5-docs/tree/development/docs/api/networkinterfaces
They include a link to the Doxygen class and an example.
Note: This doesn't block this PR. If we decide to add this, it can be in a different PR.
No description provided.