prepare usage of boilerplate

This commit is contained in:
Wolfgang Hottgenroth 2019-04-25 16:28:00 +02:00
parent c4a5d45e6b
commit 965c2c6133
Signed by: wn
GPG Key ID: B586EAFCDF2F65F4
11 changed files with 4 additions and 697 deletions

3
.gitmodules vendored Normal file
View File

@ -0,0 +1,3 @@
[submodule "esp8266boilerplate"]
path = esp8266boilerplate
url = ../esp8266boilerplate.git

View File

@ -1,40 +0,0 @@
#!/usr/bin/python
from Cheetah.Template import Template
configItems = [
{"label":"_", "key":"magic", "type":"I", "default": ""},
{"label":"Config Username", "key":"confUser", "type":"C", "length":16, "default":"admin"},
{"label":"Config Password", "key":"confPasswd", "type":"C", "length":16, "default":"geheim123"},
{"label":"Wifi SSID", "key":"wifiSsid", "type":"C", "length":32, "default":"test"},
{"label":"Wifi Key", "key":"wifiKey", "type":"C", "length":64, "default":"geheim"},
{"label":"MQTT Broker", "key":"mqttBroker", "type":"C", "length":32, "default":"broker.hottis.de"},
{"label":"MQTT Username", "key":"mqttUser", "type":"C", "length":32, "default":"RgbLed1"},
{"label":"MQTT Password", "key":"mqttPass", "type":"C", "length":32, "default":"geheim123"},
{"label":"MQTT ClientId", "key":"mqttClientId", "type":"C", "length":32, "default":"RgbLed1"},
{"label":"MQTT Port", "key":"mqttPort", "type":"I", "default":8883},
{"label":"MQTT Topic Color Command", "key":"mqttTopicColorCommand", "type":"C", "length":64, "default":"IoT/RgbLed1/ColorCommand"},
{"label":"MQTT Topic Command", "key":"mqttTopicCommand", "type":"C", "length":64, "default":"IoT/RgbLed1/Command"},
{"label":"MQTT DebugTopic", "key":"mqttDebugTopic", "type":"C", "length":64, "default":"IoT/RgbLed1/Debug"},
{"label":"DebugMode", "key":"debugMode", "type":"I", "default":0}
]
magic = 0xC0DE0005
appName = "ESP8266 based TwoLedSignal"
confWifiSsid = "espconfig"
params = {
"magic":magic,
"appName":appName,
"confWifiSsid":confWifiSsid,
"configItems":configItems
}
h_file = Template(file="configuration_h.tmpl", searchList=[params])
open('configuration.h','w').write(str(h_file))
c_file = Template(file="configuration_c.tmpl", searchList=[params])
open('configuration.cpp','w').write(str(c_file))

View File

