examples/gnrc_border_router: Add ethos and start_network.sh to README.md #4996

kYc0o · 2016-03-08T18:34:32Z

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

miri64 · 2016-03-08T18:58:47Z

examples/gnrc_border_router/README.md

+
+
+# 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.


It's not typical to reference a merged PR in a documentation text.

Also, please try to keep the lines under 80 characters long.

Yes we'll wait until the PR is merged, then I'll change that part

But #4438 is already merged

we are waiting for #4725

You mean I should remove the reference to the closed PR?

jnohlgard · 2016-03-08T20:25:37Z

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

miri64 · 2016-03-08T20:32:01Z

2001:0000::/29 - 2001:01F8::/29 are also viable for experimental use

miri64 · 2016-03-08T20:34:41Z

examples/gnrc_border_router/README.md

+
+
+# 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.


s/ethos/\0/g

And still too long lines

Why the long lines bother you? Do you think I should split into 2 paragraphs?

jnohlgard · 2016-03-08T20:40:42Z

@authmillenon I interpret that paragraph that they mean more for routing experiments across sites for developing the IPv6 internet, not for local IoT experiments.

miri64 · 2016-03-08T20:43:17Z

examples/gnrc_border_router/README.md

+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:


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)

miri64 · 2016-03-08T20:50:50Z

@authmillenon I interpret that paragraph that they mean more for routing experiments across sites for developing the IPv6 internet, not for local IoT experiments.

Well the RFC also references 2001:db8::/32 for documentation purposes which is exactly what we have here. :-)

biboc · 2016-03-23T07:52:32Z

Ping @authmillenon

kYc0o · 2016-03-23T08:09:01Z

Oops! That's me, I'll address the comments ASAP

kYc0o · 2016-03-26T11:46:46Z

I addressed most of the comments and changed the addresses for "documentation purposes" to 2001:db8::/32.

emmanuelsearch · 2016-03-30T10:40:43Z

@kYc0o what's the status on this PR, on your side?
@aabadie do you see ways to improve this README based on your recent experience?

kaspar030 · 2016-03-30T11:02:13Z

Current #4725 drops the slip mode completely. Should the readme reflect this?

OlegHahm · 2016-03-30T11:09:25Z

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.

kYc0o · 2016-03-30T13:10:07Z

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

kYc0o · 2016-04-01T10:32:05Z

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?

kYc0o · 2016-04-12T15:23:20Z

As for my last tests, this guide is still valid, aiming to merge it once #4725 is merged too?

kaspar030 · 2016-04-12T19:44:21Z

ACK after you shorten the lines to <= 80 characters. :)

aabadie · 2016-04-13T07:28:34Z

examples/gnrc_border_router/README.md

+```bash
+sudo sh start_network.sh /dev/ttyACMx tap0 2001:db8::/64
+```
+


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.

haukepetersen · 2016-04-13T08:18:58Z

@aabadie: thanks for you input!

@kYc0o: could you adjust the README ASAP!? Would be good to merge this as soon as possible, as the border router app was merged and has a broken doc currently...

emmanuelsearch · 2016-04-13T08:25:06Z

examples/gnrc_border_router/README.md

@@ -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. 


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).

UHCP (micro Host Control Protocol)

micro host configuration protocol ;)

kYc0o · 2016-04-13T10:41:59Z

Comments addressed. Sorry for the delay, I was sick this morning... Please check if all comments were correctly addressed.

emmanuelsearch · 2016-04-13T10:52:16Z

examples/gnrc_border_router/README.md

+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:


"example" => "example on the mote"
"ping" => "ping it from your machine"

emmanuelsearch · 2016-04-13T10:59:53Z

Thanks. Added a few comments. ACK when addressed.

kYc0o · 2016-04-13T14:50:16Z

Thanks to you @emmanuelsearch.

aabadie · 2016-04-13T15:07:46Z

examples/gnrc_border_router/README.md

+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.


using the global address => using their global address

kYc0o · 2016-04-14T09:48:17Z

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.

emmanuelsearch · 2016-04-14T09:51:50Z

re-ACK. Merge at will (and back port to release branch asap).

kYc0o · 2016-04-14T09:55:50Z

Squashed and go!

miri64 · 2016-04-19T10:34:26Z

Needs backport.

kYc0o added Area: network Area: Networking Area: doc Area: Documentation labels Mar 8, 2016

kYc0o assigned miri64 Mar 8, 2016

kYc0o added this to the Release 2016.04 milestone Mar 8, 2016

OlegHahm added the State: waiting for other PR State: The PR requires another PR to be merged first label Mar 8, 2016

miri64 reviewed Mar 8, 2016
View reviewed changes

emmanuelsearch mentioned this pull request Mar 30, 2016

simplified border router setup #4725

Merged

kaspar030 removed the State: waiting for other PR State: The PR requires another PR to be merged first label Apr 12, 2016

aabadie reviewed Apr 13, 2016
View reviewed changes

emmanuelsearch reviewed Apr 13, 2016
View reviewed changes

aabadie reviewed Apr 13, 2016
View reviewed changes

examples/gnrc_border_router: Add ethos and start_network.sh to README.md

6d7f3ae

kYc0o force-pushed the br_readme branch from 9003931 to 6d7f3ae Compare April 14, 2016 09:53

kYc0o merged commit 998c4ab into RIOT-OS:master Apr 14, 2016

miri64 added the Process: needs backport Integration Process: The PR is required to be backported to a release or feature branch label Apr 19, 2016

miri64 mentioned this pull request Apr 19, 2016

examples/gnrc_border_router: Add ethos and start_network.sh to README.md (backport) #5348

Merged

miri64 removed the Process: needs backport Integration Process: The PR is required to be backported to a release or feature branch label Apr 19, 2016



		# 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.



		# 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.

examples/gnrc_border_router: Add ethos and start_network.sh to README.md #4996

examples/gnrc_border_router: Add ethos and start_network.sh to README.md #4996

Conversation

kYc0o commented Mar 8, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jnohlgard commented Mar 8, 2016

miri64 commented Mar 8, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jnohlgard commented Mar 8, 2016

Choose a reason for hiding this comment

miri64 commented Mar 8, 2016

biboc commented Mar 23, 2016

kYc0o commented Mar 23, 2016

kYc0o commented Mar 26, 2016

emmanuelsearch commented Mar 30, 2016

kaspar030 commented Mar 30, 2016

OlegHahm commented Mar 30, 2016

kYc0o commented Mar 30, 2016

kYc0o commented Apr 1, 2016

kYc0o commented Apr 12, 2016

kaspar030 commented Apr 12, 2016

Choose a reason for hiding this comment

haukepetersen commented Apr 13, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kYc0o commented Apr 13, 2016

Choose a reason for hiding this comment

emmanuelsearch commented Apr 13, 2016

kYc0o commented Apr 13, 2016

Choose a reason for hiding this comment

kYc0o commented Apr 14, 2016

emmanuelsearch commented Apr 14, 2016

kYc0o commented Apr 14, 2016

miri64 commented Apr 19, 2016