Skip to content
This repository was archived by the owner on Apr 24, 2019. It is now read-only.

Commit cead58d

Browse files
authored
Merge pull request #27 from geky/doc-additions
Updated docs with WiFi information, removed Cellular information
2 parents 6ffa583 + f27ad1a commit cead58d

File tree

1 file changed

+36
-39
lines changed

1 file changed

+36
-39
lines changed

README.md

Lines changed: 36 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ To configure the example application, please:
4141

4242
The application uses Ethernet as the default connection type. To change the connection type, set one of them in `mbed_app.json`. For example, to enable 6LoWPAN ND mode:
4343

44-
```
45-
"network-interface":{
46-
"help": "options are ETHERNET,WIFI,MESH_LOWPAN_ND,MESH_THREAD.",
47-
"value": "MESH_LOWPAN_ND"
48-
},
44+
```json
45+
"network-interface": {
46+
"help": "options are ETHERNET,WIFI,MESH_LOWPAN_ND,MESH_THREAD.",
47+
"value": "MESH_LOWPAN_ND"
48+
}
4949
```
5050

5151
### Client credentials
@@ -81,20 +81,20 @@ You can view debug traces from the gateway with a serial port monitor. The gatew
8181

8282
The default 2.4GHz channel settings are already defined by the [mbed-mesh-api](https://github.com/ARMmbed/mbed-mesh-api) to match the mbed gateway settings. The application can override these settings by adding them to the `mbed_app.json` file in the main project directory. For example:
8383

84-
```
85-
"target_overrides": {
86-
"*": {
87-
"mbed-mesh-api.6lowpan-nd-channel-page": 0,
88-
"mbed-mesh-api.6lowpan-nd-channel": 12,
89-
"mbed-mesh-api.thread-config-channel-page": 0,
90-
"mbed-mesh-api.thread-config-channel": 12
91-
}
92-
}
84+
```json
85+
"target_overrides": {
86+
"*": {
87+
"mbed-mesh-api.6lowpan-nd-channel-page": 0,
88+
"mbed-mesh-api.6lowpan-nd-channel": 12,
89+
"mbed-mesh-api.thread-config-channel-page": 0,
90+
"mbed-mesh-api.thread-config-channel": 12
91+
}
92+
}
9393
```
9494

9595
For sub-GHz shields (AT86RF212B) use the following overrides, **6LoWPAN ND only**:
9696

97-
```
97+
```json
9898
"mbed-mesh-api.6lowpan-nd-channel-page": 2,
9999
"mbed-mesh-api.6lowpan-nd-channel": 1
100100
```
@@ -105,8 +105,8 @@ For more information about the radio shields, see [the related documentation](do
105105

106106
With Thread, you can change the operating mode of the client from the default router mode to a sleepy end device by adding the following override to the `mbed_app.json` file:
107107

108-
```
109-
"mbed-mesh-api.thread-device-type": "MESH_DEVICE_TYPE_THREAD_SLEEPY_END_DEVICE"
108+
```json
109+
"mbed-mesh-api.thread-device-type": "MESH_DEVICE_TYPE_THREAD_SLEEPY_END_DEVICE"
110110
```
111111

112112
### Ethernet settings
@@ -116,36 +116,33 @@ For running the example application using Ethernet, you need:
116116
- An Ethernet cable.
117117
- An Ethernet connection to the internet.
118118

119-
### Cellular settings
120-
121-
TBD
122-
123119
### Wi-Fi settings
124120

125-
The example application uses ESP8266 WiFi Interface for managing the wireless connectivity. To run this application using WiFi, you need to:
121+
The example application uses ESP8266 WiFi Interface for managing the wireless connectivity. To run this application using WiFi, you need:
126122

127-
1. Have [ESP8266](https://en.wikipedia.org/wiki/ESP8266) WiFi module running [Espressif Firmware](https://codeload.github.com/espressif/ESP8266_AT/zip/master)
128-
1. Mount WiFi module onto [K64F Grove Shield v2](https://developer.mbed.org/platforms/FRDM-K64F/#supported-seeed-studio-grove-extension)
123+
1. An [ESP8266](https://en.wikipedia.org/wiki/ESP8266) WiFi module
124+
1. Updated [Espressif Firmware](https://developer.mbed.org/teams/ESP8266/wiki/Firmware-Update)
125+
1. Mount the WiFi module onto [K64F Grove Shield v2](https://developer.mbed.org/platforms/FRDM-K64F/#supported-seeed-studio-grove-extension)
129126
1. Attach the shield on the K64F board.
130127
1. In the `mbed_app.json` file, change
131-
```
132-
"network-interface":{
133-
"help": "options are ETHERNET,WIFI,MESH_LOWPAN_ND,MESH_THREAD.",
134-
"value": "WIFI"
135-
},
128+
```json
129+
"network-interface": {
130+
"help": "options are ETHERNET,WIFI,MESH_LOWPAN_ND,MESH_THREAD.",
131+
"value": "WIFI"
132+
}
136133
```
137134

138135
1. Provide your WiFi SSID and password here, remember to leave `\"` in the beginning and end of your SSID and password(as shown in the example below), else example will not be able to pick up the SSID and password in correct format.
139-
```
140-
"wifi-ssid": {
141-
"help": "WiFi SSID",
142-
"value": "\"SSID\""
143-
},
144-
"wifi-password": {
145-
"help": "WiFi Password",
146-
"value": "\"Password\""
147-
}
148-
```
136+
```json
137+
"wifi-ssid": {
138+
"help": "WiFi SSID",
139+
"value": "\"SSID\""
140+
},
141+
"wifi-password": {
142+
"help": "WiFi Password",
143+
"value": "\"Password\""
144+
}
145+
```
149146

150147
### IP address setup
151148

0 commit comments

Comments
 (0)