Task/283 use classes to reduce extern and globals by nk25719 · Pull Request #598 · PubInv/krake

nk25719 · 2026-08-01T15:50:18Z

Objective of this PR: examine changes done in branch.

- Necessary libraries have been added and are tracked in the 'platform.ini' file

- Moved WiFiManager and ElegantOTA libraries to the bottom of the list - Clean builds failed during first compilation due to libraries depending on other libraries not build yet

- The baud rate with PlatformIO defaults to 9800 - The correct baud rate for the serial connection with the ESP32-WROOM is 115200

- The defines in `gpad_utility.h` are still defined in the file for completeness - The values are empty since the values are now fed in via a pre-build script - The benefit of this is that to change the values of the defines does not require modifying a source file - The values, like the firmware version and product name, can now be provided programmatically - Like pulling a version from git tag - A static config file with the values

…ries

- Changes include linking to instructions for installing the PIO CLI tools and setting up the shell commands - Instructions for building the LittleFS filesystem

- The project can now be openned in the Arduino IDE by opening the GPAD_API.ino file

- PlatformIO recommends listing a specific version for packages (and platforms) and preceding the '@' with a '^' (caret) so the latest compatible version will be used - The "tip" is in a blue box under this section: https://docs.platformio.org/en/latest/core/userguide/pkg/cmd_install.html#id17

- Added a char enum which maps the chars used to indicate the commands to actual enum variants - The main switch statement in GPAD_HAL.cpp now switches over the Command enum instead of the hardcoded chars

- GPAD_API_VERSION is now defined as a preprocessor directive, like FIRMWARE_VERSION - The value is published via MQTT just like the FIRMWARE_VERSION

…ment - The GPAD API version is now hardcoded as an actual value - It is not something that should be able to be changed by a compilation flag

nk25719 · 2026-08-01T15:50:18Z

Objective of this PR: examine changes done in branch.

- Necessary libraries have been added and are tracked in the 'platform.ini' file

- Moved WiFiManager and ElegantOTA libraries to the bottom of the list - Clean builds failed during first compilation due to libraries depending on other libraries not build yet

- The baud rate with PlatformIO defaults to 9800 - The correct baud rate for the serial connection with the ESP32-WROOM is 115200

- The defines in `gpad_utility.h` are still defined in the file for completeness - The values are empty since the values are now fed in via a pre-build script - The benefit of this is that to change the values of the defines does not require modifying a source file - The values, like the firmware version and product name, can now be provided programmatically - Like pulling a version from git tag - A static config file with the values

…ries

- Changes include linking to instructions for installing the PIO CLI tools and setting up the shell commands - Instructions for building the LittleFS filesystem

- The project can now be openned in the Arduino IDE by opening the GPAD_API.ino file

- PlatformIO recommends listing a specific version for packages (and platforms) and preceding the '@' with a '^' (caret) so the latest compatible version will be used - The "tip" is in a blue box under this section: https://docs.platformio.org/en/latest/core/userguide/pkg/cmd_install.html#id17

- Added a char enum which maps the chars used to indicate the commands to actual enum variants - The main switch statement in GPAD_HAL.cpp now switches over the Command enum instead of the hardcoded chars

- GPAD_API_VERSION is now defined as a preprocessor directive, like FIRMWARE_VERSION - The value is published via MQTT just like the FIRMWARE_VERSION

…ment - The GPAD API version is now hardcoded as an actual value - It is not something that should be able to be changed by a compilation flag

nk25719 · 2026-08-01T15:50:18Z

Objective of this PR: examine changes done in branch.

- Necessary libraries have been added and are tracked in the 'platform.ini' file

- Moved WiFiManager and ElegantOTA libraries to the bottom of the list - Clean builds failed during first compilation due to libraries depending on other libraries not build yet

- The baud rate with PlatformIO defaults to 9800 - The correct baud rate for the serial connection with the ESP32-WROOM is 115200

