fix: publish raw OTA files to rolling release with backup artifacts

.gitea/workflows/ota-build.yml

@@ -0,0 +1,140 @@
+name: OTA build
+
+on:
+  push:
+    branches:
+      - '**'
+  workflow_dispatch:
+
+jobs:
+  build-ota:
+    runs-on: ubuntu-latest
+    timeout-minutes: 45
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install PlatformIO
+        run: |
+          python -m pip install --upgrade pip
+          pip install platformio
+
+      - name: Build OTA firmware binaries
+        run: pio run
+
+      - name: Prepare direct OTA files
+        run: |
+          set -eu
+          rm -rf dist/ota
+          project_name="${GITHUB_REPOSITORY#*/}"
+          project_name="${project_name#PlatformIO_}"
+          timestamp="$(date -u +%Y-%m-%dT%H-%M-%SZ)"
+          mkdir -p dist/ota
+          found=0
+          for fw in .pio/build/*/firmware.bin .pio/build/*/firmware.hex; do
+            [ -f "$fw" ] || continue
+            env_name="$(basename "$(dirname "$fw")")"
+            ext="${fw##*.}"
+            cp "$fw" "dist/ota/${project_name}_${env_name}_${timestamp}.${ext}"
+            found=1
+          done
+          if [ "$found" -eq 0 ]; then
+            echo 'No firmware.bin or firmware.hex artifacts were produced.' >&2
+            exit 1
+          fi
+          find dist/ota -maxdepth 1 -type f | sort
+
+      - name: Upload backup OTA artifact ZIP
+        uses: actions/upload-artifact@v3
+        with:
+          name: ota-files
+          path: dist/ota/*
+          if-no-files-found: error
+
+      - name: Publish raw OTA files to rolling release
+        env:
+          GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
+        run: |
+          python - <<'PY'
+          import json
+          import mimetypes
+          import os
+          import sys
+          from pathlib import Path
+          from urllib.request import Request, urlopen
+          from urllib.error import HTTPError
+
+          server = os.environ['GITHUB_SERVER_URL']
+          repo = os.environ['GITHUB_REPOSITORY']
+          token = os.environ.get('GITEA_TOKEN')
+          if not token:
+              print('GITEA_TOKEN missing', file=sys.stderr)
+              sys.exit(1)
+          api = f"{server}/api/v1/repos/{repo}"
+          headers = {
+              'Authorization': f'token {token}',
+              'Accept': 'application/json',
+              'Content-Type': 'application/json',
+              'User-Agent': 'Hermes-Agent'
+          }
+          tag = 'ota-builds'
+          release_name = 'OTA Builds'
+          body = 'Rolling OTA files from the latest successful push build.'
+
+          def req(url, method='GET', data=None, extra_headers=None):
+              h = dict(headers)
+              if extra_headers:
+                  h.update(extra_headers)
+              payload = None if data is None else json.dumps(data).encode()
+              r = Request(url, data=payload, headers=h, method=method)
+              with urlopen(r, timeout=120) as resp:
+                  body = resp.read()
+              if not body:
+                  return None
+              text = body.decode()
+              try:
+                  return json.loads(text)
+              except json.JSONDecodeError:
+                  return text
+
+          try:
+              release = req(f"{api}/releases/tags/{tag}")
+          except HTTPError as e:
+              if e.code != 404:
+                  raise
+              release = req(f"{api}/releases", method='POST', data={
+                  'tag_name': tag,
+                  'target': os.environ.get('GITHUB_SHA', ''),
+                  'name': release_name,
+                  'body': body,
+                  'draft': False,
+                  'prerelease': True,
+              })
+
+          release_id = release['id']
+          existing = req(f"{api}/releases/{release_id}/assets") or []
+          for asset in existing:
+              rid = asset['id']
+              req(f"{api}/releases/{release_id}/assets/{rid}", method='DELETE')
+
+          for path in sorted(Path('dist/ota').glob('*')):
+              if not path.is_file():
+                  continue
+              mime = mimetypes.guess_type(path.name)[0] or 'application/octet-stream'
+              upload_headers = {
+                  'Authorization': f'token {token}',
+                  'Content-Type': mime,
+                  'Accept': 'application/json',
+                  'User-Agent': 'Hermes-Agent'
+              }
+              url = f"{api}/releases/{release_id}/assets?name={path.name}"
+              data = path.read_bytes()
+              r = Request(url, data=data, headers=upload_headers, method='POST')
+              with urlopen(r, timeout=240) as resp:
+                  print(resp.read().decode())
+          PY

platformio.ini

@@ -1,14 +1,17 @@
-; 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
+; 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
+lib_deps = 
+	knolleary/PubSubClient@^2.8
+	bblanchon/ArduinoJson@^6.19.4

src/main.cpp

@@ -1,54 +1,63 @@
 #include <Arduino.h>
+#include <ArduinoJson.h>
+#include <ESPmDNS.h>
+#include <PubSubClient.h>
+#include <SPIFFS.h>
+#include <Update.h>
+#include <WebServer.h>
 #include <WiFi.h>
 #include <WiFiClient.h>
 #include <WiFiClientSecure.h>
-#include <WebServer.h>
-#include <ESPmDNS.h>
-#include <Update.h>
-#include <SPIFFS.h>
 
 const char* host = "esp32gragedoor";
 const char* ssid = "JoNelsDarlings";
 const char* password = "Paris2016";
+const char* mqtt_server = "mqtt.ddns.kawomi.com";
 
 const int buttonPin = 4;  // Reed switch - don't forget the pull down resistor.
-const int ledPin =  2;    // Internal LED
+const int ledPin = 2;     // Internal LED
+int wifiState = WL_DISCONNECTED;   // Wifi-Connection Status
 
+boolean bForceResend = true;  // send initial state to mqtt on startup.
 int previousState;
 WebServer server(80);
+WiFiClient espClient;
+PubSubClient mqttClient(espClient);
+#define MSG_BUFFER_SIZE (50)
+char msg[MSG_BUFFER_SIZE];
 
 /*
  * Login page
  */
 
