lbsadmin
/
ESPUI
mirror of https://github.com/s00500/ESPUI.git
1
0
Fork 0
Code Issues Releases Activity

Use DEBUG_ESPUI to en/disable debug code from being compiled 

Include clang-format file for formatting code and format code
This commit is contained in:
Moritz Wirger 2020-09-28 10:40:31 +02:00
parent db4164f621
commit 1e5ee117c5
3 changed files with 1216 additions and 999 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
.clang-format Executable file
View File

@ -0,0 +1,58 @@
---
# Based on Webkit style
BasedOnStyle: Webkit
IndentWidth: 4
ColumnLimit: 120
---
Language: Cpp
Standard: Cpp11
# Pointers aligned to the left
DerivePointerAlignment: false
PointerAlignment: Left
AccessModifierOffset: -4
AllowShortFunctionsOnASingleLine: Inline
AlwaysBreakTemplateDeclarations: true
BreakBeforeBraces: Custom
BraceWrapping:
AfterClass: true
AfterControlStatement: true
AfterEnum: true
AfterFunction: true
AfterNamespace: true
AfterStruct: true
AfterUnion: true
AfterExternBlock: true
BeforeCatch: true
BeforeElse: true
SplitEmptyFunction: false
SplitEmptyRecord: false
SplitEmptyNamespace: false
BreakConstructorInitializers: BeforeColon
CompactNamespaces: false
ConstructorInitializerAllOnOneLineOrOnePerLine: true
ConstructorInitializerIndentWidth: 4
Cpp11BracedListStyle: true
FixNamespaceComments: true
IncludeBlocks: Regroup
IncludeCategories:
# C++ standard headers (no .h)
- Regex: '<[[:alnum:]_-]+>'
Priority: 1
# Extenal libraries (with .h)
- Regex: '<[[:alnum:]_./-]+>'
Priority: 2
# Headers from same folder
- Regex: '"[[:alnum:]_.-]+"'
Priority: 3
# Headers from other folders
- Regex: '"[[:alnum:]_/.-]+"'
Priority: 4
IndentCaseLabels: false
NamespaceIndentation: All
SortIncludes: true
SortUsingDeclarations: true
SpaceAfterTemplateKeyword: true
SpacesInAngles: false
SpacesInParentheses: false
SpacesInSquareBrackets: false
UseTab: Never

209
src/ESPUI.cpp
View File

