summaryrefslogtreecommitdiffstatshomepage
path: root/docs/esp8266/quickref.rst
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-04-05 16:29:52 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-04-05 16:30:51 +0300
commite4cb7c61582e0908f5c461b297f0387aa9c33785 (patch)
tree5bbd944a23b3cbcb5c2af4148b24e6f9563accc5 /docs/esp8266/quickref.rst
parent2c8356c482b2bb4eaf7248297b3b68e4a376a90b (diff)
downloadmicropython-e4cb7c61582e0908f5c461b297f0387aa9c33785.tar.gz
micropython-e4cb7c61582e0908f5c461b297f0387aa9c33785.zip
docs/esp8266/quickref: Add note about physical vs logical pin numbers.
Diffstat (limited to 'docs/esp8266/quickref.rst')
-rw-r--r--docs/esp8266/quickref.rst8
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/esp8266/quickref.rst b/docs/esp8266/quickref.rst
index 3cecb83998..febad37366 100644
--- a/docs/esp8266/quickref.rst
+++ b/docs/esp8266/quickref.rst
@@ -111,7 +111,13 @@ Use the ``machine.Pin`` class::
p4 = Pin(4, Pin.IN, Pin.PULL_UP) # enable internal pull-up resistor
p5 = Pin(5, Pin.OUT, value=1) # set pin high on creation
-Available pins are: 0, 1, 2, 3, 4, 5, 12, 13, 14, 15, 16.
+Available pins are: 0, 1, 2, 3, 4, 5, 12, 13, 14, 15, 16, which correspond
+to the actual GPIO pin numbers of ESP8266 chip. Note that many end-user
+boards use their own adhoc pin numbering (marked e.g. D0, D1, ...). As
+MicroPython supports different boards and modules, physical pin numbering
+was chosen as the lowest common denominator. For mapping between board
+logical pins and physical chip pins, consult your board documentation.
+
Note that Pin(1) and Pin(3) are REPL UART TX and RX respectively.
Also note that Pin(16) is a special pin (used for wakeup from deepsleep
mode) and may be not available for use with higher-level classes like