-const char* loginIndex = 
- "<form name='loginForm'>"
+const char* loginIndex =
+    "<form name='loginForm'>"
     "<table width='20%' bgcolor='A09F9F' align='center'>"
-        "<tr>"
-            "<td colspan=2>"
-                "<center><font size=4><b>ESP32 Login Page</b></font></center>"
-                "<br>"
-            "</td>"
-            "<br>"
-            "<br>"
-        "</tr>"
-        "<td>Username:</td>"
-        "<td><input type='text' size=25 name='userid'><br></td>"
-        "</tr>"
-        "<br>"
-        "<br>"
-        "<tr>"
-            "<td>Password:</td>"
-            "<td><input type='Password' size=25 name='pwd'><br></td>"
-            "<br>"
-            "<br>"
-        "</tr>"
-        "<tr>"
-            "<td><input type='submit' onclick='check(this.form)' value='Login'></td>"
-        "</tr>"
+    "<tr>"
+    "<td colspan=2>"
+    "<center><font size=4><b>ESP32 Login Page</b></font></center>"
+    "<br>"
+    "</td>"
+    "<br>"
+    "<br>"
+    "</tr>"
+    "<td>Username:</td>"
+    "<td><input type='text' size=25 name='userid'><br></td>"
+    "</tr>"
+    "<br>"
+    "<br>"
+    "<tr>"
+    "<td>Password:</td>"
+    "<td><input type='Password' size=25 name='pwd'><br></td>"
+    "<br>"
+    "<br>"
+    "</tr>"
+    "<tr>"
+    "<td><input type='submit' onclick='check(this.form)' value='Login'></td>"
+    "</tr>"
     "</table>"
-"</form>"
-"<script>"
+    "</form>"
+    "<script>"
     "function check(form)"
     "{"
     "if(form.userid.value=='admin' && form.pwd.value=='admin')"
@@ -60,58 +69,60 @@ const char* loginIndex =
     " alert('Error Password or Username')/*displays error message*/"
     "}"
     "}"
-"</script>";
- 
+    "</script>";
+
 /*
  * Server Index Page
  */
- 
-const char* serverIndex = 
-"<script src='https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js'></script>"
-"<form method='POST' action='#' enctype='multipart/form-data' id='upload_form'>"
-   "<input type='file' name='update'>"
-        "<input type='submit' value='Update'>"
+
+const char* serverIndex =
+    "<script "
+    "src='https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js'></"
+    "script>"
+    "<form method='POST' action='#' enctype='multipart/form-data' "
+    "id='upload_form'>"
+    "<input type='file' name='update'>"
+    "<input type='submit' value='Update'>"
     "</form>"