@ -1,153 +0,0 @@
#raw
#include <Arduino.h>
#include <ESP8266WiFi.h>
#include <ESP8266WebServer.h>
#include <EEPROM.h>
#include "defines.h"
#include "configuration.h"
#end raw
tConfigBlock configBlock;
const uint32_t MAGIC = $magic;
const char* CONFIG_SSID = "$confWifiSsid";
extern ESP8266WebServer webServer;
bool configSaved = false;
static bool checkAuthentication() {
Serial.print("User: "); Serial.println(configBlock.confUser);
Serial.print("Pass: "); Serial.println(configBlock.confPasswd);
return webServer.authenticate(configBlock.confUser, configBlock.confPasswd);
}
void configServeIndex() {
bool configValid = (configBlock.magic == MAGIC);
if (! configValid) {
configBlock.magic = MAGIC;
#for $configItem in $configItems
#if $configItem.label != "_"
#if $configItem.type == "C"
strcpy(configBlock.$configItem.key, "$configItem.default");
#else if $configItem.type == "I"
configBlock.$configItem.key = $configItem.default;
#end if
#end if
#end for
}
if (! checkAuthentication()) {
return webServer.requestAuthentication();
}
String buffer =
"<!doctype html"
"<html lang=\"en\">"
" <head>"
" <title>$appName</title>"
" </head>"
" <body>"
" <h1>$appName - ESP8266 Configuration Page</h1>";
if (configSaved) {
configSaved = false;
buffer += "<h2>Configuration saved</h2>";
}
buffer +=
" <form action=\"/config\" method=\"GET\">"
" <table>"
#for $configItem in $configItems
#if $configItem.label != "_"
" <tr>"
" <td>"
" <label for\"$configItem.key\">$configItem.label</label>"
" </td><td>"
" <input type=\"text\" name=\"$configItem.key\" id=\"$configItem.key\" ";
#if $configItem.type == "C"
buffer += " size=\"$configItem.length\" ";
buffer += " value=\"";
buffer += configBlock.$configItem.key;
buffer += "\"";
#else if $configItem.type == "I"
buffer += " value=\"";
buffer += configBlock.$configItem.key;
buffer += "\"";
#end if
buffer +=
" />"
" </td>"
" </tr>"
#end if
#end for
" <tr>"
" <td colspan=\"2\">"
" <button type=\"submit\">Save</button>"
" </td>"
" </tr>"
" </table>"
" </form>"
" </body>"
"</html>";
webServer.send(200, "text/html", buffer);
#ifdef DEBUG
Serial.println("indexHtml request served");
#endif
}
void configServeGetConfiguration() {
if (! checkAuthentication()) {
return webServer.requestAuthentication();
}
String arg;
#for $configItem in $configItems
#if $configItem.label != "_"
arg = webServer.arg("$configItem.key");
#if $configItem.type == "C"
strcpy(configBlock.$configItem.key, arg.c_str());
#else if $configItem.type == "I"
configBlock.$configItem.key = atoi(arg.c_str());
#end if
#end if
#end for
configBlock.magic = MAGIC;
showConfiguration();
EEPROM.begin(512);
EEPROM.put(EEPROM_ADDR, configBlock);
EEPROM.commit();
Serial.println("EEPROM saved");
configSaved = true;
webServer.sendHeader("Location", String("/"), true);
webServer.send(302, "text/plain", "");
//webServer.send(200, "text/html", "configuration saved");
}
void showConfiguration() {
Serial.println("Configuration is");
#for $configItem in $configItems
Serial.print("$configItem.key = <");
Serial.print(configBlock.$configItem.key);
Serial.println(">");
#end for
Serial.println("---");
}

View File

@ -1,17 +0,0 @@
typedef struct {
#for $configItem in $configItems
#if $configItem.type == 'C'
char ${configItem.key}[$configItem.length];
#else if $configItem.type == 'I'
uint32_t $configItem.key;
#end if
#end for
} tConfigBlock;
extern const uint32_t MAGIC;
extern tConfigBlock configBlock;
extern const char* CONFIG_SSID;
void configServeIndex();
void configServeGetConfiguration();
void showConfiguration();

View File

