From ba3a0acbceb133ab359b905f114386fd2572a723 Mon Sep 17 00:00:00 2001 From: Fisch Date: Mon, 25 Jul 2022 12:31:08 +0200 Subject: [PATCH] working ota example --- .gitignore | 5 ++ .vscode/extensions.json | 10 +++ include/README | 39 +++++++++++ lib/README | 46 +++++++++++++ platformio.ini | 16 +++++ src/main.cpp | 145 ++++++++++++++++++++++++++++++++++++++++ test/README | 11 +++ 7 files changed, 272 insertions(+) create mode 100644 .gitignore create mode 100644 .vscode/extensions.json 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..89cc49c --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..080e70d --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,10 @@ +{ + // See http://go.microsoft.com/fwlink/?LinkId=827846 + // for the documentation about the extensions.json format + "recommendations": [ + "platformio.platformio-ide" + ], + "unwantedRecommendations": [ + "ms-vscode.cpptools-extension-pack" + ] +} diff --git a/include/README b/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/include/README @@ -0,0 +1,39 @@ + +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 usual convention is to give header files names that end with `.h'. +It is most portable to use only letters, digits, dashes, and underscores in +header file names, and at most one dot. + +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..6debab1 --- /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 executable file. + +The source code of each library should be placed in a an own separate directory +("lib/your_library_name/[here are source files]"). + +For example, see a structure of the following two libraries `Foo` and `Bar`: + +|--lib +| | +| |--Bar +| | |--docs +| | |--examples +| | |--src +| | |- Bar.c +| | |- Bar.h +| | |- library.json (optional, 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 + +and a contents of `src/main.c`: +``` +#include +#include + +int main (void) +{ + ... +} + +``` + +PlatformIO Library Dependency Finder will find automatically dependent +libraries 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..2b208bb --- /dev/null +++ b/platformio.ini @@ -0,0 +1,16 @@ +; 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:lolin32] +platform = espressif32 +board = lolin32 +framework = arduino +monitor_speed = 115200 +upload_speed = 921600 \ No newline at end of file diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..76bbe95 --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,145 @@ +#include +#include +#include + +#define OTA_WIFI_SSID "Chaos-West temp alternative" +#define OTA_WIFI_PASSWORD "" +#define OTA_WAIT_TIMEOUT 1000 // in 0.1s increments -> 10s + +void normal_loop(); +void normal_setup(); +void checkOTA(); +bool initOTA(); + +enum OTA_MODE { + NONE, + SEARCHING, + WAITING, + UPDATING +} otaMode; + +uint16_t otaWaitCounter; + +void checkOTA() { + otaMode = SEARCHING; + Serial.println("looking for OTA WiFi..."); + + // WARNING: to allow ESP-NOW work, this WiFi must be on Channel 1 + if (OTA_WIFI_PASSWORD!="") { + WiFi.begin(OTA_WIFI_SSID, OTA_WIFI_PASSWORD); //wifi with password + }else{ + WiFi.begin(OTA_WIFI_SSID); //open wifi + } + + while (WiFi.waitForConnectResult() != WL_CONNECTED) { + Serial.println("no OTA WiFi found, proceed normal boot"); + otaMode = NONE; + return; + } + + otaMode = WAITING; +} + +void normal_setup() { + Serial.println("Booting normal"); + + WiFi.disconnect(); + WiFi.mode(WIFI_STA); + WiFi.disconnect(); + Serial.printf("wifi channel: %d\n", WiFi.channel()); + +} + +void setup() { + Serial.begin(115200); + + delay(1000); + + Serial.println(); + Serial.println("Initializing..."); + + + checkOTA(); + if(!initOTA()) { //initialize ota when ota enabled + normal_setup(); + } +} + +bool initOTA() { + if (otaMode == WAITING) { + Serial.println("connected to OTA WiFi. Waiting for firmware..."); + Serial.print("IP address: "); + Serial.println(WiFi.localIP()); + + ArduinoOTA + .onStart([]() { + otaMode = UPDATING; + String type; + if (ArduinoOTA.getCommand() == U_FLASH) + type = "sketch"; + else // U_SPIFFS + type = "filesystem"; + + // NOTE: if updating SPIFFS this would be the place to unmount SPIFFS using SPIFFS.end() + Serial.println("Start updating " + type); + }) + .onEnd([]() { + Serial.println("\nEnd"); + }) + .onProgress([](unsigned int progress, unsigned int total) { + int prog = (progress / (total / 100)); + Serial.printf("Progress: %u%%\r", prog); + + }) + .onError([](ota_error_t error) { + Serial.printf("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(); + return 1; //ota ok + }else{ + return 0; //not using ota + } +} + + +void loop() { + + if (otaMode != NONE) { + ArduinoOTA.handle(); + + if(otaMode == WAITING) { + static long mil = millis(); + static boolean huehott = false; + + if(millis() - mil > 100) { + huehott = !huehott; + mil = millis(); + + otaWaitCounter++; + if(otaWaitCounter >= OTA_WAIT_TIMEOUT) { + Serial.println("OTA wait timeout, proceeding normal boot"); + otaMode = NONE; + normal_setup(); + } + } + } + + } else { + normal_loop(); + + } +} + +void normal_loop() { + static unsigned long last_print=0; + if (millis()-last_print>1000) { + last_print=millis(); + Serial.println("Loop"); + } +} \ No newline at end of file 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