- The defines in `gpad_utility.h` are still defined in the file for completeness - The values are empty since the values are now fed in via a pre-build script - The benefit of this is that to change the values of the defines does not require modifying a source file - The values, like the firmware version and product name, can now be provided programmatically - Like pulling a version from git tag - A static config file with the values

…ries

- Changes include linking to instructions for installing the PIO CLI tools and setting up the shell commands - Instructions for building the LittleFS filesystem

- The project can now be openned in the Arduino IDE by opening the GPAD_API.ino file

- PlatformIO recommends listing a specific version for packages (and platforms) and preceding the '@' with a '^' (caret) so the latest compatible version will be used - The "tip" is in a blue box under this section: https://docs.platformio.org/en/latest/core/userguide/pkg/cmd_install.html#id17

- Added a char enum which maps the chars used to indicate the commands to actual enum variants - The main switch statement in GPAD_HAL.cpp now switches over the Command enum instead of the hardcoded chars

- GPAD_API_VERSION is now defined as a preprocessor directive, like FIRMWARE_VERSION - The value is published via MQTT just like the FIRMWARE_VERSION

…ment - The GPAD API version is now hardcoded as an actual value - It is not something that should be able to be changed by a compilation flag

nk25719 · 2026-08-01T15:50:18Z

Objective of this PR: examine changes done in branch.

- Necessary libraries have been added and are tracked in the 'platform.ini' file

- Moved WiFiManager and ElegantOTA libraries to the bottom of the list - Clean builds failed during first compilation due to libraries depending on other libraries not build yet

- The baud rate with PlatformIO defaults to 9800 - The correct baud rate for the serial connection with the ESP32-WROOM is 115200

- The defines in `gpad_utility.h` are still defined in the file for completeness - The values are empty since the values are now fed in via a pre-build script - The benefit of this is that to change the values of the defines does not require modifying a source file - The values, like the firmware version and product name, can now be provided programmatically - Like pulling a version from git tag - A static config file with the values

…ries

- Changes include linking to instructions for installing the PIO CLI tools and setting up the shell commands - Instructions for building the LittleFS filesystem

- The project can now be openned in the Arduino IDE by opening the GPAD_API.ino file

- PlatformIO recommends listing a specific version for packages (and platforms) and preceding the '@' with a '^' (caret) so the latest compatible version will be used - The "tip" is in a blue box under this section: https://docs.platformio.org/en/latest/core/userguide/pkg/cmd_install.html#id17

- Added a char enum which maps the chars used to indicate the commands to actual enum variants - The main switch statement in GPAD_HAL.cpp now switches over the Command enum instead of the hardcoded chars

- GPAD_API_VERSION is now defined as a preprocessor directive, like FIRMWARE_VERSION - The value is published via MQTT just like the FIRMWARE_VERSION

…ment - The GPAD API version is now hardcoded as an actual value - It is not something that should be able to be changed by a compilation flag

nk25719 · 2026-08-01T15:50:18Z

Objective of this PR: examine changes done in branch.

- Necessary libraries have been added and are tracked in the 'platform.ini' file

- Moved WiFiManager and ElegantOTA libraries to the bottom of the list - Clean builds failed during first compilation due to libraries depending on other libraries not build yet

- The baud rate with PlatformIO defaults to 9800 - The correct baud rate for the serial connection with the ESP32-WROOM is 115200

- The defines in `gpad_utility.h` are still defined in the file for completeness - The values are empty since the values are now fed in via a pre-build script - The benefit of this is that to change the values of the defines does not require modifying a source file - The values, like the firmware version and product name, can now be provided programmatically - Like pulling a version from git tag - A static config file with the values

…ries

- Changes include linking to instructions for installing the PIO CLI tools and setting up the shell commands - Instructions for building the LittleFS filesystem

- The project can now be openned in the Arduino IDE by opening the GPAD_API.ino file

