arduino / docs-content

Arduino documentation (docs.arduino.cc)
https://docs.arduino.cc/
Creative Commons Attribution Share Alike 4.0 International
140 stars 352 forks source link

Use standardized pin macros in Nano ESP32 "default" sketch #1960

Closed per1234 closed 1 month ago

per1234 commented 1 month ago

This sketch is intended to produce the LED blinking behavior the board has when shipped. Previously, bespoke pin name macros were defined in the sketch, which were problematic:

The green and blue LED pin numbers were only appropriate for the first limited run of the board that used a different RGB LED than the LED on subsequent runs of the board, which the majority of customers will have.

The pin numbers were not correct when the development tool had the "By Arduino pin (default)" pin numbering configuration.

What This PR Changes

The "Arduino ESP32 Boards" core provides pin macros for all four of the LEDs. Using these macros in the sketch sets an example of best practices programming for the reader and fixes both the problems that were present in the previous version of the sketch:

The LED_GREEN and LED_BLUE macros are the correct pin numbers for the LEDs on the majority of the Nano ESP32 boards.

These macros are configured to be correct for both pin numbering configurations.

Contribution Guidelines


Originally reported at https://forum.arduino.cc/t/confusing-pin-numbering-in-the-default-sketch/1260852

jcarolinares commented 1 month ago

Hello, thank you both

Being Karl out at this moment I'm adding @jacobhylen to make sure we properly apply the changes with content knowledge to avoid unexpected changes or problems.

Please @jacobhylen double check or merge if everything is fine by your part :)