- "<div id='prg'>progress: 0%</div>"
- "<script>"
-  "$('form').submit(function(e){"
-  "e.preventDefault();"
-  "var form = $('#upload_form')[0];"
-  "var data = new FormData(form);"
-  " $.ajax({"
-  "url: '/update',"
-  "type: 'POST',"
-  "data: data,"
-  "contentType: false,"
-  "processData:false,"
-  "xhr: function() {"
-  "var xhr = new window.XMLHttpRequest();"
-  "xhr.upload.addEventListener('progress', function(evt) {"
-  "if (evt.lengthComputable) {"
-  "var per = evt.loaded / evt.total;"
-  "$('#prg').html('progress: ' + Math.round(per*100) + '%');"
-  "}"
-  "}, false);"
-  "return xhr;"
-  "},"
-  "success:function(d, s) {"
-  "console.log('success!')" 
- "},"
- "error: function (a, b, c) {"
- "}"
- "});"
- "});"
- "</script>";
+    "<div id='prg'>progress: 0%</div>"
+    "<script>"
+    "$('form').submit(function(e){"
+    "e.preventDefault();"
+    "var form = $('#upload_form')[0];"
+    "var data = new FormData(form);"
+    " $.ajax({"
+    "url: '/update',"
+    "type: 'POST',"
+    "data: data,"
+    "contentType: false,"
+    "processData:false,"
+    "xhr: function() {"
+    "var xhr = new window.XMLHttpRequest();"
+    "xhr.upload.addEventListener('progress', function(evt) {"
+    "if (evt.lengthComputable) {"
+    "var per = evt.loaded / evt.total;"
+    "$('#prg').html('progress: ' + Math.round(per*100) + '%');"
+    "}"
+    "}, false);"
+    "return xhr;"
+    "},"
+    "success:function(d, s) {"
+    "console.log('success!')"
+    "},"
+    "error: function (a, b, c) {"
+    "}"
+    "});"
+    "});"
+    "</script>";
 
