Skip to content

Commit 91ba910

Browse files
committed
Edited README.md
1 parent 4dd14c0 commit 91ba910

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
# otbr-mqtt-sn
2-
Docker file for OpenThread Border Router with MQTT-SN
1+
2+
Dockerfile for OpenThread Border Router with MQTT-SN.
3+
34

45
# Building
56

@@ -9,6 +10,26 @@ docker build --no-cache -t otbr-mqtt-sn -f ./Dockerfile .
910

1011
# Running
1112

13+
To run the container with the default parameters:
14+
1215
```shell
1316
docker run --name otbr-mqtt-sn -p 8080:80 --dns=127.0.0.1 -it --privileged otbr-mqtt-sn
14-
```
17+
```
18+
19+
The most common network parameters can be set on the docker comman line. The default values are taken from the Nordic Semiconductor border router such that it works with the examples in the [Nordic Semiconductor nRF5 SDK for Thread and Zigbee](https://www.nordicsemi.com/Software-and-tools/Software/nRF5-SDK-for-Thread-and-Zigbee).
20+
The command line options with default values are shown in the following table.
21+
22+
| Parameter | command line option | default value |
23+
|----------------------|:--------------------------------|:---------------------------------|
24+
| Network Name | --network-name | OTBR-MQTT-SN |
25+
| NCP Serial Port | --ncp-path | /dev/ttyACM0 |
26+
| PAN ID | --panid | 0xABCD |
27+
| Extended PAN ID | --xpanid | DEAD00BEEF00CAFE |
28+
| NCP Channel | --ncp-channel | 11 |
29+
| Network Key | --network-key | 00112233445566778899AABBCCDDEEFF |
30+
| Network PSKc | --pskc | E00F739803E92CB42DAA7CCE1D2A394D |
31+
| TUN Interface Name | --interface | wpan0 |
32+
| NAT64 Prefix | --nat64-prefix | 64:ff9b::/96 |
33+
| Default prefix route | --disable-default-prefix-route | Enabled |
34+
| Default prefix slaac | --disable-default-prefix-slaac | Enabled |
35+

0 commit comments

Comments
 (0)