diff --git a/.doxygen/Doxyfile b/.doxygen/Doxyfile index 21014f452..435be1bff 100644 --- a/.doxygen/Doxyfile +++ b/.doxygen/Doxyfile @@ -917,7 +917,8 @@ RECURSIVE = YES EXCLUDE = ../node_modules \ ../travis \ ../dist \ - ../data + ../data \ + ../secrets.h # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded diff --git a/.vscode/c_cpp_properties.json b/.vscode/c_cpp_properties.json index 07664b9ff..c814cca06 100644 --- a/.vscode/c_cpp_properties.json +++ b/.vscode/c_cpp_properties.json @@ -6,7 +6,9 @@ "${workspaceFolder}/**", "${workspaceFolder}/../libraries/**", "${workspaceFolder}/../tools/**", - "${workspaceFolder}/../hardware/esp8266com/esp8266/**" + "${workspaceFolder}/../hardware/esp8266com/esp8266/**", + "C:\\Users\\sporadic\\Documents\\Arduino\\hardware\\esp8266com\\esp8266\\**", + "C:\\Users\\sporadic\\Documents\\Arduino\\tools\\**" ], "defines": [ "_DEBUG", diff --git a/.vscode/settings.json b/.vscode/settings.json index d17c273c0..ed9996ef7 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -2,5 +2,48 @@ "search.exclude": { "**/node_modules": true, "**/.doxygen": true + }, + "javascript.implicitProjectConfig.checkJs": true, + "files.associations": { + "array": "cpp", + "atomic": "cpp", + "*.tcc": "cpp", + "bitset": "cpp", + "cctype": "cpp", + "clocale": "cpp", + "cmath": "cpp", + "cstdarg": "cpp", + "cstdint": "cpp", + "cstdio": "cpp", + "cstdlib": "cpp", + "cstring": "cpp", + "ctime": "cpp", + "cwchar": "cpp", + "cwctype": "cpp", + "deque": "cpp", + "list": "cpp", + "unordered_map": "cpp", + "vector": "cpp", + "exception": "cpp", + "fstream": "cpp", + "functional": "cpp", + "initializer_list": "cpp", + "iomanip": "cpp", + "iosfwd": "cpp", + "iostream": "cpp", + "istream": "cpp", + "limits": "cpp", + "new": "cpp", + "ostream": "cpp", + "numeric": "cpp", + "sstream": "cpp", + "stdexcept": "cpp", + "streambuf": "cpp", + "cinttypes": "cpp", + "regex": "cpp", + "tuple": "cpp", + "type_traits": "cpp", + "utility": "cpp", + "typeinfo": "cpp" } } \ No newline at end of file diff --git a/ESPixelStick.ino b/ESPixelStick.ino index c8b340465..b739ccbaa 100644 --- a/ESPixelStick.ino +++ b/ESPixelStick.ino @@ -21,7 +21,7 @@ /* BEGIN - Configuration */ /*****************************************/ // Create secrets.h with a #define for SECRETS_SSID and SECRETS_PASS -// or delete the #include and enter them directly below. +// or delete the #include and enter the strings directly below. #include "secrets.h" /* Fallback configuration if config.json is empty or fails */ @@ -39,7 +39,8 @@ const char passphrase[] = SECRETS_PASS; #include "src/ESPixelStick.h" #include "src/EFUpdate.h" #include "src/FileIO.h" -#include "src/wshandler.h" +#include "src/WebIO.h" +//#include "src/wshandler.h" // Inputs #include "src/input/_Input.h" @@ -80,12 +81,14 @@ static void _u0_putc(char c){ /// Map of input modules std::map::const_iterator itInput; +const String strddp="ddp"; const std::map INPUT_MODES = { { E131Input::KEY, new E131Input() } }; /// Map of output modules std::map::const_iterator itOutput; +const String strdmx="dmx"; const std::map OUTPUT_MODES = { { WS2811::KEY, new WS2811() } }; @@ -133,7 +136,6 @@ void initWifi(); void initWeb(); void setInput(); void setOutput(); -void serializeConfig(String &jsonString, bool pretty = false, bool creds = false); /// Radio configuration /** ESP8266 radio configuration routines that are executed at startup. */ @@ -213,8 +215,6 @@ void setup() { WiFi.hostname(config.hostname); // Configure inputs and outputs -// setInput(input); -// setOutput(output); setMode(input, output); // Setup WiFi Handlers @@ -293,11 +293,10 @@ void connectWifi() { LOG_PORT.print(F("Connecting with DHCP")); } else { // We don't use DNS, so just set it to our gateway - WiFi.config(IPAddress(config.ip[0], config.ip[1], config.ip[2], config.ip[3]), - IPAddress(config.gateway[0], config.gateway[1], config.gateway[2], config.gateway[3]), - IPAddress(config.netmask[0], config.netmask[1], config.netmask[2], config.netmask[3]), - IPAddress(config.gateway[0], config.gateway[1], config.gateway[2], config.gateway[3]) - ); + IPAddress ip = ip.fromString(config.ip); + IPAddress gateway = gateway.fromString(config.gateway); + IPAddress netmask = netmask.fromString(config.netmask); + WiFi.config(ip, gateway, netmask, gateway); LOG_PORT.print(F("Connecting with Static IP")); } } @@ -349,7 +348,7 @@ void initWeb() { DefaultHeaders::Instance().addHeader(F("Access-Control-Allow-Origin"), "*"); // Setup WebSockets - ws.onEvent(wsEvent); + ws.onEvent(WebIO::onEvent); web.addHandler(&ws); // Heap status handler @@ -360,14 +359,17 @@ void initWeb() { // JSON Config Handler web.on("/conf", HTTP_GET, [](AsyncWebServerRequest *request) { String jsonString; - serializeConfig(jsonString, true); + serializeCore(jsonString, true); request->send(200, "text/json", jsonString); }); // Firmware upload handler - only in station mode web.on("/updatefw", HTTP_POST, [](AsyncWebServerRequest *request) { ws.textAll("X6"); - }, handle_fw_upload).setFilter(ON_STA_FILTER); + }, WebIO::onFirmwareUpload).setFilter(ON_STA_FILTER); + + // Root access for testing + web.serveStatic("/root", SPIFFS, "/"); // Static Handler web.serveStatic("/", SPIFFS, "/www/").setDefaultFile("index.html"); @@ -447,8 +449,8 @@ void validateConfig() { if (!config.hostname.length()) config.hostname = "esps-" + String(chipId); - - itInput = INPUT_MODES.find(config.inputmode); +//TODO: Update this to set to ws2811 and e131 if no config found + itInput = INPUT_MODES.find(config.input); if (itInput != INPUT_MODES.end()) { input = itInput->second; LOG_PORT.printf("- Input mode set to %s\n", input->getKey().c_str()); @@ -456,10 +458,11 @@ void validateConfig() { itInput = INPUT_MODES.begin(); LOG_PORT.printf("* Input mode from core config invalid, setting to %s.\n", itInput->first.c_str()); + config.input = itInput->first; input = itInput->second; } - itOutput = OUTPUT_MODES.find(config.outputmode); + itOutput = OUTPUT_MODES.find(config.output); if (itOutput != OUTPUT_MODES.end()) { output = itOutput->second; LOG_PORT.printf("- Output mode set to %s\n", output->getKey().c_str()); @@ -467,15 +470,17 @@ void validateConfig() { itOutput = OUTPUT_MODES.begin(); LOG_PORT.printf("* Input mode from core config invalid, setting to %s.\n", itOutput->first.c_str()); + config.output = itOutput->first; output = itOutput->second; } } -void deserialize(DynamicJsonDocument &json) { + +void deserializeCore(DynamicJsonDocument &json) { // Device if (json.containsKey("device")) { config.id = json["device"]["id"].as(); - config.inputmode = json["device"]["inputmode"].as(); - config.outputmode = json["device"]["outputmode"].as(); + config.input = json["device"]["input"].as(); + config.output = json["device"]["output"].as(); } else { LOG_PORT.println("No device settings found."); } @@ -494,11 +499,10 @@ void deserialize(DynamicJsonDocument &json) { config.passphrase = passphrase; // Network - for (int i = 0; i < 4; i++) { - config.ip[i] = networkJson["ip"][i]; - config.netmask[i] = networkJson["netmask"][i]; - config.gateway[i] = networkJson["gateway"][i]; - } + config.ip = networkJson["ip"].as(); + config.netmask = networkJson["netmask"].as(); + config.gateway = networkJson["gateway"].as(); + config.dhcp = networkJson["dhcp"]; config.sta_timeout = networkJson["sta_timeout"] | CLIENT_TIMEOUT; if (config.sta_timeout < 5) { @@ -532,7 +536,7 @@ void loadConfig() { // Zeroize Config struct memset(&config, 0, sizeof(config)); - if (FileIO::loadConfig(CONFIG_FILE, &deserialize)) { + if (FileIO::loadConfig(CONFIG_FILE, &deserializeCore)) { validateConfig(); } else { // Load failed, create a new config file and save it @@ -543,13 +547,15 @@ void loadConfig() { } // Serialize the current config into a JSON string -void serializeConfig(String &jsonString, bool pretty, bool creds) { +void serializeCore(String &jsonString, boolean pretty, boolean creds) { // Create buffer and root object DynamicJsonDocument json(1024); // Device JsonObject device = json.createNestedObject("device"); device["id"] = config.id.c_str(); + device["input"] = config.input.c_str(); + device["output"] = config.output.c_str(); // Network JsonObject network = json.createNestedObject("network"); @@ -557,14 +563,10 @@ void serializeConfig(String &jsonString, bool pretty, bool creds) { if (creds) network["passphrase"] = config.passphrase.c_str(); network["hostname"] = config.hostname.c_str(); - JsonArray ip = network.createNestedArray("ip"); - JsonArray netmask = network.createNestedArray("netmask"); - JsonArray gateway = network.createNestedArray("gateway"); - for (int i = 0; i < 4; i++) { - ip.add(config.ip[i]); - netmask.add(config.netmask[i]); - gateway.add(config.gateway[i]); - } + network["ip"] = config.ip.c_str(); + network["netmask"] = config.netmask.c_str(); + network["gateway"] = config.gateway.c_str(); + network["dhcp"] = config.dhcp; network["sta_timeout"] = config.sta_timeout; @@ -584,7 +586,7 @@ void saveConfig() { // Serialize Config String jsonString; - serializeConfig(jsonString, true, true); + serializeCore(jsonString, false, true); // Save Config FileIO::saveConfig(CONFIG_FILE, jsonString); diff --git a/data/config.json b/data/config.json index f175bbab8..3976d8ee0 100644 --- a/data/config.json +++ b/data/config.json @@ -1,31 +1,16 @@ { "device": { "id": "ESPixelStick", - "inputmode": "e131", - "outputmode": "ws2811" + "input": "e131", + "output": "ws2811" }, "network": { "ssid": "", "passphrase": "", - "ip": [ - 192, - 168, - 1, - 10 - ], - "netmask": [ - 255, - 255, - 255, - 0 - ], - "gateway": [ - 192, - 168, - 1, - 1 - ], + "ip": "192.168.1.10", + "netmask": "255.255.255.0", + "gateway": "192.168.1.1", "dhcp": true, "ap_fallback": false }, diff --git a/gulpfile.js b/gulpfile.js index ab61fb38f..56b7c11c3 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -12,7 +12,7 @@ var rename = require('gulp-rename'); /* HTML Task */ gulp.task('html', function() { - return gulp.src(['html/*.html', 'html/*.htm']) + return gulp.src(['html/*.html']) .pipe(plumber()) .pipe(htmlmin({ collapseWhitespace: true, diff --git a/html/e131.html b/html/e131.html new file mode 100644 index 000000000..bee0000aa --- /dev/null +++ b/html/e131.html @@ -0,0 +1,21 @@ +
+ E1.31 Configuration +
+ +
+
+
+ +
+
+
+ +
+
+ +
+
+
+
+
+
\ No newline at end of file diff --git a/html/index.html b/html/index.html index b1d8957eb..8bf2e4c6f 100644 --- a/html/index.html +++ b/html/index.html @@ -6,8 +6,10 @@ + + @@ -29,7 +31,7 @@ +
+
+
+
+