-
-void send_notification(String subject){
-  //return;
+void send_notification(String subject) {
+  // return;
   Serial.println("Sending Notification.");
   WiFiClientSecure client;
-  client.setInsecure(); // NOT RECOMMENDED
-  const char* host="deadswitch.kawomi.com";
-  const int port=443;
-  if (!client.connect(host,port)) {
+  client.setInsecure();  // NOT RECOMMENDED
+  const char* host = "deadswitch.kawomi.com";
+  const int port = 443;
+  if (!client.connect(host, port)) {
     Serial.println("connection failed");
     return;
   }
@@ -119,29 +130,54 @@ void send_notification(String subject){
   String url = "/api/v1?topic=" + subject + "&secs=0&email=none";
   Serial.print("Requesting URL: ");
   Serial.println(url);
-  client.print(String("POST ") + url + " HTTP/1.1\r\n" +
-                  "Host: " + host + "\r\n" +
-                  "Content-Type: application/x-www-form-urlencoded\r\n" +
-                  "Content-Length: 14\r\n\r\n" +
-                  "platform=esp32\r\n");
+  client.print(String("POST ") + url + " HTTP/1.1\r\n" + "Host: " + host +
+               "\r\n" + "Content-Type: application/x-www-form-urlencoded\r\n" +
+               "Content-Length: 14\r\n\r\n" + "platform=esp32\r\n");
+}
 
+void send_mqtt(String value) {
+  const size_t CAPACITY = JSON_OBJECT_SIZE(1);
+  StaticJsonDocument<CAPACITY> doc;
+
+  // create an object
+  JsonObject object = doc.to<JsonObject>();
+  object["status"] = value.c_str();
+
+  // serialize the object and send the result to Serial
+  static char sensorStatus[150];
+  serializeJson(doc, sensorStatus);
+  Serial.println(sensorStatus);
+
+  mqttClient.publish("Address/Livorno/Garagedoor", sensorStatus, true);
+}
+
+void reconnect() {
+  // Loop until we're reconnected
+  while (!mqttClient.connected()) {
+    Serial.print("Attempting MQTT connection...");
+    // Create a random client ID
+    String clientId = "ESP32Client-";
+    clientId += String(random(0xffff), HEX);
+    // Attempt to connect
+    if (mqttClient.connect(clientId.c_str())) {
+      Serial.println("MQTT connected");
+      // Once connected, publish an announcement...
+    } else {
+      Serial.print("MQTT failed, rc=");
+      Serial.print(mqttClient.state());
+      Serial.println(" try again in 5 seconds");
+      // Wait 5 seconds before retrying
+      delay(5000);
+    }
+  }
 }
 
 /*
  * setup function
  */
-void setup(void) {
-  Serial.begin(9600);  
-  delay(500);
 
-  Serial.println(">>>>>>>>>> Garage Door Monitor <<<<<<<<<<<<<<");
-  pinMode(buttonPin, INPUT);
-  pinMode(ledPin, OUTPUT);
-  
-  // if we stat up we need to see what the status is...
-  digitalWrite(ledPin, previousState= digitalRead(buttonPin));
-  Serial.printf("Initial State: %d",previousState);
-  // Connect to WiFi network
+void wifiSetup(void){
+// Connect to WiFi network
   WiFi.begin(ssid, password);
   Serial.println("");
 
@@ -151,7 +187,8 @@ void setup(void) {
     delay(500);
     Serial.print(".");
     if (wifiConnAttements++ > 120) {
-      Serial.println("<Wifi not connecting after 120 attmepts (1 min.)  - rebooting>");
+      Serial.println(
+          "<Wifi not connecting after 120 attmepts (1 min.)  - rebooting>");
       ESP.restart();
     }
   }
@@ -163,21 +200,39 @@ void setup(void) {
   Serial.println(WiFi.localIP());
 
   /*use mdns for host name resolution*/
-  if (!MDNS.begin(host)) { //http://esp32garagedoor.local
+  if (!MDNS.begin(host)) {  // http://esp32garagedoor.local
     while (1) {
       Serial.println("Error setting up MDNS responder!");
       delay(1000);
     }
   }
   Serial.println("mDNS responder started");
+}
 
-  if(!SPIFFS.begin(true)){
-    while (1) {
-      Serial.println("An Error has occurred while mounting SPIFFS");
-      delay(1000);
-    }
+void setup(void) {
+  Serial.begin(9600);
+  delay(500);
+
+  Serial.println(">>>>>>>>>> Garage Door Monitor <<<<<<<<<<<<<<");
+  pinMode(buttonPin, INPUT);
+  pinMode(ledPin, OUTPUT);
+
+  // if we stat up we need to see what the status is...
+  digitalWrite(ledPin, previousState = digitalRead(buttonPin));
+  Serial.printf("Initial State: %d", previousState);
+
+  randomSeed(micros());
+
+  wifiSetup();
+  
+  mqttClient.setServer(mqtt_server, 1883);
+  Serial.println("mqtt server set.");
+
+  if (!SPIFFS.begin(true)) {
+    Serial.println("An Error has occurred while mounting SPIFFS");
   }
 
+  // send_mqtt("rebooted");
   send_notification("garagedoor.rebooted.livorno.address");
 
   /*return index page which is stored in serverIndex */
@@ -191,69 +246,113 @@ void setup(void) {
       Serial.println("There was a problem opening the file for reading.");
       thePage += "There was a problem opening the file for reading.";
     }
-    
+
     while (file.available()) {
-      thePage+=String((char)file.read());
-    } 
+      thePage += String((char)file.read());
+    }
 
     file.close();
     server.send(200, "text/html", thePage);
   });
   server.on("/status", HTTP_GET, []() {
     server.sendHeader("Connection", "close");
-    boolean isOpen=digitalRead(buttonPin)==HIGH;
-    server.send(200, "application/json", "{ \"isOpen\": " + String(isOpen?"true":"false") + "  }");
+    boolean isOpen = digitalRead(buttonPin) == HIGH;
+    server.send(200, "application/json",
+                "{ \"isOpen\": " + String(isOpen ? "true" : "false") + ", \"freeMem\": " + String(esp_get_free_heap_size()) + "  }");
+    // send_mqtt("statusquery");
   });
+
+  server.on("/sendmqtt", HTTP_GET, []() {
+    server.sendHeader("Connection", "close");
+    server.send(200, "text/html", "mqtt resend.");
+    bForceResend = true;
+  });
+
   server.on("/serverIndex", HTTP_GET, []() {
     server.sendHeader("Connection", "close");
     server.send(200, "text/html", serverIndex);
   });
   /*handling uploading firmware file */
-  server.on("/update", HTTP_POST, []() {
-    server.sendHeader("Connection", "close");
-    server.send(200, "text/plain", (Update.hasError()) ? "FAIL" : "OK");
-    ESP.restart();
-  }, []() {
-    HTTPUpload& upload = server.upload();
-    if (upload.status == UPLOAD_FILE_START) {
-      Serial.printf("Update: %s\n", upload.filename.c_str());
-      if (!Update.begin(UPDATE_SIZE_UNKNOWN)) { //start with max available size
-        Update.printError(Serial);
-      }
-    } else if (upload.status == UPLOAD_FILE_WRITE) {
-      /* flashing firmware to ESP*/
-      if (Update.write(upload.buf, upload.currentSize) != upload.currentSize) {
-        Update.printError(Serial);
-      }
-    } else if (upload.status == UPLOAD_FILE_END) {
-      if (Update.end(true)) { //true to set the size to the current progress
-        Serial.printf("Update Success: %u\nRebooting...\n", upload.totalSize);
-      } else {
-        Update.printError(Serial);
-      }
-    }
-  });
+  server.on(
+      "/update", HTTP_POST,
+      []() {
+        server.sendHeader("Connection", "close");
+        server.send(200, "text/plain", (Update.hasError()) ? "FAIL" : "OK");
+        ESP.restart();
+      },
+      []() {
+        HTTPUpload& upload = server.upload();
+        if (upload.status == UPLOAD_FILE_START) {
+          Serial.printf("Update: %s\n", upload.filename.c_str());
+          if (!Update.begin(
+                  UPDATE_SIZE_UNKNOWN)) {  // start with max available size
+            Update.printError(Serial);
+          }
+        } else if (upload.status == UPLOAD_FILE_WRITE) {
+          /* flashing firmware to ESP*/
+          if (Update.write(upload.buf, upload.currentSize) !=
+              upload.currentSize) {
+            Update.printError(Serial);
+          }
+        } else if (upload.status == UPLOAD_FILE_END) {
+          if (Update.end(
+                  true)) {  // true to set the size to the current progress
+            Serial.printf("Update Success: %u\nRebooting...\n",
+                          upload.totalSize);
+          } else {
+            Update.printError(Serial);
+          }
+        }
+      });
   server.begin();
 }
 
-
-
+int loopCounter=0;
 void loop(void) {
+  /*if (wifiState!=WiFi.status()) {
+    Serial.print("Wifi Status Change: ");
+    Serial.println(WiFi.status()); 
+    wifiState=WiFi.status();
+  } */
+
+  // if we lost connection reconnect...
+  if (WL_CONNECTED != WiFi.status()){
+    // This didn't work - let's try rebooting instead. 
+    //WiFi.disconnect();
+    //delay(1000);
+    // wifiSetup();
+    ESP.restart();
+  }
+
   server.handleClient();
   delay(1000);
 
+  if (!mqttClient.connected()) {
+    reconnect();
+    // send_mqtt("(re)connected");
+  }
+  mqttClient.loop();
+
   int buttonState = digitalRead(buttonPin);
 
-  if (buttonState!=previousState){
+  if (buttonState != previousState || bForceResend) {
+    bForceResend = false;
     if (buttonState == HIGH) {
       digitalWrite(ledPin, HIGH);
       Serial.println("Garage Opened");
-      send_notification("garagedoor.opened.livorno.address");
+      // send_notification("garagedoor.opened.livorno.address");
+      send_mqtt("opened");
     } else {
       digitalWrite(ledPin, LOW);
       Serial.println("Garage Closed");
-      send_notification("garagedoor.closed.livorno.address");
+      // send_notification("garagedoor.closed.livorno.address");
+      send_mqtt("closed");
     }
-    previousState=buttonState;
+    previousState = buttonState;
+  }
+
+  if (loopCounter++ > 59){ // log memory every minute.
+    Serial.println("Free memory: " + String(esp_get_free_heap_size()) + " bytes");
+    loopCounter=0;
   }
 }