Skip to content

Commit b9815d7

Browse files
Mel WVeijo Pesonen
authored andcommitted
Editorial changes to driver readme
1 parent e805161 commit b9815d7

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,29 @@ ESP8266 modules come in different shapes and formats, but the most important fac
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

11-
It is advisable to update the [AT firmware](https://www.espressif.com/en/support/download/at?keys=) at least to version
12-
1.7.0.0
11+
We advise updating the [AT firmware](https://www.espressif.com/en/support/download/at?keys=) to at least version
12+
1.7.0.0.
1313

14-
v1.6 driver supports AT firmware up to version 1.6.2. Mbed OS 5.10 supports AT firmwares up to version 1.6.2. v1.7
15-
driver found from Mbed OS 5.11 allows usage of AT firmware version 1.7.0.0.
14+
The `v1.6` driver supports AT firmware up to version 1.6.2. Mbed OS 5.10 supports AT firmware up to version 1.6.2. The `v1.7`
15+
driver found from Mbed OS 5.11 allows you to use AT firmware version 1.7.0.0.
1616

17-
**NOTE** Here we are talking about AT firmware version - not SDK version. SDK firmware without AT is no use.
17+
**NOTE** This refers to AT firmware version, not SDK version.
1818

19-
**NOTE** AT firmware version numbers and driver version numbers do not match to each other. E.g., driver version v1.7
20-
does imply that it will support AT FW version 1.7.0.0
19+
**NOTE** AT firmware version numbers and driver version numbers do not necessarily correspond: driver version `v1.7`
20+
does not imply AT FW version 1.7.0.0 support.
2121

2222
## Restrictions
2323

24-
- The ESP8266 WiFi module does not allow the TCP client to bind on a specific port.
24+
- The ESP8266 Wi-Fi module does not allow the TCP client to bind on a specific port.
2525
- Setting up a UDP server is not possible.
26-
- The serial port does not have hardware flow control enabled by default. The AT command set does not either have a way
27-
to limit the download rate. Therefore, downloading anything larger than the serial port input buffer is unreliable -
28-
unless [AT firmware](https://www.espressif.com/en/support/download/at?keys=) version 1.7.0 or later is used. With older
29-
firmware an application should be able to read fast enough to stay ahead of the network. This affects mostly the TCP
30-
protocol where data would be lost with no notification. On UDP - with all firmware versions - this would lead to only
31-
packet losses which the higher layer protocol should recover from.
26+
- 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
27+
unless you use [AT firmware](https://www.espressif.com/en/support/download/at?keys=) version 1.7.0 or later. With older
28+
firmware, an application should be able to read fast enough to stay ahead of the network. This applies mostly to TCP
29+
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.
3230

3331
## Mandatory configuration
34-
![mbed_lib.json](mbed_lib.json) configuration assumes Arduino form factor. Please adjust according to which board is in
35-
use. Parameters are overridable from your app config file.
32+
33+
![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.
3634

3735
Least one is expected to check are the following configuration parameters
3836

0 commit comments

Comments
 (0)