Skip to content

Commit 7672f91

Browse files
authored
chore: Explain pin #defines (#51)
1 parent 52648a1 commit 7672f91

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

src/Notecard.h

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,22 @@
3838

3939
#ifdef ARDUINO_ARCH_ESP32
4040

41+
/*
42+
* \brief Adafruit Feather-Specific Definitions
43+
*
44+
* The Adafruit feather specification defines standard pinout names for digital
45+
* and analog pins. Unfortunately, the Adafruit Huzzah32 does not comply with
46+
* this specification. As such, we provide mappings for the pins that are
47+
* technically incorrect but which make it easier to write code that works
48+
* across different feathers.
49+
*
50+
* On the ESP32 for instance, the pinout for Digital Pin 14 is located where
51+
* D5 is usually located, so our symbol maps D5 to Digital Pin 14 on that
52+
* board, etc...
53+
*
54+
* \see https://learn.adafruit.com/adafruit-feather/feather-specification
55+
*/
56+
4157
#ifdef B0
4258
#undef B0
4359
#endif

0 commit comments

Comments
 (0)