2024-01-06 16:54:23 +00:00
|
|
|
/*
|
|
|
|
|
xdrv_121_gpioviewer.ino - GPIOViewer for Tasmota
|
|
|
|
|
|
|
|
|
|
SPDX-FileCopyrightText: 2024 Theo Arends
|
|
|
|
|
|
|
|
|
|
SPDX-License-Identifier: GPL-3.0-only
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifdef USE_GPIO_VIEWER
|
|
|
|
|
/*********************************************************************************************\
|
|
|
|
|
* GPIOViewer support
|
|
|
|
|
*
|
|
|
|
|
* Open webpage <device_ip_address>:8080 and watch realtime GPIO states
|
|
|
|
|
\*********************************************************************************************/
|
|
|
|
|
|
|
|
|
|
#define XDRV_121 121
|
|
|
|
|
|
2024-01-07 14:10:19 +00:00
|
|
|
#define GV_PORT 5557
|
2024-01-06 16:54:23 +00:00
|
|
|
#define GV_SAMPLING_INTERVAL 100 // Relates to FUNC_EVERY_100_MSECOND
|
|
|
|
|
|
2024-01-07 14:10:19 +00:00
|
|
|
const char *GVRelease = "1.0.7";
|
2024-01-06 16:54:23 +00:00
|
|
|
|
|
|
|
|
#define GV_BASE_URL "https://thelastoutpostworkshop.github.io/microcontroller_devkit/gpio_viewer/assets/"
|
|
|
|
|
|
|
|
|
|
const char HTTP_GV_PAGE[] PROGMEM =
|
|
|
|
|
"<!DOCTYPE HTML>"
|
|
|
|
|
"<html>"
|
|
|
|
|
"<head>"
|
|
|
|
|
"<title>Tasmota GPIO State</title>"
|
|
|
|
|
"<base href='" GV_BASE_URL "'>"
|
|
|
|
|
"<link id='defaultStyleSheet' rel='stylesheet' href=''>"
|
|
|
|
|
"<link id='boardStyleSheet' rel='stylesheet' href=''>"
|
|
|
|
|
"<link rel='icon' href='favicon.ico' type='image/x-icon'>"
|
|
|
|
|
"<script src='script/webSocket.js'></script>"
|
|
|
|
|
"<script src='script/boardSwitcher.js'></script>"
|
|
|
|
|
"<script>"
|
|
|
|
|
"var serverPort=" STR(GV_PORT) ";"
|
|
|
|
|
"var ip='%s';" // WiFi.localIP().toString().c_str()
|
|
|
|
|
"var source=new EventSource('http://%s:" STR(GV_PORT) "/events');" // WiFi.localIP().toString().c_str()
|
|
|
|
|
"var sampling_interval='" STR(GV_SAMPLING_INTERVAL) "';"
|
2024-01-06 20:57:09 +00:00
|
|
|
"var freeSketchSpace='%s';" // GVFormatBytes(ESP_getFreeSketchSpace()).c_str()
|
2024-01-06 16:54:23 +00:00
|
|
|
"</script>"
|
|
|
|
|
"</head>"
|
|
|
|
|
"<body>"
|
|
|
|
|
"<div class='grid-container'>"
|
2024-01-07 14:10:19 +00:00
|
|
|
"<div id='messageBox' class='message-box hidden'></div>"
|
2024-01-06 16:54:23 +00:00
|
|
|
"<header class='header'></header>"
|
|
|
|
|
// Image
|
|
|
|
|
"<div class='image-container'>"
|
|
|
|
|
"<div id='imageWrapper' class='image-wrapper'>"
|
|
|
|
|
"<img id='boardImage' src='' alt='Board Image'>"
|
|
|
|
|
"<div id='indicators'></div>"
|
|
|
|
|
"</div>"
|
|
|
|
|
"</div>"
|
|
|
|
|
"</div>"
|
|
|
|
|
"</body>"
|
|
|
|
|
"</html>";
|
|
|
|
|
|
2024-01-06 20:57:09 +00:00
|
|
|
const char HTTP_GV_EVENT[] PROGMEM =
|
|
|
|
|
"HTTP/1.1 200 OK\n"
|
|
|
|
|
"Content-Type: text/event-stream;\n"
|
|
|
|
|
"Connection: keep-alive\n"
|
|
|
|
|
"Cache-Control: no-cache\n"
|
|
|
|
|
"Access-Control-Allow-Origin: *\n\n";
|
|
|
|
|
|
2024-01-06 16:54:23 +00:00
|
|
|
enum GVPinTypes {
|
|
|
|
|
digitalPin = 0,
|
|
|
|
|
PWMPin = 1,
|
|
|
|
|
analogPin = 2
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
struct {
|
|
|
|
|
WiFiClient WebClient;
|
|
|
|
|
ESP8266WebServer *WebServer;
|
2024-01-06 20:57:09 +00:00
|
|
|
uint32_t lastPinStates[MAX_GPIO_PIN];
|
2024-01-07 14:10:19 +00:00
|
|
|
uint32_t resolution;
|
|
|
|
|
uint32_t freeHeap;
|
|
|
|
|
uint32_t freePSRAM;
|
2024-01-06 20:57:09 +00:00
|
|
|
bool sse_ready;
|
2024-01-06 16:54:23 +00:00
|
|
|
bool active;
|
|
|
|
|
} GV;
|
|
|
|
|
|
|
|
|
|
String GVFormatBytes(size_t bytes) {
|
|
|
|
|
if (bytes < 1024) {
|
|
|
|
|
return String(bytes) + " B";
|
|
|
|
|
}
|
|
|
|
|
else if (bytes < (1024 * 1024)) {
|
|
|
|
|
return String(bytes / 1024.0, 2) + " KB";
|
|
|
|
|
}
|
|
|
|
|
else {
|
|
|
|
|
return String(bytes / 1024.0 / 1024.0, 2) + " MB";
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2024-01-07 14:10:19 +00:00
|
|
|
int GVReadGPIO(int gpioNum, uint32_t *originalValue, uint32_t *pintype) {
|
|
|
|
|
uint32_t pin_type = GetPin(gpioNum) / 32;
|
|
|
|
|
/*
|
|
|
|
|
if (GPIO_NONE == pin_type) {
|
|
|
|
|
*pintype = digitalPin;
|
|
|
|
|
*originalValue = 0;
|
|
|
|
|
return 0;
|
2024-01-06 16:54:23 +00:00
|
|
|
}
|
2024-01-07 14:10:19 +00:00
|
|
|
*/
|
2024-01-06 16:54:23 +00:00
|
|
|
#ifdef ESP32
|
2024-01-07 14:10:19 +00:00
|
|
|
int pwm_resolution = ledcReadDutyResolution(gpioNum);
|
|
|
|
|
if (pwm_resolution > 0) {
|
2024-01-06 16:54:23 +00:00
|
|
|
*pintype = PWMPin;
|
2024-01-07 14:10:19 +00:00
|
|
|
*originalValue = ledcRead2(gpioNum);
|
|
|
|
|
return changeUIntScale(*originalValue, 0, pwm_resolution, 0, 255); // bring back to 0..255
|
2024-01-06 16:54:23 +00:00
|
|
|
}
|
|
|
|
|
#endif // ESP32
|
2024-01-07 14:10:19 +00:00
|
|
|
|
2024-01-06 16:54:23 +00:00
|
|
|
#ifdef ESP8266
|
2024-01-07 14:10:19 +00:00
|
|
|
int pwm_value = AnalogRead(gpioNum);
|
|
|
|
|
if (pwm_value > -1) {
|
|
|
|
|
*pintype = PWMPin;
|
|
|
|
|
*originalValue = pwm_value;
|
|
|
|
|
int pwm_resolution = GV.resolution;
|
|
|
|
|
return changeUIntScale(*originalValue, 0, pwm_resolution, 0, 255); // bring back to 0..255
|
|
|
|
|
}
|
2024-01-06 16:54:23 +00:00
|
|
|
#endif // ESP8266
|
|
|
|
|
|
2024-01-07 14:10:19 +00:00
|
|
|
else if (AdcPin(gpioNum)) {
|
|
|
|
|
int adc_resolution = (1 << AdcResolution()) - 1;
|
|
|
|
|
*originalValue = AdcRead(gpioNum, 2);
|
2024-01-06 16:54:23 +00:00
|
|
|
*pintype = analogPin;
|
2024-01-07 14:10:19 +00:00
|
|
|
return changeUIntScale(*originalValue, 0, adc_resolution, 0, 255); // bring back to 0..255
|
2024-01-06 16:54:23 +00:00
|
|
|
}
|
2024-01-07 14:10:19 +00:00
|
|
|
|
|
|
|
|
*pintype = digitalPin;
|
|
|
|
|
int value = digitalRead(gpioNum);
|
|
|
|
|
*originalValue = value;
|
|
|
|
|
if (value == 1) {
|
|
|
|
|
return 256;
|
2024-01-06 16:54:23 +00:00
|
|
|
}
|
2024-01-07 14:10:19 +00:00
|
|
|
return 0;
|
2024-01-06 16:54:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void GVResetStatePins(void) {
|
|
|
|
|
uint32_t originalValue;
|
|
|
|
|
uint32_t pintype;
|
|
|
|
|
AddLog(LOG_LEVEL_INFO, "IOV: GPIOViewer Connected, sampling interval is " STR(GV_SAMPLING_INTERVAL) "ms");
|
|
|
|
|
|
2024-01-07 14:10:19 +00:00
|
|
|
for (uint32_t pin = 0; pin < MAX_GPIO_PIN; pin++) {
|
|
|
|
|
GV.lastPinStates[pin] = GVReadGPIO(pin, &originalValue, &pintype);
|
2024-01-06 16:54:23 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2024-01-06 20:57:09 +00:00
|
|
|
//void GVEventSend(const char *message, const char *event=NULL, uint32_t id=0, uint32_t reconnect=0);
|
|
|
|
|
void GVEventSend(const char *message, const char *event, uint32_t id) {
|
2024-01-06 16:54:23 +00:00
|
|
|
if (GV.WebClient.connected()) {
|
|
|
|
|
// generateEventMessage() in AsyncEventSource.cpp
|
|
|
|
|
// GV.WebClient.printf_P(PSTR("retry: 0\r\nid: %u\r\nevent: %s\r\ndata: %s\r\n\r\n"), id, event, message);
|
|
|
|
|
GV.WebClient.printf_P(PSTR("id: %u\r\nevent: %s\r\ndata: %s\r\n\r\n"), id, event, message);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Monitor GPIO Values
|
|
|
|
|
void GVMonitorTask(void) {
|
2024-01-07 14:10:19 +00:00
|
|
|
#ifdef ESP8266
|
|
|
|
|
// Can change on the fly
|
|
|
|
|
uint32_t pwm_range = Settings->pwm_range + 1;
|
|
|
|
|
GV.resolution = 0;
|
|
|
|
|
while (pwm_range) {
|
|
|
|
|
GV.resolution++;
|
|
|
|
|
pwm_range >>= 1;
|
|
|
|
|
}
|
|
|
|
|
#endif // ESP8266
|
|
|
|
|
|
2024-01-06 16:54:23 +00:00
|
|
|
uint32_t originalValue;
|
|
|
|
|
uint32_t pintype;
|
|
|
|
|
|
|
|
|
|
String jsonMessage = "{";
|
|
|
|
|
bool hasChanges = false;
|
2024-01-07 14:10:19 +00:00
|
|
|
for (uint32_t pin = 0; pin < MAX_GPIO_PIN; pin++) {
|
|
|
|
|
int currentState = GVReadGPIO(pin, &originalValue, &pintype);
|
2024-01-06 16:54:23 +00:00
|
|
|
|
2024-01-07 14:10:19 +00:00
|
|
|
if (originalValue != GV.lastPinStates[pin]) {
|
|
|
|
|
if (hasChanges) {
|
2024-01-06 16:54:23 +00:00
|
|
|
jsonMessage += ", ";
|
2024-01-07 14:10:19 +00:00
|
|
|
}
|
|
|
|
|
jsonMessage += "\"" + String(pin) + "\": {\"s\": " + currentState + ", \"v\": " + originalValue + ", \"t\": " + pintype + "}";
|
|
|
|
|
GV.lastPinStates[pin] = currentState;
|
|
|
|
|
hasChanges = true;
|
2024-01-06 16:54:23 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
jsonMessage += "}";
|
|
|
|
|
|
|
|
|
|
if (hasChanges) {
|
2024-01-06 20:57:09 +00:00
|
|
|
GVEventSend(jsonMessage.c_str(), "gpio-state", millis());
|
2024-01-06 16:54:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
uint32_t heap = ESP_getFreeHeap();
|
|
|
|
|
if (heap != GV.freeHeap) {
|
|
|
|
|
GV.freeHeap = heap;
|
2024-01-06 20:57:09 +00:00
|
|
|
GVEventSend(GVFormatBytes(GV.freeHeap).c_str(), "free_heap", millis());
|
2024-01-06 16:54:23 +00:00
|
|
|
}
|
2024-01-07 14:10:19 +00:00
|
|
|
|
|
|
|
|
#ifdef ESP32
|
|
|
|
|
if (UsePSRAM()) {
|
|
|
|
|
uint32_t psram = ESP.getFreePsram();
|
|
|
|
|
if (psram != GV.freePSRAM) {
|
|
|
|
|
GV.freePSRAM = psram;
|
|
|
|
|
GVEventSend(GVFormatBytes(GV.freePSRAM).c_str(), "free_psram", millis());
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
#endif // ESP32
|
2024-01-06 16:54:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void GVBegin(void) {
|
|
|
|
|
GV.WebServer = new ESP8266WebServer(GV_PORT);
|
|
|
|
|
// Set CORS headers for global responses
|
|
|
|
|
GV.WebServer->sendHeader("Access-Control-Allow-Origin", "*");
|
|
|
|
|
GV.WebServer->sendHeader("Access-Control-Allow-Methods", "GET, POST, OPTIONS");
|
|
|
|
|
GV.WebServer->sendHeader("Access-Control-Allow-Headers", "Content-Type");
|
|
|
|
|
GV.WebServer->on("/events", GVHandleEvents);
|
|
|
|
|
GV.WebServer->on("/", GVHandleRoot);
|
|
|
|
|
GV.WebServer->on("/release", GVHandleRelease);
|
|
|
|
|
GV.WebServer->begin();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void GVHandleEvents(void) {
|
2024-01-06 20:57:09 +00:00
|
|
|
GVResetStatePins();
|
2024-01-06 16:54:23 +00:00
|
|
|
|
2024-01-06 20:57:09 +00:00
|
|
|
GV.WebClient = GV.WebServer->client();
|
|
|
|
|
GV.WebClient.setNoDelay(true);
|
|
|
|
|
// GV.WebClient.setSync(true);
|
2024-01-06 20:46:37 +00:00
|
|
|
|
2024-01-06 20:57:09 +00:00
|
|
|
GV.WebServer->setContentLength(CONTENT_LENGTH_UNKNOWN); // The payload can go on forever
|
|
|
|
|
GV.WebServer->sendContent_P(HTTP_GV_EVENT);
|
|
|
|
|
|
|
|
|
|
GV.sse_ready = true; // Ready for async updates
|
2024-01-06 16:54:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void GVHandleRoot(void) {
|
|
|
|
|
char* content = ext_snprintf_malloc_P(HTTP_GV_PAGE,
|
|
|
|
|
WiFi.localIP().toString().c_str(),
|
|
|
|
|
WiFi.localIP().toString().c_str(),
|
2024-01-06 20:57:09 +00:00
|
|
|
GVFormatBytes(ESP_getFreeSketchSpace()).c_str());
|
|
|
|
|
if (content == nullptr) { return; } // Avoid crash
|
2024-01-06 16:54:23 +00:00
|
|
|
|
|
|
|
|
GV.WebServer->send_P(200, "text/html", content);
|
|
|
|
|
free(content);
|
2024-01-06 20:57:09 +00:00
|
|
|
|
|
|
|
|
GV.sse_ready = false; // Allow restart of updates on page load
|
2024-01-06 16:54:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void GVHandleRelease(void) {
|
|
|
|
|
String jsonResponse = "{\"release\": \"" + String(GVRelease) + "\"}";
|
|
|
|
|
|
|
|
|
|
GV.WebServer->send(200, "application/json", jsonResponse);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/*********************************************************************************************\
|
|
|
|
|
* Interface
|
|
|
|
|
\*********************************************************************************************/
|
|
|
|
|
|
|
|
|
|
bool Xdrv121(uint32_t function) {
|
|
|
|
|
bool result = false;
|
|
|
|
|
|
|
|
|
|
if (GV.active) {
|
|
|
|
|
switch (function) {
|
|
|
|
|
case FUNC_LOOP:
|
|
|
|
|
if (GV.WebServer) { GV.WebServer->handleClient(); }
|
|
|
|
|
break;
|
|
|
|
|
case FUNC_EVERY_100_MSECOND:
|
2024-01-06 20:57:09 +00:00
|
|
|
if (GV.sse_ready) { GVMonitorTask(); }
|
2024-01-06 16:54:23 +00:00
|
|
|
break;
|
|
|
|
|
case FUNC_ACTIVE:
|
|
|
|
|
result = true;
|
|
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
switch (function) {
|
|
|
|
|
case FUNC_EVERY_SECOND:
|
|
|
|
|
if (!TasmotaGlobal.global_state.network_down) {
|
|
|
|
|
GVBegin();
|
|
|
|
|
GV.active = true;
|
|
|
|
|
}
|
|
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
return result;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#endif // USE_GPIO_VIEWER
|
