Code split up cpp

src/config.cpp

@@ -0,0 +1,226 @@
+/*
+ * -------------------------------------------------------------------
+ * EmonESP Serial to Emoncms gateway
+ * -------------------------------------------------------------------
+ * Adaptation of Chris Howells OpenEVSE ESP Wifi
+ * by Trystan Lea, Glyn Hudson, OpenEnergyMonitor
+ * All adaptation GNU General Public License as below.
+ *
+ * -------------------------------------------------------------------
+ *
+ * This file is part of OpenEnergyMonitor.org project.
+ * EmonESP is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3, or (at your option)
+ * any later version.
+ * EmonESP is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with EmonESP; see the file COPYING.  If not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+#include "emonesp.h"
+#include "config.h"
+
+#include <Arduino.h>
+#include <EEPROM.h>                   // Save config settings
+
+// Wifi Network Strings
+String esid = "";
+String epass = "";
+
+// Web server authentication (leave blank for none)
+String www_username = "";
+String www_password = "";
+
+// EMONCMS SERVER strings
+String emoncms_server = "";
+String emoncms_node = "";
+String emoncms_apikey = "";
+String emoncms_fingerprint = "";
+
+// MQTT Settings
+String mqtt_server = "";
+String mqtt_topic = "";
+String mqtt_user = "";
+String mqtt_pass = "";
+String mqtt_feed_prefix = "";
+
+#define EEPROM_ESID_SIZE          32
+#define EEPROM_EPASS_SIZE         64
+#define EEPROM_EMON_API_KEY_SIZE  32
+#define EEPROM_EMON_SERVER_SIZE   45
+#define EEPROM_EMON_NODE_SIZE     32
+#define EEPROM_MQTT_SERVER_SIZE   45
+#define EEPROM_MQTT_TOPIC_SIZE    32
+#define EEPROM_MQTT_USER_SIZE     32
+#define EEPROM_MQTT_PASS_SIZE     64
+#define EEPROM_EMON_FINGERPRINT_SIZE  60
+#define EEPROM_MQTT_FEED_PREFIX_SIZE  10
+#define EEPROM_WWW_USER_SIZE      16
+#define EEPROM_WWW_PASS_SIZE      16
+#define EEPROM_SIZE 512
+
+#define EEPROM_ESID_START         0
+#define EEPROM_ESID_END           (EEPROM_ESID_START + EEPROM_ESID_SIZE)
+#define EEPROM_EPASS_START        EEPROM_ESID_END
+#define EEPROM_EPASS_END          (EEPROM_EPASS_START + EEPROM_EPASS_SIZE)
+#define EEPROM_EMON_API_KEY_START EEPROM_EPASS_END
+#define EEPROM_EMON_API_KEY_END   (EEPROM_EMON_API_KEY_START + EEPROM_EMON_API_KEY_SIZE)
+#define EEPROM_EMON_SERVER_START  EEPROM_EMON_API_KEY_END
+#define EEPROM_EMON_SERVER_END    (EEPROM_EMON_SERVER_START + EEPROM_EMON_SERVER_SIZE)
+#define EEPROM_EMON_NODE_START    EEPROM_EMON_SERVER_END
+#define EEPROM_EMON_NODE_END      (EEPROM_EMON_NODE_START + EEPROM_EMON_NODE_SIZE)
+#define EEPROM_MQTT_SERVER_START  EEPROM_EMON_NODE_END
+#define EEPROM_MQTT_SERVER_END    (EEPROM_MQTT_SERVER_START + EEPROM_MQTT_SERVER_SIZE)
+#define EEPROM_MQTT_TOPIC_START   EEPROM_MQTT_SERVER_END
+#define EEPROM_MQTT_TOPIC_END     (EEPROM_MQTT_TOPIC_START + EEPROM_MQTT_TOPIC_SIZE)
+#define EEPROM_MQTT_USER_START    EEPROM_MQTT_TOPIC_END
+#define EEPROM_MQTT_USER_END      (EEPROM_MQTT_USER_START + EEPROM_MQTT_USER_SIZE)
+#define EEPROM_MQTT_PASS_START    EEPROM_MQTT_USER_END
+#define EEPROM_MQTT_PASS_END      (EEPROM_MQTT_PASS_START + EEPROM_MQTT_PASS_SIZE)
+#define EEPROM_EMON_FINGERPRINT_START  EEPROM_MQTT_PASS_END
+#define EEPROM_EMON_FINGERPRINT_END    (EEPROM_EMON_FINGERPRINT_START + EEPROM_EMON_FINGERPRINT_SIZE)
+#define EEPROM_MQTT_FEED_PREFIX_START  EEPROM_EMON_FINGERPRINT_END
+#define EEPROM_MQTT_FEED_PREFIX_END    (EEPROM_MQTT_FEED_PREFIX_START + EEPROM_MQTT_FEED_PREFIX_SIZE)
+#define EEPROM_WWW_USER_START     EEPROM_MQTT_FEED_PREFIX_END
+#define EEPROM_WWW_USER_END       (EEPROM_WWW_USER_START + EEPROM_WWW_USER_SIZE)
+#define EEPROM_WWW_PASS_START     EEPROM_WWW_USER_END
+#define EEPROM_WWW_PASS_END       (EEPROM_WWW_PASS_START + EEPROM_WWW_PASS_SIZE)
+
+// -------------------------------------------------------------------
+// Reset EEPROM, wipes all settings
+// -------------------------------------------------------------------
+void ResetEEPROM(){
+  //DEBUG.println("Erasing EEPROM");
+  for (int i = 0; i < EEPROM_SIZE; ++i) {
+    EEPROM.write(i, 0);
+    //DEBUG.print("#");
+  }
+  EEPROM.commit();
+}
+
+void EEPROM_read_srting(int start, int count, String& val) {
+  for (int i = 0; i < count; ++i){
+    byte c = EEPROM.read(start+i);
+    if (c!=0 && c!=255) val += (char) c;
+  }
+}
+
+void EEPROM_write_string(int start, int count, String val) {
+  for (int i = 0; i < count; ++i){
+    if (i<val.length()) {
+      EEPROM.write(start+i, val[i]);
+    } else {
+      EEPROM.write(start+i, 0);
+    }
+  }
+}
+
+// -------------------------------------------------------------------
+// Load saved settings from EEPROM
+// -------------------------------------------------------------------
+void config_load_settings()
+{
+  EEPROM.begin(EEPROM_SIZE);
+
+  // Load WiFi values
+  EEPROM_read_srting(EEPROM_ESID_START, EEPROM_ESID_SIZE, esid);
+  EEPROM_read_srting(EEPROM_EPASS_START, EEPROM_EPASS_SIZE, epass);
+
+  // EmonCMS settings
+  EEPROM_read_srting(EEPROM_EMON_API_KEY_START, EEPROM_EMON_API_KEY_SIZE, emoncms_apikey);
+  EEPROM_read_srting(EEPROM_EMON_SERVER_START, EEPROM_EMON_SERVER_SIZE, emoncms_server);
+  EEPROM_read_srting(EEPROM_EMON_NODE_START, EEPROM_EMON_NODE_SIZE, emoncms_node);
+  EEPROM_read_srting(EEPROM_EMON_FINGERPRINT_START, EEPROM_EMON_FINGERPRINT_SIZE, emoncms_fingerprint);
+
+  // MQTT settings
+  EEPROM_read_srting(EEPROM_MQTT_SERVER_START, EEPROM_MQTT_SERVER_SIZE, mqtt_server);
+  EEPROM_read_srting(EEPROM_MQTT_TOPIC_START, EEPROM_MQTT_TOPIC_SIZE, mqtt_topic);
+  EEPROM_read_srting(EEPROM_MQTT_FEED_PREFIX_START, EEPROM_MQTT_FEED_PREFIX_SIZE, mqtt_feed_prefix);
+  EEPROM_read_srting(EEPROM_MQTT_USER_START, EEPROM_MQTT_USER_SIZE, mqtt_user);
+  EEPROM_read_srting(EEPROM_MQTT_PASS_START, EEPROM_MQTT_PASS_SIZE, mqtt_pass);
+
+  // Web server credentials
+  EEPROM_read_srting(EEPROM_WWW_USER_START, EEPROM_WWW_USER_SIZE, www_username);
+  EEPROM_read_srting(EEPROM_WWW_PASS_START, EEPROM_WWW_PASS_SIZE, www_password);
+}
+
+void config_save_emoncms(String server, String node, String apikey, String fingerprint)
+{
+  emoncms_server = server;
+  emoncms_node = node;
+  emoncms_apikey = apikey;
+  emoncms_fingerprint = fingerprint;
+
+  // save apikey to EEPROM
+  EEPROM_write_string(EEPROM_EMON_API_KEY_START, EEPROM_EMON_API_KEY_SIZE, emoncms_apikey);
+
+  // save emoncms server to EEPROM max 45 characters
+  EEPROM_write_string(EEPROM_EMON_SERVER_START, EEPROM_EMON_SERVER_SIZE, emoncms_server);
+
+  // save emoncms node to EEPROM max 32 characters
+  EEPROM_write_string(EEPROM_EMON_NODE_START, EEPROM_EMON_NODE_SIZE, emoncms_node);
+
+  // save emoncms HTTPS fingerprint to EEPROM max 60 characters
+  EEPROM_write_string(EEPROM_EMON_FINGERPRINT_START, EEPROM_EMON_FINGERPRINT_SIZE, emoncms_fingerprint);
+
+  EEPROM.commit();
+}
+
+void config_save_mqtt(String server, String topic, String prefix, String user, String pass)
+{
+  mqtt_server = server;
+  mqtt_topic = topic;
+  mqtt_feed_prefix = prefix;
+  mqtt_user = user;
+  mqtt_pass = pass;
+
+  // Save MQTT server max 45 characters
+  EEPROM_write_string(EEPROM_MQTT_SERVER_START, EEPROM_MQTT_SERVER_SIZE, mqtt_server);
+
+  // Save MQTT topic max 32 characters
+  EEPROM_write_string(EEPROM_MQTT_TOPIC_START, EEPROM_MQTT_TOPIC_SIZE, mqtt_topic);
+
+  // Save MQTT topic separator max 10 characters
+  EEPROM_write_string(EEPROM_MQTT_FEED_PREFIX_START, EEPROM_MQTT_FEED_PREFIX_SIZE, mqtt_feed_prefix);
+
+  // Save MQTT username max 32 characters
+  EEPROM_write_string(EEPROM_MQTT_USER_START, EEPROM_MQTT_USER_SIZE, mqtt_user);
+
+  // Save MQTT pass max 64 characters
+  EEPROM_write_string(EEPROM_MQTT_PASS_START, EEPROM_MQTT_PASS_SIZE, mqtt_pass);
+
+  EEPROM.commit();
+}
+
+void config_save_admin(String user, String pass)
+{
+  www_username = user;
+  www_password = pass;
+
+  EEPROM_write_string(EEPROM_WWW_USER_START, EEPROM_WWW_USER_SIZE, user);
+  EEPROM_write_string(EEPROM_WWW_PASS_START, EEPROM_WWW_PASS_SIZE, pass);
+
+  EEPROM.commit();
+}
+
+void config_save_wifi(String qsid, String qpass)
+{
+  esid = qsid;
+  epass = qpass;
+
+  EEPROM_write_string(EEPROM_ESID_START, EEPROM_ESID_SIZE, qsid);
+  EEPROM_write_string(EEPROM_EPASS_START, EEPROM_EPASS_SIZE, qpass);
+
+  EEPROM.commit();
+}
+
+void config_reset()
+{
+  ResetEEPROM();
+}

src/config.h

@@ -0,0 +1,91 @@
+/*
+ * -------------------------------------------------------------------
+ * EmonESP Serial to Emoncms gateway
+ * -------------------------------------------------------------------
+ * Adaptation of Chris Howells OpenEVSE ESP Wifi
+ * by Trystan Lea, Glyn Hudson, OpenEnergyMonitor
+ * All adaptation GNU General Public License as below.
+ *
+ * -------------------------------------------------------------------
+ *
+ * This file is part of OpenEnergyMonitor.org project.
+ * EmonESP is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3, or (at your option)
+ * any later version.
+ * EmonESP is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with EmonESP; see the file COPYING.  If not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+#ifndef _EMONESP_CONFIG_H
+#define _EMONESP_CONFIG_H
+
+#include <Arduino.h>
+
+// -------------------------------------------------------------------
+// Load and save the EmonESP config.
+//
+// This initial implementation saves the config to the EEPROM area of flash
+// -------------------------------------------------------------------
+
+// Global config varables
+
+// Wifi Network Strings
+extern String esid;
+extern String epass;
+
+// Web server authentication (leave blank for none)
+extern String www_username;
+extern String www_password;
+
+// EMONCMS SERVER strings
+extern String emoncms_server;
+extern String emoncms_node;
+extern String emoncms_apikey;
+extern String emoncms_fingerprint;
+
+// MQTT Settings
+extern String mqtt_server;
+extern String mqtt_topic;
+extern String mqtt_user;
+extern String mqtt_pass;
+extern String mqtt_feed_prefix;
+
+// -------------------------------------------------------------------
+// Load saved settings
+// -------------------------------------------------------------------
+extern void config_load_settings();
+
+// -------------------------------------------------------------------
+// Save the EmonCMS server details
+// -------------------------------------------------------------------
+extern void config_save_emoncms(String server, String node, String apikey, String fingerprint);
+
+// -------------------------------------------------------------------
+// Save the MQTT broker details
+// -------------------------------------------------------------------
+extern void config_save_mqtt(String server, String topic, String prefix, String user, String pass);
+
+// -------------------------------------------------------------------
+// Save the admin/web interface details
+// -------------------------------------------------------------------
+extern void config_save_admin(String user, String pass);
+
+// -------------------------------------------------------------------
+// Save the Wifi details
+// -------------------------------------------------------------------
+extern void config_save_wifi(String qsid, String qpass);
+
+
+// -------------------------------------------------------------------
+// Reset the config back to defaults
+// -------------------------------------------------------------------
+extern void config_reset();
+
+#endif // _EMONESP_CONFIG_H