nk25719 / KiCad-esp32-6leds-2switches-1pj-circuit

In this repo I am practicing KICAD. Created an ESP32 DevKit V1 module and a PCB footprint. I designed a circuit around this ESP32 consisting of six lamps, four switches, and two power jacks and added a voltage regulater to Vin to maintain a supply of +5V. (This project was originally made of two switches and 1 power jack and was named homeWork2.)
0 stars 1 forks source link

Inconsistant Naming, Wrong Naming of Button Pins Firmware versus Schematic Version 1 PCB #45

Open ForrestErickson opened 1 week ago

ForrestErickson commented 1 week ago

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] The name of GPIO pins on the schematic and PCB should match the naming in firmware. Names should reflect function.

However for example S1 is called "S1-morseCodeDanger1" on the schematic and PCB and connected to GPIO36 image image

But in the firmware is const int MUTE_BUTTON_PIN = 36; // GPIO 36 for the mute button

These names are inconsistent. In all firmware other pins and pin names should be reviewed and corrected where errors are found.

Describe the solution you'd like A clear and concise description of what you want to happen.

Change in all firmware to reflect the actual name on the schematic and PCB (and / or possibly Krake)

ForrestErickson commented 1 week ago

Note the exact text on the schematic for the switches has a "-" which is not a character that can be used in a variable name. Example: S1-morseCodeDanger1 So change to S1_morseCodeDanger1

Lesson Learned

In future use only upper case letters and numbers and underscore for net names which will be referenced in firmware.

nk25719 commented 1 week ago

During the process of transferring the PMD into a Krake, the switches and the LED were renamed.

PMD inherrited MUTE_BUTTON_PIN = 36; // GPIO 36 for the mute button from Krake