@ -1,389 +0,0 @@
#include <Arduino.h>
#include <ESP8266WiFi.h>
#include <ESP8266WebServer.h>
#include <EEPROM.h>
#include "defines.h"
#include "configuration.h"
tConfigBlock configBlock;
const uint32_t MAGIC = 3235774471;
const char* CONFIG_SSID = "espconfig";
extern ESP8266WebServer webServer;
bool configSaved = false;
static bool checkAuthentication() {
Serial.print("User: "); Serial.println(configBlock.confUser);
Serial.print("Pass: "); Serial.println(configBlock.confPasswd);
return webServer.authenticate(configBlock.confUser, configBlock.confPasswd);
}
void configServeIndex() {
bool configValid = (configBlock.magic == MAGIC);
if (! configValid) {
configBlock.magic = MAGIC;
strcpy(configBlock.confUser, "admin");
strcpy(configBlock.confPasswd, "geheim123");
strcpy(configBlock.wifiSsid, "test");
strcpy(configBlock.wifiKey, "geheim");
strcpy(configBlock.mqttBroker, "broker.hottis.de");
strcpy(configBlock.mqttUser, "RgbLed1");
strcpy(configBlock.mqttPass, "geheim123");
strcpy(configBlock.mqttClientId, "RgbLed1");
configBlock.mqttPort = 8883;
strcpy(configBlock.mqttTopicColorCommand, "IoT/RgbLed1/ColorCommand");
strcpy(configBlock.mqttTopicCommand, "IoT/RgbLed1/Command");
strcpy(configBlock.mqttDebugTopic, "IoT/RgbLed1/Debug");
configBlock.debugMode = 0;
}
if (! checkAuthentication()) {
return webServer.requestAuthentication();
}
String buffer =
"<!doctype html"
"<html lang=\"en\">"
" <head>"
" <title>ESP8266 based TwoLedSignal</title>"
" </head>"
" <body>"
" <h1>ESP8266 based TwoLedSignal - ESP8266 Configuration Page</h1>";
if (configSaved) {
configSaved = false;
buffer += "<h2>Configuration saved</h2>";
}
buffer +=
" <form action=\"/config\" method=\"GET\">"
" <table>"
" <tr>"
" <td>"
" <label for\"confUser\">Config Username</label>"
" </td><td>"
" <input type=\"text\" name=\"confUser\" id=\"confUser\" ";
buffer += " size=\"16\" ";
buffer += " value=\"";
buffer += configBlock.confUser;
buffer += "\"";
buffer +=
" />"
" </td>"
" </tr>"
" <tr>"
" <td>"
" <label for\"confPasswd\">Config Password</label>"
" </td><td>"
" <input type=\"text\" name=\"confPasswd\" id=\"confPasswd\" ";
buffer += " size=\"16\" ";
buffer += " value=\"";
buffer += configBlock.confPasswd;
buffer += "\"";
buffer +=
" />"
" </td>"
" </tr>"
" <tr>"
" <td>"
" <label for\"wifiSsid\">Wifi SSID</label>"
" </td><td>"
" <input type=\"text\" name=\"wifiSsid\" id=\"wifiSsid\" ";
buffer += " size=\"32\" ";
buffer += " value=\"";
buffer += configBlock.wifiSsid;
buffer += "\"";
buffer +=
" />"
" </td>"
" </tr>"
" <tr>"
" <td>"
" <label for\"wifiKey\">Wifi Key</label>"
" </td><td>"
" <input type=\"text\" name=\"wifiKey\" id=\"wifiKey\" ";
buffer += " size=\"64\" ";
buffer += " value=\"";
buffer += configBlock.wifiKey;
buffer += "\"";
buffer +=
" />"
" </td>"
" </tr>"
" <tr>"
" <td>"
" <label for\"mqttBroker\">MQTT Broker</label>"
" </td><td>"
" <input type=\"text\" name=\"mqttBroker\" id=\"mqttBroker\" ";
buffer += " size=\"32\" ";
buffer += " value=\"";
buffer += configBlock.mqttBroker;
buffer += "\"";
buffer +=
" />"
" </td>"
" </tr>"
" <tr>"
" <td>"
" <label for\"mqttUser\">MQTT Username</label>"
" </td><td>"
" <input type=\"text\" name=\"mqttUser\" id=\"mqttUser\" ";
buffer += " size=\"32\" ";
buffer += " value=\"";
buffer += configBlock.mqttUser;
buffer += "\"";
buffer +=
" />"
" </td>"
" </tr>"
" <tr>"
" <td>"
" <label for\"mqttPass\">MQTT Password</label>"
" </td><td>"
" <input type=\"text\" name=\"mqttPass\" id=\"mqttPass\" ";
buffer += " size=\"32\" ";
buffer += " value=\"";
buffer += configBlock.mqttPass;
buffer += "\"";
buffer +=
" />"
" </td>"
" </tr>"
" <tr>"
" <td>"
" <label for\"mqttClientId\">MQTT ClientId</label>"
" </td><td>"
" <input type=\"text\" name=\"mqttClientId\" id=\"mqttClientId\" ";
buffer += " size=\"32\" ";
buffer += " value=\"";
buffer += configBlock.mqttClientId;
buffer += "\"";
buffer +=
" />"
" </td>"
" </tr>"
" <tr>"
" <td>"
" <label for\"mqttPort\">MQTT Port</label>"
" </td><td>"
" <input type=\"text\" name=\"mqttPort\" id=\"mqttPort\" ";
buffer += " value=\"";
buffer += configBlock.mqttPort;
buffer += "\"";
buffer +=
" />"
" </td>"
" </tr>"
" <tr>"
" <td>"
" <label for\"mqttTopicColorCommand\">MQTT Topic Color Command</label>"
" </td><td>"
" <input type=\"text\" name=\"mqttTopicColorCommand\" id=\"mqttTopicColorCommand\" ";
buffer += " size=\"64\" ";
buffer += " value=\"";
buffer += configBlock.mqttTopicColorCommand;
buffer += "\"";
buffer +=
" />"
" </td>"
" </tr>"
" <tr>"
" <td>"
" <label for\"mqttTopicCommand\">MQTT Topic Command</label>"
" </td><td>"
" <input type=\"text\" name=\"mqttTopicCommand\" id=\"mqttTopicCommand\" ";
buffer += " size=\"64\" ";
buffer += " value=\"";
buffer += configBlock.mqttTopicCommand;
buffer += "\"";
buffer +=
" />"
" </td>"
" </tr>"
" <tr>"
" <td>"
" <label for\"mqttDebugTopic\">MQTT DebugTopic</label>"
" </td><td>"
" <input type=\"text\" name=\"mqttDebugTopic\" id=\"mqttDebugTopic\" ";
buffer += " size=\"64\" ";
buffer += " value=\"";
buffer += configBlock.mqttDebugTopic;
buffer += "\"";
buffer +=
" />"
" </td>"
" </tr>"
" <tr>"
" <td>"
" <label for\"debugMode\">DebugMode</label>"
" </td><td>"
" <input type=\"text\" name=\"debugMode\" id=\"debugMode\" ";
buffer += " value=\"";
buffer += configBlock.debugMode;
buffer += "\"";
buffer +=
" />"
" </td>"
" </tr>"
" <tr>"
" <td colspan=\"2\">"
" <button type=\"submit\">Save</button>"
" </td>"
" </tr>"
" </table>"
" </form>"
" </body>"
"</html>";
webServer.send(200, "text/html", buffer);
#ifdef DEBUG
Serial.println("indexHtml request served");
#endif
}
void configServeGetConfiguration() {
if (! checkAuthentication()) {
return webServer.requestAuthentication();
}
String arg;
arg = webServer.arg("confUser");
strcpy(configBlock.confUser, arg.c_str());
arg = webServer.arg("confPasswd");
strcpy(configBlock.confPasswd, arg.c_str());
arg = webServer.arg("wifiSsid");
strcpy(configBlock.wifiSsid, arg.c_str());
arg = webServer.arg("wifiKey");
strcpy(configBlock.wifiKey, arg.c_str());
arg = webServer.arg("mqttBroker");
strcpy(configBlock.mqttBroker, arg.c_str());
arg = webServer.arg("mqttUser");
strcpy(configBlock.mqttUser, arg.c_str());
arg = webServer.arg("mqttPass");
strcpy(configBlock.mqttPass, arg.c_str());
arg = webServer.arg("mqttClientId");
strcpy(configBlock.mqttClientId, arg.c_str());
arg = webServer.arg("mqttPort");
configBlock.mqttPort = atoi(arg.c_str());
arg = webServer.arg("mqttTopicColorCommand");
strcpy(configBlock.mqttTopicColorCommand, arg.c_str());
arg = webServer.arg("mqttTopicCommand");
strcpy(configBlock.mqttTopicCommand, arg.c_str());
arg = webServer.arg("mqttDebugTopic");
strcpy(configBlock.mqttDebugTopic, arg.c_str());
arg = webServer.arg("debugMode");
configBlock.debugMode = atoi(arg.c_str());
configBlock.magic = MAGIC;
showConfiguration();
EEPROM.begin(512);
EEPROM.put(EEPROM_ADDR, configBlock);
EEPROM.commit();
Serial.println("EEPROM saved");
configSaved = true;
webServer.sendHeader("Location", String("/"), true);
webServer.send(302, "text/plain", "");
//webServer.send(200, "text/html", "configuration saved");
}
void showConfiguration() {
Serial.println("Configuration is");
Serial.print("magic = <");
Serial.print(configBlock.magic);
Serial.println(">");
Serial.print("confUser = <");
Serial.print(configBlock.confUser);
Serial.println(">");
Serial.print("confPasswd = <");
Serial.print(configBlock.confPasswd);
Serial.println(">");
Serial.print("wifiSsid = <");
Serial.print(configBlock.wifiSsid);
Serial.println(">");
Serial.print("wifiKey = <");
Serial.print(configBlock.wifiKey);
Serial.println(">");
Serial.print("mqttBroker = <");
Serial.print(configBlock.mqttBroker);
Serial.println(">");
Serial.print("mqttUser = <");
Serial.print(configBlock.mqttUser);
Serial.println(">");
Serial.print("mqttPass = <");
Serial.print(configBlock.mqttPass);
Serial.println(">");
Serial.print("mqttClientId = <");
Serial.print(configBlock.mqttClientId);
Serial.println(">");
Serial.print("mqttPort = <");
Serial.print(configBlock.mqttPort);
Serial.println(">");
Serial.print("mqttTopicColorCommand = <");
Serial.print(configBlock.mqttTopicColorCommand);
Serial.println(">");
Serial.print("mqttTopicCommand = <");
Serial.print(configBlock.mqttTopicCommand);
Serial.println(">");
Serial.print("mqttDebugTopic = <");
Serial.print(configBlock.mqttDebugTopic);
Serial.println(">");
Serial.print("debugMode = <");
Serial.print(configBlock.debugMode);
Serial.println(">");
Serial.println("---");
}

