-
Notifications
You must be signed in to change notification settings - Fork 178
Update 6LoWPAN mesh documentation #866
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update 6LoWPAN mesh documentation #866
Conversation
-Update EUI64 reading in Thread commissioning -Fix few broken links -Update Thread application list
@mikter , @AnotherButler would you please review? |
Update phrasing for active voice.
Point links to rendered examples.
Point links to rendered example.
Delete extra parentheses.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR 👍
@@ -49,7 +49,7 @@ Link quality and errors are easiest to debug using Wireshark. | |||
|
|||
#### How to send/receive with UDP and TCP sockets. How to use multicast groups? | |||
|
|||
The mesh minimal uses socket communication and multicasting. See more details in the [mesh minimal example](https://github.com/ARMmbed/mbed-os-example-mesh-minimal). | |||
The mesh minimal uses socket communication and multicasting. See more details in the [mesh minimal example](../apis/mesh-api.html#mesh-example). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Socket communication is not documented in https://os.mbed.com/docs/v5.10/apis/mesh-api.html#mesh-example. This is because file https://github.com/ARMmbed/mbed-os-example-mesh-minimal/blob/master/mesh_led_control_example.cpp is missing from the example. Can the example in docs be updated to contain all files or should the link point to the original application in github?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@AnotherButler can you comment on this issue.
Other changes are fine for me
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this version include the updates? https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-mesh-minimal/file/c841ae60db06/main.cpp/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes it does, the file https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-mesh-minimal/file/c841ae60db06/mesh_led_control_example.cpp/ is available there.
I was a little bit confused how to find file mesh_led_control_example.cpp
as it is not available in the https://os.mbed.com/docs/v5.11/apis/mesh-api.html#mesh-example.
Maybe file mesh_led_control_example.cpp
could be added also to the https://os.mbed.com/docs/v5.11/apis/mesh-api.html#mesh-example if it is not confusing the user too much?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll update the version of the example transcluded into https://os.mbed.com/docs/v5.11/apis/mesh-api.html#mesh-example. This should fix the issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR up: #889
-Update EUI64 reading in Thread commissioning
-Fix few broken links
-Update Thread application list