Skip to content

Commit 0100234

Browse files
Mel WVeijo Pesonen
Mel W
authored and
Veijo Pesonen
committed
Editorial changes, streamlining sentences
1 parent d1b768c commit 0100234

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The Mbed OS driver for the ESP8266 WiFi module.
44

55
## Firmware version
66

7-
ESP8266 modules come in different shapes and formats, but the most important factor is the firmware version in it. To
7+
ESP8266 modules come in different shapes and formats, but the firmware version is the most important factor. To
88
make sure that the firmware in your module is compatible with Mbed OS, follow the
99
[Update guide](https://developer.mbed.org/teams/ESP8266/wiki/Firmware-Update).
1010

@@ -13,18 +13,18 @@ This driver supports AT firmware versions 1.3.0 to 1.7.0. We advise updating the
1313

1414
## Restrictions
1515

16-
- The ESP8266 Wi-Fi module does not allow the TCP client to bind on a specific port.
16+
- The ESP8266 Wi-Fi module does not allow the TCP client to bind to a specific port.
1717
- Setting up a UDP server is not possible.
1818
- The serial port does not have hardware flow control enabled by default. Additionally, the AT command set does not have a method for limiting the download rate. Therefore, downloading anything larger than the serial port input buffer is unreliable
1919
unless you use [AT firmware](https://www.espressif.com/en/support/download/at?keys=) version 1.7.0 or later. With older
2020
firmware, an application should be able to read fast enough to stay ahead of the network. This applies mostly to TCP
21-
protocol, where data would be lost without notification. With all firmware versions on UDP, this would lead to packet loss that the higher-layer protocol should recover from.
21+
protocol, where data would be lost without notification. On UDP using all firmware versions, the higher-layer protocol should recover from packet loss.
2222

2323
## Mandatory configuration
2424

2525
![mbed_lib.json](mbed_lib.json) configuration assumes Arduino form factor. Please adjust according to your board. You can override parameters from your app config file.
2626

27-
Least one is expected to check are the following configuration parameters
27+
At minimum, check the following configuration parameters:
2828

2929
```javascript
3030
{
@@ -54,14 +54,12 @@ Least one is expected to check are the following configuration parameters
5454
## UART HW flow control
5555

5656
UART HW flow control requires you to additionally wire the CTS and RTS flow control pins between your board and your
57-
ESP8266 module. Once this is done remember to add configuration option for flow control in your app config file. Here a
58-
[ST NUCLEO-F429ZI](https://os.mbed.com/platforms/ST-Nucleo-F429ZI/) board and
59-
[ESPBee XBee Module](https://www.cascologix.com/product/espbee/) are used as an example.
57+
ESP8266 module. After this, remember to add the configuration option for flow control to your app configuration file. This example uses the [ST NUCLEO-F429ZI](https://os.mbed.com/platforms/ST-Nucleo-F429ZI/) board and
58+
[ESPBee XBee Module](https://www.cascologix.com/product/espbee/).
6059

61-
**NOTE** Not all modules expose ESP8266's RTS and CTS pins so beware when you are choosing one.
60+
**Note:** Not all modules expose ESP8266's RTS and CTS pins, so choose modules carefully.
6261

63-
Once you have your HW set up add configuration like this in your app config - Arduino pins D1 and D0 assumed to be used
64-
as TX and RX:
62+
Once you have your hardware set up, add a configuration like the following to your app configuration file. Arduino pins D1 and D0 are used as TX and RX:
6563

6664
``` javascript
6765
"target_overrides": {
@@ -72,23 +70,26 @@ as TX and RX:
7270
```
7371
7472
### Example board pins
73+
7574
1. TX - D1 (Arduino Uno Revision 3 connectivity headers)
7675
2. RX - D0 (Arduino Uno Revision 3 connectivity headers)
7776
3. RTS - PG_12 (STMicroelectronics Morpho extension pin headers)
7877
4. CTS - PG_15 (STMicroelectronics Morpho extension pin headers)
7978
8079
### Example ESP8266 pins
81-
1. TX - D1 (Arduino Wireless Protoshield headers)/ TX (ESPBee XBee headers)
80+
81+
1. TX - D1 (Arduino Wireless Protoshield headers)/ TX (ESPBee XBee headers)
8282
2. RX - D0 (Arduino Wireless Protoshield headers)/ RX (ESPBee XBee headers)
8383
3. RTS - RTS (ESPBee XBee headers)
8484
4. CTS - CTS (ESPBee XBee headers)
8585
8686
### Connections
87+
8788
With these pictures only consider the green and yellow wires which are connected to ESP8266. Pink wire is for reset and
8889
the rest for firmware update. TX and RX go through Arduino pins D1 and D0.
8990
90-
**NOTE** GPIO15(ESPBee RTS) needs to be pulled down during startup to boot from flash, instead of firmware update or
91-
boot from SD card. Once the software is running the same pin is used as the RTS pin.
91+
**Note:** Pull down GPIO15(ESPBee RTS) during startup to boot from flash, instead of **firmware update** or
92+
**boot from SD card**. Once the software is running, the same pin is used as the RTS pin:
9293
9394
1. Board TX - ESP8266 RX
9495
2. Board RX - ESP8266 TX

0 commit comments

Comments
 (0)