Skip to content

Commit e4cb7c6

Browse files
committed
docs/esp8266/quickref: Add note about physical vs logical pin numbers.
1 parent 2c8356c commit e4cb7c6

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/esp8266/quickref.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,13 @@ Use the ``machine.Pin`` class::
111111
p4 = Pin(4, Pin.IN, Pin.PULL_UP) # enable internal pull-up resistor
112112
p5 = Pin(5, Pin.OUT, value=1) # set pin high on creation
113113

114-
Available pins are: 0, 1, 2, 3, 4, 5, 12, 13, 14, 15, 16.
114+
Available pins are: 0, 1, 2, 3, 4, 5, 12, 13, 14, 15, 16, which correspond
115+
to the actual GPIO pin numbers of ESP8266 chip. Note that many end-user
116+
boards use their own adhoc pin numbering (marked e.g. D0, D1, ...). As
117+
MicroPython supports different boards and modules, physical pin numbering
118+
was chosen as the lowest common denominator. For mapping between board
119+
logical pins and physical chip pins, consult your board documentation.
120+
115121
Note that Pin(1) and Pin(3) are REPL UART TX and RX respectively.
116122
Also note that Pin(16) is a special pin (used for wakeup from deepsleep
117123
mode) and may be not available for use with higher-level classes like

0 commit comments

Comments
 (0)