- PlatformIO recommends listing a specific version for packages (and platforms) and preceding the '@' with a '^' (caret) so the latest compatible version will be used - The "tip" is in a blue box under this section: https://docs.platformio.org/en/latest/core/userguide/pkg/cmd_install.html#id17

- Added a char enum which maps the chars used to indicate the commands to actual enum variants - The main switch statement in GPAD_HAL.cpp now switches over the Command enum instead of the hardcoded chars

- GPAD_API_VERSION is now defined as a preprocessor directive, like FIRMWARE_VERSION - The value is published via MQTT just like the FIRMWARE_VERSION

…ment - The GPAD API version is now hardcoded as an actual value - It is not something that should be able to be changed by a compilation flag

nk25719 · 2026-08-01T15:50:18Z

Objective of this PR: examine changes done in branch.

- Necessary libraries have been added and are tracked in the 'platform.ini' file

- Moved WiFiManager and ElegantOTA libraries to the bottom of the list - Clean builds failed during first compilation due to libraries depending on other libraries not build yet

- The baud rate with PlatformIO defaults to 9800 - The correct baud rate for the serial connection with the ESP32-WROOM is 115200

- The defines in `gpad_utility.h` are still defined in the file for completeness - The values are empty since the values are now fed in via a pre-build script - The benefit of this is that to change the values of the defines does not require modifying a source file - The values, like the firmware version and product name, can now be provided programmatically - Like pulling a version from git tag - A static config file with the values

…ries

- Changes include linking to instructions for installing the PIO CLI tools and setting up the shell commands - Instructions for building the LittleFS filesystem

- The project can now be openned in the Arduino IDE by opening the GPAD_API.ino file

- PlatformIO recommends listing a specific version for packages (and platforms) and preceding the '@' with a '^' (caret) so the latest compatible version will be used - The "tip" is in a blue box under this section: https://docs.platformio.org/en/latest/core/userguide/pkg/cmd_install.html#id17

- Added a char enum which maps the chars used to indicate the commands to actual enum variants - The main switch statement in GPAD_HAL.cpp now switches over the Command enum instead of the hardcoded chars

- GPAD_API_VERSION is now defined as a preprocessor directive, like FIRMWARE_VERSION - The value is published via MQTT just like the FIRMWARE_VERSION

…ment - The GPAD API version is now hardcoded as an actual value - It is not something that should be able to be changed by a compilation flag

nk25719 · 2026-08-01T15:50:18Z

Objective of this PR: examine changes done in branch.

- Necessary libraries have been added and are tracked in the 'platform.ini' file

- Moved WiFiManager and ElegantOTA libraries to the bottom of the list - Clean builds failed during first compilation due to libraries depending on other libraries not build yet

- The baud rate with PlatformIO defaults to 9800 - The correct baud rate for the serial connection with the ESP32-WROOM is 115200

- The defines in `gpad_utility.h` are still defined in the file for completeness - The values are empty since the values are now fed in via a pre-build script - The benefit of this is that to change the values of the defines does not require modifying a source file - The values, like the firmware version and product name, can now be provided programmatically - Like pulling a version from git tag - A static config file with the values

…ries

- Changes include linking to instructions for installing the PIO CLI tools and setting up the shell commands - Instructions for building the LittleFS filesystem

- The project can now be openned in the Arduino IDE by opening the GPAD_API.ino file

- PlatformIO recommends listing a specific version for packages (and platforms) and preceding the '@' with a '^' (caret) so the latest compatible version will be used - The "tip" is in a blue box under this section: https://docs.platformio.org/en/latest/core/userguide/pkg/cmd_install.html#id17

- Added a char enum which maps the chars used to indicate the commands to actual enum variants - The main switch statement in GPAD_HAL.cpp now switches over the Command enum instead of the hardcoded chars

- GPAD_API_VERSION is now defined as a preprocessor directive, like FIRMWARE_VERSION - The value is published via MQTT just like the FIRMWARE_VERSION

…ment - The GPAD API version is now hardcoded as an actual value - It is not something that should be able to be changed by a compilation flag

