Merge branch 'master' into lambda-with-examples

README.md

@@ -62,6 +62,9 @@ The Library runs on any kind of **ESP8266** and **ESP32** (NodeMCU, AI Thinker,
 - Time control by @iangray001
 - Vertical controls by @iangray001
 - Time/date/password/color input types by @pcbbc
+- Delayed response support @MartinMueller2003
+- Fragmented control transfer @ MartinMueller2003
+- Extended Callback @MartinMueller2003
 
 ## Roadmap
 

data/js/controls.js

@@ -60,6 +60,8 @@ const UPDATE_SEPARATOR = 119;
 const UI_TIME = 20;
 const UPDATE_TIME = 120;
 
+const UI_FRAGMENT = 21;
+
 const UP = 0;
 const DOWN = 1;
 const LEFT = 2;
@@ -77,6 +79,8 @@ const C_ALIZARIN = 6;
 const C_DARK = 7;
 const C_NONE = 255;
 
+var controlAssemblyArray = new Object();
+var FragmentAssemblyTimer = new Object();
 var graphData = new Array();
 var hasAccel = false;
 var sliderContinuous = false;
@@ -190,6 +194,12 @@ function restart() {
 }
 
 function conStatusError() {
+    FragmentAssemblyTimer.forEach(element => {
+        clearInterval(element);
+    });
+    FragmentAssemblyTimer = new Object();
+    controlAssemblyArray = new Object();
+
     if (true === websockConnected) {
         websockConnected = false;
         websock.close();
@@ -210,17 +220,20 @@ function handleVisibilityChange() {
 }
 
 function start() {
+    let location = window.location.hostname;
+    let port = window.location.port;
+//    let location = "192.168.10.229";
+//    let port = "";
+
     document.addEventListener("visibilitychange", handleVisibilityChange, false);
     if (
-        window.location.port != "" ||
+        port != "" ||
-        window.location.port != 80 ||
+        port != 80 ||
-        window.location.port != 443
+        port != 443
     ) {
-        websock = new WebSocket(
+        websock = new WebSocket( "ws://" + location + "/ws" );
-            "ws://" + window.location.hostname + ":" + window.location.port + "/ws"
-        );
     } else {
-        websock = new WebSocket("ws://" + window.location.hostname + "/ws");
+        websock = new WebSocket("ws://" + location + "/ws");
     }
 
     // is the timer running?
@@ -241,33 +254,54 @@ function start() {
         $("#conStatus").addClass("color-green");
         $("#conStatus").text("Connected");
         websockConnected = true;
+        FragmentAssemblyTimer.forEach(element => {
+            clearInterval(element);
+        });
+        FragmentAssemblyTimer = new Object();
+        controlAssemblyArray = new Object();
     };
 
     websock.onclose = function (evt) {
+        // console.log("Close evt: '" + evt + "'");
+        // console.log("Close reason: '" + evt.reason + "'");
+        // console.log("Close code: '" + evt.code + "'");
         console.log("websock close");
         conStatusError();
+        FragmentAssemblyTimer.forEach(element => {
+            clearInterval(element);
+        });
+        FragmentAssemblyTimer = new Object();
+        controlAssemblyArray = new Object();
     };
 
     websock.onerror = function (evt) {
         console.log("websock Error");
-        console.log(evt);
+        // console.log("Error evt: '" + evt + "'");
+        // console.log("Error data: '" + evt.data + "'");
 
         restart();
+        FragmentAssemblyTimer.forEach(element => {
+            clearInterval(element);
+        });
+        FragmentAssemblyTimer = new Object();
+        controlAssemblyArray = new Object();
     };
 
     var handleEvent = function (evt) {
-        console.log(evt);
+        // console.log("handleEvent:Data evt: '" + evt + "'");
+        // console.log("handleEvent:Data data: '" + evt.data + "'");
         try {
             var data = JSON.parse(evt.data);
         }
         catch (Event) {
             console.error(Event);
-            // start the update over again
+            // console.info("start the update over again");
             websock.send("uiok:" + 0);
             return;
         }
         var e = document.body;
         var center = "";
+        // console.info("data.type: '" + data.type + "'");
 
         switch (data.type) {
             case UI_INITIAL_GUI:
@@ -279,7 +313,9 @@ function start() {
                 if (data.sliderContinuous) {
                     sliderContinuous = data.sliderContinuous;
                 }
+                // console.info("UI_INITIAL_GUI:data record: '" + data + "'");
                 data.controls.forEach(element => {
+                    // console.info("element: '" + JSON.stringify(element) + "'");
                     var fauxEvent = {
                         data: JSON.stringify(element),
                     };
@@ -295,7 +331,9 @@ function start() {
                 break;
 
             case UI_EXTEND_GUI:
+                // console.info("UI_EXTEND_GUI data record: '" + data + "'");
                 data.controls.forEach(element => {
+                    // console.info("UI_EXTEND_GUI:element: '" + JSON.stringify(element) + "'");
                     var fauxEvent = {
                         data: JSON.stringify(element),
                     };
@@ -601,6 +639,88 @@ function start() {
                 websock.send("time:" + rv + ":" + data.id);
                 break;
 
+            case UI_FRAGMENT:
+                let FragmentLen = data.length;
+                let FragementOffset = data.offset;
+                let NextFragmentOffset = FragementOffset + FragmentLen;
+                let Total = data.total;
+                let Arrived = (FragmentLen + FragementOffset);
+                let FragmentFinal = Total === Arrived;
+                // console.info("UI_FRAGMENT:FragmentLen        '" + FragmentLen + "'");
+                // console.info("UI_FRAGMENT:FragementOffset    '" + FragementOffset + "'");
+                // console.info("UI_FRAGMENT:NextFragmentOffset '" + NextFragmentOffset + "'");
+                // console.info("UI_FRAGMENT:Total              '" + Total + "'");
+                // console.info("UI_FRAGMENT:Arrived            '" + Arrived + "'");
+                // console.info("UI_FRAGMENT:FragmentFinal      '" + FragmentFinal + "'");
+
+                if (!data.hasOwnProperty('control')) 
+                {
+                    console.error("UI_FRAGMENT:Missing control record, skipping control");
+                    break;
+                }
+                let control = data.control;
+                StopFragmentAssemblyTimer(data.control.id);
+                
+                // is this the first fragment?
+                if(0 === FragementOffset)
+                {
+                    // console.info("Found first fragment");
+                    controlAssemblyArray[control.id] = data;
+                    // console.info("Value: " + controlAssemblyArray[control.id].control.value);
+                    controlAssemblyArray[control.id].offset = NextFragmentOffset;
+                    StartFragmentAssemblyTimer(control.id);
+                    let TotalRequest = JSON.stringify({ 'id' : control.id, 'offset' : NextFragmentOffset });
+                    websock.send("uifragmentok:" + 0 + ": " + TotalRequest + ":");
+                    // console.info("asked for fragment 2");
+                    break;
+                }
+
+                // not first fragment. are we assembling this control?
+                if("undefined" === typeof controlAssemblyArray[control.id])
+                {
+                    // it looks like we missed the first fragment. Start the control over
+                    console.error("Missing first fragment for control: " + control.id);
+                    StartFragmentAssemblyTimer(control.id);
+                    let TotalRequest = JSON.stringify({ 'id' : control.id, 'offset' : 0 });
+                    websock.send("uifragmentok:" + 0 + ": " + TotalRequest + ":");
+                    // console.info("asked for fragment 1");
+                    break;
+                }
+                
+                // is this the expected next fragment
+                if(FragementOffset !== controlAssemblyArray[control.id].offset)
+                {
+                    console.error("Wrong next fragment. Expected: " + controlAssemblyArray[control.id].offset + " Got: " + FragementOffset);
+                    StartFragmentAssemblyTimer(control.id);
+                    let TotalRequest = JSON.stringify({ 'id' : control.id, 'offset' : controlAssemblyArray[control.id].length + controlAssemblyArray[control.id].offset });
+                    websock.send("uifragmentok:" + 0 + ": " + TotalRequest + ":");
+                    // console.info("asked for the expected fragment");
+                    break;
+                }
+
+                // console.info("Add to existing fragment");
+                controlAssemblyArray[control.id].control.value += control.value;
+                controlAssemblyArray[control.id].offset = NextFragmentOffset;
+                // console.info("Value: " + controlAssemblyArray[control.id].control.value);
+
+                if(true === FragmentFinal)
+                {
+                    var fauxEvent = {
+                        data: JSON.stringify(controlAssemblyArray[control.id].control),
+                    };
+                    handleEvent(fauxEvent);
+                    controlAssemblyArray[control.id] = null;
+                    // console.info("Found last fragment");
+                }
+                else
+                {
+                    // console.info("Ask for next fragment.");
+                    StartFragmentAssemblyTimer(control.id);
+                    let TotalRequest = JSON.stringify({ 'id' : control.id, 'offset' : NextFragmentOffset});
+                    websock.send("uifragmentok:" + 0 + ": " + TotalRequest + ":");
+                }
+                break;
+
             default:
                 console.error("Unknown type or event");
                 break;
@@ -650,6 +770,36 @@ function start() {
     websock.onmessage = handleEvent;
 }
 
+function StartFragmentAssemblyTimer(Id)
+{
+    StopFragmentAssemblyTimer(Id);
+    FragmentAssemblyTimer[Id] = setInterval(function(_Id)
+    {
+        // does the fragment assembly still exist?
+        if("undefined" !== typeof controlAssemblyArray[_Id])
+        {
+            if(null !== controlAssemblyArray[_Id])
+            {
+                // we have a valid control that is being assembled
+                // ask for the next part
+                let TotalRequest = JSON.stringify({ 'id' : controlAssemblyArray[_Id].control.id, 'offset' : controlAssemblyArray[_Id].offset});
+                websock.send("uifragmentok:" + 0 + ": " + TotalRequest + ":");
+            }
+        }
+    }, 1000, Id);
+}
+
+function StopFragmentAssemblyTimer(Id)
+{
+    if("undefined" !== typeof FragmentAssemblyTimer[Id])
+    {
+        if(FragmentAssemblyTimer[Id])
+        {
+            clearInterval(FragmentAssemblyTimer[Id]);
+        }
+    }
+}
+
 function sliderchange(number) {
     var val = $("#sl" + number).val();
     websock.send("slvalue:" + val + ":" + number);

data/js/controls.min.js

@@ -1,14 +1,14 @@
-const UI_INITIAL_GUI=200;const UI_RELOAD=201;const UPDATE_OFFSET=100;const UI_EXTEND_GUI=210;const UI_TITEL=0;const UI_PAD=1;const UPDATE_PAD=101;const UI_CPAD=2;const UPDATE_CPAD=102;const UI_BUTTON=3;const UPDATE_BUTTON=103;const UI_LABEL=4;const UPDATE_LABEL=104;const UI_SWITCHER=5;const UPDATE_SWITCHER=105;const UI_SLIDER=6;const UPDATE_SLIDER=106;const UI_NUMBER=7;const UPDATE_NUMBER=107;const UI_TEXT_INPUT=8;const UPDATE_TEXT_INPUT=108;const UI_GRAPH=9;const ADD_GRAPH_POINT=10;const CLEAR_GRAPH=109;const UI_TAB=11;const UPDATE_TAB=111;const UI_SELECT=12;const UPDATE_SELECT=112;const UI_OPTION=13;const UPDATE_OPTION=113;const UI_MIN=14;const UPDATE_MIN=114;const UI_MAX=15;const UPDATE_MAX=115;const UI_STEP=16;const UPDATE_STEP=116;const UI_GAUGE=17;const UPDATE_GAUGE=117;const UI_ACCEL=18;const UPDATE_ACCEL=118;const UI_SEPARATOR=19;const UPDATE_SEPARATOR=119;const UI_TIME=20;const UPDATE_TIME=120;const UP=0;const DOWN=1;const LEFT=2;const RIGHT=3;const CENTER=4;const C_TURQUOISE=0;const C_EMERALD=1;const C_PETERRIVER=2;const C_WETASPHALT=3;const C_SUNFLOWER=4;const C_CARROT=5;const C_ALIZARIN=6;const C_DARK=7;const C_NONE=255;var graphData=new Array();var hasAccel=false;var sliderContinuous=false;function colorClass(colorId){colorId=Number(colorId);switch(colorId){case C_TURQUOISE:return"turquoise";case C_EMERALD:return"emerald";case C_PETERRIVER:return"peterriver";case C_WETASPHALT:return"wetasphalt";case C_SUNFLOWER:return"sunflower";case C_CARROT:return"carrot";case C_ALIZARIN:return"alizarin";case C_DARK:case C_NONE:return"dark";default:return"";}}
+const UI_INITIAL_GUI=200;const UI_RELOAD=201;const UPDATE_OFFSET=100;const UI_EXTEND_GUI=210;const UI_TITEL=0;const UI_PAD=1;const UPDATE_PAD=101;const UI_CPAD=2;const UPDATE_CPAD=102;const UI_BUTTON=3;const UPDATE_BUTTON=103;const UI_LABEL=4;const UPDATE_LABEL=104;const UI_SWITCHER=5;const UPDATE_SWITCHER=105;const UI_SLIDER=6;const UPDATE_SLIDER=106;const UI_NUMBER=7;const UPDATE_NUMBER=107;const UI_TEXT_INPUT=8;const UPDATE_TEXT_INPUT=108;const UI_GRAPH=9;const ADD_GRAPH_POINT=10;const CLEAR_GRAPH=109;const UI_TAB=11;const UPDATE_TAB=111;const UI_SELECT=12;const UPDATE_SELECT=112;const UI_OPTION=13;const UPDATE_OPTION=113;const UI_MIN=14;const UPDATE_MIN=114;const UI_MAX=15;const UPDATE_MAX=115;const UI_STEP=16;const UPDATE_STEP=116;const UI_GAUGE=17;const UPDATE_GAUGE=117;const UI_ACCEL=18;const UPDATE_ACCEL=118;const UI_SEPARATOR=19;const UPDATE_SEPARATOR=119;const UI_TIME=20;const UPDATE_TIME=120;const UI_FRAGMENT=21;const UP=0;const DOWN=1;const LEFT=2;const RIGHT=3;const CENTER=4;const C_TURQUOISE=0;const C_EMERALD=1;const C_PETERRIVER=2;const C_WETASPHALT=3;const C_SUNFLOWER=4;const C_CARROT=5;const C_ALIZARIN=6;const C_DARK=7;const C_NONE=255;var controlAssemblyArray=new Object();var FragmentAssemblyTimer=new Object();var graphData=new Array();var hasAccel=false;var sliderContinuous=false;function colorClass(colorId){colorId=Number(colorId);switch(colorId){case C_TURQUOISE:return"turquoise";case C_EMERALD:return"emerald";case C_PETERRIVER:return"peterriver";case C_WETASPHALT:return"wetasphalt";case C_SUNFLOWER:return"sunflower";case C_CARROT:return"carrot";case C_ALIZARIN:return"alizarin";case C_DARK:case C_NONE:return"dark";default:return"";}}
 var websock;var websockConnected=false;var WebSocketTimer=null;function requestOrientationPermission(){}
 function saveGraphData(){localStorage.setItem("espuigraphs",JSON.stringify(graphData));}
 function restoreGraphData(id){var savedData=localStorage.getItem("espuigraphs",graphData);if(savedData!=null){savedData=JSON.parse(savedData);let idData=savedData[id];return Array.isArray(idData)?idData:[];}
 return[];}
 function restart(){$(document).add("*").off();$("#row").html("");conStatusError();start();}
-function conStatusError(){if(true===websockConnected){websockConnected=false;websock.close();$("#conStatus").removeClass("color-green");$("#conStatus").addClass("color-red");$("#conStatus").html("Error / No Connection ↻");$("#conStatus").off();$("#conStatus").on({click:restart,});}}
+function conStatusError(){FragmentAssemblyTimer.forEach(element=>{clearInterval(element);});FragmentAssemblyTimer=new Object();controlAssemblyArray=new Object();if(true===websockConnected){websockConnected=false;websock.close();$("#conStatus").removeClass("color-green");$("#conStatus").addClass("color-red");$("#conStatus").html("Error / No Connection ↻");$("#conStatus").off();$("#conStatus").on({click:restart,});}}
 function handleVisibilityChange(){if(!websockConnected&&!document.hidden){restart();}}
-function start(){document.addEventListener("visibilitychange",handleVisibilityChange,false);if(window.location.port!=""||window.location.port!=80||window.location.port!=443){websock=new WebSocket("ws://"+window.location.hostname+":"+window.location.port+"/ws");}else{websock=new WebSocket("ws://"+window.location.hostname+"/ws");}
+function start(){let location=window.location.hostname;let port=window.location.port;document.addEventListener("visibilitychange",handleVisibilityChange,false);if(port!=""||port!=80||port!=443){websock=new WebSocket("ws://"+location+"/ws");}else{websock=new WebSocket("ws://"+location+"/ws");}
 if(null===WebSocketTimer){WebSocketTimer=setInterval(function(){if(websock.readyState===3){restart();}},5000);}
-websock.onopen=function(evt){console.log("websock open");$("#conStatus").addClass("color-green");$("#conStatus").text("Connected");websockConnected=true;};websock.onclose=function(evt){console.log("websock close");conStatusError();};websock.onerror=function(evt){console.log("websock Error");console.log(evt);restart();};var handleEvent=function(evt){console.log(evt);try{var data=JSON.parse(evt.data);}
+websock.onopen=function(evt){console.log("websock open");$("#conStatus").addClass("color-green");$("#conStatus").text("Connected");websockConnected=true;FragmentAssemblyTimer.forEach(element=>{clearInterval(element);});FragmentAssemblyTimer=new Object();controlAssemblyArray=new Object();};websock.onclose=function(evt){console.log("websock close");conStatusError();FragmentAssemblyTimer.forEach(element=>{clearInterval(element);});FragmentAssemblyTimer=new Object();controlAssemblyArray=new Object();};websock.onerror=function(evt){console.log("websock Error");restart();FragmentAssemblyTimer.forEach(element=>{clearInterval(element);});FragmentAssemblyTimer=new Object();controlAssemblyArray=new Object();};var handleEvent=function(evt){try{var data=JSON.parse(evt.data);}
 catch(Event){console.error(Event);websock.send("uiok:"+0);return;}
 var e=document.body;var center="";switch(data.type){case UI_INITIAL_GUI:$("#row").html("");$("#tabsnav").html("");$("#tabscontent").html("");if(data.sliderContinuous){sliderContinuous=data.sliderContinuous;}
 data.controls.forEach(element=>{var fauxEvent={data:JSON.stringify(element),};handleEvent(fauxEvent);});if(data.totalcontrols>(data.controls.length-1)){websock.send("uiok:"+(data.controls.length-1));}
@@ -43,7 +43,19 @@ if(data.hasOwnProperty('inputType')){$("#text"+data.id).attr("type",data.inputTy
 break;case UPDATE_SELECT:$("#select"+data.id).val(data.value);if(data.hasOwnProperty('elementStyle')){$("#select"+data.id).attr("style",data.elementStyle);}
 break;case UPDATE_BUTTON:$("#btn"+data.id).val(data.value);$("#btn"+data.id).text(data.value);if(data.hasOwnProperty('elementStyle')){$("#btn"+data.id).attr("style",data.elementStyle);}
 break;case UPDATE_PAD:case UPDATE_CPAD:break;case UPDATE_GAUGE:$("#gauge"+data.id).val(data.value);if(data.hasOwnProperty('elementStyle')){$("#gauge"+data.id).attr("style",data.elementStyle);}
-break;case UPDATE_ACCEL:break;case UPDATE_TIME:var rv=new Date().toISOString();websock.send("time:"+rv+":"+data.id);break;default:console.error("Unknown type or event");break;}
+break;case UPDATE_ACCEL:break;case UPDATE_TIME:var rv=new Date().toISOString();websock.send("time:"+rv+":"+data.id);break;case UI_FRAGMENT:let FragmentLen=data.length;let FragementOffset=data.offset;let NextFragmentOffset=FragementOffset+FragmentLen;let Total=data.total;let Arrived=(FragmentLen+FragementOffset);let FragmentFinal=Total===Arrived;if(!data.hasOwnProperty('control'))
+{console.error("UI_FRAGMENT:Missing control record, skipping control");break;}
+let control=data.control;StopFragmentAssemblyTimer(data.control.id);if(0===FragementOffset)
+{controlAssemblyArray[control.id]=data;controlAssemblyArray[control.id].offset=NextFragmentOffset;StartFragmentAssemblyTimer(control.id);let TotalRequest=JSON.stringify({'id':control.id,'offset':NextFragmentOffset});websock.send("uifragmentok:"+0+": "+TotalRequest+":");break;}
+if("undefined"===typeof controlAssemblyArray[control.id])
+{console.error("Missing first fragment for control: "+control.id);StartFragmentAssemblyTimer(control.id);let TotalRequest=JSON.stringify({'id':control.id,'offset':0});websock.send("uifragmentok:"+0+": "+TotalRequest+":");break;}
+if(FragementOffset!==controlAssemblyArray[control.id].offset)
+{console.error("Wrong next fragment. Expected: "+controlAssemblyArray[control.id].offset+" Got: "+FragementOffset);StartFragmentAssemblyTimer(control.id);let TotalRequest=JSON.stringify({'id':control.id,'offset':controlAssemblyArray[control.id].length+controlAssemblyArray[control.id].offset});websock.send("uifragmentok:"+0+": "+TotalRequest+":");break;}
+controlAssemblyArray[control.id].control.value+=control.value;controlAssemblyArray[control.id].offset=NextFragmentOffset;if(true===FragmentFinal)
+{var fauxEvent={data:JSON.stringify(controlAssemblyArray[control.id].control),};handleEvent(fauxEvent);controlAssemblyArray[control.id]=null;}
+else
+{StartFragmentAssemblyTimer(control.id);let TotalRequest=JSON.stringify({'id':control.id,'offset':NextFragmentOffset});websock.send("uifragmentok:"+0+": "+TotalRequest+":");}
+break;default:console.error("Unknown type or event");break;}
 if(data.type>=UI_TITEL&&data.type<UPDATE_OFFSET){processEnabled(data);}
 if(data.type>=UPDATE_OFFSET&&data.type<UI_INITIAL_GUI){var element=$("#id"+data.id);if(data.hasOwnProperty('panelStyle')){$("#id"+data.id).attr("style",data.panelStyle);}
 if(data.hasOwnProperty('visible')){if(data['visible'])
@@ -52,6 +64,15 @@ $("#id"+data.id).hide();}
 if(data.type==UPDATE_SLIDER){element.removeClass("slider-turquoise slider-emerald slider-peterriver slider-wetasphalt slider-sunflower slider-carrot slider-alizarin");element.addClass("slider-"+colorClass(data.color));}else{element.removeClass("turquoise emerald peterriver wetasphalt sunflower carrot alizarin");element.addClass(colorClass(data.color));}
 processEnabled(data);}
 $(".range-slider__range").each(function(){$(this)[0].value=$(this).attr("value");$(this).next().html($(this).attr("value"));});};websock.onmessage=handleEvent;}
+function StartFragmentAssemblyTimer(Id)
+{StopFragmentAssemblyTimer(Id);FragmentAssemblyTimer[Id]=setInterval(function(_Id)
+{if("undefined"!==typeof controlAssemblyArray[_Id])
+{if(null!==controlAssemblyArray[_Id])
+{let TotalRequest=JSON.stringify({'id':controlAssemblyArray[_Id].control.id,'offset':controlAssemblyArray[_Id].offset});websock.send("uifragmentok:"+0+": "+TotalRequest+":");}}},1000,Id);}
+function StopFragmentAssemblyTimer(Id)
+{if("undefined"!==typeof FragmentAssemblyTimer[Id])
+{if(FragmentAssemblyTimer[Id])
+{clearInterval(FragmentAssemblyTimer[Id]);}}}
 function sliderchange(number){var val=$("#sl"+number).val();websock.send("slvalue:"+val+":"+number);$(".range-slider__range").each(function(){$(this).attr("value",$(this)[0].value);});}
 function numberchange(number){var val=$("#num"+number).val();websock.send("nvalue:"+val+":"+number);}
 function textchange(number){var val=$("#text"+number).val();websock.send("tvalue:"+val+":"+number);}

src/ESPUI.h

@@ -1,7 +1,7 @@
 #pragma once
 
 // comment out to turn off debug output
-#define DEBUG_ESPUI true
+// #define DEBUG_ESPUI true
 #define WS_AUTHENTICATION false
 
 #include <Arduino.h>
@@ -87,16 +87,13 @@ enum Verbosity : uint8_t
 class ESPUIClass
 {
 public:
-
-#ifdef ESP32
     ESPUIClass()
     {
+#ifdef ESP32
         ControlsSemaphore = xSemaphoreCreateMutex();
         xSemaphoreGive(ControlsSemaphore);
-    }
-    SemaphoreHandle_t ControlsSemaphore = NULL;
 #endif // def ESP32
-
+	}
     unsigned int jsonUpdateDocumentSize = 2000;
 #ifdef ESP8266
     unsigned int jsonInitialDocumentSize = 2000;
@@ -196,7 +193,6 @@ public:
     void jsonDom(uint16_t startidx, AsyncWebSocketClient* client = nullptr, bool Updating = false);
 
     Verbosity verbosity = Verbosity::Quiet;
-    AsyncWebServer* server;
 
     // emulate former extended callback API by using an intermediate lambda (no deprecation)
     uint16_t addControl(ControlType type, const char* label, const String& value, ControlColor color, uint16_t parentControl, std::function<void(Control*, int, void*)> callback, void* userData)
@@ -240,8 +236,13 @@ protected:
     friend class ESPUIclient;
     friend class ESPUIcontrol;
 
+#ifdef ESP32
+    SemaphoreHandle_t ControlsSemaphore = NULL;
+#endif // def ESP32
+
     void        RemoveToBeDeletedControls();
 
+    AsyncWebServer* server;
     AsyncWebSocket* ws;
 
     const char* basicAuthUsername = nullptr;

src/ESPUIclient.cpp

@@ -229,7 +229,21 @@ void ESPUIclient::onWsEvent(AwsEventType type, void* arg, uint8_t* data, size_t
             if (cmd.equals(F("uiok")))
             {
                 // Serial.println(F("ESPUIclient::OnWsEvent:WS_EVT_DATA:uiok:ProcessAck"));
-                pCurrentFsmState->ProcessAck(id);
+                pCurrentFsmState->ProcessAck(id, emptyString);
+                break;
+            }
+
+            if (cmd.equals(F("uifragmentok")))
+            {
+                if(!emptyString.equals(value))
+                {
+                    // Serial.println(String(F("ESPUIclient::OnWsEvent:WS_EVT_DATA:uifragmentok:ProcessAck:value: '")) + value + "'");
+                    pCurrentFsmState->ProcessAck(uint16_t(-1), value);
+                }
+                else
+                {
+                    // Serial.println(F("ERROR:ESPUIclient::OnWsEvent:WS_EVT_DATA:uifragmentok:ProcessAck:Fragment Header is missing"));
+                }
                 break;
             }
 
@@ -269,7 +283,8 @@ client will acknowledge receipt by requesting the next chunk.
  */
 uint32_t ESPUIclient::prepareJSONChunk(uint16_t startindex,
                                       DynamicJsonDocument & rootDoc,
-                                      bool InUpdateMode)
+                                      bool InUpdateMode,
+                                      String FragmentRequestString)
 {
 #ifdef ESP32
     xSemaphoreTake(ESPUI.ControlsSemaphore, portMAX_DELAY);
@@ -283,8 +298,61 @@ uint32_t ESPUIclient::prepareJSONChunk(uint16_t startindex,
         // Follow the list until control points to the startindex'th node
         Control* control = ESPUI.controls;
         uint32_t currentIndex = 0;
+        uint32_t DataOffset = 0;
         JsonArray items = rootDoc[F("controls")];
+        bool SingleControl = false;
 
+        if(!emptyString.equals(FragmentRequestString))
+        {
+            // Serial.println(F("prepareJSONChunk:Fragmentation:Got Header (1)"));
+            // Serial.println(String("prepareJSONChunk:startindex:                  ") + String(startindex));
+            // Serial.println(String("prepareJSONChunk:currentIndex:                ") + String(currentIndex));
+            // Serial.println(String("prepareJSONChunk:FragmentRequestString:      '") + FragmentRequestString + "'");
+
+            // this is actually a fragment or directed update request
+            // parse the string we got from the UI and try to update that specific 
+            // control.
+            DynamicJsonDocument FragmentRequest(FragmentRequestString.length() * 3);
+            if(0 >= FragmentRequest.capacity())
+            {
+                Serial.println(F("ERROR:prepareJSONChunk:Fragmentation:Could not allocate memory for a fragmentation request. Skipping Response"));
+                break;
+            }
+            size_t FragmentRequestStartOffset = FragmentRequestString.indexOf("{");
+            DeserializationError error = deserializeJson(FragmentRequest, FragmentRequestString.substring(FragmentRequestStartOffset));
+            if(DeserializationError::Ok != error)
+            {
+                Serial.println(F("ERROR:prepareJSONChunk:Fragmentation:Could not extract json from the fragment request"));
+                break;
+            }
+
+            if(!FragmentRequest.containsKey(F("id")))
+            {
+                Serial.println(F("ERROR:prepareJSONChunk:Fragmentation:Request does not contain a control ID"));
+                break;
+            }
+            uint16_t ControlId = uint16_t(FragmentRequest[F("id")]);
+
+            if(!FragmentRequest.containsKey(F("offset")))
+            {
+                Serial.println(F("ERROR:prepareJSONChunk:Fragmentation:Request does not contain a starting offset"));
+                break;
+            }
+            DataOffset = uint16_t(FragmentRequest[F("offset")]);
+            control = ESPUI.getControlNoLock(ControlId);
+            if(nullptr == control)
+            {
+                Serial.println(String(F("ERROR:prepareJSONChunk:Fragmentation:Requested control: ")) + String(ControlId) + F(" does not exist"));
+                break;
+            }
+
+            // Serial.println(F("prepareJSONChunk:Fragmentation:disable the control search operation"));
+            currentIndex = 1;
+            startindex = 0;
+            SingleControl = true;
+        }
+
+        // find a control to send
         while ((startindex > currentIndex) && (nullptr != control))
         {
             // only count active controls
@@ -320,14 +388,14 @@ uint32_t ESPUIclient::prepareJSONChunk(uint16_t startindex,
         while (nullptr != control)
         {
             // skip deleted controls or controls that have not been updated
-            if (control->ToBeDeleted())
+            if (control->ToBeDeleted() && !SingleControl)
             {
                 // Serial.println(String("prepareJSONChunk: Ignoring Deleted control: ") + String(control->id));
                 control = control->next;
                 continue;
             }
 
-            if(InUpdateMode)
+            if(InUpdateMode && !SingleControl)
             {
                 if(control->IsUpdated())
                 {
@@ -343,7 +411,7 @@ uint32_t ESPUIclient::prepareJSONChunk(uint16_t startindex,
 
             JsonObject item = items.createNestedObject();
             elementcount++;
-            control->MarshalControl(item, InUpdateMode);
+            control->MarshalControl(item, InUpdateMode, DataOffset);
             
             if (rootDoc.overflowed() || (ESPUI.jsonChunkNumberMax > 0 && (elementcount % ESPUI.jsonChunkNumberMax) == 0))
             {
@@ -351,6 +419,7 @@ uint32_t ESPUIclient::prepareJSONChunk(uint16_t startindex,
                 if (1 == elementcount)
                 {
                     Serial.println(String(F("ERROR: prepareJSONChunk: Control ")) + String(control->id) + F(" is too large to be sent to the browser."));
+                    // Serial.println(String(F("ERROR: prepareJSONChunk: value: ")) + control->value);
                     rootDoc.clear();
                     item = items.createNestedObject();
                     control->MarshalErrorMessage(item);
@@ -366,7 +435,11 @@ uint32_t ESPUIclient::prepareJSONChunk(uint16_t startindex,
                 }
                 // exit the loop
                 control = nullptr;
-
+            }
+            else if (SingleControl)
+            {
+                // Serial.println("prepareJSONChunk: exit loop");
+                control = nullptr;
             }
             else
             {
@@ -404,8 +477,7 @@ CLIENT: controls.js:handleEvent()
 etc.
     Returns true if all controls have been sent (aka: Done)
 */
-bool ESPUIclient::SendControlsToClient(uint16_t startidx,
+bool ESPUIclient::SendControlsToClient(uint16_t startidx, ClientUpdateType_t TransferMode, String FragmentRequest)
-                                       ClientUpdateType_t TransferMode)
 {
     bool Response = false;
     // Serial.println(String("ESPUIclient:SendControlsToClient:startidx: ") + String(startidx));
@@ -417,9 +489,9 @@ bool ESPUIclient::SendControlsToClient(uint16_t startidx,
             break;
         }
 
-        if (startidx >= ESPUI.controlCount)
+        else if ((startidx >= ESPUI.controlCount) && (emptyString.equals(FragmentRequest)))
         {
-            // Serial.println("ESPUIclient:SendControlsToClient: No more controls to send.");
+            // Serial.println(F("ERROR:ESPUIclient:SendControlsToClient: No more controls to send."));
             Response = true;
             break;
         }
@@ -427,7 +499,7 @@ bool ESPUIclient::SendControlsToClient(uint16_t startidx,
         DynamicJsonDocument document(ESPUI.jsonInitialDocumentSize);
         FillInHeader(document);
         document[F("startindex")] = startidx;
-        document[F("totalcontrols")] = 65534; // ESPUI.controlCount;
+        document[F("totalcontrols")] = uint16_t(-1); // ESPUI.controlCount;
 
         if(0 == startidx)
         {
@@ -437,7 +509,7 @@ bool ESPUIclient::SendControlsToClient(uint16_t startidx,
         // Serial.println(String("ESPUIclient:SendControlsToClient:type: ") + String((uint32_t)document["type"]));
 
         // Serial.println("ESPUIclient:SendControlsToClient: Build Controls.");
-        if(prepareJSONChunk(startidx, document, ClientUpdateType_t::UpdateNeeded == TransferMode))
+        if(prepareJSONChunk(startidx, document, ClientUpdateType_t::UpdateNeeded == TransferMode, FragmentRequest))
         {
             #if defined(DEBUG_ESPUI)
                 if (ESPUI.verbosity >= Verbosity::VerboseJSON)

src/ESPUIclient.h

@@ -44,8 +44,8 @@ protected:
 
     bool        CanSend();
     void        FillInHeader(ArduinoJson::DynamicJsonDocument& document);
-    uint32_t    prepareJSONChunk(uint16_t startindex, DynamicJsonDocument& rootDoc, bool InUpdateMode);
+    uint32_t    prepareJSONChunk(uint16_t startindex, DynamicJsonDocument& rootDoc, bool InUpdateMode, String value);
-    bool        SendControlsToClient(uint16_t startidx, ClientUpdateType_t TransferMode);
+    bool        SendControlsToClient(uint16_t startidx, ClientUpdateType_t TransferMode, String FragmentRequest);
 
     bool        SendClientNotification(ClientUpdateType_t value);
 

src/ESPUIclientFsm.cpp

@@ -58,13 +58,21 @@ bool fsm_EspuiClient_state_Idle::NotifyClient()
     return Response;
 }
 
-void fsm_EspuiClient_state_Idle::ProcessAck(uint16_t)
+void fsm_EspuiClient_state_Idle::ProcessAck(uint16_t ControlIndex, String FragmentRequestString)
+{
+    if(!emptyString.equals(FragmentRequestString))
+    {
+        // Serial.println(F("fsm_EspuiClient_state_Idle::ProcessAck:Fragmentation:Got fragment Header"));
+        Parent->SendControlsToClient(ControlIndex, ClientUpdateType_t::UpdateNeeded, FragmentRequestString);
+    }
+    else
     {
         // This is an unexpected request for control data from the browser
         // treat it as if it was a rebuild operation
         // Serial.println(F("fsm_EspuiClient_state_Idle: ProcessAck"));
         Parent->NotifyClient(ClientUpdateType_t::RebuildNeeded);
     }
+}
 
 //----------------------------------------------
 //----------------------------------------------
@@ -75,10 +83,10 @@ bool fsm_EspuiClient_state_SendingUpdate::NotifyClient()
     return true; /* Ignore request */
 }
 
-void fsm_EspuiClient_state_SendingUpdate::ProcessAck(uint16_t ControlIndex)
+void fsm_EspuiClient_state_SendingUpdate::ProcessAck(uint16_t ControlIndex, String FragmentRequest)
 {
     // Serial.println(F("fsm_EspuiClient_state_SendingUpdate: ProcessAck"));
-    if(Parent->SendControlsToClient(ControlIndex, ClientUpdateType_t::UpdateNeeded))
+    if(Parent->SendControlsToClient(ControlIndex, ClientUpdateType_t::UpdateNeeded, FragmentRequest))
     {
         // No more data to send. Go back to idle or start next request
         Parent->fsm_EspuiClient_state_Idle_imp.Init();
@@ -95,13 +103,25 @@ bool fsm_EspuiClient_state_Rebuilding::NotifyClient()
     return true; /* Ignore request */
 }
 
-void fsm_EspuiClient_state_Rebuilding::ProcessAck(uint16_t ControlIndex)
+void fsm_EspuiClient_state_Rebuilding::ProcessAck(uint16_t ControlIndex, String FragmentRequest)
 {
     // Serial.println(F("fsm_EspuiClient_state_Rebuilding: ProcessAck"));
-    if(Parent->SendControlsToClient(ControlIndex, ClientUpdateType_t::RebuildNeeded))
+    if(Parent->SendControlsToClient(ControlIndex, ClientUpdateType_t::RebuildNeeded, FragmentRequest))
     {
         // No more data to send. Go back to idle or start next request
         Parent->fsm_EspuiClient_state_Idle_imp.Init();
         Parent->fsm_EspuiClient_state_Idle_imp.NotifyClient();
     }
 }
+
+//----------------------------------------------
+//----------------------------------------------
+//----------------------------------------------
+void fsm_EspuiClient_state_Reloading::ProcessAck(uint16_t ControlIndex, String FragmentRequestString)
+{
+    if(!emptyString.equals(FragmentRequestString))
+    {
+        // Serial.println(F("fsm_EspuiClient_state_Reloading::ProcessAck:Fragmentation:Got fragment Header"));
+        Parent->SendControlsToClient(ControlIndex, ClientUpdateType_t::UpdateNeeded, FragmentRequestString);
+    }
+}

src/ESPUIclientFsm.h

@@ -20,7 +20,7 @@ public:
 
             void Init();
     virtual bool NotifyClient() = 0;
-    virtual void ProcessAck(uint16_t id) = 0;
+    virtual void ProcessAck(uint16_t id, String FragmentRequest) = 0;
     virtual String GetStateName () = 0;
             void SetParent(ESPUIclient * value) { Parent = value; }
 
@@ -36,7 +36,7 @@ public:
     virtual     ~fsm_EspuiClient_state_Idle() {}
 
     virtual bool NotifyClient();
-    virtual void ProcessAck(uint16_t id);
+    virtual void ProcessAck(uint16_t id, String FragmentRequest);
             String GetStateName() { return String(F("Idle")); }
 
 }; // fsm_EspuiClient_state_Idle
@@ -48,7 +48,7 @@ public:
     virtual     ~fsm_EspuiClient_state_SendingUpdate() {}
 
     virtual bool NotifyClient();
-    virtual void ProcessAck(uint16_t id);
+    virtual void ProcessAck(uint16_t id, String FragmentRequest);
             String GetStateName() { return String(F("Sending Update")); }
 
 }; // fsm_EspuiClient_state_SendingUpdate
@@ -60,7 +60,7 @@ public:
     virtual     ~fsm_EspuiClient_state_Rebuilding() {}
 
     virtual bool NotifyClient();
-    virtual void ProcessAck(uint16_t id);
+    virtual void ProcessAck(uint16_t id, String FragmentRequest);
             String GetStateName() { return String(F("Sending Rebuild")); }
 
 }; // fsm_EspuiClient_state_Rebuilding
@@ -72,7 +72,7 @@ public:
     virtual     ~fsm_EspuiClient_state_Reloading() {}
 
     virtual bool NotifyClient() { return false; }
-    virtual void ProcessAck(uint16_t) {}
+    virtual void ProcessAck(uint16_t id, String FragmentRequest);
             String GetStateName() { return String(F("Reloading")); }
 
 }; // fsm_EspuiClient_state_Reloading

src/ESPUIcontrol.cpp

@@ -46,8 +46,43 @@ void Control::DeleteControl()
     callback = nullptr;
 }
 
-void Control::MarshalControl(JsonObject & item, bool refresh)
+void Control::MarshalControl(JsonObject & _item, bool refresh, uint32_t StartingOffset)
 {
+    JsonObject & item = _item;
+    uint32_t length = value.length();
+    uint32_t maxLength = uint32_t(double(ESPUI.jsonInitialDocumentSize) * 0.75);
+    if((length > maxLength) || StartingOffset)
+    {
+    	/*
+        Serial.println(String("MarshalControl:Start Fragment Processing"));
+        Serial.println(String("MarshalControl:id:                ") + String(id));
+        Serial.println(String("MarshalControl:length:            ") + String(length));
+        Serial.println(String("MarshalControl:StartingOffset:    ") + String(StartingOffset));
+        Serial.println(String("MarshalControl:maxLength:         ") + String(maxLength));
+
+        if(0 == StartingOffset)
+        {
+            Serial.println(String("MarshalControl: New control to fragement. ID: ") + String(id));
+        }
+        else
+        {
+            Serial.println(String("MarshalControl: Next fragement. ID: ") + String(id));
+        }
+		*/
+
+        // indicate that no additional controls should be sent
+        _item[F("type")] = uint32_t(ControlType::Fragment);
+        _item[F("id")]   = id;
+
+        length = min((length - StartingOffset), maxLength);
+        // Serial.println(String("MarshalControl:Final length:      ") + String(length));
+
+        _item[F("offset")] = StartingOffset;
+        _item[F("length")] = length;
+        _item[F("total")] = value.length();
+        item = _item.createNestedObject(F("control"));
+    }
+
     item[F("id")]      = id;
     ControlType TempType = (ControlType::Password == type) ? ControlType::Text : type;
     if(refresh)
@@ -58,8 +93,9 @@ void Control::MarshalControl(JsonObject & item, bool refresh)
     {
         item[F("type")] = uint32_t(TempType);
     }
+
     item[F("label")]   = label;
-    item[F ("value")]   = (ControlType::Password == type) ? F ("--------") : value;
+    item[F ("value")]   = (ControlType::Password == type) ? F ("--------") : value.substring(StartingOffset, length + StartingOffset);
     item[F("visible")] = visible;
     item[F("color")]   = (int)color;
     item[F("enabled")] = enabled;

src/ESPUIcontrol.h

@@ -31,6 +31,7 @@ enum ControlType : uint8_t
     Separator,
     Time,
 
+    Fragment,
     Password = 99,
     UpdateOffset = 100,
 };
@@ -81,7 +82,7 @@ public:
 
     void SendCallback(int type);
     bool HasCallback() { return (nullptr != callback); }
-    void MarshalControl(ArduinoJson::JsonObject& item, bool refresh);
+    void MarshalControl(ArduinoJson::JsonObject& item, bool refresh, uint32_t DataOffset);
     void MarshalErrorMessage(ArduinoJson::JsonObject& item);
     bool ToBeDeleted() { return (ControlSyncState_t::deleted == ControlSyncState); }
     void DeleteControl();