1
0
mirror of https://github.com/s00500/ESPUI.git synced 2025-07-03 19:50:20 +00:00

23 Commits
1.4.4 ... 1.5.0

Author SHA1 Message Date
477e8e6459 formating 2018-05-27 12:10:21 +02:00
92a1189762 update readme 2018-05-27 12:08:54 +02:00
b992260506 Update switch image 2018-05-27 12:06:02 +02:00
e86f1cd95c Merge branch 'development' of https://github.com/s00500/ESPUI 2018-05-27 12:03:56 +02:00
9717f6c239 Merge pull request #13 from s00500/development
Merging loads of changes
2018-05-27 12:01:48 +02:00
8803eaa37d Updating documentation 2018-05-27 12:01:06 +02:00
e7a09d0640 Updating images 2018-05-27 11:57:24 +02:00
9093e8d01e fix typo 2018-05-27 11:48:51 +02:00
e771320e6a #9 adjusting labels for wraping
renaming datafiles
going on for numbers
2018-05-27 11:47:53 +02:00
7646d4e629 #9 documenting multiline use of labels 2018-05-27 11:41:52 +02:00
c901ff9408 Changing Example titel and reformat 2018-05-27 10:43:47 +02:00
cb5f00cbc0 Adding Backendcode for #10 graph and #9 number controls 2018-05-27 10:42:29 +02:00
845ee0f2cd Adding Memory mode an Gzipdata as default 2018-05-27 10:35:37 +02:00
35336208de Cleaning up prepareFileSystem, changing button style 2018-05-27 00:16:53 +02:00
d9648152ef Fixing Switch style in up to date firefox 2018-05-26 23:18:05 +02:00
27a33e55e7 Adding platformio support 2018-05-20 14:39:24 +02:00
b421b84b11 version bump 2018-05-13 19:50:48 +02:00
f1012b2fe2 Closes #12 implementing all events for websockets 2018-05-13 19:44:56 +02:00
cc633a7c85 Closes #11 Bugfix for retrun values on error 2018-05-13 19:39:21 +02:00
40b13430cb #9 adding control id as return value 2018-04-17 19:54:07 +02:00
dda4e9e771 Merge pull request #8 from per1234/keywords-separa
Use correct separator in keywords.txt
2018-02-20 09:19:09 +01:00
1390b73218 Use correct separator in keywords.txt
The Arduino IDE currently requires the use of a tab separator between the name and identifier. Without this tab the keyword is not highlighted.

Reference:
https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification#keywords
2018-02-19 23:39:35 -08:00
5f7f8dd4e5 ixing filelist functions for esp8266 2018-01-14 12:22:26 +01:00
28 changed files with 630 additions and 293 deletions

View File

