@@ -10,4 +10,25 @@ There are multitude of modules and boards from different sources which carry
1010ESP8266 chip. MicroPython tries to provide a generic port which would run on
1111as many boards/modules as possible, but there may be limitations. Adafruit
1212Feather HUZZAH board is taken as a reference board for the port (for example,
13- testing is performed on it).
13+ testing is performed on it). If you have another board, please make sure you
14+ have datasheet, schematics and other reference materials for your board
15+ handy to look up various aspects of your board functioning.
16+
17+ To make a generic ESP8266 port and support as many boards as possible,
18+ following design and implementation decision were made:
19+
20+ * GPIO pin numbering is based on ESP8266 chip numbering, not some "logical"
21+ numbering of a particular board. Please have manual/pin diagram of your board
22+ handy to find correspondce between your board pins and actual ESP8266 pins.
23+ We also encourage users of various boards to share this mapping via MicroPython
24+ forum, with the idea to collect community-maintained reference materials
25+ eventually.
26+
27+ * All pins which make sense to support, are supported by MicroPython
28+ (for example, we don't expose pins which are used to connect SPI flash
29+ are not exposed, as they're unlikely useful for anything else, and
30+ operating on them will lead to board lock-up). However, any particular
31+ board may expose only subset of pins. Consult your board reference manual.
32+
33+ * Some boards may lack external pins/internal connectivity to support
34+ ESP8266 deepsleep mode.
0 commit comments