Define customizable settings in WifiManager written to SPIFFS

README.md

@@ -0,0 +1,12 @@
+# Presence button
+
+Project notifying that the Hackerspace is open/closed on different channels (Matrix, Fuz.re homepage), while respecting the privacy of attendants.
+
+More info on [Fuz wiki](https://wiki.fuz.re/doku.php?id=projets:fuz:presence_button).
+
+## Dependencies
+
+Developped with the Arduino IDE, the script relies on the following third-party libraries:
+
+* https://arduinojson.org/ v6
+* https://github.com/tzapu/WiFiManager

main.ino

@@ -1,3 +1,5 @@
+#include <FS.h>                   //this needs to be first, or it all crashes and burns...
+
 #include <ESP8266WiFi.h>          //https://github.com/esp8266/Arduino
 
 //needed for library
@@ -5,6 +7,9 @@
 #include <ESP8266WebServer.h>
 #include <WiFiManager.h>          //https://github.com/tzapu/WiFiManager
 
+#include <ArduinoJson.h>          //https://github.com/bblanchon/ArduinoJson
+
+
 //for LED status
 #include <Ticker.h>
 Ticker ticker;
@@ -19,7 +24,7 @@ void tick()
   digitalWrite(LED_PIN, !state);     // set pin to the opposite state
 }
 
