Skip to content

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

Merged
merged 5 commits into from
Jan 22, 2019

Conversation

artokin
Copy link

@artokin artokin commented Dec 7, 2018

-Update EUI64 reading in Thread commissioning
-Fix few broken links
-Update Thread application list

-Update EUI64 reading in Thread commissioning
-Fix few broken links
-Update Thread application list
@artokin
Copy link
Author

artokin commented Dec 7, 2018

@mikter , @AnotherButler would you please review?

Amanda Butler added 4 commits December 7, 2018 09:53
Update phrasing for active voice.
Point links to rendered examples.
Point links to rendered example.
Delete extra parentheses.
Copy link
Contributor

@AnotherButler AnotherButler left a 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 👍

@AnotherButler AnotherButler requested a review from mikter December 7, 2018 15:59
@@ -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).
Copy link
Author

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?

Copy link

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Author

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?

Copy link
Contributor

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR up: #889

@AnotherButler AnotherButler merged commit 839dbb2 into ARMmbed:development Jan 22, 2019
AnotherButler pushed a commit that referenced this pull request Jan 22, 2019
AnotherButler pushed a commit that referenced this pull request Jan 22, 2019
AnotherButler pushed a commit that referenced this pull request Jan 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants