From ef26d2e297f614ef3be6a9c8eb53adf38414a74d Mon Sep 17 00:00:00 2001 From: Junior Date: Wed, 19 Mar 2025 13:09:30 -0400 Subject: [PATCH] Initial commit --- .gitignore | 7 +++++ include/README | 37 ++++++++++++++++++++++++ lib/README | 46 ++++++++++++++++++++++++++++++ platformio.ini | 18 ++++++++++++ src/main.cpp | 88 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ test/README | 11 ++++++++ 6 files changed, 207 insertions(+) create mode 100644 .gitignore create mode 100644 include/README create mode 100644 lib/README create mode 100644 platformio.ini create mode 100644 src/main.cpp create mode 100644 test/README diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b57bd79 --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +.pio +.vscode +*.code-workspace + +# Vim +*.swp +*.swo diff --git a/include/README b/include/README new file mode 100644 index 0000000..49819c0 --- /dev/null +++ b/include/README @@ -0,0 +1,37 @@ + +This directory is intended for project header files. + +A header file is a file containing C declarations and macro definitions +to be shared between several project source files. You request the use of a +header file in your project source file (C, C++, etc) located in `src` folder +by including it, with the C preprocessing directive `#include'. + +```src/main.c + +#include "header.h" + +int main (void) +{ + ... +} +``` + +Including a header file produces the same results as copying the header file +into each source file that needs it. Such copying would be time-consuming +and error-prone. With a header file, the related declarations appear +in only one place. If they need to be changed, they can be changed in one +place, and programs that include the header file will automatically use the +new version when next recompiled. The header file eliminates the labor of +finding and changing all the copies as well as the risk that a failure to +find one copy will result in inconsistencies within a program. + +In C, the convention is to give header files names that end with `.h'. + +Read more about using header files in official GCC documentation: + +* Include Syntax +* Include Operation +* Once-Only Headers +* Computed Includes + +https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html diff --git a/lib/README b/lib/README new file mode 100644 index 0000000..9379397 --- /dev/null +++ b/lib/README @@ -0,0 +1,46 @@ + +This directory is intended for project specific (private) libraries. +PlatformIO will compile them to static libraries and link into the executable file. + +The source code of each library should be placed in a separate directory +("lib/your_library_name/[Code]"). + +For example, see the structure of the following example libraries `Foo` and `Bar`: + +|--lib +| | +| |--Bar +| | |--docs +| | |--examples +| | |--src +| | |- Bar.c +| | |- Bar.h +| | |- library.json (optional. for custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html +| | +| |--Foo +| | |- Foo.c +| | |- Foo.h +| | +| |- README --> THIS FILE +| +|- platformio.ini +|--src + |- main.c + +Example contents of `src/main.c` using Foo and Bar: +``` +#include +#include + +int main (void) +{ + ... +} + +``` + +The PlatformIO Library Dependency Finder will find automatically dependent +libraries by scanning project source files. + +More information about PlatformIO Library Dependency Finder +- https://docs.platformio.org/page/librarymanager/ldf.html diff --git a/platformio.ini b/platformio.ini new file mode 100644 index 0000000..15860ad --- /dev/null +++ b/platformio.ini @@ -0,0 +1,18 @@ +; PlatformIO Project Configuration File +; +; Build options: build flags, source filter +; Upload options: custom upload port, speed and extra flags +; Library options: dependencies, extra library storages +; Advanced options: extra scripting +; +; Please visit documentation for the other options and examples +; https://docs.platformio.org/page/projectconf.html + +[env:esp32doit-devkit-v1] +platform = espressif32 +board = esp32doit-devkit-v1 +framework = arduino +monitor_speed = 115200 +lib_deps = tzapu/WiFiManager@^2.0.17 +;upload_protocol = espota +;upload_port = 192.168.2.233 diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..dbceb59 --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,88 @@ +#include +#include +#include +#include +#include + +#define FIRMWARE "2.0" + +#define BUTTONPIN 23 +#define DEBOUNCEMS 15 +#define BOARD "ESP32" +#define SERVICE "LEDsActionButton" + +String toggleURL = "http://moon.basement.lan/l/actionbutton.php?state="; +String statusURL = "http://moon.basement.lan/l/boardstatus.php"; +unsigned short buttonState = HIGH, lastButtonState = HIGH; + +void sendToggleMessage(bool state) { + char webMsg[255] = ""; + strcat(webMsg, toggleURL.c_str()); + strcat(webMsg, (state) ? "true" : "false"); + HTTPClient http; + http.begin(webMsg); + http.GET(); + http.end(); +} + +void sendDeviceStatus() { + WiFiClient client; + HTTPClient http; + http.begin(client, statusURL.c_str()); + http.addHeader("Content-Type", "application/x-www-form-urlencoded"); + String httpData = "mac=" + WiFi.macAddress() + "&board=" + BOARD + "&firmware=" + FIRMWARE + "&service=" + SERVICE; + int httpResponseCode = http.POST(httpData); + http.end(); +} + +void setup() { + Serial.begin(115200); + pinMode(BUTTONPIN, INPUT_PULLUP); + Serial.println("MAC Address: " + WiFi.macAddress()); + WiFiManager wifiManager; + wifiManager.autoConnect("LEDsActionButton"); + sendDeviceStatus(); + ArduinoOTA.onStart([]() { + String type; + if ( ArduinoOTA.getCommand() == U_FLASH ) + type = "sketch"; + else // U_SPIFFS + type = "filesystem"; + Serial.println("Start OTA updating " + type); + }); + ArduinoOTA.onEnd([]() { + Serial.println("\nOTA Update Completed"); + }); + ArduinoOTA.onError([](ota_error_t error) { + Serial.printf("OTA Update Error[%u]: ", error); + if (error == OTA_AUTH_ERROR) Serial.println("Auth Failed"); + else if (error == OTA_BEGIN_ERROR) Serial.println("Begin Failed"); + else if (error == OTA_CONNECT_ERROR) Serial.println("Connect Failed"); + else if (error == OTA_RECEIVE_ERROR) Serial.println("Receive Failed"); + else if (error == OTA_END_ERROR) Serial.println("End Failed"); + }); + ArduinoOTA.begin(); +} + +unsigned long lastDebounceTime = 0; +bool toggleState = false; +bool debouncing = false; +void loop() { + unsigned short buttonCheck = digitalRead(BUTTONPIN); + if ( buttonCheck != lastButtonState ) { + debouncing = true; + lastDebounceTime = millis(); + } + if ( debouncing && (millis() >= (lastDebounceTime + DEBOUNCEMS)) ) { + debouncing = false; + if ( buttonCheck != buttonState ) { + buttonState = buttonCheck; + if ( buttonState == LOW ) { + toggleState = !toggleState; + sendToggleMessage(toggleState); + } + } + } + lastButtonState = buttonCheck; + ArduinoOTA.handle(); +} diff --git a/test/README b/test/README new file mode 100644 index 0000000..9b1e87b --- /dev/null +++ b/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PlatformIO Test Runner and project tests. + +Unit Testing is a software testing method by which individual units of +source code, sets of one or more MCU program modules together with associated +control data, usage procedures, and operating procedures, are tested to +determine whether they are fit for use. Unit testing finds problems early +in the development cycle. + +More information about PlatformIO Unit Testing: +- https://docs.platformio.org/en/latest/advanced/unit-testing/index.html