summaryrefslogtreecommitdiffstatshomepage
path: root/docs/esp8266
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-05-02 16:00:44 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-05-02 16:00:44 +0300
commit5aa4db0505aeabd2f612eb702443e35c92fbdbde (patch)
treed5978a801815b7be0c4d0a1b63623b13786cb25e /docs/esp8266
parent74c6363b9760f62e2c0df3410b1e39b60cd1b123 (diff)
downloadmicropython-5aa4db0505aeabd2f612eb702443e35c92fbdbde.tar.gz
micropython-5aa4db0505aeabd2f612eb702443e35c92fbdbde.zip
docs/esp8266/general: Add more points to "Multitude of boards" section.
Diffstat (limited to 'docs/esp8266')
-rw-r--r--docs/esp8266/general.rst23
1 files changed, 22 insertions, 1 deletions
diff --git a/docs/esp8266/general.rst b/docs/esp8266/general.rst
index 966b8794f2..887d964b12 100644
--- a/docs/esp8266/general.rst
+++ b/docs/esp8266/general.rst
@@ -10,4 +10,25 @@ There are multitude of modules and boards from different sources which carry
ESP8266 chip. MicroPython tries to provide a generic port which would run on
as many boards/modules as possible, but there may be limitations. Adafruit
Feather HUZZAH board is taken as a reference board for the port (for example,
-testing is performed on it).
+testing is performed on it). If you have another board, please make sure you
+have datasheet, schematics and other reference materials for your board
+handy to look up various aspects of your board functioning.
+
+To make a generic ESP8266 port and support as many boards as possible,
+following design and implementation decision were made:
+
+* GPIO pin numbering is based on ESP8266 chip numbering, not some "logical"
+numbering of a particular board. Please have manual/pin diagram of your board
+handy to find correspondce between your board pins and actual ESP8266 pins.
+We also encourage users of various boards to share this mapping via MicroPython
+forum, with the idea to collect community-maintained reference materials
+eventually.
+
+* All pins which make sense to support, are supported by MicroPython
+(for example, we don't expose pins which are used to connect SPI flash
+are not exposed, as they're unlikely useful for anything else, and
+operating on them will lead to board lock-up). However, any particular
+board may expose only subset of pins. Consult your board reference manual.
+
+* Some boards may lack external pins/internal connectivity to support
+ESP8266 deepsleep mode.