mirror of
https://github.com/s00500/ESPUI.git
synced 2025-07-03 19:50:20 +00:00
Compare commits
6 Commits
Author | SHA1 | Date | |
---|---|---|---|
b421b84b11 | |||
f1012b2fe2 | |||
cc633a7c85 | |||
40b13430cb | |||
dda4e9e771 | |||
1390b73218 |
@ -51,7 +51,7 @@ Download the [Repository](https://github.com/s00500/ESPUI/archive/master.zip), G
|
||||
ESPUI **NEEDS** its files burnt on the SPIFFS filesystem on the ESP. **Without this ESPUI will NOT work at all**
|
||||
There are now two ways to do this: you can either use the upload tool or you use the library function `ESPUI.prepareFileSystem()`
|
||||
|
||||
#### Simple filesystem preparation (recomended)
|
||||
#### Simple filesystem preparation (recomended, but currently not working well on esp32, see issues)
|
||||
|
||||
Just open the example sketch **prepareFileSystem** and run it on the ESP, (give it 5 - 10 seconds),
|
||||
The library will create all needed files.
|
||||
@ -81,10 +81,13 @@ Now you are set to go and use any code you want to with this library
|
||||
- ~~Setup SPIFFS using values in program memory~~
|
||||
- ~~ESP8266 support~~
|
||||
- Document slider
|
||||
- New images in docu
|
||||
- proper return value (as int and not as string) for slider
|
||||
- Maybe a slider range setting, meanwhile please use map()
|
||||
- Improve slider stability
|
||||
- Improve general stability
|
||||
- Multiline Labels
|
||||
- PlattformIO Integration
|
||||
|
||||
## Documentation
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
name=ESPUI
|
||||
version=1.4.5
|
||||
version=1.4.6
|
||||
author=Lukas Bachschwell
|
||||
maintainer=Lukas Bachschwell <lukas@lbsfilm.at>
|
||||
sentence=ESP32 and ESP8266 Web Interface Library
|
||||
|
@ -108,11 +108,19 @@ void writeFile(const char *path, const char *data) {
|
||||
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();
|
||||
}
|
||||
|
||||
@ -175,10 +183,21 @@ void ESPUIClass::prepareFileSystem() {
|
||||
void onWsEvent(AsyncWebSocket *server, AsyncWebSocketClient *client,
|
||||
AwsEventType type, void *arg, uint8_t *data, size_t len) {
|
||||
switch (type) {
|
||||
case WS_EVT_DISCONNECT:
|
||||
case WS_EVT_DISCONNECT: {
|
||||
if (debug)
|
||||
Serial.printf("Disconnected!\n");
|
||||
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: {
|
||||
if (debug) {
|
||||
Serial.print("Connected: ");
|
||||
@ -190,19 +209,20 @@ void onWsEvent(AsyncWebSocket *server, AsyncWebSocketClient *client,
|
||||
Serial.println("JSON Data Sent to Client!");
|
||||
}
|
||||
} break;
|
||||
case WS_EVT_DATA:
|
||||
case WS_EVT_DATA: {
|
||||
String msg = "";
|
||||
for (size_t i = 0; i < len; i++) {
|
||||
msg += (char)data[i];
|
||||
}
|
||||
|
||||
int id = msg.substring(msg.lastIndexOf(':') + 1).toInt();
|
||||
if (id >= ESPUI.cIndex) {
|
||||
if (debug)
|
||||
Serial.println("Maleformated id in websocket message");
|
||||
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:")) {
|
||||
c->callback(*c, B_DOWN);
|
||||
@ -240,16 +260,19 @@ void onWsEvent(AsyncWebSocket *server, AsyncWebSocketClient *client,
|
||||
ESPUI.updateSlider(c->id, value, client->id());
|
||||
c->callback(*c, SL_VALUE);
|
||||
}
|
||||
}
|
||||
break;
|
||||
default:
|
||||
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 (debug)
|
||||
Serial.println("UI ERROR: Element " + String(label) +
|
||||
" exists, skipping creating element!");
|
||||
return;
|
||||
return -1;
|
||||
}
|
||||
|
||||
Control *newL = new Control();
|
||||
@ -264,16 +287,17 @@ void ESPUIClass::label(const char *label, int color, String value) {
|
||||
newL->id = cIndex;
|
||||
controls[cIndex] = newL;
|
||||
cIndex++;
|
||||
return cIndex - 1;
|
||||
}
|
||||
|
||||
// TODO: this still needs a range setting
|
||||
void ESPUIClass::slider(const char *label, void (*callBack)(Control, int),
|
||||
int ESPUIClass::slider(const char *label, void (*callBack)(Control, int),
|
||||
int color, String value) {
|
||||
if (labelExists(label)) {
|
||||
if (debug)
|
||||
Serial.println("UI ERROR: Element " + String(label) +
|
||||
" exists, skipping creating element!");
|
||||
return;
|
||||
return -1;
|
||||
}
|
||||
|
||||
Control *newSL = new Control();
|
||||
@ -288,15 +312,16 @@ void ESPUIClass::slider(const char *label, void (*callBack)(Control, int),
|
||||
newSL->id = cIndex;
|
||||
controls[cIndex] = newSL;
|
||||
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) {
|
||||
if (labelExists(label)) {
|
||||
if (debug)
|
||||
Serial.println("UI ERROR: Element " + String(label) +
|
||||
" exists, skipping creating element!");
|
||||
return;
|
||||
return -1;
|
||||
}
|
||||
|
||||
Control *newB = new Control();
|
||||
@ -313,15 +338,16 @@ void ESPUIClass::button(const char *label, void (*callBack)(Control, int),
|
||||
newB->id = cIndex;
|
||||
controls[cIndex] = newB;
|
||||
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) {
|
||||
if (labelExists(label)) {
|
||||
if (debug)
|
||||
Serial.println("UI ERROR: Element " + String(label) +
|
||||
" exists, skipping creating element!");
|
||||
return;
|
||||
return -1;
|
||||
}
|
||||
|
||||
Control *newS = new Control();
|
||||
@ -333,15 +359,16 @@ void ESPUIClass::switcher(const char *label, bool startState,
|
||||
newS->id = cIndex;
|
||||
controls[cIndex] = newS;
|
||||
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) {
|
||||
if (labelExists(label)) {
|
||||
if (debug)
|
||||
Serial.println("UI ERROR: Element " + String(label) +
|
||||
" exists, skipping creating element!");
|
||||
return;
|
||||
return -1;
|
||||
}
|
||||
|
||||
Control *newP = new Control();
|
||||
@ -355,6 +382,7 @@ void ESPUIClass::pad(const char *label, bool center,
|
||||
newP->id = cIndex;
|
||||
controls[cIndex] = newP;
|
||||
cIndex++;
|
||||
return cIndex - 1;
|
||||
}
|
||||
|
||||
void ESPUIClass::print(int id, String value) {
|
||||
@ -510,7 +538,9 @@ void ESPUIClass::begin(const char *_title) {
|
||||
});
|
||||
|
||||
server->onNotFound(
|
||||
[](AsyncWebServerRequest *request) { request->send(404); });
|
||||
[](AsyncWebServerRequest *request) {
|
||||
request->send(404);
|
||||
});
|
||||
|
||||
server->begin();
|
||||
if (debug)
|
||||
|
50
src/ESPUI.h
50
src/ESPUI.h
@ -86,44 +86,44 @@ typedef struct Control {
|
||||
class ESPUIClass {
|
||||
|
||||
public:
|
||||
void begin(const char *_title); // Setup servers and page
|
||||
void begin(const char *_title); // Setup servers and page
|
||||
|
||||
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();
|
||||
// Creating Elements
|
||||
void label(const char *label, int color, String value = ""); // Create Label
|
||||
void button(const char *label, void (*callBack)(Control, int), int color,
|
||||
// Creating Elements
|
||||
int label(const char *label, int color, String value = ""); // Create Label
|
||||
int button(const char *label, void (*callBack)(Control, int), int color,
|
||||
String value = ""); // Create Event Button
|
||||
void switcher(const char *label, bool startState,
|
||||
int 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 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
|
||||
int slider(const char *label, void (*callBack)(Control, int), int color, String value); // Create Slider Control
|
||||
|
||||
// Update Elements
|
||||
void print(int id, String value);
|
||||
void print(String label, String value);
|
||||
// Update Elements
|
||||
void print(int id, String value);
|
||||
void print(String label, String value);
|
||||
|
||||
void updateSwitcher(int id, bool nValue, int clientId = -1);
|
||||
void updateSwitcher(String label, bool nValue, int clientId = -1);
|
||||
void updateSwitcher(int id, bool nValue, int clientId = -1);
|
||||
void updateSwitcher(String label, bool nValue, int clientId = -1);
|
||||
|
||||
void updateSlider(int id, int nValue, int clientId = -1);
|
||||
void updateSlider(String label, int nValue, int clientId = -1);
|
||||
void updateSlider(int id, int nValue, int clientId = -1);
|
||||
void updateSlider(String label, int nValue, int clientId = -1);
|
||||
|
||||
void textThem(String text, int clientId);
|
||||
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);
|
||||
// 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:
|
||||
AsyncWebServer *server;
|
||||
AsyncWebSocket *ws;
|
||||
AsyncWebServer *server;
|
||||
AsyncWebSocket *ws;
|
||||
};
|
||||
|
||||
extern ESPUIClass ESPUI;
|
||||
|
Reference in New Issue
Block a user