SVGHMI: Behave when project path include spaces, and make more understandable error in case of problem extracting geometry with inkscape.
// svghmi.js
var updates = {};
var need_cache_apply = [];
function dispatch_value(index, value) {
let widgets = subscribers(index);
let oldval = cache[index];
cache[index] = value;
if(widgets.size > 0) {
for(let widget of widgets){
widget.new_hmi_value(index, value, oldval);
}
}
};
function init_widgets() {
Object.keys(hmi_widgets).forEach(function(id) {
let widget = hmi_widgets[id];
let init = widget.init;
if(typeof(init) == "function"){
try {
init.call(widget);
} catch(err) {
console.log(err);
}
}
});
};
// Open WebSocket to relative "/ws" address
var ws = new WebSocket(window.location.href.replace(/^http(s?:\/\/[^\/]*)\/.*$/, 'ws$1/ws'));
ws.binaryType = 'arraybuffer';
const dvgetters = {
INT: (dv,offset) => [dv.getInt16(offset, true), 2],
BOOL: (dv,offset) => [dv.getInt8(offset, true), 1],
NODE: (dv,offset) => [dv.getInt8(offset, true), 1],
STRING: (dv, offset) => {
size = dv.getInt8(offset);
return [
String.fromCharCode.apply(null, new Uint8Array(
dv.buffer, /* original buffer */
offset + 1, /* string starts after size*/
size /* size of string */
)), size + 1]; /* total increment */
}
};
// Apply updates recieved through ws.onmessage to subscribed widgets
function apply_updates() {
for(let index in updates){
// serving as a key, index becomes a string
// -> pass Number(index) instead
dispatch_value(Number(index), updates[index]);
delete updates[index];
}
}
// Called on requestAnimationFrame, modifies DOM
var requestAnimationFrameID = null;
function animate() {
// Do the page swith if any one pending
if(current_subscribed_page != current_visible_page){
switch_visible_page(current_subscribed_page);
}
while(widget = need_cache_apply.pop()){
widget.apply_cache();
}
if(jumps_need_update) update_jumps();
apply_updates();
pending_widget_animates.forEach(widget => widget._animate());
pending_widget_animates = [];
requestAnimationFrameID = null;
}
function requestHMIAnimation() {
if(requestAnimationFrameID == null){
requestAnimationFrameID = window.requestAnimationFrame(animate);
}
}
// Message reception handler
// Hash is verified and HMI values updates resulting from binary parsing
// are stored until browser can compute next frame, DOM is left untouched
ws.onmessage = function (evt) {
let data = evt.data;
let dv = new DataView(data);
let i = 0;
try {
for(let hash_int of hmi_hash) {
if(hash_int != dv.getUint8(i)){
throw new Error("Hash doesn't match");
};
i++;
};
while(i < data.byteLength){
let index = dv.getUint32(i, true);
i += 4;
let iectype = hmitree_types[index];
if(iectype != undefined){
let dvgetter = dvgetters[iectype];
let [value, bytesize] = dvgetter(dv,i);
updates[index] = value;
i += bytesize;
} else {
throw new Error("Unknown index "+index);
}
};
// register for rendering on next frame, since there are updates
requestHMIAnimation();
} catch(err) {
// 1003 is for "Unsupported Data"
// ws.close(1003, err.message);
// TODO : remove debug alert ?
alert("Error : "+err.message+"\\\\nHMI will be reloaded.");
// force reload ignoring cache
location.reload(true);
}
};
function send_blob(data) {
if(data.length > 0) {
ws.send(new Blob([new Uint8Array(hmi_hash)].concat(data)));
};
};
const typedarray_types = {
INT: (number) => new Int16Array([number]),
BOOL: (truth) => new Int16Array([truth]),
NODE: (truth) => new Int16Array([truth]),
STRING: (str) => {
// beremiz default string max size is 128
str = str.slice(0,128);
binary = new Uint8Array(str.length + 1);
binary[0] = str.length;
for(var i = 0; i < str.length; i++){
binary[i+1] = str.charCodeAt(i);
}
return binary;
}
/* TODO */
};
function send_reset() {
send_blob(new Uint8Array([1])); /* reset = 1 */
};
var subscriptions = [];
function subscribers(index) {
let entry = subscriptions[index];
let res;
if(entry == undefined){
res = new Set();
subscriptions[index] = [res,0];
}else{
[res, _ign] = entry;
}
return res
}
function get_subscription_period(index) {
let entry = subscriptions[index];
if(entry == undefined)
return 0;
let [_ign, period] = entry;
return period;
}
function set_subscription_period(index, period) {
let entry = subscriptions[index];
if(entry == undefined){
subscriptions[index] = [new Set(), period];
} else {
entry[1] = period;
}
}
// artificially subscribe the watchdog widget to "/heartbeat" hmi variable
// Since dispatch directly calls change_hmi_value,
// PLC will periodically send variable at given frequency
subscribers(heartbeat_index).add({
/* type: "Watchdog", */
frequency: 1,
indexes: [heartbeat_index],
new_hmi_value: function(index, value, oldval) {
apply_hmi_value(heartbeat_index, value+1);
}
});
function update_subscriptions() {
let delta = [];
for(let index in subscriptions){
let widgets = subscribers(index);
// periods are in ms
let previous_period = get_subscription_period(index);
// subscribing with a zero period is unsubscribing
let new_period = 0;
if(widgets.size > 0) {
let maxfreq = 0;
for(let widget of widgets){
let wf = widget.frequency;
if(wf != undefined && maxfreq < wf)
maxfreq = wf;
}
if(maxfreq != 0)
new_period = 1000/maxfreq;
}
if(previous_period != new_period) {
set_subscription_period(index, new_period);
if(index <= last_remote_index){
delta.push(
new Uint8Array([2]), /* subscribe = 2 */
new Uint32Array([index]),
new Uint16Array([new_period]));
}
}
}
send_blob(delta);
};
function send_hmi_value(index, value) {
if(index > last_remote_index){
console.log("updated local variable ",index,value);
updates[index] = value;
requestHMIAnimation();
return;
}
let iectype = hmitree_types[index];
let tobinary = typedarray_types[iectype];
send_blob([
new Uint8Array([0]), /* setval = 0 */
new Uint32Array([index]),
tobinary(value)]);
// DON'T DO THAT unless read_iterator in svghmi.c modifies wbuf as well, not only rbuf
// cache[index] = value;
};
function apply_hmi_value(index, new_val) {
let old_val = cache[index]
if(new_val != undefined && old_val != new_val)
send_hmi_value(index, new_val);
return new_val;
}
quotes = {"'":null, '"':null};
function change_hmi_value(index, opstr) {
let op = opstr[0];
let given_val;
if(opstr.length < 2)
return undefined; // TODO raise
if(opstr[1] in quotes){
if(opstr.length < 3)
return undefined; // TODO raise
if(opstr[opstr.length-1] == opstr[1]){
given_val = opstr.slice(2,opstr.length-1);
}
} else {
given_val = Number(opstr.slice(1));
}
let old_val = cache[index];
let new_val;
switch(op){
case "=":
new_val = given_val;
break;
case "+":
new_val = old_val + given_val;
break;
case "-":
new_val = old_val - given_val;
break;
case "*":
new_val = old_val * given_val;
break;
case "/":
new_val = old_val / given_val;
break;
}
if(new_val != undefined && old_val != new_val)
send_hmi_value(index, new_val);
// TODO else raise
return new_val;
}
var current_visible_page;
var current_subscribed_page;
var current_page_index;
function prepare_svg() {
for(let eltid in detachable_elements){
let [element,parent] = detachable_elements[eltid];
parent.removeChild(element);
}
};
function switch_page(page_name, page_index) {
if(current_subscribed_page != current_visible_page){
/* page switch already going */
/* TODO LOG ERROR */
return false;
}
if(page_name == undefined)
page_name = current_subscribed_page;
let old_desc = page_desc[current_subscribed_page];
let new_desc = page_desc[page_name];
if(new_desc == undefined){
/* TODO LOG ERROR */
return false;
}
if(page_index == undefined){
page_index = new_desc.page_index;
}
if(old_desc){
old_desc.widgets.map(([widget,relativeness])=>widget.unsub());
}
var new_offset = page_index == undefined ? 0 : page_index - new_desc.page_index;
container_id = page_name + (page_index != undefined ? page_index : "");
new_desc.widgets.map(([widget,relativeness])=>widget.sub(new_offset,relativeness,container_id));
update_subscriptions();
current_subscribed_page = page_name;
current_page_index = page_index;
jumps_need_update = true;
requestHMIAnimation();
jump_history.push([page_name, page_index]);
if(jump_history.length > 42)
jump_history.shift();
return true;
};
function switch_visible_page(page_name) {
let old_desc = page_desc[current_visible_page];
let new_desc = page_desc[page_name];
if(old_desc){
for(let eltid in old_desc.required_detachables){
if(!(eltid in new_desc.required_detachables)){
let [element, parent] = old_desc.required_detachables[eltid];
parent.removeChild(element);
}
}
for(let eltid in new_desc.required_detachables){
if(!(eltid in old_desc.required_detachables)){
let [element, parent] = new_desc.required_detachables[eltid];
parent.appendChild(element);
}
}
}else{
for(let eltid in new_desc.required_detachables){
let [element, parent] = new_desc.required_detachables[eltid];
parent.appendChild(element);
}
}
svg_root.setAttribute('viewBox',new_desc.bbox.join(" "));
current_visible_page = page_name;
};
// Once connection established
ws.onopen = function (evt) {
init_widgets();
send_reset();
// show main page
prepare_svg();
switch_page(default_page);
};
ws.onclose = function (evt) {
// TODO : add visible notification while waiting for reload
console.log("Connection closed. code:"+evt.code+" reason:"+evt.reason+" wasClean:"+evt.wasClean+" Reload in 10s.");
// TODO : re-enable auto reload when not in debug
//window.setTimeout(() => location.reload(true), 10000);
alert("Connection closed. code:"+evt.code+" reason:"+evt.reason+" wasClean:"+evt.wasClean+".");
};
var xmlns = "http://www.w3.org/2000/svg";
var edit_callback;
function edit_value(path, valuetype, callback, initial, size) {
let [keypadid, xcoord, ycoord] = keypads[valuetype];
console.log('XXX TODO : Edit value', path, valuetype, callback, initial, keypadid);
edit_callback = callback;
let widget = hmi_widgets[keypadid];
widget.start_edit(path, valuetype, callback, initial, size);
};
var current_modal; /* TODO stack ?*/
function show_modal(size) {
let [element, parent] = detachable_elements[this.element.id];
tmpgrp = document.createElementNS(xmlns,"g");
tmpgrpattr = document.createAttribute("transform");
let [xcoord,ycoord] = this.coordinates;
let [xdest,ydest] = page_desc[current_visible_page].bbox;
if (typeof size === 'undefined'){
tmpgrpattr.value = "translate("+String(xdest-xcoord)+","+String(ydest-ycoord)+")";
}
else{
tmpgrpattr.value = "translate("+String(xdest-xcoord+size.x)+","+String(ydest-ycoord+size.y)+")";
}
tmpgrp.setAttributeNode(tmpgrpattr);
tmpgrp.appendChild(element);
parent.appendChild(tmpgrp);
current_modal = [this.element.id, tmpgrp];
};
function end_modal() {
let [eltid, tmpgrp] = current_modal;
let [element, parent] = detachable_elements[this.element.id];
parent.removeChild(tmpgrp);
current_modal = undefined;
};
function widget_active_activable(eltsub) {
if(eltsub.inactive_style === undefined)
eltsub.inactive_style = eltsub.inactive.getAttribute("style");
eltsub.inactive.setAttribute("style", "display:none");
if(eltsub.active_style !== undefined)
eltsub.active.setAttribute("style", eltsub.active_style);
console.log("active", eltsub);
};
function widget_inactive_activable(eltsub) {
if(eltsub.active_style === undefined)
eltsub.active_style = eltsub.active.getAttribute("style");
eltsub.active.setAttribute("style", "display:none");
if(eltsub.inactive_style !== undefined)
eltsub.inactive.setAttribute("style", eltsub.inactive_style);
console.log("inactive", eltsub);
};