Started adding ESP support

.gitignore

@@ -1 +1,2 @@
 .pio
+include/wifi.h

README.md

@@ -0,0 +1,6 @@
+Do this on ESP platforms
+
+    echo '#define WIFI_SSID "..."' > include/wifi.h
+    echo '#define WIFI_PW "..."' >> include/wifi.h
+
+To be able to connect to WiFi.

include/SerialLCD.h

@@ -1,7 +1,13 @@
 #ifndef _SERIAL_LCD_H_
 #define _SERIAL_LCD_H_
 
+#if defined(PLATFORM_AVR)
 #include <SendOnlySoftwareSerial.h>
+#elif defined(PLATFORM_ESP)
+#include <SoftwareSerial.h>
+#else
+#error platform not supported
+#endif
 
 class SerialLCD {
 public:
@@ -22,7 +28,11 @@ public:
     void write(int line, int col, const char *text);
     
 private:
+#if defined(PLATFORM_AVR)
     SendOnlySoftwareSerial *lcd;
+#elif defined(PLATFORM_ESP)
+    SoftwareSerial *lcd;
+#endif
 };
 
 #endif // _SERIAL_LCD_H_

include/SimpleUpdater.h

@@ -0,0 +1,54 @@
+/*
+ * SimpleUpdater.h
+ *
+ * ESP8266 / ESP32 Environmental Sensor
+ *
+ * ----------------------------------------------------------------------------
+ * "THE BEER-WARE LICENSE" (Revision 42):
+ * <xythobuz@xythobuz.de> wrote this file.  As long as you retain this notice
+ * you can do whatever you want with this stuff. If we meet some day, and you
+ * think this stuff is worth it, you can buy me a beer in return.   Thomas Buck
+ * ----------------------------------------------------------------------------
+ */
+
+#ifndef __ESP_SIMPLE_UPDATER__
+#define __ESP_SIMPLE_UPDATER__
+
+#if defined(ARDUINO_ARCH_ESP8266)
+#include <ESP8266WebServer.h>
+#include <ESP8266HTTPUpdateServer.h>
+#define UPDATE_WEB_SERVER ESP8266WebServer
+#elif defined(ARDUINO_ARCH_ESP32)
+#include <WebServer.h>
+#define UPDATE_WEB_SERVER WebServer
+#endif
+
+#if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)
+
+class SimpleUpdater {
+public:
+    SimpleUpdater(String _uri = String("/update"));
+    void setup(UPDATE_WEB_SERVER *_server);
+    
+private:
+
+#if defined(ARDUINO_ARCH_ESP8266)
+    
+    ESP8266HTTPUpdateServer updateServer;
+
+#elif defined(ARDUINO_ARCH_ESP32)
+    
+    void get(void);
+    void postResult(void);
+    void postUpload(void);
+    
+#endif
+    
+    String uri;
+    UPDATE_WEB_SERVER *server;
+};
+
+#endif
+
+#endif // __ESP_SIMPLE_UPDATER__
+

include/WifiStuff.h

@@ -0,0 +1,7 @@
+#ifndef _WIFI_STUFF_H_
+#define _WIFI_STUFF_H_
+
+void wifi_setup();
+void wifi_run();
+
+#endif // _WIFI_STUFF_H_

include/config.h

@@ -14,4 +14,14 @@
 #define AUTO_PUMP_RUNTIME 5
 #define MAX_AUTO_PLANT_RUNTIME 15
 
+// Sketch version
+#define FIRMWARE_VERSION "0.1"
+
+// all given in milliseconds
+#define SERVER_HANDLE_INTERVAL 10
+#define LED_BLINK_INTERVAL (2 * 1000)
+#define LED_INIT_BLINK_INTERVAL 500
+#define LED_CONNECT_BLINK_INTERVAL 250
+#define LED_ERROR_BLINK_INTERVAL 100
+
 #endif // _CONFIG_H_

platformio.ini

@@ -9,12 +9,45 @@
 ; https://docs.platformio.org/page/projectconf.html
 
 [platformio]
-default_envs = leonardo
+default_envs = esp32_main, arduino_ui
 
