Skip to content

Updated readme and makefile so its easier for newbies to get ipv6 adresses #21500

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

KiyoLelou10
Copy link

I updated the Makefile so that you can get ipv6 addresses for this example from the boarder router. I explained this in an additional note that I included in the read me

@KiyoLelou10 KiyoLelou10 requested a review from jia200x as a code owner May 21, 2025 13:02
@github-actions github-actions bot added Area: doc Area: Documentation Area: examples Area: Example Applications labels May 21, 2025
Copy link
Member

@chrysn chrysn left a comment

Choose a reason for hiding this comment

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

Hi, welcome, and thanks for taking the time to enhance RIOT. First PR and it's a round number :-)

A few comments inline.

Comment on lines +54 to +56
#DEFAULT_CHANNEL ?= x

#include $(RIOTMAKE)/default-radio-settings.inc.mk
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
#DEFAULT_CHANNEL ?= x
#include $(RIOTMAKE)/default-radio-settings.inc.mk
# Set a custom channel if needed
include $(RIOTMAKE)/default-radio-settings.inc.mk

No need to comment that out: many other examples have that at the end active, I just never ran this example in a situation where it was needed. They all prefix it with this line, and none of them actually set a diverging channel. (So either a user is aware how they can change the DEFAULT_CHANNEL, or none of the peers diverge from the default anyway).

@@ -51,6 +51,9 @@ Once that is ready, in a parallel shell, run:
```
$ aiocoap-client 'coap://[2a02:0b18:c13b:8018:1234:56ff:fe78:90ab]/.well-known/core'
```
Note if you want to work with global addresses after flushing the example on a board, run the boarder router example in examples/networking/gnrc/gnrc_border_router please use the channel used there and replace the x in this line of the makefile: DEFAULT_CHANNEL ?= x with the channel used by the boarder router. If unsure you can always execute the boarder router and type in ifconfig to get the channel. Please comment out #DEFAULT_CHANNEL ?= x (The x should now be an actual number ) and comment out this line:
Copy link
Member

Choose a reason for hiding this comment

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

This tip strongly depends on the radio technology -- other boards have WiFi and need credentials, or they have USB Ethernet or are native (and then they don't need config but instead need the user's network manager to pick them up and forward the Internet to them).

This is handled inconsistently across the examples, but at least this should reflect that for running on an 802.15.4 board, then those setups are necessary. Maybe it can refer to a general network section documentation? (@AnnsAnns, you're working on the guides, is anything brewing there that could be linked as a general "this example uses the network, but there are many supported types, pick yours from this guide to get an address"?)

@chrysn chrysn self-assigned this May 21, 2025
@crasbe crasbe added the Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation label May 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation Area: examples Area: Example Applications Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants