Skip to content

Commit dbf3dd5

Browse files
author
Jarno Lämsä
authored
Update readme with wi-sun information (#242)
1 parent bd03679 commit dbf3dd5

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
With this application, you can use the [mesh networking API](https://os.mbed.com/docs/latest/apis/mesh-api.html) that [Mbed OS](https://github.com/ARMmbed/mbed-os) provides.
44

55
The application demonstrates a light control application, where devices can control the LED status of all devices in the network.
6-
The application can be built for the unsecure 6LoWPAN-ND or Thread network.
6+
The application can be built for the unsecure 6LoWPAN-ND, Thread or Wi-SUN network.
77

8-
See the [6LoWPAN overview](https://os.mbed.com/docs/latest/reference/mesh-tech.html) for the definition of star and mesh networks. These same principles apply also to Thread protocol.
8+
See the [6LoWPAN overview](https://os.mbed.com/docs/latest/reference/mesh-tech.html) for the definition of star and mesh networks. These same principles apply also to Thread and Wi-SUN protocols.
99

1010
## Setup
1111

@@ -28,6 +28,7 @@ Select the protocol the network is based on:
2828

2929
- 6LoWPAN-ND.
3030
- Thread.
31+
- Wi-SUN
3132

3233
Select the device role:
3334

@@ -42,6 +43,7 @@ Example configuration files are provide under `configs/` directory. You may over
4243
|------------------|-------|
4344
|`configs/mesh_6lowpan.json` | 6LoWPAN-ND based mesh network. |
4445
|`configs/mesh_thread.json` | Thread based mesh network. |
46+
|`configs/mesh_wisun_S2LP.json` | Wi-SUN based mesh network. |
4547

4648
An example of the `mbed_app.json` file:
4749

@@ -70,6 +72,7 @@ The following tables show the values to use in the `mbed_app.json` file for your
7072

7173
- For a 6LoWPAN-ND based network, use `nsapi.default-mesh-type: LOWPAN`.
7274
- For a Thread-based network, use `nsapi.default-mesh-type: THREAD`.
75+
- For a Wi-SUN-based network, use `nsapi.default-mesh-type: WISUN`.
7376

7477
#### 6LoWPAN-ND
7578

@@ -103,6 +106,15 @@ The Thread stack learns the network settings from the commissioning process and
103106
- Commission the device to the Thread network.
104107
- When you restart the device next time, the device reads the Thread configuration settings from the SD card and tries to attach to an existing network.
105108

109+
#### Wi-SUN
110+
111+
**nsapi.default-mesh-type: WISUN**
112+
113+
|Device role|`nanostack.configuration` value|
114+
|-----------|-------------------------|
115+
|Mesh router (default) | ws_router |
116+
117+
106118
### Requirements for hardware
107119

108120
The networking stack used in this example requires TLS functionality to be enabled on Mbed TLS.
@@ -118,13 +130,23 @@ You also need to check how LEDs and buttons are configured for your hardware, an
118130

119131
To run a 6LoWPAN-ND network, you need a working RF driver for Nanostack. This example uses the Atmel AT86RF233 by default.
120132

121-
To change the RF driver modify the `mbed_app.json` file by setting preferred RF driver `provide_default` value to true, For example, to use MCR20a RF driver:
133+
To change the RF driver modify the `mbed_app.json` file by setting preferred RF driver `provide_default` value to true, For example, to use MCR20a RF driver:
122134

123135
```json
124136
"atmel-rf.provide-default": false,
125137
"mcr20a.provide-default": true,
126138
```
127139

140+
To run a Wi-SUN network, there is currently only one supported Radio, STM S2LP.
141+
142+
To use the S2LP, modify the `mbed_app.json` file by setting:
143+
144+
```json
145+
"s2lp.provide-default": true,
146+
```
147+
148+
Note that the provide-default for each radio driver defaults to false, so there is no need to list all the possible drivers in the `mbed_app.json`.
149+
128150
### Compile the application
129151

130152
```

0 commit comments

Comments
 (0)