-[env:leonardo]
+[env:esp8266_main]
+platform = espressif8266
+board = esp01_1m
+framework = arduino
+build_flags = -D PLATFORM_ESP -D FUNCTION_CONTROL
+lib_deps =
+    https://github.com/rlogiacco/CircularBuffer
+    https://github.com/plerup/espsoftwareserial
+
+[env:esp32_main]
+platform = espressif32
+board = esp32dev
+framework = arduino
+build_flags = -D PLATFORM_ESP -D FUNCTION_CONTROL
+upload_protocol = esptool
+upload_port = /dev/ttyUSB1
+lib_deps =
+    https://github.com/rlogiacco/CircularBuffer
+    https://github.com/plerup/espsoftwareserial
+
+[env:arduino_ui]
+platform = atmelavr
+board = pro16MHzatmega328
+framework = arduino
+build_flags = -D PLATFORM_AVR -D FUNCTION_UI
+upload_port = /dev/ttyUSB1
+monitor_port = /dev/ttyUSB1
+monitor_speed = 115200
+lib_deps =
+  https://github.com/nickgammon/SendOnlySoftwareSerial
+  https://github.com/rlogiacco/CircularBuffer
+
+[env:leonardo_ui]
 platform = atmelavr
 board = leonardo
 framework = arduino
+build_flags = -D PLATFORM_AVR -D FUNCTION_UI
 upload_port = /dev/ttyACM0
 monitor_port = /dev/ttyACM0
 monitor_speed = 115200

src/SerialLCD.cpp

@@ -4,7 +4,12 @@
 #define LCD_DELAY 3 // 3
 
 SerialLCD::SerialLCD(int tx_pin) {
+#if defined(PLATFORM_AVR)
     lcd = new SendOnlySoftwareSerial(tx_pin);
+#elif defined(PLATFORM_ESP)
+    lcd = new SoftwareSerial(tx_pin);
+#endif
+    
     lcd->begin(9600);
 }
 

src/SimpleUpdater.cpp

