Skip to content

Commit 44c8dff

Browse files
authored
Merge pull request #90 from jhermanowski/tasks-fixes
Tasks: Updates broken and outdated links.
2 parents 7250d79 + eb187f6 commit 44c8dff

7 files changed

Lines changed: 21 additions & 21 deletions

File tree

task-02/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ static const shell_command_t shell_commands[] = {
3030
Please note, that the list of shell commands must be terminated with an empty entry.
3131

3232
## Task 2.2: Control the hardware
33-
1. Include the [`led.h`](https://doc.riot-os.org/led_8h.html) file to get access
33+
1. Include the [`led.h`](https://api.riot-os.org/led_8h.html) file to get access
3434
to the `LED0_TOGGLE` macro.
3535
2. Write a command handler `toggle` in [`main.c`](main.c) that toggles the
3636
primary LED on the board using the `LED0_TOGGLE` macro.
3737

38-
[Read the Doc](https://doc.riot-os.org/group__sys__shell.html)
38+
[Read the Doc](https://api.riot-os.org/group__sys__shell.html)
3939

4040
[next task](../task-03)

task-03/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Threads in RIOT are functions with signature
55
```C
66
void *thread_handler(void *arg);
77
```
8-
Use [`thread_create()`](https://doc.riot-os.org/thread_8h.html#a87c94d383e64a09974fc8665f82a99b3) from
9-
[`thread.h`](https://doc.riot-os.org/thread_8h.html) to start it
8+
Use [`thread_create()`](https://api.riot-os.org/group__core__thread.html#ga7e0403a9aa86ce0ec136f6b069d4434a) from
9+
[`thread.h`](https://api.riot-os.org/group__core__thread.html) to start it
1010
```C
1111
thread_create(stack, sizeof(stack),
1212
THREAD_PRIORITY_MAIN - 1,
@@ -21,6 +21,6 @@ thread_create returns a kernel_pid_t type, which can be helpful to assign to a v
2121
* Run the application on `native`: `make all term`
2222
* Check your output, it should read: `I'm in "thread" now`
2323

24-
[Read the doc](https://doc.riot-os.org/group__core__thread.html)
24+
[Read the doc](https://api.riot-os.org/group__core__thread.html)
2525

2626
[next task](../task-04)

task-04/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[previous task](../task-03)
22

33
# Task 4: Timers
4-
[`xtimer`](https://doc.riot-os.org/group__sys__xtimer.html) is the high level API of RIOT to multiplex hardware timers.
4+
[`xtimer`](https://api.riot-os.org/group__sys__xtimer.html) is the high level API of RIOT to multiplex hardware timers.
55
For this task we need only the following functions
66

77
- `xtimer_now_usec()` to get current system time in microseconds
@@ -16,6 +16,6 @@ USEMODULE += xtimer
1616
* Create a thread in [`main.c`](main.c#L12) that prints the current system time every 2 seconds
1717
* Check the existence of the thread with `ps` shell command
1818

19-
[Read the doc](https://doc.riot-os.org/group__sys__xtimer.html)
19+
[Read the doc](https://api.riot-os.org/group__sys__xtimer.html)
2020

2121
[next task](../task-05)

task-05/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# Task 5: Using network devices
44

55
## RIOT's Networking architecture
6-
Network devices are accessed through [`netdev`](https://doc.riot-os.org/group__drivers__netdev__api.html) driver API
6+
Network devices are accessed through [`netdev`](https://api.riot-os.org/group__drivers__netdev__api.html) driver API
77

88
![Networking overview](../overview-net.png)
99

@@ -41,6 +41,6 @@ sudo ./../RIOT/dist/tools/tapsetup/tapsetup -c 2
4141
* Type `ifconfig` to get your hardware addresses
4242
* Use `txtsnd` to send one of your neighbors a friendly message
4343

44-
[Read the Doc](https://doc.riot-os.org/group__drivers__netdev__api.html)
44+
[Read the Doc](https://api.riot-os.org/group__drivers__netdev__api.html)
4545

4646
[next task](../task-06)

task-06/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# 6. UDP Client / Server
44

5-
The transport layer (UDP, TCP, etc) is accessed through [`sock`](https://doc.riot-os.org/group__net__sock.html) driver API
5+
The transport layer (UDP, TCP, etc) is accessed through [`sock`](https://api.riot-os.org/group__net__sock.html) driver API
66

77
![Networking overview](../overview-net.png)
88

@@ -91,7 +91,7 @@ USEMODULE += gnrc_sock_udp
9191
```
9292
udp <tap0-IPv6-addr> 8888 hello
9393
```
94-
[Read the Doc](https://doc.riot-os.org/group__net__sock.html)
94+
[Read the Doc](https://api.riot-os.org/group__net__sock.html)
9595
9696
## Task 6.3 -- Exchange UDP packets with your neighbors
9797
* Compile, flash and run on the board `BOARD=samr21-xpro make all flash term`

task-07/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ you should be able to handle it.
99
It uses the [example applications in the RIOT repository](https://github.com/RIOT-OS/RIOT/tree/master/examples).
1010

1111
## Task 7.1: Compile the `gnrc_minimal` application
12-
* Go to the [`gnrc_minimal` application](https://github.com/RIOT-OS/RIOT/tree/master/examples/gnrc_minimal)
12+
* Go to the [`gnrc_minimal` application](https://github.com/RIOT-OS/RIOT/tree/master/examples/networking/gnrc/minimal)
1313
* Compile and run on `native`
1414
* Should print something like `My address is fe80::d403:24ff:fe89:2460`
1515
* Ping RIOT instance from Linux:
@@ -21,9 +21,9 @@ Note: on MAC use `bridge0` instead of `tapbr0`.
2121

2222
## Task 7.2: Extend `gnrc_minimal` application
2323
* Add the `gnrc_udp` module to the application's
24-
[Makefile](https://github.com/RIOT-OS/RIOT/blob/master/examples/gnrc_minimal/Makefile)
25-
* To be able to receive packets, a [message queue](http://doc.riot-os.org/group__net__gnrc.html) must be
26-
created using [msg_init_queue](https://doc.riot-os.org/group__core__msg.html#ga480e6f32c8ab18579b62a890f3fda2cd):
24+
[Makefile](https://github.com/RIOT-OS/RIOT/blob/master/examples/networking/gnrc/minimal/Makefile)
25+
* To be able to receive packets, a [message queue](http://api.riot-os.org/group__net__gnrc.html) must be
26+
created using [msg_init_queue](https://api.riot-os.org/group__core__msg.html#ga480e6f32c8ab18579b62a890f3fda2cd):
2727

2828
```C
2929
msg_t msg_queue[num];
@@ -33,7 +33,7 @@ msg_init_queue(msg_queue, num);
3333
Note: `num` must be in powers of 2.
3434
3535
* You can register for packets of a certain type and context (port 8888 in our
36-
case) using `gnrc_netreg_register()` from [`net/gnrc/netreg.h`](https://doc.riot-os.org/group__net__gnrc__netreg.html):
36+
case) using `gnrc_netreg_register()` from [`net/gnrc/netreg.h`](https://api.riot-os.org/group__net__gnrc__netreg.html):
3737
* The current thread can be obtained with the `thread_getpid()` function from
3838
`thread.h`
3939
@@ -42,7 +42,7 @@ gnrc_netreg_entry_t server = GNRC_NETREG_ENTRY_INIT_PID(8888, thread_getpid());
4242
gnrc_netreg_register(GNRC_NETTYPE_UDP, &server);
4343
```
4444

45-
* Packets can be received using the IPC receive function [msg_receive()](https://doc.riot-os.org/group__core__msg.html#gae3e05f08bd71d6f65dc727624c4d5f7a):
45+
* Packets can be received using the IPC receive function [msg_receive()](https://api.riot-os.org/group__core__msg.html#gae3e05f08bd71d6f65dc727624c4d5f7a):
4646

4747
```C
4848
msg_t msg;
@@ -66,14 +66,14 @@ gnrc_pktbuf_release(pkt);
6666
2. Use `netcat` on your host to test your application on native node.
6767

6868
## Task 7.3: Send your neighbor some messages again
69-
* Go to the [`gnrc_networking` application](https://github.com/RIOT-OS/RIOT/tree/master/examples/gnrc_networking)
69+
* Go to the [`gnrc_networking` application](https://github.com/RIOT-OS/RIOT/tree/master/examples/networking/gnrc/networking)
7070
* Have a look in `udp.c` how packets are constructed and send
7171
* Compile, flash, and run on the board `BOARD=samr21-xpro make all flash term`
7272
* Type `help`
73-
* Start UDP server on port 8888 using `udp server 8888`
73+
* Start UDP server on port 8888 using `udp server start 8888`
7474
* Get your IPv6 address using `ifconfig`
7575
* Send your neighbor some messages using `udp send`
7676

77-
[Read the Doc](https://doc.riot-os.org/group__net__gnrc.html)
77+
[Read the Doc](https://api.riot-os.org/group__net__gnrc.html)
7878

7979
[next task](../task-08)

task-09/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
This task will demonstrate basic routing functionalities in RIOT provided by the [RPL](https://tools.ietf.org/html/rfc6550) (IPv6 Routing Protocol for Low-Power and Lossy Networks) routing protocol and multihop communication.
66

7-
It uses an adapted version of the default [`gnrc_networking`](https://github.com/RIOT-OS/RIOT/tree/master/examples/gnrc_networking) example in the RIOT repository.
7+
It uses an adapted version of the default [`gnrc_networking`](https://github.com/RIOT-OS/RIOT/tree/master/examples/networking/gnrc/networking) example in the RIOT repository.
88

99
## Prerequisites
1010

0 commit comments

Comments
 (0)