@ -1,18 +1,16 @@
#include "ESPUI.h" #include <functional>
#include "dataIndexHTML.h"
#include "dataNormalizeCSS.h"
#include "dataStyleCSS.h"
#include "dataControlsJS.h"
#include "dataGraphJS.h"
#include "dataSliderJS.h"
#include "dataTabbedcontentJS.h"
#include "dataZeptoJS.h"
#include <ESPAsyncWebServer.h> #include <ESPAsyncWebServer.h>
#include <functional>
#include "ESPUI.h"
#include "dataControlsJS.h"
#include "dataGraphJS.h"
#include "dataIndexHTML.h"
#include "dataNormalizeCSS.h"
#include "dataSliderJS.h"
#include "dataStyleCSS.h"
#include "dataTabbedcontentJS.h"
#include "dataZeptoJS.h"
uint16_t Control::idCounter = 0; uint16_t Control::idCounter = 0;
@ -20,29 +18,35 @@ uint16_t Control::idCounter = 0;
#if defined(ESP32) #if defined(ESP32)
void listDir(const char* dirname, uint8_t levels) void listDir(const char* dirname, uint8_t levels)
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.printf_P(F("Listing directory: %s\n"), dirname); Serial.printf_P(F("Listing directory: %s\n"), dirname);
} }
#endif
File root = LittleFS.open(dirname); File root = LittleFS.open(dirname);
if (!root) if (!root)
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.println(F("Failed to open directory")); Serial.println(F("Failed to open directory"));
} }
#endif
return; return;
} }
if (!root.isDirectory()) if (!root.isDirectory())
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.println(F("Not a directory")); Serial.println(F("Not a directory"));
} }
#endif
return; return;
} }
@ -53,11 +57,13 @@ void listDir(const char *dirname, uint8_t levels)
{ {
if (file.isDirectory()) if (file.isDirectory())
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.print(F(" DIR : ")); Serial.print(F(" DIR : "));
Serial.println(file.name()); Serial.println(file.name());
} }
#endif
if (levels) if (levels)
{ {
@ -66,6 +72,7 @@ void listDir(const char *dirname, uint8_t levels)
} }
else else
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.print(F(" FILE: ")); Serial.print(F(" FILE: "));
@ -73,6 +80,7 @@ void listDir(const char *dirname, uint8_t levels)
Serial.print(F(" SIZE: ")); Serial.print(F(" SIZE: "));
Serial.println(file.size()); Serial.println(file.size());
} }
#endif
} }
file = root.openNextFile(); file = root.openNextFile();
@ -125,57 +133,71 @@ void ESPUIClass::list()
void deleteFile(const char* path) void deleteFile(const char* path)
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.print(LittleFS.exists(path)); Serial.print(LittleFS.exists(path));
} }
#endif
if (!LittleFS.exists(path)) if (!LittleFS.exists(path))
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.printf_P(PSTR("File: %s does not exist, not deleting\n"), path); Serial.printf_P(PSTR("File: %s does not exist, not deleting\n"), path);
} }
#endif
return; return;
} }
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.printf_P(PSTR("Deleting file: %s\n"), path); Serial.printf_P(PSTR("Deleting file: %s\n"), path);
} }
#endif
if (LittleFS.remove(path)) if (LittleFS.remove(path))
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.println(F("File deleted")); Serial.println(F("File deleted"));
} }
#endif
} }
else else
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.println(F("Delete failed")); Serial.println(F("Delete failed"));
} }
#endif
} }
} }
void writeFile(const char* path, const char* data) void writeFile(const char* path, const char* data)
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.printf_P(PSTR("Writing file: %s\n"), path); Serial.printf_P(PSTR("Writing file: %s\n"), path);
} }
#endif
File file = LittleFS.open(path, FILE_WRITE); File file = LittleFS.open(path, FILE_WRITE);
if (!file) if (!file)
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.println(F("Failed to open file for writing")); Serial.println(F("Failed to open file for writing"));
} }
#endif
return; return;
} }
@ -184,34 +206,42 @@ void writeFile(const char *path, const char *data)
if (file.print(data)) if (file.print(data))
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.println(F("File written")); Serial.println(F("File written"));
} }
#endif
} }
else else
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.println(F("Write failed")); Serial.println(F("Write failed"));
} }
#endif
} }
#else #else
if (file.print(FPSTR(data))) if (file.print(FPSTR(data)))
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.println(F("File written")); Serial.println(F("File written"));
} }
#endif
} }
else else
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.println(F("Write failed")); Serial.println(F("Write failed"));
} }
#endif
} }
#endif #endif
@ -224,38 +254,46 @@ void ESPUIClass::prepareFileSystem()
{ {
// this function should only be used once // this function should only be used once
#if defined(DEBUG_ESPUI)
if (this->verbosity) if (this->verbosity)
{ {
Serial.println(F("About to prepare filesystem...")); Serial.println(F("About to prepare filesystem..."));
} }
#endif
#if defined(ESP32) #if defined(ESP32)
LittleFS.format(); LittleFS.format();
if (!LittleFS.begin(true)) if (!LittleFS.begin(true))
{ {
#if defined(DEBUG_ESPUI)
if (this->verbosity) if (this->verbosity)
{ {
Serial.println(F("SPIFFS Mount Failed")); Serial.println(F("SPIFFS Mount Failed"));
} }
#endif
return; return;
} }
#if defined(DEBUG_ESPUI)
if (this->verbosity) if (this->verbosity)
{ {
listDir("/", 1); listDir("/", 1);
Serial.println(F("SPIFFS Mount ESP32 Done")); Serial.println(F("SPIFFS Mount ESP32 Done"));
} }
#endif
#else #else
LittleFS.format(); LittleFS.format();
LittleFS.begin(); LittleFS.begin();
#if defined(DEBUG_ESPUI)
if (this->verbosity) if (this->verbosity)
{ {
Serial.println(F("SPIFFS Mount ESP8266 Done")); Serial.println(F("SPIFFS Mount ESP8266 Done"));
} }
#endif
#endif #endif
@ -270,10 +308,12 @@ void ESPUIClass::prepareFileSystem()
deleteFile("/js/graph.js"); deleteFile("/js/graph.js");
deleteFile("/js/tabbedcontent.js"); deleteFile("/js/tabbedcontent.js");
#if defined(DEBUG_ESPUI)
if (this->verbosity) if (this->verbosity)
{ {
Serial.println(F("Cleanup done")); Serial.println(F("Cleanup done"));
} }
#endif
// Now write // Now write
writeFile("/index.htm", HTML_INDEX); writeFile("/index.htm", HTML_INDEX);
@ -288,17 +328,21 @@ void ESPUIClass::prepareFileSystem()
writeFile("/js/tabbedcontent.js", JS_TABBEDCONTENT); writeFile("/js/tabbedcontent.js", JS_TABBEDCONTENT);
#if defined(DEBUG_ESPUI)
if (this->verbosity) if (this->verbosity)
{ {
Serial.println(F("Done Initializing filesystem :-)")); Serial.println(F("Done Initializing filesystem :-)"));
} }
#endif
#if defined(ESP32) #if defined(ESP32)
#if defined(DEBUG_ESPUI)
if (this->verbosity) if (this->verbosity)
{ {
listDir("/", 1); listDir("/", 1);
} }
#endif
#endif #endif
@ -306,54 +350,65 @@ void ESPUIClass::prepareFileSystem()
} }
// Handle Websockets Communication // Handle Websockets Communication
void onWsEvent(AsyncWebSocket *server, AsyncWebSocketClient *client, AwsEventType type, void *arg, uint8_t *data, size_t len) void onWsEvent(
AsyncWebSocket* server, AsyncWebSocketClient* client, AwsEventType type, void* arg, uint8_t* data, size_t len)
{ {
switch (type) switch (type)
{ {
case WS_EVT_DISCONNECT: case WS_EVT_DISCONNECT:
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.print(F("Disconnected!\n")); Serial.print(F("Disconnected!\n"));
} }
#endif
break; break;
} }
case WS_EVT_PONG: case WS_EVT_PONG:
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.print(F("Received PONG!\n")); Serial.print(F("Received PONG!\n"));
} }
#endif
break; break;
} }
case WS_EVT_ERROR: case WS_EVT_ERROR:
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.print(F("WebSocket Error!\n")); Serial.print(F("WebSocket Error!\n"));
} }
#endif
break; break;
} }
case WS_EVT_CONNECT: case WS_EVT_CONNECT:
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.print(F("Connected: ")); Serial.print(F("Connected: "));
Serial.println(client->id()); Serial.println(client->id());
} }
#endif
ESPUI.jsonDom(client); ESPUI.jsonDom(client);
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.println(F("JSON Data Sent to Client!")); Serial.println(F("JSON Data Sent to Client!"));
} }
#endif
} }
break; break;
@ -369,6 +424,7 @@ void onWsEvent(AsyncWebSocket *server, AsyncWebSocketClient *client, AwsEventTyp
uint16_t id = msg.substring(msg.lastIndexOf(':') + 1).toInt(); uint16_t id = msg.substring(msg.lastIndexOf(':') + 1).toInt();
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity >= Verbosity::VerboseJSON) if (ESPUI.verbosity >= Verbosity::VerboseJSON)
{ {
Serial.print(F("WS rec: ")); Serial.print(F("WS rec: "));
@ -376,27 +432,32 @@ void onWsEvent(AsyncWebSocket *server, AsyncWebSocketClient *client, AwsEventTyp
Serial.print(F("WS recognised ID: ")); Serial.print(F("WS recognised ID: "));
Serial.println(id); Serial.println(id);
} }
#endif
Control* c = ESPUI.getControl(id); Control* c = ESPUI.getControl(id);
if (c == nullptr) if (c == nullptr)
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.print(F("No control found for ID ")); Serial.print(F("No control found for ID "));
Serial.println(id); Serial.println(id);
} }
#endif
return; return;
} }
if (c->callback == nullptr) if (c->callback == nullptr)
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.print(F("No callback found for ID ")); Serial.print(F("No callback found for ID "));
Serial.println(id); Serial.println(id);
} }
#endif
return; return;
} }
@ -487,10 +548,12 @@ void onWsEvent(AsyncWebSocket *server, AsyncWebSocketClient *client, AwsEventTyp
} }
else else
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.println(F("Malformated message from the websocket")); Serial.println(F("Malformated message from the websocket"));
} }
#endif
} }
} }
break; break;
@ -500,8 +563,8 @@ void onWsEvent(AsyncWebSocket *server, AsyncWebSocketClient *client, AwsEventTyp
} }
} }
uint16_t ESPUIClass::addControl(ControlType type, const char *label, const String& value, ControlColor color, uint16_t parentControl, uint16_t ESPUIClass::addControl(ControlType type, const char* label, const String& value, ControlColor color,
void (*callback)(Control *, int)) uint16_t parentControl, void (*callback)(Control*, int))
{ {
Control* control = new Control(type, label, callback, value, color, parentControl); Control* control = new Control(type, label, callback, value, color, parentControl);
@ -571,11 +634,18 @@ bool ESPUIClass::removeControl(uint16_t id, bool force_reload_ui)
return false; return false;
} }
uint16_t ESPUIClass::label(const char *label, ControlColor color, const String& value) { return addControl(ControlType::Label, label, value, color); } uint16_t ESPUIClass::label(const char* label, ControlColor color, const String& value)
{
return addControl(ControlType::Label, label, value, color);
}
uint16_t ESPUIClass::graph(const char *label, ControlColor color) { return addControl(ControlType::Graph, label, "", color); } uint16_t ESPUIClass::graph(const char* label, ControlColor color)
{
return addControl(ControlType::Graph, label, "", color);
}
uint16_t ESPUIClass::slider(const char *label, void (*callback)(Control *, int), ControlColor color, int value, int min, int max) uint16_t ESPUIClass::slider(
const char* label, void (*callback)(Control*, int), ControlColor color, int value, int min, int max)
{ {
uint16_t sliderId = addControl(ControlType::Slider, label, String(value), color, Control::noParent, callback); uint16_t sliderId = addControl(ControlType::Slider, label, String(value), color, Control::noParent, callback);
addControl(ControlType::Min, label, String(min), ControlColor::None, sliderId); addControl(ControlType::Min, label, String(min), ControlColor::None, sliderId);
@ -603,7 +673,8 @@ uint16_t ESPUIClass::padWithCenter(const char *label, void (*callback)(Control *
return addControl(ControlType::PadWithCenter, label, "", color, Control::noParent, callback); return addControl(ControlType::PadWithCenter, label, "", color, Control::noParent, callback);
} }
uint16_t ESPUIClass::number(const char *label, void (*callback)(Control *, int), ControlColor color, int number, int min, int max) uint16_t ESPUIClass::number(
const char* label, void (*callback)(Control*, int), ControlColor color, int number, int min, int max)
{ {
uint16_t numberId = addControl(ControlType::Number, label, String(number), color, Control::noParent, callback); uint16_t numberId = addControl(ControlType::Number, label, String(number), color, Control::noParent, callback);
addControl(ControlType::Min, label, String(min), ControlColor::None, numberId); addControl(ControlType::Min, label, String(min), ControlColor::None, numberId);
@ -663,17 +734,21 @@ void ESPUIClass::updateControl(Control *control, int clientId)
root["color"] = (int)control->color; root["color"] = (int)control->color;
serializeJson(document, json); serializeJson(document, json);
#if defined(DEBUG_ESPUI)
if (this->verbosity >= Verbosity::VerboseJSON) if (this->verbosity >= Verbosity::VerboseJSON)
{ {
Serial.println(json); Serial.println(json);
} }
#endif
if (clientId < 0) if (clientId < 0)
{ {
#if defined(DEBUG_ESPUI)
if (this->verbosity >= Verbosity::VerboseJSON) if (this->verbosity >= Verbosity::VerboseJSON)
{ {
Serial.println(F("TextAll")); Serial.println(F("TextAll"));
} }
#endif
this->ws->textAll(json); this->ws->textAll(json);
return; return;
} }
@ -703,10 +778,12 @@ void ESPUIClass::updateControl(uint16_t id, int clientId)
if (!control) if (!control)
{ {
#if defined(DEBUG_ESPUI)
if (this->verbosity) if (this->verbosity)
{ {
Serial.printf_P(PSTR("Error: There is no control with ID %d"), id); Serial.printf_P(PSTR("Error: There is no control with ID %d"), id);
} }
#endif
return; return;
} }
@ -730,31 +807,57 @@ void ESPUIClass::updateControlValue(uint16_t id, const String& value, int client
if (!control) if (!control)
{ {
#if defined(DEBUG_ESPUI)
if (this->verbosity) if (this->verbosity)
{ {
Serial.printf_P(PSTR("Error: There is no control with ID %d"), id); Serial.printf_P(PSTR("Error: There is no control with ID %d"), id);
} }
#endif
return; return;
} }
updateControlValue(control, value, clientId); updateControlValue(control, value, clientId);
} }
void ESPUIClass::print(uint16_t id, const String& value) { updateControlValue(id, value); } void ESPUIClass::print(uint16_t id, const String& value)
{
updateControlValue(id, value);
}
void ESPUIClass::updateLabel(uint16_t id, const String& value) { updateControlValue(id, value); } void ESPUIClass::updateLabel(uint16_t id, const String& value)
{
updateControlValue(id, value);
}
void ESPUIClass::updateSlider(uint16_t id, int nValue, int clientId) { updateControlValue(id, String(nValue), clientId); } void ESPUIClass::updateSlider(uint16_t id, int nValue, int clientId)
{
updateControlValue(id, String(nValue), clientId);
}
void ESPUIClass::updateSwitcher(uint16_t id, bool nValue, int clientId) { updateControlValue(id, String(nValue ? "1" : "0"), clientId); } void ESPUIClass::updateSwitcher(uint16_t id, bool nValue, int clientId)
{
updateControlValue(id, String(nValue ? "1" : "0"), clientId);
}
void ESPUIClass::updateNumber(uint16_t id, int number, int clientId) { updateControlValue(id, String(number), clientId); } void ESPUIClass::updateNumber(uint16_t id, int number, int clientId)
{
updateControlValue(id, String(number), clientId);
}
void ESPUIClass::updateText(uint16_t id, const String& text, int clientId) { updateControlValue(id, text, clientId); } void ESPUIClass::updateText(uint16_t id, const String& text, int clientId)
{
updateControlValue(id, text, clientId);
}
void ESPUIClass::updateSelect(uint16_t id, const String& text, int clientId) { updateControlValue(id, text, clientId); } void ESPUIClass::updateSelect(uint16_t id, const String& text, int clientId)
{
updateControlValue(id, text, clientId);
}
void ESPUIClass::updateGauge(uint16_t id, int number, int clientId) { updateControlValue(id, String(number), clientId); } void ESPUIClass::updateGauge(uint16_t id, int number, int clientId)
{
updateControlValue(id, String(number), clientId);
}
void ESPUIClass::clearGraph(uint16_t id, int clientId) {} void ESPUIClass::clearGraph(uint16_t id, int clientId) {}
@ -775,10 +878,12 @@ void ESPUIClass::addGraphPoint(uint16_t id, int nValue, int clientId)
root["id"] = control->id; root["id"] = control->id;
serializeJson(document, json); serializeJson(document, json);
#if defined(DEBUG_ESPUI)
if (this->verbosity >= Verbosity::VerboseJSON) if (this->verbosity >= Verbosity::VerboseJSON)
{ {
Serial.println(json); Serial.println(json);
} }
#endif
if (clientId < 0) if (clientId < 0)
{ {
@ -797,10 +902,12 @@ void ESPUIClass::addGraphPoint(uint16_t id, int nValue, int clientId)
{ {
this->ws->client(tryId)->text(json); this->ws->client(tryId)->text(json);
#if defined(DEBUG_ESPUI)
if (this->verbosity >= Verbosity::VerboseJSON) if (this->verbosity >= Verbosity::VerboseJSON)
{ {
Serial.println(json); Serial.println(json);
} }
#endif
} }
count++; count++;
@ -864,10 +971,12 @@ void ESPUIClass::jsonDom(AsyncWebSocketClient *client)
// Send as one big bunch // Send as one big bunch
serializeJson(document, json); serializeJson(document, json);
#if defined(DEBUG_ESPUI)
if (this->verbosity >= Verbosity::VerboseJSON) if (this->verbosity >= Verbosity::VerboseJSON)
{ {
Serial.println(json); Serial.println(json);
} }
#endif
if (client != nullptr) if (client != nullptr)
{ {
@ -888,10 +997,12 @@ void ESPUIClass::jsonReload()
root["type"] = (int)UI_RELOAD; root["type"] = (int)UI_RELOAD;
serializeJson(document, json); serializeJson(document, json);
#if defined(DEBUG_ESPUI)
if (this->verbosity >= Verbosity::VerboseJSON) if (this->verbosity >= Verbosity::VerboseJSON)
{ {
Serial.println(json); Serial.println(json);
} }
#endif
this->ws->textAll(json); this->ws->textAll(json);
} }
@ -916,25 +1027,33 @@ void ESPUIClass::beginSPIFFS(const char *_title, const char *username, const cha
if (!LittleFS.begin()) if (!LittleFS.begin())
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.println(F("SPIFFS Mount Failed, PLEASE CHECK THE README ON HOW TO PREPARE YOUR ESP!!!!!!!")); Serial.println(F("SPIFFS Mount Failed, PLEASE CHECK THE README ON HOW TO "
"PREPARE YOUR ESP!!!!!!!"));
} }
#endif
return; return;
} }
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
listDir("/", 1); listDir("/", 1);
} }
#endif
if (!LittleFS.exists("/index.htm")) if (!LittleFS.exists("/index.htm"))
{ {
#if defined(DEBUG_ESPUI)
if (ESPUI.verbosity) if (ESPUI.verbosity)
{ {
Serial.println(F("Please read the README!!!!!!!, Make sure to ESPUI.prepareFileSystem() once in an empty sketch")); Serial.println(F("Please read the README!!!!!!!, Make sure to "
"ESPUI.prepareFileSystem() once in an empty sketch"));
} }
#endif
return; return;
} }
@ -969,10 +1088,12 @@ void ESPUIClass::beginSPIFFS(const char *_title, const char *username, const cha
server->begin(); server->begin();
#if defined(DEBUG_ESPUI)
if (this->verbosity) if (this->verbosity)
{ {
Serial.println(F("UI Initialized")); Serial.println(F("UI Initialized"));
} }
#endif
} }
void ESPUIClass::begin(const char* _title, const char* username, const char* password) void ESPUIClass::begin(const char* _title, const char* username, const char* password)
@ -1018,7 +1139,8 @@ void ESPUIClass::begin(const char *_title, const char *username, const char *pas
return request->requestAuthentication(); return request->requestAuthentication();
} }
AsyncWebServerResponse *response = request->beginResponse_P(200, "application/javascript", JS_ZEPTO_GZIP, sizeof(JS_ZEPTO_GZIP)); AsyncWebServerResponse* response
= request->beginResponse_P(200, "application/javascript", JS_ZEPTO_GZIP, sizeof(JS_ZEPTO_GZIP));
response->addHeader("Content-Encoding", "gzip"); response->addHeader("Content-Encoding", "gzip");
request->send(response); request->send(response);
}); });
@ -1029,7 +1151,8 @@ void ESPUIClass::begin(const char *_title, const char *username, const char *pas
return request->requestAuthentication(); return request->requestAuthentication();
} }
AsyncWebServerResponse *response = request->beginResponse_P(200, "application/javascript", JS_CONTROLS_GZIP, sizeof(JS_CONTROLS_GZIP)); AsyncWebServerResponse* response
= request->beginResponse_P(200, "application/javascript", JS_CONTROLS_GZIP, sizeof(JS_CONTROLS_GZIP));
response->addHeader("Content-Encoding", "gzip"); response->addHeader("Content-Encoding", "gzip");
request->send(response); request->send(response);
}); });
@ -1040,7 +1163,8 @@ void ESPUIClass::begin(const char *_title, const char *username, const char *pas
return request->requestAuthentication(); return request->requestAuthentication();
} }
AsyncWebServerResponse *response = request->beginResponse_P(200, "application/javascript", JS_SLIDER_GZIP, sizeof(JS_SLIDER_GZIP)); AsyncWebServerResponse* response
= request->beginResponse_P(200, "application/javascript", JS_SLIDER_GZIP, sizeof(JS_SLIDER_GZIP));
response->addHeader("Content-Encoding", "gzip"); response->addHeader("Content-Encoding", "gzip");
request->send(response); request->send(response);
}); });
@ -1051,7 +1175,8 @@ void ESPUIClass::begin(const char *_title, const char *username, const char *pas
return request->requestAuthentication(); return request->requestAuthentication();
} }
AsyncWebServerResponse *response = request->beginResponse_P(200, "application/javascript", JS_GRAPH_GZIP, sizeof(JS_GRAPH_GZIP)); AsyncWebServerResponse* response
= request->beginResponse_P(200, "application/javascript", JS_GRAPH_GZIP, sizeof(JS_GRAPH_GZIP));
response->addHeader("Content-Encoding", "gzip"); response->addHeader("Content-Encoding", "gzip");
request->send(response); request->send(response);
}); });
@ -1062,7 +1187,8 @@ void ESPUIClass::begin(const char *_title, const char *username, const char *pas
return request->requestAuthentication(); return request->requestAuthentication();
} }
AsyncWebServerResponse *response = request->beginResponse_P(200, "application/javascript", JS_TABBEDCONTENT_GZIP, sizeof(JS_TABBEDCONTENT_GZIP)); AsyncWebServerResponse* response = request->beginResponse_P(
200, "application/javascript", JS_TABBEDCONTENT_GZIP, sizeof(JS_TABBEDCONTENT_GZIP));
response->addHeader("Content-Encoding", "gzip"); response->addHeader("Content-Encoding", "gzip");
request->send(response); request->send(response);
}); });
@ -1075,7 +1201,8 @@ void ESPUIClass::begin(const char *_title, const char *username, const char *pas
return request->requestAuthentication(); return request->requestAuthentication();
} }
AsyncWebServerResponse *response = request->beginResponse_P(200, "text/css", CSS_STYLE_GZIP, sizeof(CSS_STYLE_GZIP)); AsyncWebServerResponse* response
= request->beginResponse_P(200, "text/css", CSS_STYLE_GZIP, sizeof(CSS_STYLE_GZIP));
response->addHeader("Content-Encoding", "gzip"); response->addHeader("Content-Encoding", "gzip");
request->send(response); request->send(response);
}); });
@ -1086,7 +1213,8 @@ void ESPUIClass::begin(const char *_title, const char *username, const char *pas
return request->requestAuthentication(); return request->requestAuthentication();
} }
AsyncWebServerResponse *response = request->beginResponse_P(200, "text/css", CSS_NORMALIZE_GZIP, sizeof(CSS_NORMALIZE_GZIP)); AsyncWebServerResponse* response
= request->beginResponse_P(200, "text/css", CSS_NORMALIZE_GZIP, sizeof(CSS_NORMALIZE_GZIP));
response->addHeader("Content-Encoding", "gzip"); response->addHeader("Content-Encoding", "gzip");
request->send(response); request->send(response);
}); });
@ -1105,12 +1233,17 @@ void ESPUIClass::begin(const char *_title, const char *username, const char *pas
server->begin(); server->begin();
#if defined(DEBUG_ESPUI)
if (this->verbosity) if (this->verbosity)
{ {
Serial.println(F("UI Initialized")); Serial.println(F("UI Initialized"));
} }
#endif
} }
void ESPUIClass::setVerbosity(Verbosity v) { this->verbosity = v; } void ESPUIClass::setVerbosity(Verbosity v)
{
this->verbosity = v;
}
ESPUIClass ESPUI; ESPUIClass ESPUI;