View File

@ -1,24 +0,0 @@
typedef struct {
uint32_t magic;
char confUser[16];
char confPasswd[16];
char wifiSsid[32];
char wifiKey[64];
char mqttBroker[32];
char mqttUser[32];
char mqttPass[32];
char mqttClientId[32];
uint32_t mqttPort;
char mqttTopicColorCommand[64];
char mqttTopicCommand[64];
char mqttDebugTopic[64];
uint32_t debugMode;
} tConfigBlock;
extern const uint32_t MAGIC;
extern tConfigBlock configBlock;
extern const char* CONFIG_SSID;
void configServeIndex();
void configServeGetConfiguration();
void showConfiguration();

View File

@ -1,56 +0,0 @@
/*
* configurationMode.cpp
*
* Created on: Aug 20, 2017
* Author: wn
*/
#include "defines.h"
#include <ESP8266WiFi.h>
#include <ESP8266WebServer.h>
#include <PubSubClient.h>
#include <EEPROM.h>
#include "configurationMode.h"
#include "configuration.h"
ESP8266WebServer webServer(80);
void configServeNotFound() {
webServer.send(404, "text/plain", "page not found");
#ifdef DEBUG
Serial.println("page not found served");
#endif
}
void setupConfigurationNetwork() {
WiFi.mode(WIFI_AP);
WiFi.softAP(CONFIG_SSID);
#ifdef DEBUG
Serial.println("AP started");
#endif
}
void setupConfigurationServer() {
webServer.on("/", configServeIndex);
webServer.on("/config", configServeGetConfiguration);
webServer.onNotFound(configServeNotFound);
webServer.begin();
#ifdef DEBUG
Serial.println("Webserver started");
#endif
}
void loopConfiguration() {
webServer.handleClient();
}

View File

@ -1,18 +0,0 @@
/*
* configurationMode.h
*
* Created on: Aug 20, 2017
* Author: wn
*/
#ifndef CONFIGURATIONMODE_H_
#define CONFIGURATIONMODE_H_
void setupConfigurationNetwork();
void setupConfigurationServer();
void loopConfiguration();
#endif /* CONFIGURATIONMODE_H_ */

1
esp8266boilerplate Submodule

@ -0,0 +1 @@
Subproject commit 28b32656aa94ebe02b3e48db614cde552fa16957