Diff: README.md

Revision:

115:45399116b171

Parent:

112:6e06a534b348

Child:

120:1f3dd60107dd

--- a/README.md	Thu Nov 23 09:00:08 2017 +0000
+++ b/README.md	Fri Nov 24 10:00:07 2017 +0000
@@ -65,7 +65,7 @@
 
 * [AT86RF233/212B](https://github.com/ARMmbed/atmel-rf-driver)
 * [NXP-MCR20a](https://github.com/ARMmbed/mcr20a-rf-driver)
-* [X-NUCLEO-IDS01A4](https://github.com/ARMmbed/stm-spirit1-rf-driver) (*a.k.a.* Spirit1) radio shields. Check instructions for compilation [here](#compile-configuration-for-spirit1)
+* [X-NUCLEO-IDS01A4](https://github.com/ARMmbed/stm-spirit1-rf-driver) (*a.k.a.* Spirit1) radio shields. Check instructions for compilation [here](#compile-configuration-for-spirit1).
 
 To select the radio shield make sure that the `mbed_app.json` file points to the correct radio driver type:
 
@@ -122,12 +122,12 @@
 
 ```json
 "mbed-mesh-api.6lowpan-nd-channel-page": 2,
-"mbed-mesh-api.6lowpan-nd-channel": 1
+"mbed-mesh-api.6lowpan-nd-channel": 1,
+"mbed-mesh-api.6lowpan-nd-channel-mask": "(1<<1)"
 ```
 
 For more information about the radio shields, see [the related documentation](docs/radio_module_identify.md). 
  
-=======
 #### Supported combinations of board and shields
 
 See Mesh-minimal's [Notes on different hardware](https://github.com/ARMmbed/mbed-os-example-mesh-minimal/blob/master/Hardware.md) for known combinations of development boards and RF shields that have been tested with mesh networking stack.
@@ -155,6 +155,7 @@
 * UBLOX_EVK_ODIN_W2. Check instructions for compilation [here](#compile-configuration-for-odin-wifi).
 * K64F + GROVE SEEED shield using [ESP8266](https://en.wikipedia.org/wiki/ESP8266) WiFi module.
 * NUCLEO_F429ZI + GROVE SEEED shield using [ESP8266](https://en.wikipedia.org/wiki/ESP8266) WiFi module.
+* [NUCLEO_F401RE](https://os.mbed.com/platforms/ST-Nucleo-F401RE/) + [X-NUCLEO-IDW0XX1](https://github.com/ARMmbed/wifi-x-nucleo-idw01m1/).
 
 To run this application using ESP8266 WiFi Interface, you need:
 
@@ -166,8 +167,8 @@
 
 ```json
     "network-interface": {
-        "help": "options are ETHERNET,WIFI,MESH_LOWPAN_ND,MESH_THREAD.",
-        "value": "WIFI"
+        "help": "options are ETHERNET,WIFI_ESP8266,WIFI_IDW0XX1,WIFI_ODIN,MESH_LOWPAN_ND,MESH_THREAD.",
+        "value": "WIFI_ESP8266"
     }
 ```
 
@@ -201,14 +202,36 @@
 
 #### Compile configuration for ODIN WiFi
 
-To compile ODIN WiFi configuration, you need to tell mbed NOT to compile the related files. To do that, set up a `.mbedignore` file. An example file is available in the `configs` folder.     
+To compile ODIN WiFi configuration, you need to tell mbed NOT to compile mesh files for example. To do that, set up a `.mbedignore` file. An example file is available in the `configs` folder.
 
 This should resolve the issue:
 
-```     
-cp configs/eth-wifi-mbedignore ./.mbedignore 
-```    
- 
+``` bash
+cp configs/wifi_odin_v4.json mbed_app.json
+<use your favourite editor to modify mbed_app.json for WiFi details>
+cp configs/mesh-mbedignore ./.mbedignore 
+```
+
+#### Compile configuration for STM `X-NUCLEO-IDW0XX1` WiFi expansion boards
+
+Currently, two STM WiFi expansion boards are available:
+- `X-NUCLEO-IDW01M1`, which is the Morpho form-factor board, and
+- `X-NUCLEO-IDW04A1`, which is the Arduino form-factor board.
+
+The label is clearly printed on the PCB.
+
+To compile STM X-NUCLEO WiFi configuration, you need to tell mbed NOT to compile mesh files for example. To do that, set up a `.mbedignore` file. Example files are available in the `configs` folder.
+
+This should resolve the issue (example for `X-NUCLEO-IDW01M1`):
+
+``` bash
+cp configs/wifi_idw01m1_v4.json mbed_app.json
+<use your favourite editor to modify mbed_app.json for WiFi details>
+cp configs/mesh-mbedignore ./.mbedignore 
+```
+
+If you have issues with the `X-NUCLEO-IDW04A1` board, please double-check that macro `IDW04A1_WIFI_HW_BUG_WA` has been added to the `macros` section of the `mbed_app.json` file.
+
 ### Non listed board support 
 
 Apart from the listed configurations, this example can work on other Mbed OS supported hardware boards which support any of the given network interface including Ethernet, WiFi, Mesh (6LoWPAN) or Thread, provided the configuration fulfills condition that the target hardware has TLS entropy implemented for it. On devices where hardware entropy is not present, TLS is disabled by default. This would result in compile time failures or linking failures.