64
src/ESPUI.h
View File

@ -11,11 +11,12 @@
#if defined(ESP32) #if defined(ESP32)
#include "LittleFS.h"
#include "WiFi.h"
#include <AsyncTCP.h> #include <AsyncTCP.h>
#include <ESPAsyncWebServer.h> #include <ESPAsyncWebServer.h>
#include "LittleFS.h"
#include "WiFi.h"
#else #else
#include <ArduinoOTA.h> #include <ArduinoOTA.h>
@ -23,8 +24,8 @@
#include <ESP8266mDNS.h> #include <ESP8266mDNS.h>
#include <ESPAsyncTCP.h> #include <ESPAsyncTCP.h>
#include <ESPAsyncWebServer.h> #include <ESPAsyncWebServer.h>
#include <LittleFS.h>
#include <Hash.h> #include <Hash.h>
#include <LittleFS.h>
#include <SPIFFSEditor.h> #include <SPIFFSEditor.h>
#define FILE_WRITE "w" #define FILE_WRITE "w"
@ -140,16 +141,29 @@ public:
static constexpr uint16_t noParent = 0xffff; static constexpr uint16_t noParent = 0xffff;
Control(ControlType type, const char *label, void (*callback)(Control *, int), const String& value, ControlColor color, Control(ControlType type, const char* label, void (*callback)(Control*, int), const String& value,
uint16_t parentControl = Control::noParent) ControlColor color, uint16_t parentControl = Control::noParent)
: type(type), label(label), callback(callback), value(value), color(color), parentControl(parentControl), next(nullptr) : type(type),
label(label),
callback(callback),
value(value),
color(color),
parentControl(parentControl),
next(nullptr)
{ {
id = idCounter++; id = idCounter++;
} }
Control(const Control& control) Control(const Control& control)
: type(control.type), id(control.id), label(control.label), callback(control.callback), value(control.value), color(control.color), : type(control.type),
parentControl(control.parentControl), next(control.next) {} id(control.id),
label(control.label),
callback(control.callback),
value(control.value),
color(control.color),
parentControl(control.parentControl),
next(control.next)
{}
private: private:
static uint16_t idCounter; static uint16_t idCounter;
@ -200,31 +214,43 @@ public:
bool sliderContinuous; bool sliderContinuous;
void setVerbosity(Verbosity verbosity); void setVerbosity(Verbosity verbosity);
void begin(const char *_title, const char *username = nullptr, const char *password = nullptr); // Setup server and page in Memorymode void begin(const char* _title, const char* username = nullptr,
void beginSPIFFS(const char *_title, const char *username = nullptr, const char *password = nullptr); // Setup server and page in SPIFFSmode const char* password = nullptr); // Setup server and page in Memorymode
void beginSPIFFS(const char* _title, const char* username = nullptr,
const char* password = nullptr); // Setup server and page in SPIFFSmode
void prepareFileSystem(); // Initially preps the filesystem and loads a lot of stuff into SPIFFS void prepareFileSystem(); // Initially preps the filesystem and loads a lot of
// stuff into SPIFFS
void list(); // Lists SPIFFS directory void list(); // Lists SPIFFS directory
uint16_t addControl(ControlType type, const char *label, const String& value = String(""), ControlColor color = ControlColor::Turquoise, uint16_t parentControl = Control::noParent, void (*callback)(Control *, int) = nullptr); uint16_t addControl(ControlType type, const char* label, const String& value = String(""),
ControlColor color = ControlColor::Turquoise, uint16_t parentControl = Control::noParent,
void (*callback)(Control*, int) = nullptr);
bool removeControl(uint16_t id, bool force_reload_ui = false); bool removeControl(uint16_t id, bool force_reload_ui = false);
// create Elements // create Elements
uint16_t button(const char *label, void (*callback)(Control *, int), ControlColor color, const String& value = ""); // Create Event Button uint16_t button(const char* label, void (*callback)(Control*, int), ControlColor color,
uint16_t switcher(const char *label, void (*callback)(Control *, int), ControlColor color, bool startState = false); // Create Toggle Button const String& value = ""); // Create Event Button
uint16_t pad(const char *label, void (*callback)(Control *, int), ControlColor color); // Create Pad Control uint16_t switcher(const char* label, void (*callback)(Control*, int), ControlColor color,
uint16_t padWithCenter(const char *label, void (*callback)(Control *, int), ControlColor color); // Create Pad Control with Centerbutton bool startState = false); // Create Toggle Button
uint16_t pad(const char* label, void (*callback)(Control*, int),
ControlColor color); // Create Pad Control
uint16_t padWithCenter(const char* label, void (*callback)(Control*, int),
ControlColor color); // Create Pad Control with Centerbutton
uint16_t slider(const char* label, void (*callback)(Control*, int), ControlColor color, int value, int min = 0, uint16_t slider(const char* label, void (*callback)(Control*, int), ControlColor color, int value, int min = 0,
int max = 100); // Create Slider Control int max = 100); // Create Slider Control
uint16_t number(const char* label, void (*callback)(Control*, int), ControlColor color, int value, int min = 0, uint16_t number(const char* label, void (*callback)(Control*, int), ControlColor color, int value, int min = 0,
int max = 100); // Create a Number Input Control int max = 100); // Create a Number Input Control
uint16_t text(const char *label, void (*callback)(Control *, int), ControlColor color, const String& value = ""); // Create a Text Input Control uint16_t text(const char* label, void (*callback)(Control*, int), ControlColor color,
const String& value = ""); // Create a Text Input Control
// Output only // Output only
uint16_t label(const char *label, ControlColor color, const String& value = ""); // Create Label uint16_t label(const char* label, ControlColor color,
const String& value = ""); // Create Label
uint16_t graph(const char* label, ControlColor color); // Create Graph display uint16_t graph(const char* label, ControlColor color); // Create Graph display
uint16_t gauge(const char *label, ControlColor color, int value, int min = 0, int max = 100); // Create Gauge display uint16_t gauge(const char* label, ControlColor color, int value, int min = 0,
int max = 100); // Create Gauge display
// Input only // Input only
uint16_t accelerometer(const char* label, void (*callback)(Control*, int), ControlColor color); uint16_t accelerometer(const char* label, void (*callback)(Control*, int), ControlColor color);