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

Commit c14566e

Browse files
author
Janne Kiiskilä
committed
README.md - small re-org
Remove the known issues, they were all fixed already. Insert a table of supported boards/network connectivity, easier to read. Now, once we insert the "NANOSTACK" feature to the `*.json`s, we do not need the extra compilation instructions either.
1 parent 3f0da43 commit c14566e

File tree

2 files changed

+95
-123
lines changed

2 files changed

+95
-123
lines changed

‎README.md

Lines changed: 60 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,8 @@ The application:
2121
To configure the example application:
2222

2323
1. [Select network and board](#select-network-and-board)
24-
* [Ethernet](#ethernet)
25-
* [Mesh (6LoWPAN and Thread)](#mesh)
2624
* [WiFi](#wifi)
25+
* [Mesh (6LoWPAN and Thread)](#mesh)
2726
* [Non listed boards](#non-listed-board-support)
2827
1. [Set the client credentials](#client-credentials).
2928
1. [Set up an IP address](#ip-address-setup). This step is optional.
@@ -33,19 +32,68 @@ To configure the example application:
3332

3433
This example supports following hardware-network combinations:
3534

36-
### Ethernet
35+
| Board | Ethernet | WiFi | Mesh config | Special notes |
36+
|------------------------------------------------------------------------------|----------------------------------------------------|-------------|---------------|
37+
|[FRDM-K64F](https://developer.mbed.org/platforms/FRDM-K64F/) | `mbed_app.json` | `configs/wifi_esp8266_v4.json` <br>GROVE SEEED shield using [ESP8266](https://en.wikipedia.org/wiki/ESP8266) WiFi module | multiple | - |
38+
|[NUCLEO_F429ZI](https://developer.mbed.org/platforms/ST-Nucleo-F429ZI/) | `mbed_app.json` | `configs/wifi_esp8266_v4.json`<br>GROVE SEEED shield using [ESP8266](https://en.wikipedia.org/wiki/ESP8266) WiFi module | multiple | - |
39+
|[UBLOX_EVK_ODIN_W2](https://developer.mbed.org/platforms/ublox-EVK-ODIN-W2/) | `mbed_app.json` | `configs/wifi_odin_v4.json`<br>Using built-in WiFi | | Ethernet requires EMAC override. |
40+
|[REALTEK RTL8195AM](https://developer.mbed.org/platforms/REALTEK-RTL8195AM/) | no ethernet | `configs/wifi_rtw_v4.json`<br>Using built-in WiFi | | You *must* update [DAPLINK](https://developer.mbed.org/platforms/REALTEK-RTL8195AM/#daplink-firmware-update).) |
41+
42+
We recommend updating the DAPLINK firmware of the boards before using them.
43+
44+
## WiFi
3745

3846
#### Supported boards
3947

40-
* [FRDM-K64F](https://developer.mbed.org/platforms/FRDM-K64F/)
41-
* [NUCLEO_F429ZI](https://developer.mbed.org/platforms/ST-Nucleo-F429ZI/)
42-
* [UBLOX_EVK_ODIN_W2](https://developer.mbed.org/platforms/ublox-EVK-ODIN-W2/) (use the supplied `configs/eth_v4.json`)
43-
* [REALTEK RTL8195AM](https://developer.mbed.org/platforms/REALTEK-RTL8195AM/) (use the supplied `configs/wifi_realtek_v4.json`, remember to update [DAPLINK](https://developer.mbed.org/platforms/REALTEK-RTL8195AM/#daplink-firmware-update).)
48+
* K64F + GROVE SEEED shield using [ESP8266](https://en.wikipedia.org/wiki/ESP8266) WiFi module.
49+
* NUCLEO_F429ZI + GROVE SEEED shield using [ESP8266](https://en.wikipedia.org/wiki/ESP8266) WiFi module.
50+
* UBLOX_EVK_ODIN_W2 with built-in WiFi.
51+
* REALTEK RTL8195AM with built-in WiFi.
52+
53+
To run this application using ESP8266 WiFi Interface, you need:
54+
55+
1. An [ESP8266](https://en.wikipedia.org/wiki/ESP8266) WiFi module.
56+
1. Updated [Espressif Firmware](https://developer.mbed.org/teams/ESP8266/wiki/Firmware-Update).
57+
1. Mount the WiFi module onto [K64F Grove Shield v2](https://developer.mbed.org/platforms/FRDM-K64F/#supported-seeed-studio-grove-extension).
58+
1. Attach the shield on your board.
59+
1. In the `mbed_app.json` file, change `network-interface` parameter to match your WiFi, for example for ESP8266:
60+
61+
```json
62+
"network-interface": {
63+
"help": "options are ETHERNET, WIFI_ESP8266, WIFI_ODIN, WIFI_RTW, MESH_LOWPAN_ND,MESH_THREAD.",
64+
"value": "WIFI_ESP8266"
65+
}
66+
```
67+
You can use values `WIFI_ODIN` for ODIN UBLOX EVK W2 and `WIFI_RTW` for Realtek RTL8195AM.
68+
69+
Provide your WiFi SSID and password here and leave `\"` in the beginning and end of your SSID and password (as shown in the example below). Otherwise, the example cannot pick up the SSID and password in correct format.
70+
71+
```json
72+
"wifi-ssid": {
73+
"help": "WiFi SSID",
74+
"value": "\"SSID\""
75+
},
76+
"wifi-password": {
77+
"help": "WiFi Password",
78+
"value": "\"Password\""
79+
}
80+
```
81+
82+
<span class="notes">**Note:** Some devices do not support the Grove Shield or use the primary UART for USB communication. On such devices, modify the `mbed_app.json` to use the serial pins connected to the ESP8266.</span>
4483

45-
For running the example application using Ethernet, you need:
84+
For example, NUCLEO_F401RE requires a different serial connection:
85+
86+
```json
87+
"wifi-tx": {
88+
"help": "TX pin for serial connection to external device",
89+
"value": "PA_11"
90+
},
91+
"wifi-rx": {
92+
"help": "RX pin for serial connection to external device",
93+
"value": "PA_12"
94+
}
95+
```
4696

47-
- An Ethernet cable.
48-
- An Ethernet connection to the internet.
4997

5098
### Mesh
5199

@@ -128,7 +176,7 @@ For sub-GHz shields ([Spirit1](https://github.com/ARMmbed/stm-spirit1-rf-driver)
128176

129177
For more information about the radio shields, see [the related documentation](docs/radio_module_identify.md).
130178

131-
=======
179+
132180
#### Supported combinations of board and shields
133181

134182
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.
@@ -149,68 +197,6 @@ With Thread, you can change the operating mode of the client from the default ro
149197
"mbed-mesh-api.thread-device-type": "MESH_DEVICE_TYPE_THREAD_SLEEPY_END_DEVICE"
150198
```
151199

152-
## WiFi
153-
154-
#### Supported boards
155-
156-
* UBLOX_EVK_ODIN_W2 with built-in WiFi. Please read [instructions for compilation](#compile-configuration-for-odin-and-realtek-wifi).
157-
* K64F + GROVE SEEED shield using [ESP8266](https://en.wikipedia.org/wiki/ESP8266) WiFi module.
158-
* NUCLEO_F429ZI + GROVE SEEED shield using [ESP8266](https://en.wikipedia.org/wiki/ESP8266) WiFi module.
159-
* REALTEK RTL8195AM with built-in WiFi. Please read [instructions for compilation](#compile-configuration-for-odin-and-realtek-wifi).
160-
161-
To run this application using ESP8266 WiFi Interface, you need:
162-
163-
1. An [ESP8266](https://en.wikipedia.org/wiki/ESP8266) WiFi module.
164-
1. Updated [Espressif Firmware](https://developer.mbed.org/teams/ESP8266/wiki/Firmware-Update).
165-
1. Mount the WiFi module onto [K64F Grove Shield v2](https://developer.mbed.org/platforms/FRDM-K64F/#supported-seeed-studio-grove-extension).
166-
1. Attach the shield on your board.
167-
1. In the `mbed_app.json` file, change `network-interface` parameter to match your WiFi, for example for ESP8266:
168-
169-
```json
170-
"network-interface": {
171-
"help": "options are ETHERNET, WIFI_ESP8266, WIFI_ODIN, WIFI_REALTEK, MESH_LOWPAN_ND,MESH_THREAD.",
172-
"value": "WIFI_ESP8266"
173-
}
174-
```
175-
You can use values `WIFI_ODIN` for ODIN UBLOX EVK W2 and `WIFI_REALTEK` for Realtek RTL8195AM.
176-
177-
Provide your WiFi SSID and password here and leave `\"` in the beginning and end of your SSID and password (as shown in the example below). Otherwise, the example cannot pick up the SSID and password in correct format.
178-
179-
```json
180-
"wifi-ssid": {
181-
"help": "WiFi SSID",
182-
"value": "\"SSID\""
183-
},
184-
"wifi-password": {
185-
"help": "WiFi Password",
186-
"value": "\"Password\""
187-
}
188-
```
189-
190-
<span class="notes">**Note:** Some devices do not support the Grove Shield or use the primary UART for USB communication. On such devices, modify the `mbed_app.json` to use the serial pins connected to the ESP8266.</span>
191-
192-
For example, NUCLEO_F401RE requires a different serial connection:
193-
194-
```json
195-
"wifi-tx": {
196-
"help": "TX pin for serial connection to external device",
197-
"value": "PA_11"
198-
},
199-
"wifi-rx": {
200-
"help": "RX pin for serial connection to external device",
201-
"value": "PA_12"
202-
}
203-
```
204-
205-
#### Compile configuration for ODIN and Realtek WiFi
206-
207-
To compile ODIN and Realtek 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.
208-
209-
This should resolve the issue:
210-
211-
```bash
212-
cp configs/eth-wifi-mbedignore ./.mbedignore
213-
```
214200

215201

216202
### Non listed board support
@@ -295,17 +281,7 @@ To build the example using mbed CLI:
295281
```
296282
mbed compile -m K64F -t GCC_ARM -c --app-config configs/6lowpan_Atmel_RF.json
297283
```
298-
299-
If you are using either of the following configurations remember to copy .mbedignore as well:
300-
301-
```
302-
configs/eth_*
303-
configs/wifi_*
304-
```
305-
306-
```
307-
cp configs/eth-wifi-mbedignore ./.mbedignore
308-
```
284+
309285
310286
mbed CLI builds a binary file under the project’s `BUILD/` directory.
311287
@@ -391,9 +367,5 @@ To learn how to get notifications when resource 1 changes, or how to use resourc
391367
392368
## Known issues
393369
394-
### mbed OS 5.4
395370
396-
* [UBLOX_EVK_ODIN_W2]: This example is not compiling with IAR. See [#194](https://github.com/ARMmbed/mbed-os-example-client/issues/194)
397-
* [NUCLEO_F429ZI]: This example is not compiling with IAR. See [#194](https://github.com/ARMmbed/mbed-os-example-client/issues/194)
398371
399-
Fix for those issues coming via; [mbed-os PR 3920] (https://github.com/ARMmbed/mbed-os/pull/3920)

‎security.h

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
1-
/*
2-
* Copyright (c) 2015 ARM Limited. All rights reserved.
3-
* SPDX-License-Identifier: Apache-2.0
4-
* Licensed under the Apache License, Version 2.0 (the License); you may
5-
* not use this file except in compliance with the License.
6-
* You may obtain a copy of the License at
7-
*
8-
* http://www.apache.org/licenses/LICENSE-2.0
9-
*
10-
* Unless required by applicable law or agreed to in writing, software
11-
* distributed under the License is distributed on an AS IS BASIS, WITHOUT
12-
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13-
* See the License for the specific language governing permissions and
14-
* limitations under the License.
15-
*/
16-
#ifndef __SECURITY_H__
17-
#define __SECURITY_H__
18-
19-
#include <inttypes.h>
20-
21-
#define MBED_DOMAIN "DOMAIN"
22-
#define MBED_ENDPOINT_NAME "ENDPOINT_NAME"
23-
24-
const uint8_t SERVER_CERT[] = "-----BEGIN CERTIFICATE-----\r\n"
25-
"-----END CERTIFICATE-----\r\n";
26-
27-
const uint8_t CERT[] = "-----BEGIN CERTIFICATE-----\r\n"
28-
"-----END CERTIFICATE-----\r\n";
29-
30-
const uint8_t KEY[] = "-----BEGIN PRIVATE KEY-----\r\n"
31-
"-----END PRIVATE KEY-----\r\n";
32-
33-
#endif //__SECURITY_H__
34-
35-
#error "You need to get security.h credentials from connector.mbed.com and replace the content of this security.h file"
1+
/*
2+
* Copyright (c) 2015 ARM Limited. All rights reserved.
3+
* SPDX-License-Identifier: Apache-2.0
4+
* Licensed under the Apache License, Version 2.0 (the License); you may
5+
* not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an AS IS BASIS, WITHOUT
12+
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
#ifndef __SECURITY_H__
17+
#define __SECURITY_H__
18+
19+
#include <inttypes.h>
20+
21+
#define MBED_DOMAIN "DOMAIN"
22+
#define MBED_ENDPOINT_NAME "ENDPOINT_NAME"
23+
24+
const uint8_t SERVER_CERT[] = "-----BEGIN CERTIFICATE-----\r\n"
25+
"-----END CERTIFICATE-----\r\n";
26+
27+
const uint8_t CERT[] = "-----BEGIN CERTIFICATE-----\r\n"
28+
"-----END CERTIFICATE-----\r\n";
29+
30+
const uint8_t KEY[] = "-----BEGIN PRIVATE KEY-----\r\n"
31+
"-----END PRIVATE KEY-----\r\n";
32+
33+
#endif //__SECURITY_H__
34+
35+
#error "You need to get security.h credentials from connector.mbed.com and replace the content of this security.h file"

0 commit comments

Comments
 (0)