@ -29,7 +29,7 @@ This library is dependent on the following libraries to function properly.
Make sure all the dependencies are installed, then install like so: Make sure all the dependencies are installed, then install like so:
#### Directly Through Arduino IDE #### Directly Through Arduino IDE (*recommended*)
You can find this Library in the Arduino IDE library manager You can find this Library in the Arduino IDE library manager
Go to Sketch > Include Library > Library Manager > Search for "ESPUI" > Install Go to Sketch > Include Library > Library Manager > Search for "ESPUI" > Install
@ -46,14 +46,19 @@ For macOs: Download the [Repository](https://github.com/s00500/ESPUI/archive/mas
Download the [Repository](https://github.com/s00500/ESPUI/archive/master.zip), Go to Sketch>Include Library>Add .zip Library> Select the Downloaded .zip File. Download the [Repository](https://github.com/s00500/ESPUI/archive/master.zip), Go to Sketch>Include Library>Add .zip Library> Select the Downloaded .zip File.
## Getting started (Filesystem upload) ## Getting started
ESPUI **NEEDS** its files burnt on the SPIFFS filesystem on the ESP. **Without this ESPUI will NOT work at all** ESPUI serves several Files to the browser to build up its webinterface. This can be achieved in 2 wasy:
There are now two ways to do this: you can either use the upload tool or you use the library function `ESPUI.prepareFileSystem()` *PROGMEM* or *SPIFFS*
#### Simple filesystem preparation (recomended) *When `ESPUI.begin()` is called the default is serving files from Memory and ESPUI should work out of the box!*
Just open the example sketch **prepareFileSystem** and run it on the ESP, (give it 5 - 10 seconds), But if this causes your program to *use too much memory* you can burn the files into the SPIFFS filesystem on the ESP.
There are now two ways to do this: you can either use the ESP file upload tool or you use the library function `ESPUI.prepareFileSystem()`
#### Simple filesystem preparation (*recommended*)
Just open the example sketch **prepareFileSystem** and run it on the ESP, (give it up to 30 seconds, you can see the status on the Serial Monitor),
The library will create all needed files. The library will create all needed files.
Congratulations, you are done, from now on you just need to to this again when there is a library update, or when you want to use another chip :-) Congratulations, you are done, from now on you just need to to this again when there is a library update, or when you want to use another chip :-)
Now you can upload your normal sketch, when you do not call the `ESPUI.prepareFileSystem()` function the compiler will strip out all the unnecessary that is already saved in the chip's filesystem and you have more programm memory to work with. Now you can upload your normal sketch, when you do not call the `ESPUI.prepareFileSystem()` function the compiler will strip out all the unnecessary that is already saved in the chip's filesystem and you have more programm memory to work with.
@ -75,16 +80,31 @@ Now you are set to go and use any code you want to with this library
- Slider - Slider
Checkout the example for the usage Checkout the example for the usage
## Available colors:
- COLOR_TURQUOISE
- COLOR_EMERALD
- COLOR_PETERRIVER
- COLOR_WETASPHALT
- COLOR_SUNFLOWER
- COLOR_CARROT
- COLOR_ALIZARIN
- COLOR_NONE
## Roadmap : ## Roadmap :
- ~~Setup SPIFFS using values in program memory~~ - ~~Setup SPIFFS using values in program memory~~
- ~~ESP8266 support~~ - ~~ESP8266 support~~
- Document slider - ~~PlattformIO Integration~~
- ~~Multiline Labels~~
- ~~GZip Files and serve from memory~~
- Datagraph output -> *WIP*
- Number input -> *WIP*
- Text input -> *WIP*
- proper return value (as int and not as string) for slider - proper return value (as int and not as string) for slider
- Maybe a slider range setting, meanwhile please use map() - Maybe a slider range setting, meanwhile please use *map()*
- Improve slider stability - Improve slider stability
- Improve general stability
## Documentation ## Documentation
@ -94,7 +114,7 @@ ESPUI does not need network access and can be used in standalone access point mo
All assets are loaded from the internal SPIFFS filesystem of the ESP32. All assets are loaded from the internal SPIFFS filesystem of the ESP32.
This section will explain in detail how the Library is to be used from the Arduino code side. As of now the Facilino blocks are not implemented. This section will explain in detail how the Library is to be used from the Arduino code side. As of now the Facilino blocks are not implemented.
In the arduino setup() routine the interface can be customised by adding UI Elements. This is done by calling the corresponding library methods on the Library object ESPUI. Eg: ESPUI.button(“button”, &myCallback); creates a button in the interface that calls the “myCallback” function when changed. All buttons and items call their callback whenever there is a state change from them. This means the button will call the callback when it is pressed and also again when it is released. To separate different events an integer number with the event name is passed to the callback function that can be handled in a switch(){}case{} statement. Here is an overview of the currently implemented different elements of the UI library: In the arduino setup() routine the interface can be customised by adding UI Elements. This is done by calling the corresponding library methods on the Library object ESPUI. Eg: `ESPUI.button(“button”, &myCallback);` creates a button in the interface that calls the “myCallback” function when changed. All buttons and items call their callback whenever there is a state change from them. This means the button will call the callback when it is pressed and also again when it is released. To separate different events an integer number with the event name is passed to the callback function that can be handled in a `switch(){}case{}` statement. Here is an overview of the currently implemented different elements of the UI library:
#### Button #### Button
@ -122,17 +142,24 @@ Button pads come in two flavours: with or without a center button. They are very
![labels](https://github.com/s00500/ESPUI/blob/master/docs/ui_labels.png) ![labels](https://github.com/s00500/ESPUI/blob/master/docs/ui_labels.png)
Labels are a nice tool to get information from the robot to the user interface. This can be done to show states, values of sensors and configuration parameters. To send data from the code use ESP.print(labelId, “Text”); . Labels get a name on creation and a initial value. The name is not changeable once the UI initialised. Labels are a nice tool to get information from the robot to the user interface. This can be done to show states, values of sensors and configuration parameters. To send data from the code use `ESP.print(labelId, “Text”);` . Labels get a name on creation and a initial value. The name is not changeable once the UI initialised.
Labels automatically wrap your text. If you want them to have multiple lines use the normal `<br>` tag in the string you print to the label
#### Slider #### Slider
There is also an slider component now, needs to be documented though ![labels](https://github.com/s00500/ESPUI/blob/master/docs/ui_slider.png)
The Slider can be used to slide through a value from 1 to 100. Slides provide realtime data, are touch compatible and can be used to for example control a Servo. The current value is shown while the slider is dragged in a little bubble over the handle.
#### Initialisation of the UI #### Initialisation of the UI
After all the elements are configured you can use ESPUI.begin(“Some Title”); to start the UI interface. Make sure you setup a working network connection or AccesPoint **before** (See example). The web interface can then be used from multiple devices at once and also shows an connection status in the top bar. After all the elements are configured you can use `ESPUI.begin(“Some Title”);` to start the UI interface. (Or `ESPUI.beginSPIFFS(“Some Title”);` respectively) Make sure you setup a working network connection or AccesPoint **before** (See example). The web interface can then be used from multiple devices at once and also shows an connection status in the top bar.
The library is designed to be easy to use and can still be extended with a lot of more functionality. The library is designed to be easy to use and can still be extended with a lot of more functionality.
# Notes for Development
All changes to the client side files can be made in the examples/gui/data directory. Using the file uploader thin can be used for development. After this you have to compress them and then you can gzip them. I wrote a little useful jsfiddle for this, [CHECK IT OUT](https://jsfiddle.net/s00500/yvLbhuuv/)
# Contribute # Contribute
Liked this Library? You can **support** me by sending me a :coffee: [Coffee](https://paypal.me/lukasbachschwell/3). Liked this Library? You can **support** me by sending me a :coffee: [Coffee](https://paypal.me/lukasbachschwell/3).

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 104 KiB

After

Width:  |  Height:  |  Size: 105 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 21 KiB

BIN
docs/ui_slider.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 11 KiB

View File

@ -78,6 +78,12 @@
background-color: #999999; background-color: #999999;
margin-bottom: 10px; margin-bottom: 10px;
} }
.label-wrap {
width: 90%;
white-space: pre-wrap;
word-wrap: break-word;
}
.label.color-blue { .label.color-blue {
background-color: #6f9ad1; background-color: #6f9ad1;
@ -322,6 +328,7 @@
padding: 10px; padding: 10px;
border-radius: 3px; border-radius: 3px;
color: #fff; color: #fff;
background-color: #999999;
} }
/* Main Head Part /* Main Head Part
@ -496,24 +503,31 @@
} }
.switch input[type="checkbox"] { .switch input[type="checkbox"] {
display: none;
cursor: pointer; cursor: pointer;
height: 10px; height: 10px;
left: 12px; left: 12px;
position: absolute;
top: 8px;
width: 10px;
}
.in {
position: absolute; position: absolute;
top: 8px; top: 8px;
-webkit-transition: left 0.05s ease-in-out; left: 12px;
-moz-transition: left 0.05s ease-in-out; -webkit-transition: left 0.08s ease-in-out;
-o-transition: left 0.05s ease-in-out; -moz-transition: left 0.08s ease-in-out;
-ms-transition: left 0.05s ease-in-out; -o-transition: left 0.08s ease-in-out;
transition: left 0.05s ease-in-out; -ms-transition: left 0.08s ease-in-out;
width: 10px; transition: left 0.08s ease-in-out;
} }
.switch.checked input[type="checkbox"] { .switch.checked div {
left: 38px; left: 38px;
} }
.switch input:before { .switch .in:before {
background: #fff; background: #fff;
background: -moz-linear-gradient(top, #fff 0%, #f0f0f0 100%); background: -moz-linear-gradient(top, #fff 0%, #f0f0f0 100%);
background: -webkit-gradient(linear, left top, left bottom, color-stop(0%, #fff), color-stop(100%, #f0f0f0)); background: -webkit-gradient(linear, left top, left bottom, color-stop(0%, #fff), color-stop(100%, #f0f0f0));
@ -532,7 +546,7 @@
width: 26px; width: 26px;
} }
.switch input:after { .switch .in:after {
background: #f0f0f0; background: #f0f0f0;
background: -moz-linear-gradient(top, #f0f0f0 0%, #fff 100%); background: -moz-linear-gradient(top, #f0f0f0 0%, #fff 100%);
background: -webkit-gradient(linear, left top, left bottom, color-stop(0%, #f0f0f0), color-stop(100%, #fff)); background: -webkit-gradient(linear, left top, left bottom, color-stop(0%, #f0f0f0), color-stop(100%, #fff));
@ -548,20 +562,6 @@
width: 12px; width: 12px;
} }
.switch .icon-ok, .switch .icon-remove {
line-height: 28px;
text-shadow: 0 -2px 0 rgba(0, 0, 0, 0.2);
margin: 0 9px;
}
.switch .icon-ok {
float: left;
}
.switch .icon-remove {
float: right;
}
/* ---------------------------------------------------------------------- /* ----------------------------------------------------------------------
Material Design Range Slider - by Ravikumar Chauhan Material Design Range Slider - by Ravikumar Chauhan
------------------------------------------------------------------------- */ ------------------------------------------------------------------------- */

File diff suppressed because one or more lines are too long

View File

@ -1,14 +1,31 @@
const UI_TITEL = 0; const UI_TITEL = 0;
const UI_LABEL = 1; const UI_LABEL = 1;
const UPDATE_LABEL = 6;
const UI_BUTTON = 2; const UI_BUTTON = 2;
const UI_SWITCHER = 3; const UI_SWITCHER = 3;
const UPDATE_SWITCHER = 7;
const UI_PAD = 4; const UI_PAD = 4;
const UI_CPAD = 5; const UI_CPAD = 5;
const UPDATE_LABEL = 6;
const UPDATE_SWITCHER = 7;
const UI_SLIDER = 8; const UI_SLIDER = 8;
const UPDATE_SLIDER = 9; const UPDATE_SLIDER = 9;
const UI_NUMBER = 10;
const UPDATE_NUMBER = 11;
const UI_TEXT_INPUT = 12;
const UPDATE_TEXT_INPUT = 13;
const UI_GRAPH = 14;
const CLEAR_GRAPH = 15;
const ADD_GRAPH_POINT = 16;
const FOR = 0; const FOR = 0;
const BACK = 1; const BACK = 1;
const LEFT = 2; const LEFT = 2;
@ -97,7 +114,7 @@ function start() {
$('#mainHeader').html(data.label); $('#mainHeader').html(data.label);
break; break;
case UI_LABEL: case UI_LABEL:
$('#row').append("<div class='two columns card tcenter " + colorClass(data.color) + "'><h5 id='" + data.id + "'>" + data.label + "</h5><hr /><span id='l" + data.id + "' class='label'>" + data.value + "</span></div>"); $('#row').append("<div class='two columns card tcenter " + colorClass(data.color) + "'><h5 id='" + data.id + "'>" + data.label + "</h5><hr /><span id='l" + data.id + "' class='label label-wrap'>" + data.value + "</span></div>");
break; break;
case UI_BUTTON: case UI_BUTTON:
$('#row').append("<div class='one columns card tcenter " + colorClass(data.color) + "'><h5>" + data.label + "</h5><hr/><button onmousedown='buttonclick(" + data.id + ", true)' onmouseup='buttonclick(" + data.id + ", false)' id='" + data.id + "'>" + data.value + "</button></div>"); $('#row').append("<div class='one columns card tcenter " + colorClass(data.color) + "'><h5>" + data.label + "</h5><hr/><button onmousedown='buttonclick(" + data.id + ", true)' onmouseup='buttonclick(" + data.id + ", false)' id='" + data.id + "'>" + data.value + "</button></div>");
@ -116,15 +133,14 @@ function start() {
break; break;
case UI_SWITCHER: case UI_SWITCHER:
var label = "<label id='sl" + data.id + "' class='switch checked'>"; var label = "<label id='sl" + data.id + "' class='switch checked'>";
var input = "<input type='checkbox' id='s" + data.id + "' onClick='switcher(" + data.id + ",null)' checked>"; var input = "<div class='in'><input type='checkbox' id='s" + data.id + "' onClick='switcher(" + data.id + ",null)' checked></div>";
if (data.value == "0") { if (data.value == "0") {
label = "<label id='sl" + data.id + "' class='switch'>"; label = "<label id='sl" + data.id + "' class='switch'>";
input = "<input type='checkbox' id='s" + data.id + "' onClick='switcher(" + data.id + ",null)' >"; input = "<div class='in'><input type='checkbox' id='s" + data.id + "' onClick='switcher(" + data.id + ",null)' ></div>";
} }
$('#row').append( $('#row').append(
"<div id='" + data.id + "' class='one columns card tcenter " + colorClass(data.color) + "'><h5>" + data.label + "</h5><hr/>" + "<div id='" + data.id + "' class='one columns card tcenter " + colorClass(data.color) + "'><h5>" + data.label + "</h5><hr/>" +
label + "<i class='icon-ok'></i>" + label + input +
"<i class='icon-remove'></i>" + input +
"</label>" + "</label>" +
"</div>"); "</div>");
break; break;
@ -226,15 +242,42 @@ function start() {
"</div>" "</div>"
); );
$('#row').append( $('#row').append(
"<script>" + "<script>" +
"rkmd_rangeSlider('#sl" + data.id + "');" + "rkmd_rangeSlider('#sl" + data.id + "');" +
"</script>" "</script>"
); );
break; break;
case UPDATE_SLIDER: case UPDATE_SLIDER:
slider_move($('#sl'+data.id), data.value ,'100', false); slider_move($('#sl' + data.id), data.value, '100', false);
break; break;
case UI_NUMBER:
$('#row').append(
"<div class='two columns card tcenter" + colorClass(data.color) + "'>" +
"<h5 id='" + data.id + "'>" + data.label + "</h5><hr />" +
"<input id='num" + data.id + "' type='number' value='" + data.value + "' onchange='numberchange(" + data.id + ")' />" +
"</div>"
);
break;
case UPDATE_NUMBER:
$('#num' + data.id).val(data.value);
break;
case UI_TEXT_INPUT:
$('#row').append(
"<div class='two columns card tcenter" + colorClass(data.color) + "'>" +
"<h5 id='" + data.id + "'>" + data.label + "</h5><hr />" +
"<input id='num" + data.id + "' type='number' value='" + data.value + "' onchange='numberchange(" + data.id + ")' />" +
"</div>"
);
break;
case UPDATE_TEXT_INPUT:
$('#num' + data.id).val(data.value);
break;
default: default:
console.error('Unknown type or event'); console.error('Unknown type or event');
break; break;
@ -242,6 +285,12 @@ function start() {
}; };
} }
function numberchange(number) {
var val = $('#num' + data.id).val();
websock.send("nchange:" + number + ":" + val);
console.log(val);
}
function buttonclick(number, isdown) { function buttonclick(number, isdown) {
if (isdown) websock.send("bdown:" + number); if (isdown) websock.send("bdown:" + number);

File diff suppressed because one or more lines are too long

View File

@ -107,9 +107,9 @@ void setup(void) {
WiFi.mode(WIFI_AP); WiFi.mode(WIFI_AP);
#if defined(ESP32) #if defined(ESP32)
WiFi.setHostname(ssid); WiFi.setHostname(ssid);
#else #else
WiFi.hostname(ssid); WiFi.hostname(ssid);
#endif #endif
WiFi.softAP(ssid); WiFi.softAP(ssid);
@ -120,18 +120,18 @@ void setup(void) {
// change the beginning to this if you want to join an existing network // change the beginning to this if you want to join an existing network
/* /*
Serial.begin(115200); Serial.begin(115200);
WiFi.begin(ssid, password); WiFi.begin(ssid, password);
Serial.println(""); Serial.println("");
// Wait for connection // Wait for connection
while (WiFi.status() != WL_CONNECTED) { while (WiFi.status() != WL_CONNECTED) {
delay(500); delay(500);
Serial.print("."); Serial.print(".");
} }
Serial.println(""); Serial.println("");
Serial.print("IP address: "); Serial.print("IP address: ");
Serial.println(WiFi.localIP()); Serial.println(WiFi.localIP());
*/ */
ESPUI.label("Status:", COLOR_TURQUOISE, "Stop"); ESPUI.label("Status:", COLOR_TURQUOISE, "Stop");
ESPUI.label("Millis:", COLOR_EMERALD, "0"); ESPUI.label("Millis:", COLOR_EMERALD, "0");
@ -144,7 +144,11 @@ void setup(void) {
ESPUI.slider("Slider one", &slider, COLOR_ALIZARIN, "30"); ESPUI.slider("Slider one", &slider, COLOR_ALIZARIN, "30");
ESPUI.slider("Slider two", &slider, COLOR_NONE, "100"); ESPUI.slider("Slider two", &slider, COLOR_NONE, "100");
ESPUI.begin("ESP32 Control"); /*
.begin loads and serves all files from PROGMEM directly.
If you want to serve the files from SPIFFS use .beginSPIFFS (.prepareFileSystem has to be run in an empty sketch before)
*/
ESPUI.begin("ESPUI Control");
} }
void loop(void) { void loop(void) {

View File

@ -15,13 +15,15 @@ ESPUI KEYWORD1
label KEYWORD2 label KEYWORD2
button KEYWORD2 button KEYWORD2
switcher KEYWORD2 switcher KEYWORD2
pad KEYWORD2 pad KEYWORD2
slider KEYWORD2 slider KEYWORD2
begin KEYWORD2 begin KEYWORD2
beginSPIFFS KEYWORD2
print KEYWORD2 print KEYWORD2
updateSwitcher KEYWORD2 updateSwitcher KEYWORD2
updateSlider KEYWORD2
####################################### #######################################
# Instances (KEYWORD2) # Instances (KEYWORD2)
@ -31,18 +33,18 @@ updateSwitcher KEYWORD2
# Constants (LITERAL1) # Constants (LITERAL1)
####################################### #######################################
B_DOWN LITERAL1 B_DOWN LITERAL1
B_UP LITERAL1 B_UP LITERAL1
P_LEFT_DOWN LITERAL1 P_LEFT_DOWN LITERAL1
P_LEFT_UP LITERAL1 P_LEFT_UP LITERAL1
P_RIGHT_DOWN LITERAL1 P_RIGHT_DOWN LITERAL1
P_RIGHT_UP LITERAL1 P_RIGHT_UP LITERAL1
P_FOR_DOWN LITERAL1 P_FOR_DOWN LITERAL1
P_FOR_UP LITERAL1 P_FOR_UP LITERAL1
P_BACK_DOWN LITERAL1 P_BACK_DOWN LITERAL1
P_BACK_UP LITERAL1 P_BACK_UP LITERAL1
P_CENTER_DOWN LITERAL1 P_CENTER_DOWN LITERAL1
P_CENTER_UP LITERAL1 P_CENTER_UP LITERAL1
S_ACTIVE LITERAL1 S_ACTIVE LITERAL1
S_INACTIVE LITERAL1 S_INACTIVE LITERAL1
SL_VALUE LITERAL1 SL_VALUE LITERAL1

28
library.json Normal file
View File

@ -0,0 +1,28 @@
{
"name": "ESPUI",
"keywords": "espressif web interface iot control simple easy ui userinterface",
"description": "ESP32 and ESP8266 Web Interface Library",
"repository":
{
"type": "git",
"url": "https://github.com/s00500/ESPUI.git"
},
"authors":
[
{
"name": "Lukas Bachschwell",
"email": "lukas@lbsfilm.at",
"url": "https://lbsfilm.at",
"maintainer": true
}
],
"dependencies":
{
"name": "ESP Async WebServer",
"authors": "Hristo Gochkov",
"frameworks": "arduino"
},
"version": "1.4.6",
"frameworks": "arduino",
"platforms": "*"
}

View File

@ -1,5 +1,5 @@
name=ESPUI name=ESPUI
version=1.4.4 version=1.4.6
author=Lukas Bachschwell author=Lukas Bachschwell
maintainer=Lukas Bachschwell <lukas@lbsfilm.at> maintainer=Lukas Bachschwell <lukas@lbsfilm.at>
sentence=ESP32 and ESP8266 Web Interface Library sentence=ESP32 and ESP8266 Web Interface Library

View File

@ -1,176 +1,223 @@
#include "ESPUI.h" #include "ESPUI.h"
#include "uploadDataIndex.h" #include "dataIndexHTML.h"
#include "dataNormalizeCSS.h"
#include "dataStyleCSS.h"
#include "uploadDataStyle.h" #include "dataControlsJS.h"
#include "uploadDataNormalize.h" #include "dataSliderJS.h"
#include "dataZeptoJS.h"
#include "uploadDataControls.h"
#include "uploadDataZepto.h"
#include "uploadDataSlider.h"
#include <ESPAsyncWebServer.h> #include <ESPAsyncWebServer.h>
#include <functional> #include <functional>
// ################# Spiffs functions // ################# Spiffs functions
#if defined(ESP32)
void listDir(const char *dirname, uint8_t levels) {
Serial.printf("Listing directory: %s\n", dirname);
void listDir(const char * dirname, uint8_t levels){ File root = SPIFFS.open(dirname);
Serial.printf("Listing directory: %s\n", dirname);
File root = SPIFFS.open(dirname); if (!root) {
if(!root){ Serial.println("Failed to open directory");
Serial.println("Failed to open directory"); return;
return; }
}
if(!root.isDirectory()){ if (!root.isDirectory()) {
Serial.println("Not a directory"); Serial.println("Not a directory");
return; return;
}
File file = root.openNextFile();
while (file) {
if (file.isDirectory()) {
Serial.print(" DIR : ");
Serial.println(file.name());
if (levels) {
listDir(file.name(), levels - 1);
}
} else {
Serial.print(" FILE: ");
Serial.print(file.name());
Serial.print(" SIZE: ");
Serial.println(file.size());
} }
File file = root.openNextFile(); file = root.openNextFile();
while(file){ }
if(file.isDirectory()){ }
Serial.print(" DIR : "); #else
Serial.println(file.name());
if(levels){ void listDir(const char *dirname, uint8_t levels) {
listDir(file.name(), levels -1); // ignoring levels for esp8266
} Serial.printf("Listing directory: %s\n", dirname);
} else {
Serial.print(" FILE: "); String str = "";
Serial.print(file.name()); Dir dir = SPIFFS.openDir("/");
Serial.print(" SIZE: "); while (dir.next()) {
Serial.println(file.size()); Serial.print(" FILE: ");
} Serial.print(dir.fileName());
file = root.openNextFile(); Serial.print(" SIZE: ");
} Serial.println(dir.fileSize());
}
} }
void deleteFile(const char * path) { #endif
Serial.print(SPIFFS.exists(path));
if(!SPIFFS.exists(path)){
Serial.printf("File: %s does not exist, not deleting\n", path);
return;
}
Serial.printf("Deleting file: %s\n", path); void ESPUIClass::list() {
if (!SPIFFS.begin()) {
Serial.println("SPIFFS Mount Failed");
return;
}
listDir("/", 1);
#if defined(ESP32)
Serial.println(SPIFFS.totalBytes());
Serial.println(SPIFFS.usedBytes());
#else
FSInfo fs_info;
SPIFFS.info(fs_info);
if(SPIFFS.remove(path)){ Serial.println(fs_info.totalBytes);
Serial.println("File deleted"); Serial.println(fs_info.usedBytes);
} else { #endif
Serial.println("Delete failed");
}
} }
void writeFile(const char * path, const char * data) { void deleteFile(const char *path) {
Serial.printf("Writing file: %s\n", path); if (debug) Serial.print(SPIFFS.exists(path));
if (!SPIFFS.exists(path)) {
Serial.printf("File: %s does not exist, not deleting\n", path);
return;
}
File file = SPIFFS.open(path, FILE_WRITE); Serial.printf("Deleting file: %s\n", path);
if(!file){
Serial.println("Failed to open file for writing"); if (SPIFFS.remove(path)) {
return; Serial.println("File deleted");
} } else {
if(file.print(FPSTR(data))){ Serial.println("Delete failed");
Serial.println("File written"); }
} else { }
Serial.println("Write failed");
} void writeFile(const char *path, const char *data) {
file.close(); Serial.printf("Writing file: %s\n", path);
File file = SPIFFS.open(path, FILE_WRITE);
if (!file) {
Serial.println("Failed to open file for writing");
return;
}
#if defined(ESP32)
if (file.print(data)) {
Serial.println("File written");
} else {
Serial.println("Write failed");
}
#else
if (file.print(FPSTR(data))) {
Serial.println("File written");
} else {
Serial.println("Write failed");
}
#endif
file.close();
} }
// end Spiffs functions // end Spiffs functions
void ESPUIClass::prepareFileSystem(){ void ESPUIClass::prepareFileSystem() {
// this function should only be used once // this function should only be used once
Serial.println("About to prepare filesystem..."); Serial.println("About to prepare filesystem...");
#if defined(ESP32) #if defined(ESP32)
SPIFFS.format(); SPIFFS.format();
if(!SPIFFS.begin(true)) { if (!SPIFFS.begin(true)) {
Serial.println("SPIFFS Mount Failed"); Serial.println("SPIFFS Mount Failed");
return; return;
} }
Serial.println("SPIFFS Mount ESP32 Done"); listDir("/", 1);
Serial.println("SPIFFS Mount ESP32 Done");
#else #else
SPIFFS.format(); SPIFFS.format();
SPIFFS.begin(); SPIFFS.begin();
Serial.println("SPIFFS Mount ESP8266 Done"); Serial.println("SPIFFS Mount ESP8266 Done");
#endif #endif
listDir("/", 1); deleteFile("/index.htm");
//TODO: This is a workaround, have to find out why SPIFFS on ESP32 behaves incredibly strangely, see issue #6 deleteFile("/css/style.css");
/* deleteFile("/css/normalize.css");
deleteFile("/index.htm");
deleteFile("/css/style.css"); deleteFile("/js/zepto.min.js");
deleteFile("/css/normalize.css"); deleteFile("/js/controls.js");
deleteFile("/js/slider.js");
deleteFile("/js/zepto.min.js"); Serial.println("Cleanup done");
deleteFile("/js/controls.js");
deleteFile("/js/slider.js");
*/
Serial.println("Cleanup done"); // Now write
writeFile("/index.htm", HTML_INDEX);
// Now write writeFile("/css/style.css", CSS_STYLE);
writeFile("/index.htm", HTML_INDEX); writeFile("/css/normalize.css", CSS_NORMALIZE);
writeFile("/css/style.css", CSS_STYLE); writeFile("/js/zepto.min.js", JS_ZEPTO);
writeFile("/css/normalize.css", CSS_NORMALIZE); writeFile("/js/controls.js", JS_CONTROLS);
writeFile("/js/slider.js", JS_SLIDER);
writeFile("/js/zepto.min.js", JS_ZEPTO); Serial.println("Done Initializing filesystem :-)");
writeFile("/js/controls.js", JS_CONTROLS);
writeFile("/js/slider.js", JS_SLIDER);
Serial.println("Done Initializing filesystem :-)"); #if defined(ESP32)
listDir("/", 1); if(debug) listDir("/", 1);
SPIFFS.end(); #endif
SPIFFS.end();
} }
void ESPUIClass::list() {
if(!SPIFFS.begin()) {
Serial.println("SPIFFS Mount Failed");
return;
}
listDir("/", 1);
Serial.println(SPIFFS.totalBytes());
Serial.println(SPIFFS.usedBytes());
}
// Handle Websockets Communication // Handle Websockets Communication
void onWsEvent(AsyncWebSocket *server, AsyncWebSocketClient *client, void onWsEvent(AsyncWebSocket *server, AsyncWebSocketClient *client,
AwsEventType type, void *arg, uint8_t *data, size_t len) { AwsEventType type, void *arg, uint8_t *data, size_t len) {
switch (type) { switch (type) {
case WS_EVT_DISCONNECT: case WS_EVT_DISCONNECT: {
if (debug) if (debug)
Serial.printf("Disconnected!\n"); Serial.printf("Disconnected!\n");
break; break;
}
case WS_EVT_PONG: {
if (debug)
Serial.printf("Received PONG!\n");
break;
}
case WS_EVT_ERROR: {
if (debug)
Serial.printf("WebSocket Error!\n");
break;
}
case WS_EVT_CONNECT: { case WS_EVT_CONNECT: {
if (debug){ if (debug) {
Serial.print("Connected: "); Serial.print("Connected: ");
Serial.println(client->id()); Serial.println(client->id());
} }
ESPUI.jsonDom(client); ESPUI.jsonDom(client);
if (debug){ if (debug) {
Serial.println("JSON Data Sent to Client!"); Serial.println("JSON Data Sent to Client!");
} }
} } break;
break; case WS_EVT_DATA: {
case WS_EVT_DATA:
String msg = ""; String msg = "";
for (size_t i = 0; i < len; i++) { for (size_t i = 0; i < len; i++) {
msg += (char)data[i]; msg += (char)data[i];
} }
int id = msg.substring(msg.lastIndexOf(':') + 1).toInt(); int id = msg.substring(msg.lastIndexOf(':') + 1).toInt();
if (id >= ESPUI.cIndex){ if (id >= ESPUI.cIndex) {
if(debug) Serial.println("Maleformated id in websocket message"); if (debug)
Serial.println("Maleformated id in websocket message");
return; return;
} }
Control *c = ESPUI.controls[msg.substring(msg.lastIndexOf(':') + 1).toInt()]; Control *c = ESPUI.controls[msg.substring(msg.lastIndexOf(':') + 1).toInt()];
if (msg.startsWith("bdown:")) { if (msg.startsWith("bdown:")) {
@ -207,17 +254,22 @@ void onWsEvent(AsyncWebSocket *server, AsyncWebSocketClient *client,
int value = msg.substring(msg.indexOf(':') + 1, msg.lastIndexOf(':')).toInt(); int value = msg.substring(msg.indexOf(':') + 1, msg.lastIndexOf(':')).toInt();
ESPUI.updateSlider(c->id, value, client->id()); ESPUI.updateSlider(c->id, value, client->id());
c->callback(*c, SL_VALUE); c->callback(*c, SL_VALUE);
} else if (msg.startsWith("nvalue:")) {
int value = msg.substring(msg.indexOf(':') + 1, msg.lastIndexOf(':')).toInt();
ESPUI.updateNumber(c->id, value, client->id());
c->callback(*c, N_VALUE);
} }
}
break;
default:
break; break;
} }
} }
void ESPUIClass::label(const char *label, int color, String value) { int ESPUIClass::label(const char *label, int color, String value) {
if (labelExists(label)) { if (labelExists(label)) {
if (debug) if (debug) Serial.println("UI ERROR: Element " + String(label) + " exists, skipping creating element!");
Serial.println("UI ERROR: Element " + String(label) + return -1;
" exists, skipping creating element!");
return;
} }
Control *newL = new Control(); Control *newL = new Control();
@ -232,15 +284,32 @@ void ESPUIClass::label(const char *label, int color, String value) {
newL->id = cIndex; newL->id = cIndex;
controls[cIndex] = newL; controls[cIndex] = newL;
cIndex++; cIndex++;
return cIndex - 1;
}
int ESPUIClass::graph(const char *label, int color) {
if (labelExists(label)) {
if (debug) Serial.println("UI ERROR: Element " + String(label) + " exists, skipping creating element!");
return -1;
}
Control *newG = new Control();
newG->type = UI_GRAPH;
newG->label = label;
newG->color = color;
newG->id = cIndex;
controls[cIndex] = newG;
cIndex++;
return cIndex - 1;
} }
// TODO: this still needs a range setting // TODO: this still needs a range setting
void ESPUIClass::slider(const char *label, void (*callBack)(Control, int), int color, String value) { int ESPUIClass::slider(const char *label, void (*callBack)(Control, int), int color, String value) {
if (labelExists(label)) { if (labelExists(label)) {
if (debug) if (debug)
Serial.println("UI ERROR: Element " + String(label) + Serial.println("UI ERROR: Element " + String(label) +
" exists, skipping creating element!"); " exists, skipping creating element!");
return; return -1;
} }
Control *newSL = new Control(); Control *newSL = new Control();
@ -255,15 +324,16 @@ void ESPUIClass::slider(const char *label, void (*callBack)(Control, int), int c
newSL->id = cIndex; newSL->id = cIndex;
controls[cIndex] = newSL; controls[cIndex] = newSL;
cIndex++; cIndex++;
return cIndex - 1;
} }
void ESPUIClass::button(const char *label, void (*callBack)(Control, int), int ESPUIClass::button(const char *label, void (*callBack)(Control, int),
int color, String value) { int color, String value) {
if (labelExists(label)) { if (labelExists(label)) {
if (debug) if (debug)
Serial.println("UI ERROR: Element " + String(label) + Serial.println("UI ERROR: Element " + String(label) +
" exists, skipping creating element!"); " exists, skipping creating element!");
return; return -1;
} }
Control *newB = new Control(); Control *newB = new Control();
@ -280,15 +350,15 @@ void ESPUIClass::button(const char *label, void (*callBack)(Control, int),
newB->id = cIndex; newB->id = cIndex;
controls[cIndex] = newB; controls[cIndex] = newB;
cIndex++; cIndex++;
return cIndex - 1;
} }
void ESPUIClass::switcher(const char *label, bool startState, int ESPUIClass::switcher(const char *label, bool startState, void (*callBack)(Control, int), int color) {
void (*callBack)(Control, int), int color) {
if (labelExists(label)) { if (labelExists(label)) {
if (debug) if (debug)
Serial.println("UI ERROR: Element " + String(label) + Serial.println("UI ERROR: Element " + String(label) +
" exists, skipping creating element!"); " exists, skipping creating element!");
return; return -1;
} }
Control *newS = new Control(); Control *newS = new Control();
@ -300,15 +370,16 @@ void ESPUIClass::switcher(const char *label, bool startState,
newS->id = cIndex; newS->id = cIndex;
controls[cIndex] = newS; controls[cIndex] = newS;
cIndex++; cIndex++;
return cIndex - 1;
} }
void ESPUIClass::pad(const char *label, bool center, int ESPUIClass::pad(const char *label, bool center,
void (*callBack)(Control, int), int color) { void (*callBack)(Control, int), int color) {
if (labelExists(label)) { if (labelExists(label)) {
if (debug) if (debug)
Serial.println("UI ERROR: Element " + String(label) + Serial.println("UI ERROR: Element " + String(label) +
" exists, skipping creating element!"); " exists, skipping creating element!");
return; return -1;
} }
Control *newP = new Control(); Control *newP = new Control();
@ -322,6 +393,27 @@ void ESPUIClass::pad(const char *label, bool center,
newP->id = cIndex; newP->id = cIndex;
controls[cIndex] = newP; controls[cIndex] = newP;
cIndex++; cIndex++;
return cIndex - 1;
}
// TODO: min and max need to be saved, they also need to be sent to the frontend
int ESPUIClass::number(const char *label, void (*callBack)(Control, int), int color, int number, int min, int max) {
if (labelExists(label)) {
if (debug)
Serial.println("UI ERROR: Element " + String(label) + " exists, skipping creating element!");
return -1;
}
Control *newN = new Control();
newN->type = UI_NUMBER;
newN->label = label;
newN->color = color;
newN->value = String(number);
newN->callback = callBack;
newN->id = cIndex;
controls[cIndex] = newN;
cIndex++;
return cIndex - 1;
} }
void ESPUIClass::print(int id, String value) { void ESPUIClass::print(int id, String value) {
@ -351,25 +443,7 @@ void ESPUIClass::print(String label, String value) {
print(getIdByLabel(label), value); print(getIdByLabel(label), value);
} }
void ESPUIClass::updateSwitcher(int id, bool nValue, int clientId ) { void ESPUIClass::updateSlider(int id, int nValue, int clientId) {
if (id < cIndex && controls[id]->type == UI_SWITCHER) {
controls[id]->value = nValue ? 1 : 0;
String json;
StaticJsonBuffer<200> jsonBuffer;
JsonObject &root = jsonBuffer.createObject();
root["type"] = UPDATE_SWITCHER;
root["value"] = nValue ? 1 : 0;
root["id"] = String(id);
root.printTo(json);
textThem(json, clientId);
} else {
if (debug)
Serial.println(String("Error: ") + String(id) +
String(" is no switcher"));
}
}
void ESPUIClass::updateSlider(int id, int nValue, int clientId ) {
if (id < cIndex && controls[id]->type == UI_SLIDER) { if (id < cIndex && controls[id]->type == UI_SLIDER) {
controls[id]->value = nValue; controls[id]->value = nValue;
String json; String json;
@ -382,27 +456,66 @@ void ESPUIClass::updateSlider(int id, int nValue, int clientId ) {
textThem(json, clientId); textThem(json, clientId);
} else { } else {
if (debug) if (debug)
Serial.println(String("Error: ") + String(id) + Serial.println(String("Error: ") + String(id) + String(" is no slider"));
String(" is no slider")); }
}
void ESPUIClass::updateSwitcher(int id, bool nValue, int clientId) {
if (id < cIndex && controls[id]->type == UI_SWITCHER) {
controls[id]->value = nValue ? 1 : 0;
String json;
StaticJsonBuffer<200> jsonBuffer;
JsonObject &root = jsonBuffer.createObject();
root["type"] = UPDATE_SWITCHER;
root["value"] = nValue ? 1 : 0;
root["id"] = String(id);
root.printTo(json);
textThem(json, clientId);
} else {
if (debug) Serial.println(String("Error: ") + String(id) + String(" is no switcher"));
} }
} }
void ESPUIClass::updateSwitcher(String label, bool nValue, int clientId) { void ESPUIClass::updateSwitcher(String label, bool nValue, int clientId) {
if (!labelExists(label)) { if (!labelExists(label)) {
if (debug) if (debug)
Serial.println("UI ERROR: Element does not " + String(label) + Serial.println("UI ERROR: Element does not " + String(label) + " exist, cannot update!");
" exist, cannot update!");
return; return;
} }
updateSwitcher(getIdByLabel(label), nValue, clientId); updateSwitcher(getIdByLabel(label), nValue, clientId);
} }
// This is a hacky workaround because ESPAsyncWebServer does not have a function like this and it's clients array is private void ESPUIClass::updateNumber(int id, int number, int clientId) {
void ESPUIClass::textThem(String text, int clientId){ if (id < cIndex && controls[id]->type == UI_NUMBER) {
controls[id]->value = number;
String json;
StaticJsonBuffer<200> jsonBuffer;
JsonObject &root = jsonBuffer.createObject();
root["type"] = UPDATE_NUMBER;
root["value"] = String(number);
root["id"] = String(id);
root.printTo(json);
textThem(json, clientId);
} else {
if (debug) Serial.println(String("Error: ") + String(id) + String(" is no number"));
}
}
void ESPUIClass::updateNumber(String label, int number, int clientId) {
if (!labelExists(label)) {
if (debug) Serial.println("UI ERROR: Element does not " + String(label) + " exist, cannot update!");
return;
}
updateNumber(getIdByLabel(label), number, clientId);
}
// This is a hacky workaround because ESPAsyncWebServer does not have a function
// like this and it's clients array is private
void ESPUIClass::textThem(String text, int clientId) {
int tryId = 0; int tryId = 0;
for(int count = 0; count < this->ws->count();){ for (int count = 0; count < this->ws->count();) {
if(this->ws->hasClient(tryId)) { if (this->ws->hasClient(tryId)) {
if(clientId!=tryId){ if (clientId != tryId) {
this->ws->client(tryId)->text(text); this->ws->client(tryId)->text(text);
} }
count++; count++;
@ -448,20 +561,22 @@ void ESPUIClass::jsonDom(AsyncWebSocketClient *client) {
} }
} }
void ESPUIClass::begin(const char *_title) { void ESPUIClass::beginSPIFFS(const char *_title) {
ui_title = _title; ui_title = _title;
server = new AsyncWebServer(80); server = new AsyncWebServer(80);
ws = new AsyncWebSocket("/ws"); ws = new AsyncWebSocket("/ws");
if(!SPIFFS.begin()) { if (!SPIFFS.begin()) {
Serial.println("SPIFFS Mount Failed, PLEASE CHECK THE README ON HOW TO PREPARE YOUR ESP!!!!!!!"); Serial.println("SPIFFS Mount Failed, PLEASE CHECK THE README ON HOW TO "
return; "PREPARE YOUR ESP!!!!!!!");
return;
} }
listDir("/", 1); listDir("/", 1);
if(!SPIFFS.exists( "/index.htm")) { if (!SPIFFS.exists("/index.htm")) {
Serial.println("Please read the README!!!!!!!, Make sure to ESPUI.prepareFileSystem() once in an empty sketch"); Serial.println("Please read the README!!!!!!!, Make sure to "
"ESPUI.prepareFileSystem() once in an empty sketch");
return; return;
} }
@ -471,13 +586,82 @@ void ESPUIClass::begin(const char *_title) {
// Heap for general Servertest // Heap for general Servertest
server->on("/heap", HTTP_GET, [](AsyncWebServerRequest *request) { server->on("/heap", HTTP_GET, [](AsyncWebServerRequest *request) {
request->send(200, "text/plain", String(ESP.getFreeHeap())); request->send(200, "text/plain", String(ESP.getFreeHeap()) + " In SPIFFSmode");
}); });
server->onNotFound( server->onNotFound(
[](AsyncWebServerRequest *request) { [](AsyncWebServerRequest *request) {
request->send(404); request->send(404);
}); });
server->on("/zepto.js", HTTP_GET, [](AsyncWebServerRequest *request) {
AsyncWebServerResponse *response = request->beginResponse_P(200, "application/javascript", JS_ZEPTO_GZIP, sizeof(JS_ZEPTO_GZIP));
response->addHeader("Content-Encoding", "gzip");
request->send(response);
});
server->begin();
if (debug)
Serial.println("UI Initialized");
}
void ESPUIClass::begin(const char *_title) {
ui_title = _title;
server = new AsyncWebServer(80);
ws = new AsyncWebSocket("/ws");
ws->onEvent(onWsEvent);
server->addHandler(ws);
server->on("/", HTTP_GET, [](AsyncWebServerRequest *request) {
AsyncWebServerResponse *response = request->beginResponse_P(200, "text/html", HTML_INDEX);
request->send(response);
});
// Javascript files
server->on("/js/zepto.min.js", HTTP_GET, [](AsyncWebServerRequest *request) {
AsyncWebServerResponse *response = request->beginResponse_P(200, "application/javascript", JS_ZEPTO_GZIP, sizeof(JS_ZEPTO_GZIP));
response->addHeader("Content-Encoding", "gzip");
request->send(response);
});
server->on("/js/controls.js", HTTP_GET, [](AsyncWebServerRequest *request) {
AsyncWebServerResponse *response = request->beginResponse_P(200, "application/javascript", JS_CONTROLS_GZIP, sizeof(JS_CONTROLS_GZIP));
response->addHeader("Content-Encoding", "gzip");
request->send(response);
});
server->on("/js/slider.js", HTTP_GET, [](AsyncWebServerRequest *request) {
AsyncWebServerResponse *response = request->beginResponse_P(200, "application/javascript", JS_SLIDER_GZIP, sizeof(JS_SLIDER_GZIP));
response->addHeader("Content-Encoding", "gzip");
request->send(response);
});
// Stylesheets
server->on("/css/style.css", HTTP_GET, [](AsyncWebServerRequest *request) {
AsyncWebServerResponse *response = request->beginResponse_P(200, "text/css", CSS_STYLE_GZIP, sizeof(CSS_STYLE_GZIP));
response->addHeader("Content-Encoding", "gzip");
request->send(response);
});
server->on("/css/normalize.css", HTTP_GET, [](AsyncWebServerRequest *request) {
AsyncWebServerResponse *response = request->beginResponse_P(200, "text/css", CSS_NORMALIZE_GZIP, sizeof(CSS_NORMALIZE_GZIP));
response->addHeader("Content-Encoding", "gzip");
request->send(response);
});
// Heap for general Servertest
server->on("/heap", HTTP_GET, [](AsyncWebServerRequest *request) {
request->send(200, "text/plain", String(ESP.getFreeHeap())+ " In Memorymode");
});
server->onNotFound(
[](AsyncWebServerRequest *request) {
request->send(404);
});
server->begin(); server->begin();
if (debug) if (debug)

View File

@ -39,18 +39,35 @@ typedef struct Control {
unsigned int color; unsigned int color;
} Control; } Control;
// Types // Message Types (and control types)
#define UI_TITEL 0 #define UI_TITEL 0
#define UI_LABEL 1 #define UI_LABEL 1
#define UPDATE_LABEL 6
#define UI_BUTTON 2 #define UI_BUTTON 2
#define UI_SWITCHER 3 #define UI_SWITCHER 3
#define UPDATE_SWITCHER 7
#define UI_PAD 4 #define UI_PAD 4
#define UI_CPAD 5 #define UI_CPAD 5
#define UPDATE_LABEL 6
#define UPDATE_SWITCHER 7
#define UI_SLIDER 8 #define UI_SLIDER 8
#define UPDATE_SLIDER 9 #define UPDATE_SLIDER 9
#define UI_NUMBER 10
#define UPDATE_NUMBER 11
#define UI_TEXT_INPUT 12
#define UPDATE_TEXT_INPUT 13
#define UI_GRAPH 14
#define CLEAR_GRAPH 15
#define ADD_GRAPH_POINT 16
// Values // Values
#define B_DOWN -1 #define B_DOWN -1
#define B_UP 1 #define B_UP 1
@ -70,7 +87,7 @@ typedef struct Control {
#define S_INACTIVE 7 #define S_INACTIVE 7
#define SL_VALUE 8 #define SL_VALUE 8
#define N_VALUE 9
// Colors // Colors
#define COLOR_TURQUOISE 0 #define COLOR_TURQUOISE 0
@ -86,44 +103,56 @@ typedef struct Control {
class ESPUIClass { class ESPUIClass {
public: public:
void begin(const char *_title); // Setup servers and page void begin(const char *_title); // Setup servers and page in Memorymode
void beginSPIFFS(const char *_title); // Setup servers 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(); void list();
// Creating Elements // Creating Elements
void label(const char *label, int color, String value = ""); // Create Label
void button(const char *label, void (*callBack)(Control, int), int color,
String value = ""); // Create Event Button
void switcher(const char *label, bool startState,
void (*callBack)(Control, int),
int color); // Create Toggle Button
void pad(const char *label, bool centerButton, void (*callBack)(Control, int),
int color); // Create Pad Control
void slider(const char *label, void (*callBack)(Control, int), int color, String value); // Create Slider Control
// Update Elements int button(const char *label, void (*callBack)(Control, int), int color, String value = ""); // Create Event Button
void print(int id, String value); int switcher(const char *label, bool startState, void (*callBack)(Control, int), int color); // Create Toggle Button
void print(String label, String value); int pad(const char *label, bool centerButton, void (*callBack)(Control, int), int color); // Create Pad Control
int slider(const char *label, void (*callBack)(Control, int), int color, String value); // Create Slider Control
int number(const char *label, void (*callBack)(Control, int), int color, int number, int min, int max); // Create a Number Input Control
void updateSwitcher(int id, bool nValue, int clientId = -1); // Output only
void updateSwitcher(String label, bool nValue, int clientId = -1); int label(const char *label, int color, String value = ""); // Create Label
int graph(const char *label, int color); // Create Graph display
void updateSlider(int id, int nValue, int clientId = -1); // Update Elements
void updateSlider(String label, int nValue, int clientId = -1); void print(int id, String value);
void print(String label, String value);
void textThem(String text, int clientId); void updateSwitcher(int id, bool nValue, int clientId = -1);
void updateSwitcher(String label, bool nValue, int clientId = -1);
// Variables --- void updateSlider(int id, int nValue, int clientId = -1);
const char *ui_title = "ESPUI"; // Store UI Title and Header Name void updateSlider(String label, int nValue, int clientId = -1);
int cIndex = 0; // Control index
Control *controls[25]; void updateNumber(int id, int nValue, int clientId = -1);
void jsonDom(AsyncWebSocketClient *client); void updateNumber(String label, int nValue, int clientId = -1);
int getIdByLabel(String label);
bool labelExists(String label); void clearGraph(int id, int clientId = -1);
void clearGraph(String label, int clientId = -1);
void addGraphPoint(int id, int nValue, int clientId = -1);
void addGraphPoint(String label, int nValue, int clientId = -1);
void textThem(String text, int clientId);
// Variables ---
const char *ui_title = "ESPUI"; // Store UI Title and Header Name
int cIndex = 0; // Control index
Control *controls[25];
void jsonDom(AsyncWebSocketClient *client);
int getIdByLabel(String label);
bool labelExists(String label);
private: private:
AsyncWebServer *server; AsyncWebServer *server;
AsyncWebSocket *ws; AsyncWebSocket *ws;
}; };
extern ESPUIClass ESPUI; extern ESPUIClass ESPUI;

5
src/dataControlsJS.h Normal file

File diff suppressed because one or more lines are too long

5
src/dataNormalizeCSS.h Normal file
View File

@ -0,0 +1,5 @@
const char CSS_NORMALIZE[] PROGMEM = R"=====(
html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,hgroup,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block;vertical-align:baseline}audio:not([controls]){display:none;height:0}[hidden],template{display:none}a{background-color:transparent}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}dfn{font-style:italic}h1{font-size:2em;margin:.67em 0}mark{background:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:1em 40px}hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}pre{overflow:auto}code,kbd,pre,samp{font-family:monospace,monospace;font-size:1em}button,input,optgroup,select,textarea{color:inherit;font:inherit;margin:0}button{overflow:visible}button,select{text-transform:none}button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}input{line-height:normal}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}input[type="number"]::-webkit-inner-spin-button,input[type="number"]::-webkit-outer-spin-button{height:auto}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}fieldset{border:1px solid #c0c0c0;margin:0 2px;padding:.35em .625em .75em}legend{border:0;padding:0}textarea{overflow:auto}optgroup{font-weight:bold}table{border-collapse:collapse;border-spacing:0}td,th{padding:0}
)=====";
const uint8_t CSS_NORMALIZE_GZIP[865] PROGMEM = { 31,139,8,0,0,0,0,0,0,3,149,84,93,111,219,58,12,125,223,175,8,90,12,184,3,228,194,237,221,214,65,198,126,73,144,7,90,162,109,45,250,130,36,167,201,12,255,247,81,182,227,36,93,122,129,139,60,196,166,37,242,240,156,67,118,201,232,161,113,54,21,13,24,165,79,60,130,141,69,196,160,154,170,48,177,72,120,76,69,84,191,177,0,249,171,143,137,63,151,229,231,170,120,195,122,175,210,253,175,99,237,228,105,48,16,90,101,121,57,66,72,74,104,100,16,149,68,38,49,129,210,145,53,170,21,224,147,114,54,63,246,1,89,227,92,194,192,58,4,153,255,218,224,122,207,12,40,203,12,218,158,89,56,176,136,98,186,17,123,67,233,79,131,84,209,107,56,241,90,59,177,31,161,151,202,49,1,246,0,145,249,224,218,128,49,178,3,85,117,235,73,101,181,178,88,76,23,170,3,102,104,160,11,208,170,181,188,134,136,249,235,156,136,91,151,254,217,10,98,38,56,29,119,95,214,20,214,89,172,58,84,109,151,168,187,109,167,164,68,187,99,9,13,125,78,120,115,110,132,161,6,177,207,189,88,89,8,167,93,224,41,16,195,30,2,218,52,2,7,234,232,64,228,240,206,17,156,193,245,41,67,200,180,213,117,216,38,149,52,238,134,218,5,226,164,168,93,74,206,240,103,127,220,72,122,68,57,214,44,18,60,219,206,10,190,205,160,106,167,229,40,27,59,7,99,58,105,228,42,81,143,98,236,158,151,32,73,198,95,208,84,139,74,79,223,95,209,108,202,145,94,247,87,136,249,99,211,148,213,12,251,177,44,203,49,26,208,250,42,197,15,82,59,246,132,162,247,87,209,215,111,159,171,137,230,51,75,149,119,81,101,229,120,64,226,136,26,254,144,251,156,41,57,207,139,242,233,27,154,156,124,88,218,166,200,75,14,41,211,46,132,16,75,241,208,78,66,241,64,238,249,50,100,14,27,237,222,248,172,202,56,91,235,236,197,103,234,241,107,233,143,99,23,134,194,184,223,68,232,49,35,86,182,229,89,104,82,36,135,170,15,194,171,230,158,82,174,149,160,79,110,20,142,172,189,175,37,217,14,89,4,227,111,70,202,56,235,72,113,129,108,125,170,46,108,17,170,177,238,169,69,203,148,245,125,98,206,167,217,252,68,9,25,158,229,33,35,187,192,48,11,161,108,71,211,153,166,12,235,203,58,109,115,166,11,188,131,138,170,214,120,174,48,167,28,166,185,157,140,216,184,96,102,171,46,39,58,90,8,155,9,200,54,157,60,254,124,152,227,15,59,118,29,164,209,194,244,46,70,90,25,69,193,225,188,29,192,123,4,42,34,144,207,73,42,209,135,72,45,120,167,136,214,176,148,220,210,196,0,97,148,187,235,226,107,112,88,46,73,108,160,215,105,185,196,249,164,96,227,68,31,11,101,45,173,140,233,222,223,241,213,44,149,7,41,179,168,229,56,29,29,174,61,106,137,7,208,227,117,63,162,67,177,39,225,223,183,14,180,29,30,242,80,174,46,89,231,243,248,190,198,114,199,246,166,198,240,176,35,116,11,55,19,180,34,122,101,139,107,241,63,60,79,139,225,246,252,176,0,159,252,119,35,3,113,46,186,251,50,100,221,27,133,90,86,255,229,255,243,197,255,53,30,119,49,92,240,207,145,66,100,24,250,94,203,31,94,145,40,92,128,188,61,238,117,52,89,119,106,137,12,121,150,58,111,200,232,180,146,155,71,81,230,223,58,31,155,23,127,209,232,233,95,218,39,155,167,239,47,211,223,107,94,46,26,91,180,242,158,101,214,41,188,157,252,243,176,254,189,129,83,182,239,121,117,211,232,106,240,17,249,249,161,90,62,228,109,176,20,144,44,117,195,165,224,167,63,69,20,17,138,155,7,0,0 };

6
src/dataSliderJS.h Normal file
View File

@ -0,0 +1,6 @@
const char JS_SLIDER[] PROGMEM = R"=====(
function rkmd_rangeSlider(b){var f,e,c,a,g,d,h;f=$(b);e=f.width();c=f.offset().left;g=f;g.each(function(k,j){a=$(this);a.append(sliderDiscrete_tmplt());d=a.find('input[type="range"]');h=a.find(".slider");slider_fill=h.find(".slider-fill");slider_handle=h.find(".slider-handle");slider_label=h.find(".slider-label");var l=parseInt(d.val());slider_fill.css("width",l+"%");slider_handle.css("left",l+"%");slider_label.find("span").text(l)});f.on("mousedown touchstart",".slider-handle",function(o){if(o.button===2){return false}var m=$(this).parents(".rkmd-slider");var l=m.width();var i=m.offset().left;var k=m.find('input[type="range"]').is(":disabled");if(k===true){return false}$(this).addClass("is-active");var p=function(r){var q=r.pageX-i;if(q<=l&&!(q<"0")){slider_move(m,q,l,true)}};var n=function(q){$(this).off(j);m.find(".is-active").removeClass("is-active")};var j={mousemove:p,touchmove:p,mouseup:n,touchend:n};$(document).on(j)});f.on("mousedown touchstart",".slider",function(p){if(p.button===2){return false}var m=$(this).parents(".rkmd-slider");var l=m.width();var i=m.offset().left;var k=m.find('input[type="range"]').is(":disabled");if(k===true){return false}var o=p.pageX-i;if(o<=l&&!(o<"0")){slider_move(m,o,l,true)}var n=function(q){$(this).off(j)};var j={mouseup:n,touchend:n};$(document).on(j)})}function sliderDiscrete_tmplt(){var a='<div class="slider"><div class="slider-fill"></div><div class="slider-handle"><div class="slider-label"><span>0</span></div></div></div>';return a}function slider_move(g,a,h,e){var i=parseInt(Math.round(a/h*100));var b=g.find(".slider-fill");var c=g.find(".slider-handle");var f=g.find('input[type="range"]');b.css("width",i+"%");c.css({left:i+"%",transition:"none","-webkit-transition":"none","-moz-transition":"none"});f.val(i);if(g.find(".slider-handle span").text()!=i){g.find(".slider-handle span").text(i);var d=g.attr("id").substring(2);if(e){websock.send("slvalue:"+i+":"+d)}}};
)=====";
const uint8_t JS_SLIDER_GZIP[] PROGMEM = { 31,139,8,0,0,0,0,0,0,3,213,85,203,146,211,48,16,252,149,172,106,33,22,235,104,195,30,227,40,23,184,112,224,196,133,42,138,218,146,45,217,86,34,75,142,37,103,1,87,254,157,145,108,231,13,236,149,139,31,51,147,86,207,244,184,147,183,58,115,210,232,73,179,169,248,115,195,116,33,190,40,201,69,19,165,184,219,177,102,146,199,34,206,98,22,23,49,143,203,36,167,247,144,72,4,205,201,139,228,174,140,112,146,193,179,201,115,43,92,132,137,18,185,75,10,154,39,5,17,44,43,163,124,128,143,54,241,26,119,12,126,237,74,105,113,194,8,171,107,161,121,100,195,97,31,165,205,26,225,196,179,171,106,5,56,56,225,148,145,92,66,193,84,234,186,117,223,220,207,90,80,20,248,161,239,83,156,148,99,30,145,30,2,225,164,127,120,206,165,82,180,60,207,206,124,240,88,82,50,205,149,184,42,234,195,199,50,197,82,113,13,21,162,80,228,167,163,104,205,26,43,62,105,23,113,178,99,202,83,63,161,65,50,107,35,20,38,133,98,245,128,222,92,82,232,11,252,212,46,243,225,148,225,100,91,51,141,48,113,226,135,139,20,222,227,4,38,174,35,84,153,214,10,110,94,244,196,153,54,43,173,99,13,192,92,118,19,31,52,48,184,147,121,100,72,218,58,103,52,165,244,9,119,48,245,182,209,147,156,41,43,246,190,163,106,212,136,64,103,66,59,160,71,252,110,204,14,99,238,251,174,14,11,224,223,37,188,159,47,129,143,110,32,250,23,17,137,4,240,5,151,150,165,74,112,64,6,118,27,160,229,154,86,92,48,27,57,49,206,63,40,230,103,38,237,140,65,91,59,49,48,170,233,161,207,166,223,220,45,109,160,135,66,124,157,73,143,188,93,82,245,246,237,29,220,209,28,97,220,13,115,174,204,78,68,85,188,141,85,28,206,221,239,3,156,62,194,109,113,55,30,15,45,70,107,156,84,227,70,156,144,32,141,240,80,215,236,122,188,53,237,130,92,190,102,81,199,65,176,225,57,196,219,122,161,251,40,124,21,11,189,79,238,35,110,178,182,2,5,176,23,123,253,90,217,79,244,174,131,222,245,255,168,183,71,51,180,62,213,207,12,250,153,155,250,153,131,126,255,82,239,92,143,215,204,125,63,130,77,110,187,85,216,54,70,167,75,46,119,147,204,47,0,69,195,244,86,215,177,222,138,86,203,71,200,220,74,15,159,237,173,84,239,60,171,165,247,131,213,124,249,24,238,3,208,201,117,154,12,179,100,151,204,251,105,21,96,231,101,44,122,222,242,232,96,159,153,43,73,99,90,16,144,61,150,239,222,207,231,184,87,59,165,197,109,59,245,201,236,42,121,176,209,240,255,49,166,255,96,228,233,153,71,202,222,3,179,16,236,252,98,45,66,8,180,101,218,74,223,202,2,105,163,193,214,208,236,69,164,27,233,102,199,20,58,230,42,243,235,70,34,124,67,222,166,101,88,190,219,196,39,167,118,139,239,168,196,221,43,10,101,223,46,135,118,153,115,13,88,0,108,56,177,109,106,93,35,117,17,61,133,19,97,232,192,218,154,108,67,172,8,214,174,128,78,43,22,232,1,250,132,43,7,3,218,39,191,1,31,225,29,112,150,7,0,0 };

5
src/dataStyleCSS.h Normal file

File diff suppressed because one or more lines are too long

9
src/dataZeptoJS.h Normal file

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -1,3 +0,0 @@
const char CSS_NORMALIZE[] PROGMEM = R"=====(
html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,hgroup,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block;vertical-align:baseline}audio:not([controls]){display:none;height:0}[hidden],template{display:none}a{background-color:transparent}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}dfn{font-style:italic}h1{font-size:2em;margin:.67em 0}mark{background:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:1em 40px}hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}pre{overflow:auto}code,kbd,pre,samp{font-family:monospace,monospace;font-size:1em}button,input,optgroup,select,textarea{color:inherit;font:inherit;margin:0}button{overflow:visible}button,select{text-transform:none}button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}input{line-height:normal}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}input[type="number"]::-webkit-inner-spin-button,input[type="number"]::-webkit-outer-spin-button{height:auto}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}fieldset{border:1px solid #c0c0c0;margin:0 2px;padding:.35em .625em .75em}legend{border:0;padding:0}textarea{overflow:auto}optgroup{font-weight:bold}table{border-collapse:collapse;border-spacing:0}td,th{padding:0}
)=====";

View File

@ -1,3 +0,0 @@
const char JS_SLIDER[] PROGMEM = R"=====(
function rkmd_rangeSlider(b){var f,e,c,a,g,d,h;f=$(b);e=f.width();c=f.offset().left;g=f;g.each(function(k,j){a=$(this);a.append(sliderDiscrete_tmplt());d=a.find('input[type="range"]');h=a.find(".slider");slider_fill=h.find(".slider-fill");slider_handle=h.find(".slider-handle");slider_label=h.find(".slider-label");var l=parseInt(d.val());slider_fill.css("width",l+"%");slider_handle.css("left",l+"%");slider_label.find("span").text(l)});f.on("mousedown touchstart",".slider-handle",function(o){if(o.button===2){return false}var m=$(this).parents(".rkmd-slider");var l=m.width();var i=m.offset().left;var k=m.find('input[type="range"]').is(":disabled");if(k===true){return false}$(this).addClass("is-active");var p=function(r){var q=r.pageX-i;if(q<=l&&!(q<"0")){slider_move(m,q,l,true)}};var n=function(q){$(this).off(j);m.find(".is-active").removeClass("is-active")};var j={mousemove:p,touchmove:p,mouseup:n,touchend:n};$(document).on(j)});f.on("mousedown touchstart",".slider",function(p){if(p.button===2){return false}var m=$(this).parents(".rkmd-slider");var l=m.width();var i=m.offset().left;var k=m.find('input[type="range"]').is(":disabled");if(k===true){return false}var o=p.pageX-i;if(o<=l&&!(o<"0")){slider_move(m,o,l,true)}var n=function(q){$(this).off(j)};var j={mouseup:n,touchend:n};$(document).on(j)})}function sliderDiscrete_tmplt(){var a='<div class="slider"><div class="slider-fill"></div><div class="slider-handle"><div class="slider-label"><span>0</span></div></div></div>';return a}function slider_move(g,a,h,e){var i=parseInt(Math.round(a/h*100));var b=g.find(".slider-fill");var c=g.find(".slider-handle");var f=g.find('input[type="range"]');b.css("width",i+"%");c.css({left:i+"%",transition:"none","-webkit-transition":"none","-moz-transition":"none"});f.val(i);if(g.find(".slider-handle span").text()!=i){g.find(".slider-handle span").text(i);var d=g.attr("id").substring(2);if(e){websock.send("slvalue:"+i+":"+d)}}};
)=====";

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long