+
+
MQTT Configuration
@@ -280,15 +225,15 @@
+
- -
-
- -
+ +
+
+
- - +
+
@@ -486,11 +431,11 @@

WebSocket connection lost, attempting to reconnect... + - diff --git a/html/script.js b/html/script.js index 98d93201c..3a658028f 100644 --- a/html/script.js +++ b/html/script.js @@ -1,8 +1,8 @@ var mode = 'null'; -var gpio_list = [0, 1, 2, 3, 4, 5, 12, 13, 14, 15, 16]; var wsQueue = []; var wsBusy = false; var wsTimerId; +var ws; // Web Socket // json with effect definitions var effectInfo; @@ -99,7 +99,7 @@ $(function() { }); // Set page event feeds - feed(); + //feed(); }); // Reverse checkbox @@ -165,7 +165,7 @@ $(function() { $('#tmode').change(hideShowTestSections()); // DHCP field toggles - $('#dhcp').click(function() { + $('#dhcp').change(function() { if ($(this).is(':checked')) { $('.dhcp').addClass('hidden'); } else { @@ -236,13 +236,13 @@ $(function() { $('#hostname').keyup(function() { wifiValidation(); }); - $('#staTimeout').keyup(function() { + $('#sta_timeout').keyup(function() { wifiValidation(); }); $('#ssid').keyup(function() { wifiValidation(); }); - $('#password').keyup(function() { + $('#passphrase').keyup(function() { wifiValidation(); }); $('#ap').change(function () { @@ -261,6 +261,19 @@ $(function() { wifiValidation(); }); + // Grab interface and config on input / output change + $('#input').change(function () { + $('#imode').load($(this).val() + ".html", function() { + wsEnqueue(JSON.stringify({'cmd':{'get':'input'}})); + }); + }); + $('#output').change(function () { + $('#omode').load($(this).val() + ".html", function() { + wsEnqueue(JSON.stringify({'cmd':{'get':'output'}})); + }); + }); + + canvas = document.getElementById("canvas"); ctx = canvas.getContext("2d"); ctx.font = "20px Arial"; @@ -285,33 +298,25 @@ function wifiValidation() { var re = /^([a-zA-Z0-9][a-zA-Z0-9][a-zA-Z0-9\-.]*[a-zA-Z0-9.])$/; if (re.test($('#hostname').val()) && $('#hostname').val().length <= 255) { $('#fg_hostname').removeClass('has-error'); - $('#fg_hostname').addClass('has-success'); } else { - $('#fg_hostname').removeClass('has-success'); $('#fg_hostname').addClass('has-error'); WifiSaveDisabled = true; } - if ($('#staTimeout').val() >= 5) { + if ($('#sta_timeout').val() >= 5) { $('#fg_staTimeout').removeClass('has-error'); - $('#fg_staTimeout').addClass('has-success'); } else { - $('#fg_staTimeout').removeClass('has-success'); $('#fg_staTimeout').addClass('has-error'); WifiSaveDisabled = true; } if ($('#ssid').val().length <= 32) { $('#fg_ssid').removeClass('has-error'); - $('#fg_ssid').addClass('has-success'); } else { - $('#fg_ssid').removeClass('has-success'); $('#fg_ssid').addClass('has-error'); WifiSaveDisabled = true; } - if ($('#password').val().length <= 64) { + if ($('#passphrase').val().length <= 64) { $('#fg_password').removeClass('has-error'); - $('#fg_password').addClass('has-success'); } else { - $('#fg_password').removeClass('has-success'); $('#fg_password').addClass('has-error'); WifiSaveDisabled = true; } @@ -325,25 +330,19 @@ function wifiValidation() { if (iptest.test($('#ip').val())) { $('#fg_ip').removeClass('has-error'); - $('#fg_ip').addClass('has-success'); } else { - $('#fg_ip').removeClass('has-success'); $('#fg_ip').addClass('has-error'); WifiSaveDisabled = true; } if (iptest.test($('#netmask').val())) { $('#fg_netmask').removeClass('has-error'); - $('#fg_netmask').addClass('has-success'); } else { - $('#fg_netmask').removeClass('has-success'); $('#fg_netmask').addClass('has-error'); WifiSaveDisabled = true; } if (iptest.test($('#gateway').val())) { $('#fg_gateway').removeClass('has-error'); - $('#fg_gateway').addClass('has-success'); } else { - $('#fg_gateway').removeClass('has-success'); $('#fg_gateway').addClass('has-error'); WifiSaveDisabled = true; } @@ -366,21 +365,61 @@ function param(name) { return (location.search.split(name + '=')[1] || '').split('&')[0]; } +// Builds jQuery selectors from JSON data and updates the web interface +var selector = []; +async function updateFromJSON(obj) { + for (var k in obj) { + selector.push('#' + k); + if (typeof obj[k] == 'object' && obj[k] !== null) { + updateFromJSON(obj[k]); + } else { + var jqSelector = selector.join(' '); + if (typeof obj[k] === 'boolean') { + $(jqSelector).prop('checked', obj[k]); + } else { + $(jqSelector).val(obj[k]); + } + // Trigger keyup / change events + $(jqSelector).trigger('keyup'); + $(jqSelector).trigger('change'); + } + selector.pop(); + } +} + +// Builds jQuery selectors from JSON data and populates select options +function addOptionDataFromJSON(obj) { + for (var k in obj) { + selector.push('#' + k); + if (typeof obj[k] == 'object' && obj[k] !== null) { + addOptionDataFromJSON(obj[k]); + } else { + // Get the key and remove the json array index + var key = selector.pop().substr(1); + selector.pop(); + var jqSelector = selector.join(' '); + selector.push('',''); + $(jqSelector).append( + ''); + } + selector.pop(); + } +} + // WebSockets function wsConnect() { if ('WebSocket' in window) { // accept ?target=10.0.0.123 to make a WS connection to another device - if (target = param('target')) { -// - } else { + var target; + if (!(target = param('target'))) { target = document.location.host; } // Open a new web socket and set the binary type ws = new WebSocket('ws://' + target + '/ws'); ws.binaryType = 'arraybuffer'; - +/* ws.onopen = function() { $('#wserror').modal('hide'); wsEnqueue('E1'); // Get html elements @@ -391,9 +430,67 @@ function wsConnect() { feed(); }; +*/ + + // When connection is opened, get raw element data, option data, the config data in that order + ws.onopen = function() { + $('#wserror').modal('hide'); + wsEnqueue(JSON.stringify({'cmd':{'ele':'core'}})); // Get core element data + wsEnqueue(JSON.stringify({'cmd':{'opt':'core'}})); // Get core option data + wsEnqueue(JSON.stringify({'cmd':{'get':'core'}})); // Get core config + + wsEnqueue(JSON.stringify({'cmd':{'ele':'input'}})); // Get input element data + wsEnqueue(JSON.stringify({'cmd':{'opt':'input'}})); // Get input option data +// wsEnqueue(JSON.stringify({'cmd':{'get':'input'}})); // Get input config + + wsEnqueue(JSON.stringify({'cmd':{'ele':'output'}})); // Get output element data + wsEnqueue(JSON.stringify({'cmd':{'opt':'output'}})); // Get output option data +// wsEnqueue(JSON.stringify({'cmd':{'get':'output'}})); // Get output config + }; ws.onmessage = function (event) { if(typeof event.data === "string") { + // Process "simple" message format + if (event.data.startsWith("X")) { + var data = event.data.substr(2); + getJsonStatus(data); + // Process as JSON + } else { + var msg = JSON.parse(event.data); + // "GET" message is a response to a get request. Populate the frontend. + if (msg.hasOwnProperty("get")) { + updateFromJSON(msg.get); + } + + // "SET" message is a reponse to a set request. Data has been validated and saved, Populate the frontend. + if (msg.hasOwnProperty("set")) { + updateFromJSON(msg.set); + } + + // "ELE" message is raw data to be inserted at given node + if (msg.hasOwnProperty("ele")) { + console.log("ELEMENT DATA: " + msg.ele); + } + + // "OPT" message is select option data + if (msg.hasOwnProperty("opt")) { + addOptionDataFromJSON(msg.opt); + } + +// $('#s_count').val(config.e131.channel_count); + + /* + switch (msg.type) { + case 'get': + console.log("*** JSON get ***"); + break; + case 'set': + console.log("*** JSON set ***"); + break; + } + */ + } +/* var cmd = event.data.substr(0, 2); var data = event.data.substr(2); switch (cmd) { @@ -434,6 +531,7 @@ function wsConnect() { console.log('Unknown Command: ' + event.data); break; } +*/ } else { streamData= new Uint8Array(event.data); drawStream(streamData); @@ -454,14 +552,14 @@ function wsConnect() { function wsEnqueue(message) { //only add a message to the queue if there isn't already one of the same type already queued, otherwise update the message with the latest request. - wsQueueIndex=wsQueue.findIndex(wsCheckQueue,message); - if(wsQueueIndex == -1) { +// var wsQueueIndex = wsQueue.findIndex(wsCheckQueue,message); +// if(wsQueueIndex == -1) { //add message wsQueue.push(message); - } else { +// } else { //update message - wsQueue[wsQueueIndex]=message; - } +// wsQueue[wsQueueIndex]=message; +// } wsProcessQueue(); } @@ -478,7 +576,7 @@ function wsProcessQueue() { //set wsBusy flag that we are waiting for a response wsBusy=true; //get next message from queue. - message=wsQueue.shift(); + var message=wsQueue.shift(); //set timeout to clear flag and try next message if response isn't recieved. Short timeout for message types that don't generate a response. if(['T0','T1','T2','T3','T4','T5','T6','T7','X6'].indexOf(message.substr(0,2))) { timeout=40; @@ -559,9 +657,9 @@ function getConfig(data) { $('#name').text(config.device.id); $('#devid').val(config.device.id); $('#ssid').val(config.network.ssid); - $('#password').val(config.network.passphrase); + $('#passphrase').val(config.network.passphrase); $('#hostname').val(config.network.hostname); - $('#staTimeout').val(config.network.sta_timeout); + $('#sta_timeout').val(config.network.sta_timeout); $('#dhcp').prop('checked', config.network.dhcp); if (config.network.dhcp) { $('.dhcp').addClass('hidden'); @@ -664,7 +762,7 @@ function getConfig(data) { function getConfigStatus(data) { var status = JSON.parse(data); - $('#x_ssid').text(status.ssid); +// $('#x_ssid').text(status.ssid); $('#x_hostname').text(status.hostname); $('#x_ip').text(status.ip); $('#x_mac').text(status.mac); @@ -787,9 +885,9 @@ function submitWiFi() { var json = { 'network': { 'ssid': $('#ssid').val(), - 'passphrase': $('#password').val(), + 'passphrase': $('#passphrase').val(), 'hostname': $('#hostname').val(), - 'sta_timeout': $('#staTimeout').val(), + 'sta_timeout': $('#sta_timeout').val(), 'ip': [parseInt(ip[0]), parseInt(ip[1]), parseInt(ip[2]), parseInt(ip[3])], 'netmask': [parseInt(netmask[0]), parseInt(netmask[1]), parseInt(netmask[2]), parseInt(netmask[3])], 'gateway': [parseInt(gateway[0]), parseInt(gateway[1]), parseInt(gateway[2]), parseInt(gateway[3])], @@ -974,10 +1072,6 @@ function reboot() { wsEnqueue('X6'); } -//function getKeyByValue(object, value) { -// return Object.keys(object).find(key => object[key] === value); -//} - function getKeyByValue(obj, value) { return Object.keys(obj)[Object.values(obj).indexOf(value)]; } diff --git a/html/ws2811.html b/html/ws2811.html new file mode 100644 index 000000000..89634e0e7 --- /dev/null +++ b/html/ws2811.html @@ -0,0 +1,59 @@ +
+ WS2811 Configuration + +
+ +
+ +
+
+ +
+ +
+ +
+ +
+ +
+
+ +
+ +
+
+ +
+ +
+ +
+
+
+
+ +
+
\ No newline at end of file diff --git a/jsconfig.json b/jsconfig.json new file mode 100644 index 000000000..4ed73d509 --- /dev/null +++ b/jsconfig.json @@ -0,0 +1,12 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es2016", + "jsx": "preserve", + "checkJs": true + }, + "exclude": [ + "node_modules", + "**/node_modules/*" + ] +} \ No newline at end of file diff --git a/src/ESPixelStick.h b/src/ESPixelStick.h index bc0d52397..3c01bc652 100644 --- a/src/ESPixelStick.h +++ b/src/ESPixelStick.h @@ -51,21 +51,23 @@ const char BUILD_DATE[] = __DATE__; /// Core configuration structure typedef struct { // Device - String id; ///< Device ID - String inputmode; ///< Device Input Mode, selectable at runtime - String outputmode; ///< Device Output Mode, selectable at runtime + String id; ///< Device ID + String input; ///< Device Input Mode, selectable at runtime + String output; ///< Device Output Mode, selectable at runtime // Network String ssid; String passphrase; String hostname; - uint8_t ip[4]; - uint8_t netmask[4]; - uint8_t gateway[4]; + String ip; + String netmask; + String gateway; bool dhcp = true; ///< Use DHCP? bool ap_fallback; ///< Fallback to AP if fail to associate? uint32_t sta_timeout; ///< Timeout when connection as client (station) uint32_t ap_timeout; ///< How long to wait in AP mode with no connection before rebooting } config_t; +void serializeCore(String &jsonString, boolean pretty = false, boolean creds = false); + #endif // ESPIXELSTICK_H_ diff --git a/src/FileIO.h b/src/FileIO.h index 3489cb949..8aaed4a80 100644 --- a/src/FileIO.h +++ b/src/FileIO.h @@ -26,6 +26,7 @@ /// Deserialization callback for I/O modules typedef std::function DeserializationHandler; +/// Contains static methods used for common File IO routines class FileIO { public: /// Load configuration file @@ -50,7 +51,7 @@ class FileIO { DynamicJsonDocument json(1024); DeserializationError error = deserializeJson(json, buf.get()); if (error) { - LOG_PORT.printf("*** JSON Deserialzation Error: %s\n***", filename.c_str()); + LOG_PORT.printf("*** JSON Deserialzation Error: %s ***\n", filename.c_str()); } dsHandler(json); diff --git a/src/WebIO.h b/src/WebIO.h new file mode 100644 index 000000000..267ad3314 --- /dev/null +++ b/src/WebIO.h @@ -0,0 +1,306 @@ +/* +* WebIO.h - Static methods for common file web service routines +* +* Project: ESPixelStick - An ESP8266 and E1.31 based pixel driver +* Copyright (c) 2019 Shelby Merrick +* http://www.forkineye.com +* +* This program is provided free for you to use in any way that you wish, +* subject to the laws and regulations where you are using it. Due diligence +* is strongly suggested before using this code. Please give credit where due. +* +* The Author makes no warranty of any kind, express or implied, with regard +* to this program or the documentation contained in this document. The +* Author shall not be liable in any event for incidental or consequential +* damages in connection with, or arising out of, the furnishing, performance +* or use of these programs. +* +*/ + +#ifndef _WEBIO_H_ +#define _WEBIO_H_ + +#include +#include "ESPixelStick.h" +#include "EFUpdate.h" +#include "input/_Input.h" +#include "output/_Output.h" + +extern bool reboot; ///< Reboot flag +extern _Input *input; ///< Pointer to currently enabled input module +extern _Output *output; ///< Pointer to currently enabled output module + +extern const std::map INPUT_MODES; ///< Input Modes +extern const std::map OUTPUT_MODES; ///< Output Modes +extern std::map::const_iterator itInput; ///< Input iterator +extern std::map::const_iterator itOutput; ///< Output iterator + + +/// Contains static methods utilized for processing and working with Web Services +/** Two web service text message formats are supported. + * - Simple Messages: Start with the character 'X' + * - JSON Messages: All other messages are processed as JSON + */ +class WebIO { + private: + /// Process simple format 'X' messages + static void procSimple(uint8_t *data, AsyncWebSocketClient *client) { + switch (data[1]) { + case SimpleMessage::GET_STATUS: + DynamicJsonDocument json(1024); + + // system statistics + JsonObject system = json.createNestedObject("system"); + system["rssi"] = (String)WiFi.RSSI(); + system["freeheap"] = (String)ESP.getFreeHeap(); + system["uptime"] = (String)millis(); + + /* + // E131 statistics + JsonObject e131J = json.createNestedObject("e131"); + uint32_t seqErrors = 0; + for (int i = 0; i < ((uniLast + 1) - config.universe); i++) + seqErrors =+ seqError[i]; + + e131J["universe"] = (String)config.universe; + e131J["uniLast"] = (String)uniLast; + e131J["num_packets"] = (String)e131.stats.num_packets; + e131J["seq_errors"] = (String)seqErrors; + e131J["packet_errors"] = (String)e131.stats.packet_errors; + e131J["last_clientIP"] = e131.stats.last_clientIP.toString(); + + JsonObject ddpJ = json.createNestedObject("ddp"); + ddpJ["num_packets"] = (String)ddp.stats.packetsReceived; + ddpJ["seq_errors"] = (String)ddp.stats.errors; + ddpJ["num_bytes"] = (String)ddp.stats.bytesReceived; + ddpJ["max_channel"] = (String)ddp.stats.ddpMaxChannel; + ddpJ["min_channel"] = (String)ddp.stats.ddpMinChannel; + */ + String response; + serializeJson(json, response); + client->text("XJ" + response); + break; + } + } + + /// Process JSON messages + static void procJSON(uint8_t *data, AsyncWebSocketClient *client) { + DynamicJsonDocument json(1024); + + DeserializationError error = deserializeJson(json, reinterpret_cast(data)); + if (error) { + LOG_PORT.println(F("*** WebIO::procJSON(): Parse Error ***")); + LOG_PORT.println(reinterpret_cast(data)); + return; + } + + /** Following commands are supported: + * - get: returns requested configuration + * - set: receive and applies configuration + * - opt: returns select option lists + * - ele: returns raw element data to build elements + */ + if (json.containsKey("cmd")) { + String target; + + // Process "GET" command - return requested configuration as JSON + if (target = json["cmd"]["get"].as()) { + if (target.equalsIgnoreCase("core")) { + String jsonString; + serializeCore(jsonString, false, true); + client->text("{\"get\":" + jsonString + "}"); + } + if (target.equalsIgnoreCase("input")) + client->text("{\"get\":" + input->serialize() + "}"); + if (target.equalsIgnoreCase("output")) + client->text("{\"get\":" + output->serialize() + "}"); + } + + // Process "SET" command - receive configuration as JSON + if (target = json["cmd"]["set"].as()) { + if (target.equalsIgnoreCase("core")) { + LOG_PORT.println("*** WebIO set config core***"); + } + if (target.equalsIgnoreCase("input")) + LOG_PORT.println("*** WebIO set config input ***"); + if (target.equalsIgnoreCase("output")) + LOG_PORT.println("*** WebIO set config output ***"); + } + + // Generate select option list data + if (target = json["cmd"]["opt"].as()) { + if (target.equalsIgnoreCase("core")) { + DynamicJsonDocument json(1024); + JsonObject core = json.createNestedObject("device"); + JsonArray input = core.createNestedArray("input"); + JsonArray output = core.createNestedArray("output"); + + itInput = INPUT_MODES.begin(); + while (itInput != INPUT_MODES.end()) { + JsonObject data = input.createNestedObject(); + data[itInput->first.c_str()] = itInput->second->getBrief(); + itInput++; + } + + itOutput = OUTPUT_MODES.begin(); + while (itOutput != OUTPUT_MODES.end()) { + JsonObject data = output.createNestedObject(); + data[itOutput->first.c_str()] = itOutput->second->getBrief(); + itOutput++; + } + + String jsonString; + serializeJson(json, jsonString); + client->text("{\"opt\":" + jsonString + "}"); + } + if (target.equalsIgnoreCase("input")) + LOG_PORT.println("*** WebIO opt input ***"); + if (target.equalsIgnoreCase("output")) + LOG_PORT.println("*** WebIO opt output ***"); + } + + + // Process "ELE" command - return requested element data as JSON + if (target = json["cmd"]["ele"].as()) { + if (target.equalsIgnoreCase("core")) { + DynamicJsonDocument json(1024); + JsonObject core = json.createNestedObject("core"); + JsonArray input = core.createNestedArray("input"); + JsonArray output = core.createNestedArray("output"); + + itInput = INPUT_MODES.begin(); + while (itInput != INPUT_MODES.end()) { + input.add(itInput->first); + itInput++; + } + + itOutput = OUTPUT_MODES.begin(); + while (itOutput != OUTPUT_MODES.end()) { + output.add(itOutput->first); + itOutput++; + } + + String jsonString; + serializeJson(json, jsonString); + client->text("{\"ele\":" + jsonString + "}"); + } + if (target.equalsIgnoreCase("input")) + LOG_PORT.println("*** WebIO ele input ***"); + if (target.equalsIgnoreCase("output")) + LOG_PORT.println("*** WebIO ele output ***"); + } + + } + + + +/* From wshandler: + bool reboot = false; + switch (data[1]) { + case '1': // Set Network Config + dsNetworkConfig(json.as()); + saveConfig(); + client->text("S1"); + break; + case '2': // Set Device Config + // Reboot if MQTT changed + if (config.mqtt != json["mqtt"]["enabled"]) + reboot = true; + + dsDeviceConfig(json.as()); + saveConfig(); + + if (reboot) + client->text("S1"); + else + client->text("S2"); + break; + case '3': // Set Effect Startup Config + dsEffectConfig(json.as()); + saveConfig(); + client->text("S3"); + break; + case '4': // Set Gamma (but no save) + dsGammaConfig(json.as()); + client->text("S4"); + break; + } +*/ + } + + public: + /// Valid "Simple" message types + enum SimpleMessage { + GET_STATUS = 'J' + }; + + /// Handle Web Service events + /** Handles all Web Service event types and performs initial parsing of Web Service event data. + * Text messages that start with 'X' are treated as "Simple" format messages, else they're parsed as JSON. + */ + static void onEvent(AsyncWebSocket *server, AsyncWebSocketClient *client, + AwsEventType type, void *arg, uint8_t *data, size_t len) { + switch (type) { + case WS_EVT_DATA: { + AwsFrameInfo *info = static_cast(arg); + if (info->opcode == WS_TEXT) { + if (data[0] == 'X') { + procSimple(data, client); + } else { + procJSON(data, client); + } + } else { + LOG_PORT.println(F("-- binary message --")); + } + break; + } + case WS_EVT_CONNECT: + LOG_PORT.print(F("* WS Connect - ")); + LOG_PORT.println(client->id()); + break; + case WS_EVT_DISCONNECT: + LOG_PORT.print(F("* WS Disconnect - ")); + LOG_PORT.println(client->id()); + break; + case WS_EVT_PONG: + LOG_PORT.println(F("* WS PONG *")); + break; + case WS_EVT_ERROR: + LOG_PORT.println(F("** WS ERROR **")); + break; + } + } + + static void onFirmwareUpload(AsyncWebServerRequest *request, String filename, + size_t index, uint8_t *data, size_t len, bool final) { + static EFUpdate efupdate; /// EFU Update Handler + if (!index) { + WiFiUDP::stopAll(); + LOG_PORT.print(F("* Upload Started: ")); + LOG_PORT.println(filename.c_str()); + efupdate.begin(); + } + + if (!efupdate.process(data, len)) { + LOG_PORT.print(F("*** UPDATE ERROR: ")); + LOG_PORT.println(String(efupdate.getError())); + } + + if (efupdate.hasError()) + request->send(200, "text/plain", "Update Error: " + + String(efupdate.getError())); + + if (final) { + request->send(200, "text/plain", "Update Finished: " + + String(efupdate.getError())); + LOG_PORT.println(F("* Upload Finished.")); + efupdate.end(); + SPIFFS.begin(); + // saveConfig(); + reboot = true; + } + } + +}; + +#endif /* _WEBIO_H_ */ \ No newline at end of file diff --git a/src/input/E131Input.cpp b/src/input/E131Input.cpp index 2be8cfbf0..0957be198 100644 --- a/src/input/E131Input.cpp +++ b/src/input/E131Input.cpp @@ -134,7 +134,7 @@ void E131Input::load() { } } -String E131Input::serialize() { +String E131Input::serialize(boolean pretty = false) { DynamicJsonDocument json(1024); JsonObject e131 = json.createNestedObject("e131"); @@ -144,7 +144,11 @@ String E131Input::serialize() { e131["multicast"] = multicast; String jsonString; - serializeJsonPretty(json, jsonString); + if (pretty) + serializeJsonPretty(json, jsonString); + else + serializeJson(json, jsonString); + return jsonString; } diff --git a/src/input/E131Input.h b/src/input/E131Input.h index 34f652316..6f5ff8377 100644 --- a/src/input/E131Input.h +++ b/src/input/E131Input.h @@ -42,9 +42,6 @@ class E131Input : public _Input { uint8_t *seqTracker; ///< Current sequence numbers for each Universe uint32_t *seqError; ///< Sequence error tracking for each universe - void deserialize(DynamicJsonDocument &json); - String serialize(); - void multiSub(); public: @@ -62,6 +59,9 @@ class E131Input : public _Input { void init(); void process(); + + void deserialize(DynamicJsonDocument &json); + String serialize(boolean pretty); }; #endif /* E131INPUT_H_ */ \ No newline at end of file diff --git a/src/input/_Input.h b/src/input/_Input.h index d171ef6d4..fb465af00 100644 --- a/src/input/_Input.h +++ b/src/input/_Input.h @@ -39,6 +39,18 @@ class _Input { virtual void init() = 0; ///< Call from setup(), initializes and starts input virtual void process() = 0; ///< Call from loop(), process incoming data + virtual void deserialize(DynamicJsonDocument &json) = 0; ///< Sets configuration from JSON + virtual String serialize(boolean pretty = false) = 0; ///< Gets configuration as JSON + + /* TODO: + * - send config data as JSON to browser via ws + * - respond to JSON data from browser ws + * - proivde JSON based interface description + * - add support for this crap in the javascript + * - add static class similar for FileIO for this? + * - new class would also handle core, generate mode lists, etc.. WebIO? + */ + void setBuffer(uint8_t *buff, uint16_t size) { showBuffer = buff; showBufferSize = size; @@ -47,9 +59,6 @@ class _Input { protected: uint8_t *showBuffer; ///< Show data buffer uint16_t showBufferSize; ///< Size of show data buffer - - virtual void deserialize(DynamicJsonDocument &json) = 0; - virtual String serialize() = 0; }; #endif /* _INPUT_H_ */ \ No newline at end of file diff --git a/src/output/WS2811.cpp b/src/output/WS2811.cpp index 04f247dd3..0bb67a89c 100644 --- a/src/output/WS2811.cpp +++ b/src/output/WS2811.cpp @@ -121,7 +121,7 @@ void WS2811::validate() { if (pixelCount > PIXEL_LIMIT) pixelCount = PIXEL_LIMIT; else if (pixelCount < 1) - pixelCount = 1; + pixelCount = 170; if (groupSize > pixelCount) groupSize = pixelCount; @@ -144,10 +144,11 @@ void WS2811::validate() { void WS2811::deserialize(DynamicJsonDocument &json) { if (json.containsKey("ws2811")) { pixel_color = PixelColor(static_cast(json["pixel"]["color"])); - groupSize = json["pixel"]["groupSize"]; - zigSize = json["pixel"]["zigSize"]; - gammaVal = json["pixel"]["gammaVal"]; - briteVal = json["pixel"]["briteVal"]; + pixelCount = json["ws2811"]["pixelCount"]; + groupSize = json["ws2811"]["groupSize"]; + zigSize = json["ws2811"]["zigSize"]; + gammaVal = json["ws2811"]["gammaVal"]; + briteVal = json["ws2811"]["briteVal"]; } else { LOG_PORT.println("No WS2811 settings found."); } @@ -169,18 +170,23 @@ void WS2811::load() { } } -String WS2811::serialize() { +String WS2811::serialize(boolean pretty = false) { DynamicJsonDocument json(1024); JsonObject pixel = json.createNestedObject("ws2811"); pixel["color"] = static_cast(pixel_color); + pixel["pixelCount"] = pixelCount; pixel["groupSize"] = groupSize; pixel["zigSize"] = zigSize; pixel["gammaVal"] = gammaVal; pixel["briteVal"] = briteVal; String jsonString; - serializeJsonPretty(json, jsonString); + if (pretty) + serializeJsonPretty(json, jsonString); + else + serializeJson(json, jsonString); + return jsonString; } diff --git a/src/output/WS2811.h b/src/output/WS2811.h index c3a57ec38..07d1fa960 100644 --- a/src/output/WS2811.h +++ b/src/output/WS2811.h @@ -81,9 +81,6 @@ class WS2811 : public _Output { static uint8_t gOffset; // Index of green byte static uint8_t bOffset; // Index of blue byte - void deserialize(DynamicJsonDocument &json); - String serialize(); - /* FIFO Handlers */ static const uint8_t* ICACHE_RAM_ATTR fillWS2811(const uint8_t *buff, const uint8_t *tail); @@ -122,6 +119,10 @@ class WS2811 : public _Output { int begin(PixelColor color, uint16_t length); void updateOrder(PixelColor color); void render(); + + void deserialize(DynamicJsonDocument &json); + String serialize(boolean pretty); + uint8_t* getData(); /* Set group / zigzag counts */ diff --git a/src/output/_Output.h b/src/output/_Output.h index 1f6f8a095..d3d46af22 100644 --- a/src/output/_Output.h +++ b/src/output/_Output.h @@ -46,11 +46,11 @@ class _Output { showBuffer = buff; } + virtual void deserialize(DynamicJsonDocument &json) = 0; + virtual String serialize(boolean pretty = false) = 0; + protected: uint8_t *showBuffer; ///< Show data buffer - - virtual void deserialize(DynamicJsonDocument &json) = 0; - virtual String serialize() = 0; }; #endif /* _OUTPUT_H_ */ \ No newline at end of file