-
Notifications
You must be signed in to change notification settings - Fork 2k
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
examples/gnrc_border_router: Add ethos and start_network.sh to README.md #4996
Conversation
|
||
|
||
# gnrc_border_router with ethos | ||
A new setup is possible thanks to \#4438(https://github.com/RIOT-OS/RIOT/pull/4438) on which only one serial interface is needed. This is done through the ethos (Ethernet Over Serial) driver that multiplexes serial data between ethernet packets and shell commands. |
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.
It's not typical to reference a merged PR in a documentation text.
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.
Also, please try to keep the lines under 80 characters long.
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 we'll wait until the PR is merged, then I'll change that part
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.
But #4438 is already merged
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.
we are waiting for #4725
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.
You mean I should remove the reference to the closed PR?
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. :-)
Can you change the prefix to anything in the ULA range (fc00::/7) instead of affe:: to use the RFC 4193 designated private use addresses. Preferably something in fdxx::, see https://en.wikipedia.org/wiki/Unique_local_address#Properties |
|
|
||
|
||
# gnrc_border_router with ethos | ||
A new setup is possible on which only one serial interface is needed. This is done through the ethos (Ethernet Over Serial) driver that multiplexes serial data between ethernet packets and shell commands. |
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.
s/ethos/
\0/g
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.
And still too long lines
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.
Why the long lines bother you? Do you think I should split into 2 paragraphs?
@authmillenon I interpret that paragraph that they mean more for routing experiments across sites for developing the IPv6 internet, not for local IoT experiments. |
Now, you should be able to ping your nodes using the global addres starting by your prefix, on our case `affe::`. | ||
|
||
# gnrc_border_router using automatic configuration (not merged yet) | ||
In \#4725 (https://github.com/RIOT-OS/RIOT/pull/4725) an effort to automate all the previous steps is done using 3 tools: |
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.
You can have proper links in markdown doing this
[\#4725](https://github.com/RIOT-OS/RIOT/pull/4725)
(and it's not too disruptive for local readers either)
Well the RFC also references |
Ping @authmillenon |
Oops! That's me, I'll address the comments ASAP |
I addressed most of the comments and changed the addresses for "documentation purposes" to |
Current #4725 drops the slip mode completely. Should the readme reflect this? |
I think it might be nice to add a hint that you can use SLIP (or any Ethernet transceiver) as well. |
On my side I think I addressed most of the comments, maybe a paragraph is apparently too large but I can't see how to split it or male it short. Otherwise we are still waiting for #4725 |
Looking at #4725 there are lots of changes so it seems this is very outdated. @kaspar030 can you confirm what is up-to-date and what's not? |
As for my last tests, this guide is still valid, aiming to merge it once #4725 is merged too? |
ACK after you shorten the lines to <= 80 characters. :) |
```bash | ||
sudo sh start_network.sh /dev/ttyACMx tap0 2001:db8::/64 | ||
``` | ||
|
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 think it would be great to mention here that one has access to the shell here. For instance, one can track the neighbour cache using ncache
.
@@ -1,4 +1,144 @@ | |||
# gnrc_networking_border_router example | |||
# gnrc_border_router using automatic configuration | |||
A new setup is possible on which only one serial interface is needed. |
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.
Since this is now the default config, how about rephrasing the first two sentences with something like "This setup uses a single serial interface, ethos (Ethernet Over Serial) and UHCP (micro Host Control Protocol).
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.
UHCP (micro Host Control Protocol)
micro host configuration protocol ;)
Comments addressed. Sorry for the delay, I was sick this morning... Please check if all comments were correctly addressed. |
By typing `help` you will get the list of available shell commands. | ||
|
||
At this point you should be able to ping motes using the global address. | ||
For instance, if you use the `gnrc_networking` example, you can ping with: |
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.
"example" => "example on the mote"
"ping" => "ping it from your machine"
Thanks. Added a few comments. ACK when addressed. |
Thanks to you @emmanuelsearch. |
This is done through the same serial interface. | ||
By typing `help` you will get the list of available shell commands. | ||
|
||
At this point you should be able to ping motes using the global address. |
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.
using the global address => using their global address
Since there's already an ACK, I'll squash the commits and merge. Since it is a readme I don't think Murdock is required for this. I'll let some minutes before doing it, in case of someone has more comments. |
re-ACK. Merge at will (and back port to release branch asap). |
Squashed and go! |
Needs backport. |
I had added it in a wrong branch, open again with correct commit message
Added documentation for ethos and automatic setup with the start_network.sh script on #4725