@@ -0,0 +1,136 @@
+/*
+ * SimpleUpdater.cpp
+ *
+ * ESP8266 / ESP32 Environmental Sensor
+ *
+ * ----------------------------------------------------------------------------
+ * "THE BEER-WARE LICENSE" (Revision 42):
+ * <xythobuz@xythobuz.de> wrote this file.  As long as you retain this notice
+ * you can do whatever you want with this stuff. If we meet some day, and you
+ * think this stuff is worth it, you can buy me a beer in return.   Thomas Buck
+ * ----------------------------------------------------------------------------
+ */
+
+#if defined(ARDUINO_ARCH_ESP8266)
+#include <ESP8266HTTPUpdateServer.h>
+#elif defined(ARDUINO_ARCH_ESP32)
+#include <Update.h>
+#endif
+
+#include "SimpleUpdater.h"
+
+#if defined(ARDUINO_ARCH_ESP32)
+
+void SimpleUpdater::get(void) {
+    String uploadPage = F(
+        "<html><head>"
+        "<script src='https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js'></script>"
+        "<title>SimpleUpdater ESP32</title>"
+        "</head><body>"
+        "<h1>SimpleUpdater</h1>"
+        "<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>"
+        "<a href=\"/\">Back to Main Page</a>"
+        "<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>"
+        "</body></html>"
+    );
+    
+    server->send(200, "text/html", uploadPage);
+}
+
+void SimpleUpdater::postResult(void) {
+    server->sendHeader("Connection", "close");
+    server->send(200, "text/plain", (Update.hasError()) ? "FAIL" : "OK");
+    ESP.restart();
+}
+
+void SimpleUpdater::postUpload(void) {
+    HTTPUpload& upload = server->upload();
+    if (upload.status == UPLOAD_FILE_START) {
+        Serial.printf("Update: %s\n", upload.filename.c_str());
+        // start with max available size
+        if (!Update.begin(UPDATE_SIZE_UNKNOWN)) {
+            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) {
+        // true to set the size to the current progress
+        if (Update.end(true)) {
+            Serial.printf("Update Success: %u\nRebooting...\n", upload.totalSize);
+        } else {
+            Update.printError(Serial);
+        }
+    }
+}
+
+#endif
+
+#if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)
+
+void SimpleUpdater::setup(UPDATE_WEB_SERVER *_server) {
+    if (_server == NULL) {
+        return;
+    }
+    
+    server = _server;
+    
+#if defined(ARDUINO_ARCH_ESP8266)
+    
+    updateServer.setup(server);
+    
+#elif defined(ARDUINO_ARCH_ESP32)
+    
+    server->on(uri.c_str(), HTTP_POST, [this]() {
+        postResult();
+    }, [this]() {
+        postUpload();
+    });
+    
+    server->on(uri.c_str(), HTTP_GET, [this]() {
+        get();
+    });
+    
+#endif
+}
+
+SimpleUpdater::SimpleUpdater(String _uri) {
+    uri = _uri;
+    server = NULL;
+}
+
+#endif

src/Statemachine.cpp

@@ -464,7 +464,9 @@ void Statemachine::switch_to(States s) {
     state = s;
     
     if (s == init) {
-        print("- Giess-o-mat V0.1 -",
+        String a = String("- Giess-o-mat V") + FIRMWARE_VERSION + String(" -");
+        
+        print(a.c_str(),
               "Usage:  Enter number",
               "* Delete prev. digit",
               "# Execute input num.",

src/WifiStuff.cpp

@@ -0,0 +1,192 @@
+#include <Arduino.h>
+
+#if defined(ARDUINO_ARCH_ESP8266)
+
+#include <ESP8266WiFi.h>
+#include <ESP8266WebServer.h>
+#include <ESP8266mDNS.h>
+
+#elif defined(ARDUINO_ARCH_ESP32)
+
+#include <WiFi.h>
+#include <WebServer.h>
+#include <ESPmDNS.h>
+
+#endif
+
+#if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)
+
+#include "wifi.h"
+#include "config.h"
+#include "SimpleUpdater.h"
+#include "WifiStuff.h"
+
+#define BUILTIN_LED_PIN 1
+
+UPDATE_WEB_SERVER server(80);
+SimpleUpdater updater;
+unsigned long last_server_handle_time = 0;
+unsigned long last_led_blink_time = 0;
+
+String message_buffer_a;
+String message_buffer_b;
+String message_buffer_c;
+String message_buffer_d;
+
+void wifi_set_message_buffer(String a, String b, String c, String d) {
+    message_buffer_a = a;
+    message_buffer_b = b;
+    message_buffer_c = c;
+    message_buffer_d = d;
+}
+
+void handleRoot() {
+    String message = F("<html><head>\n");
+    message += F("<title>Giess-o-mat</title>\n");
+    message += F("</head><body>\n");
+    message += F("<h1>Giess-o-mat</h1>\n");
+    
+    message += F("\n<pre>\n");
+    message += message_buffer_a + '\n';
+    message += message_buffer_b + '\n';
+    message += message_buffer_c + '\n';
+    message += message_buffer_d + '\n';
+    message += F("\n</pre>\n");
+    
+    message += F("\n<p>\n");
+    message += F("State: ");
+    // TODO
+    message += F("\n</p>\n");
+    
+    message += F("\n<p>\n");
+    message += F("Version: ");
+    message += FIRMWARE_VERSION;
+    message += F("\n<br>\n");
+    message += F("MAC: ");
+    message += WiFi.macAddress();
+    message += F("\n</p>\n");
+
+#if defined(ARDUINO_ARCH_ESP8266)
+    
+    message += F("\n<p>\n");
+    message += F("Reset reason: ");
+    message += ESP.getResetReason();
+    message += F("\n<br>\n");
+    message += F("Free heap: ");
+    message += String(ESP.getFreeHeap());
+    message += F(" (");
+    message += String(ESP.getHeapFragmentation());
+    message += F("% fragmentation)");
+    message += F("\n<br>\n");
+    message += F("Free sketch space: ");
+    message += String(ESP.getFreeSketchSpace());
+    message += F("\n<br>\n");
+    message += F("Flash chip real size: ");
+    message += String(ESP.getFlashChipRealSize());
+
+    if (ESP.getFlashChipSize() != ESP.getFlashChipRealSize()) {
+        message += F("\n<br>\n");
+        message += F("WARNING: sdk chip size (");
+        message += (ESP.getFlashChipSize());
+        message += F(") does not match!");
+    }
+    
+    message += F("\n</p>\n");
+    
+#elif defined(ARDUINO_ARCH_ESP32)
+
+    message += F("\n<p>\n");
+    message += F("Free heap: ");
+    message += String(ESP.getFreeHeap() / 1024.0);
+    message += F("k\n<br>\n");
+    message += F("Free sketch space: ");
+    message += String(ESP.getFreeSketchSpace() / 1024.0);
+    message += F("k\n<br>\n");
+    message += F("Flash chip size: ");
+    message += String(ESP.getFlashChipSize() / 1024.0);
+    message += F("k\n</p>\n");
+    
+#endif
+
+    message += F("<p>\n");
+    message += F("Try <a href=\"/update\">/update</a> for OTA firmware updates!\n");
+    message += F("</p>\n");
+    message += F("</body></html>\n");
+
+    server.send(200, "text/html", message);
+}
+
+void wifi_setup() {
+    // Build hostname string
+    String hostname = "giess-o-mat";
+
+#if defined(ARDUINO_ARCH_ESP8266)
+
+    // Connect to WiFi AP
+    WiFi.hostname(hostname);
+    WiFi.mode(WIFI_STA);
+    WiFi.begin(WIFI_SSID, WIFI_PW);
+    while (WiFi.status() != WL_CONNECTED) {
+        delay(LED_CONNECT_BLINK_INTERVAL);
+        digitalWrite(BUILTIN_LED_PIN, !digitalRead(BUILTIN_LED_PIN));
+    }
+    
+#elif defined(ARDUINO_ARCH_ESP32)
+
+    // Set hostname workaround
+    WiFi.config(INADDR_NONE, INADDR_NONE, INADDR_NONE);
+    WiFi.setHostname(hostname.c_str());
+    
+    // Workaround for WiFi connecting only every 2nd reset
+    // https://github.com/espressif/arduino-esp32/issues/2501#issuecomment-513602522
+    WiFi.onEvent([](WiFiEvent_t event, WiFiEventInfo_t info) {
+        if (info.disconnected.reason == 202) {
+            esp_sleep_enable_timer_wakeup(10);
+            esp_deep_sleep_start();
+            delay(100);
+        }
+    }, WiFiEvent_t::SYSTEM_EVENT_STA_DISCONNECTED);
+
+    // Connect to WiFi AP
+    WiFi.mode(WIFI_STA);
+    WiFi.begin(WIFI_SSID, WIFI_PW);
+    while (WiFi.status() != WL_CONNECTED) {
+        delay(LED_CONNECT_BLINK_INTERVAL);
+        digitalWrite(BUILTIN_LED_PIN, !digitalRead(BUILTIN_LED_PIN));
+    }
+    
+    // Set hostname workaround
+    WiFi.setHostname(hostname.c_str());
+
+#endif
+
+    // Setup HTTP Server
+    MDNS.begin(hostname.c_str());
+    updater.setup(&server);
+    server.on("/", handleRoot);
+    server.begin();
+    MDNS.addService("http", "tcp", 80);
+}
+
+void wifi_run() {
+    if ((millis() - last_server_handle_time) >= SERVER_HANDLE_INTERVAL) {
+        last_server_handle_time = millis();
+        server.handleClient();
+#if defined(ARDUINO_ARCH_ESP8266)
+        MDNS.update();
+#endif
+    }
+
+    // blink heartbeat LED
+    if ((millis() - last_led_blink_time) >= LED_BLINK_INTERVAL) {
+        last_led_blink_time = millis();
+        digitalWrite(BUILTIN_LED_PIN, !digitalRead(BUILTIN_LED_PIN));
+    }
+    
+    // reset ESP every 6h to be safe
+    if (millis() >= (6 * 60 * 60 * 1000)) {
+        ESP.restart();
+    }
+}
+
+#endif // defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)

src/main.cpp

@@ -1,10 +1,17 @@
 #include <Arduino.h>
+
 #include "Keymatrix.h"
 #include "SerialLCD.h"
 #include "Statemachine.h"
 #include "Plants.h"
+#include "WifiStuff.h"
 #include "config.h"
 
+void blink_lcd(int n, int wait = 200);
+void write_to_all(const char *a, const char *b,
+                  const char *c, const char *d, int num_input);
+void backspace(void);
+
 SerialLCD lcd(9);
 
 Keymatrix keys(4, 3);
@@ -15,95 +22,12 @@ int valve_pins[5] = { 10, 11, 12, 13, 14 };
 int pump_pins[3] = { 15, 16, 17 };
 int switch_pins[2] = { 18, 19 };
 
+Statemachine sm(write_to_all, backspace);
+
 unsigned long last_input_time = 0;
 bool backlight_state = true;
-
 bool doing_multi_input = false;
 
-void write_to_all(const char *a, const char *b,
-                  const char *c, const char *d, int num_input) {
-    lcd.clear();
-    
-    if (num_input >= 0) {
-        lcd.write(0, a);
-        if (num_input >= 1) {
-            lcd.write(1, b);
-        }
-        if (num_input >= 2) {
-            lcd.write(2, c);
-        }
-        if (num_input >= 3) {
-            lcd.write(3, d);
-        }
-        
-        lcd.cursor(3);
-        doing_multi_input = true;
-    } else {
-        lcd.write(0, a);
-        lcd.write(1, b);
-        lcd.write(2, c);
-        lcd.write(3, d);
-        
-        lcd.cursor(0);
-        doing_multi_input = false;
-    }
-    
-#ifdef DEBUG_ENABLE_LCD_OUTPUT_ON_SERIAL
-    int la = strlen(a);
-    int lb = strlen(b);
-    int lc = strlen(c);
-    int ld = strlen(d);
-    
-    Serial.println();
-    Serial.println(" ----------------------");
-    
-    Serial.print("| ");
-    Serial.print(a);
-    if (la < 20) {
-        for (int i = 0; i < (20 - la); i++) {
-            Serial.print(' ');
-        }
-    }
-    Serial.println(" |");
-    
-    Serial.print("| ");
-    Serial.print(b);
-    if (lb < 20) {
-        for (int i = 0; i < (20 - lb); i++) {
-            Serial.print(' ');
-        }
-    }
-    Serial.println(" |");
-    
-    Serial.print("| ");
-    Serial.print(c);
-    if (lc < 20) {
-        for (int i = 0; i < (20 - lc); i++) {
-            Serial.print(' ');
-        }
-    }
-    Serial.println(" |");
-    
-    Serial.print("| ");
-    Serial.print(d);
-    if (ld < 20) {
-        for (int i = 0; i < (20 - ld); i++) {
-            Serial.print(' ');
-        }
-    }
-    Serial.println(" |");
-    
-    Serial.println(" ----------------------");
-    Serial.println("Please provide keypad input:");
-#endif
-}
-
-void backspace(void) {
-    lcd.write("\b");
-}
-
-Statemachine sm(write_to_all, backspace);
-
 void setup() {
     Serial.begin(115200);
     Serial.println("Initializing Giess-o-mat");
@@ -127,22 +51,19 @@ void setup() {
     lcd.clear();
 #endif
     
+#if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)
+    wifi_setup();
+#endif
+    
     Serial.println("Ready, starting main loop");
     sm.begin();
 }
 
-void blink_lcd(int n, int wait = 200) {
-    for (int i = 0; i < n; i++) {
-        lcd.setBacklight(0);
-        delay(wait);
-        
-        lcd.setBacklight(255);
-        if (i < (n - 1))
-            delay(wait);
-    }
-}
-
 void loop() {
+#if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)
+    wifi_run();
+#endif
+
     keys.scan();
     while (keys.hasEvent()) {
         auto ke = keys.getEvent();
@@ -242,3 +163,96 @@ void loop() {
         lcd.setBacklight(0);
     }
 }
+
+void write_to_all(const char *a, const char *b,
+                  const char *c, const char *d, int num_input) {
+    lcd.clear();
+    
+    if (num_input >= 0) {
+        lcd.write(0, a);
+        if (num_input >= 1) {
+            lcd.write(1, b);
+        }
+        if (num_input >= 2) {
+            lcd.write(2, c);
+        }
+        if (num_input >= 3) {
+            lcd.write(3, d);
+        }
+        
+        lcd.cursor(3);
+        doing_multi_input = true;
+    } else {
+        lcd.write(0, a);
+        lcd.write(1, b);
+        lcd.write(2, c);
+        lcd.write(3, d);
+        
+        lcd.cursor(0);
+        doing_multi_input = false;
+    }
+    
+#ifdef DEBUG_ENABLE_LCD_OUTPUT_ON_SERIAL
+    int la = strlen(a);
+    int lb = strlen(b);
+    int lc = strlen(c);
+    int ld = strlen(d);
+    
+    Serial.println();
+    Serial.println(" ----------------------");
+    
+    Serial.print("| ");
+    Serial.print(a);
+    if (la < 20) {
+        for (int i = 0; i < (20 - la); i++) {
+            Serial.print(' ');
+        }
+    }
+    Serial.println(" |");
+    
+    Serial.print("| ");
+    Serial.print(b);
+    if (lb < 20) {
+        for (int i = 0; i < (20 - lb); i++) {
+            Serial.print(' ');
+        }
+    }
+    Serial.println(" |");
+    
+    Serial.print("| ");
+    Serial.print(c);
+    if (lc < 20) {
+        for (int i = 0; i < (20 - lc); i++) {
+            Serial.print(' ');
+        }
+    }
+    Serial.println(" |");
+    
+    Serial.print("| ");
+    Serial.print(d);
+    if (ld < 20) {
+        for (int i = 0; i < (20 - ld); i++) {
+            Serial.print(' ');
+        }
+    }
+    Serial.println(" |");
+    
+    Serial.println(" ----------------------");
+    Serial.println("Please provide keypad input:");
+#endif
+}
+
+void backspace(void) {
+    lcd.write("\b");
+}
+
+void blink_lcd(int n, int wait) {
+    for (int i = 0; i < n; i++) {
+        lcd.setBacklight(0);
+        delay(wait);
+        
+        lcd.setBacklight(255);
+        if (i < (n - 1))
+            delay(wait);
+    }
+}