nk25719 · 2026-08-01T15:50:18Z

Objective of this PR: examine changes done in branch.

- Necessary libraries have been added and are tracked in the 'platform.ini' file

- Moved WiFiManager and ElegantOTA libraries to the bottom of the list - Clean builds failed during first compilation due to libraries depending on other libraries not build yet

- The baud rate with PlatformIO defaults to 9800 - The correct baud rate for the serial connection with the ESP32-WROOM is 115200

- The defines in `gpad_utility.h` are still defined in the file for completeness - The values are empty since the values are now fed in via a pre-build script - The benefit of this is that to change the values of the defines does not require modifying a source file - The values, like the firmware version and product name, can now be provided programmatically - Like pulling a version from git tag - A static config file with the values

…ries

- Changes include linking to instructions for installing the PIO CLI tools and setting up the shell commands - Instructions for building the LittleFS filesystem

- The project can now be openned in the Arduino IDE by opening the GPAD_API.ino file

- PlatformIO recommends listing a specific version for packages (and platforms) and preceding the '@' with a '^' (caret) so the latest compatible version will be used - The "tip" is in a blue box under this section: https://docs.platformio.org/en/latest/core/userguide/pkg/cmd_install.html#id17

- Added a char enum which maps the chars used to indicate the commands to actual enum variants - The main switch statement in GPAD_HAL.cpp now switches over the Command enum instead of the hardcoded chars

- GPAD_API_VERSION is now defined as a preprocessor directive, like FIRMWARE_VERSION - The value is published via MQTT just like the FIRMWARE_VERSION

…ment - The GPAD API version is now hardcoded as an actual value - It is not something that should be able to be changed by a compilation flag

TheBakedPotatoand others added 21 commits December 7, 2025 20:02

273: Initial work to migrate GPAD_API to PlatformIO
ba6c0ed
- Necessary libraries have been added and are tracked in the 'platform.ini' file

#273: Adding README for build/install instructions
424d586

#273: Reorder dependencies in platformio.ini
6afcfd2
- Moved WiFiManager and ElegantOTA libraries to the bottom of the list - Clean builds failed during first compilation due to libraries depending on other libraries not build yet

#273: Setting correct baud rate
80c06fa
- The baud rate with PlatformIO defaults to 9800 - The correct baud rate for the serial connection with the ESP32-WROOM is 115200

rob improves documentation and adds a makefile
9e4291a

restoring firmware version, and removing the refrence to Arduino Liba…
4b759bb
…ries

Update README.md
6dcc419

Update README.md
86c78b9

Bump version to 46 and back-out my changes to gpad_utility.h
e474209

(#273): Corrected data directory for LittleFS content
750d858

(#273): Auto formatting/styling
830df77

(#273): Updating the README
e42b83b
- Changes include linking to instructions for installing the PIO CLI tools and setting up the shell commands - Instructions for building the LittleFS filesystem

(#273): Changedsrcdir toGPAD_APIdir
e806715
- The project can now be openned in the Arduino IDE by opening the GPAD_API.ino file

(#273): Froze all package versions, included platform version 6.12.0
3fb66a2

Feature:#206- AddedCommandenum
ca8c407
- Added a char enum which maps the chars used to indicate the commands to actual enum variants - The main switch statement in GPAD_HAL.cpp now switches over the Command enum instead of the hardcoded chars

Feature:#206- Defined GPAD_API_VERSION value and publish value
0b3f144
- GPAD_API_VERSION is now defined as a preprocessor directive, like FIRMWARE_VERSION - The value is published via MQTT just like the FIRMWARE_VERSION

(#206): API Version is stored in class, no longer a compile time argu…
38a7da9
…ment - The GPAD API version is now hardcoded as an actual value - It is not something that should be able to be changed by a compilation flag

(#206): API version is now printed out, leveraged const for methods
7084f89

(#283): Moving functionality from GPAD_HAL into the GPAD_API class
a020d88