Skip to content

Commit 18f1f88

Browse files
author
Seppo Takalo
authored
Merge pull request #72 from ARMmbed/peknis01-patch-1
Tidying up the doc a bit.
2 parents 19d95f5 + 5ec29f9 commit 18f1f88

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1-
# The ESP8266 WiFi driver for mbed-os
2-
The mbed OS driver for the ESP8266 WiFi module
1+
# ESP8266 WiFi driver for Mbed OS
2+
3+
The Mbed OS driver for the ESP8266 WiFi module.
34

45
## Firmware version
5-
ESP8266 modules come in different shapes and forms, but most important difference is which firmware version it is programmed with. To make sure that your module has mbed-os compatible firmware follow update guide: https://developer.mbed.org/teams/ESP8266/wiki/Firmware-Update
6+
7+
ESP8266 modules come in different shapes and formats, but the most important factor is the firmware version in it. To make sure that the firmware in your module is compatible with Mbed OS, follow the [Update guide](https://developer.mbed.org/teams/ESP8266/wiki/Firmware-Update).
68

79
## Restrictions
8-
- The ESP8266 WiFi module does not allow TCP client to bind on a specific port
9-
- Setting up an UDP server is not possible
10-
- Serial port does not have hardware flow control enabled. Also AT-command set does not have any way to limit download rate. Therefore downloading anything larger that serial port input buffer is unreliable. Application should be able to read fast enough to stay ahead of the network. This affects mostly the TCP protocol where data would be lost with no notification. On UDP this would lead to only packet losses which the higher layer protocol should recover from.
10+
11+
- The ESP8266 WiFi module does not allow the TCP client to bind on a specific port.
12+
- Setting up a UDP server is not possible.
13+
- The serial port does not have hardware flow control enabled. The AT command set does not either have a way to limit the download rate. Therefore, downloading anything larger than the serial port input buffer is unreliable. An application should be able to read fast enough to stay ahead of the network. This affects mostly the TCP protocol where data would be lost with no notification. On UDP, this would lead to only packet losses which the higher layer protocol should recover from.

0 commit comments

Comments
 (0)