-//gets called when WiFiManager enters configuration mode
+//gets called when WiFiManager enters configuration mode (for LED status)
 void configModeCallback (WiFiManager *myWiFiManager) {
   Serial.println("Entered config mode");
   Serial.println(WiFi.softAPIP());
@@ -29,10 +34,28 @@ void configModeCallback (WiFiManager *myWiFiManager) {
   ticker.attach(0.2, tick);
 }
 
+
+//define your default values here, if there are different values in config.json, they are overwritten.
+char matrixUsername[50];
+char matrixPassword[50];
+char matrixRoom[200] = "!ppCFWxNWJeGbyoNZVw:matrix.fuz.re"; // #entropy:matrix.fuz.re
+char matrixMessage[500] = "Test";
+
+//flag for saving data
+bool shouldSaveConfig = false;
+
+//callback notifying us of the need to save config
+void saveConfigCallback () {
+  Serial.println(F("Should save config"));
+  shouldSaveConfig = true;
+}
+
+
 WiFiManager wifiManager;
 void setup() {
   // put your setup code here, to run once:
   Serial.begin(115200);
+  Serial.println();
 
   //set led pin as output
   pinMode(LED_PIN, OUTPUT);
@@ -41,31 +64,141 @@ void setup() {
 
   pinMode(BUTTON_PIN, INPUT);
 
+  //clean FS, for testing
+  //SPIFFS.format();
+
+  //read configuration from FS json
+  Serial.println(F("mounting FS..."));
+
+  if (SPIFFS.begin()) {
+    Serial.println(F("mounted file system"));
+    if (SPIFFS.exists("/config.json")) {
+      //file exists, reading and loading
+      Serial.println(F("reading config file"));
+      File configFile = SPIFFS.open("/config.json", "r");
+      if (configFile) {
+        Serial.println(F("opened config file"));
+        size_t size = configFile.size();
+        // Allocate a buffer to store contents of the file.
+        std::unique_ptr<char[]> buf(new char[size]);
+
+        configFile.readBytes(buf.get(), size);
+        StaticJsonDocument<800> jsonBuffer;
+        auto error = deserializeJson(jsonBuffer, buf.get());
+        if (error) {
+          Serial.print(F("deserializeJson() failed with code "));
+          Serial.println(error.c_str());
+          return;
+        } else {
+          Serial.println(F("deserializeJson() successful:"));
+
+          serializeJsonPretty(jsonBuffer, Serial);
+          Serial.println();
+
+          strcpy(matrixUsername, jsonBuffer["matrixUsername"]);
+          strcpy(matrixPassword, jsonBuffer["matrixPassword"]);
+          strcpy(matrixRoom, jsonBuffer["matrixRoom"]);
+          strcpy(matrixMessage, jsonBuffer["matrixMessage"]);
+        }
+        configFile.close();
+      }
+    }
+  } else {
+    Serial.println(F("failed to mount FS"));
+  }
+  //end read
+
+
+
+  // The extra parameters to be configured (can be either global or just in the setup)
+  // After connecting, parameter.getValue() will get you the configured value
+  // id/name placeholder/prompt default length
+  WiFiManagerParameter customMatrixUsername("Matrix username", "Matrix username", matrixUsername, 50);
+  WiFiManagerParameter customMatrixPassword("Matrix password", "Matrix password", matrixPassword, 50);
+  WiFiManagerParameter customMatrixRoom("Matrix room", "Matrix room", matrixRoom, 200);
+  WiFiManagerParameter customMatrixMessage("Matrix message", "Matrix message", matrixMessage, 500);
+
   //WiFiManager
   //Local intialization. Once its business is done, there is no need to keep it around
   //WiFiManager wifiManager;
   //reset settings - for testing
   //wifiManager.resetSettings();
 
-  //set callback that gets called when connecting to previous WiFi fails, and enters Access Point mode
+  //set callback that gets called when connecting to previous WiFi fails, and enters Access Point mode (for status LED)
   wifiManager.setAPCallback(configModeCallback);
 
+  //set config save notify callback
+  wifiManager.setSaveConfigCallback(saveConfigCallback);
+
+  //set static ip
+  //  wifiManager.setSTAStaticIPConfig(IPAddress(10,0,1,99), IPAddress(10,0,1,1), IPAddress(255,255,255,0));
+
+  //add all your parameters here
+  wifiManager.addParameter(&customMatrixUsername);
+  wifiManager.addParameter(&customMatrixPassword);
+  wifiManager.addParameter(&customMatrixRoom);
+  wifiManager.addParameter(&customMatrixMessage);
+
+  //reset settings - for testing
+  //wifiManager.resetSettings();
+
+  //set minimu quality of signal so it ignores AP's under that quality
+  //defaults to 8%
+  //wifiManager.setMinimumSignalQuality();
+
+  //sets timeout until configuration portal gets turned off
+  //useful to make it all retry or go to sleep
+  //in seconds
+  //wifiManager.setTimeout(120);
+
   //fetches ssid and pass and tries to connect
   //if it does not connect it starts an access point with the specified name
   //here  "AutoConnectAP"
   //and goes into a blocking loop awaiting configuration
   if (!wifiManager.autoConnect()) {
-    Serial.println("failed to connect and hit timeout");
+    Serial.println(F("failed to connect and hit timeout"));
+    delay(3000);
     //reset and try again, or maybe put it to deep sleep
     ESP.reset();
-    delay(1000);
+    delay(5000);
   }
 
   //if you get here you have connected to the WiFi
-  Serial.println("connected...yeey :)");
+  Serial.println(F("connected...yeey :)"));
   ticker.detach();
   //keep LED on
   digitalWrite(LED_PIN, LOW);
+
+  //read updated parameters
+  strcpy(matrixUsername, customMatrixUsername.getValue());
+  strcpy(matrixPassword, customMatrixPassword.getValue());
+  strcpy(matrixRoom, customMatrixRoom.getValue());
+  strcpy(matrixMessage, customMatrixMessage.getValue());
+
+  //save the custom parameters to FS
+  if (shouldSaveConfig) {
+    Serial.println(F("saving config"));
+    StaticJsonDocument<800> jsonBuffer;
+    jsonBuffer["matrixUsername"] = matrixUsername;
+    jsonBuffer["matrixPassword"] = matrixPassword;
+    jsonBuffer["matrixRoom"] = matrixRoom;
+    jsonBuffer["matrixMessage"] = matrixMessage;
+
+    File configFile = SPIFFS.open("/config.json", "w");
+    if (!configFile) {
+      Serial.println(F("failed to open config file for writing"));
+    }
+
+    serializeJson(jsonBuffer, Serial);
+    Serial.println();
+    serializeJson(jsonBuffer, configFile);
+    configFile.close();
+    //end save
+  }
+
+  Serial.println(F("local ip:"));
+  Serial.println(WiFi.localIP());
+
 }
 
 bool button_state = 0;
@@ -74,6 +207,7 @@ void loop() {
   button_state = digitalRead(BUTTON_PIN);
   if (button_state == 0) {
     wifiManager.resetSettings();
+    delay(500);
     ESP.reset();
   }
 }