Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 20, 2024

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented May 17, 2024

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

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.

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 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.
@per1234 per1234 added enhancement New feature or request arduino Bugs and fixes added by the Arduino Team maker labels May 17, 2024
@per1234 per1234 requested a review from karlsoderby May 17, 2024 00:19
Copy link
Contributor

@pillo79 pillo79 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Per, had no idea we had this "default" sketch code with such hardcoded numbers, after all our efforts to use pin labels etc. with the Nano. Please apply ASAP!

@jcarolinares
Copy link
Contributor

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 :)

@jcarolinares jcarolinares requested a review from jacobhylen May 20, 2024 07:59
Copy link
Contributor

@jacobhylen jacobhylen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks everyone ☀️

@jacobhylen jacobhylen merged commit 3e70f5f into arduino:main May 20, 2024
3 checks passed
@per1234 per1234 deleted the nano-esp32-default-sketch branch May 20, 2024 10:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
arduino Bugs and fixes added by the Arduino Team enhancement New feature or request maker
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants