1

// svghmi.js

     2

     3

var cache = hmitree_types.map(_ignored => undefined);

     4

var updates = {};

     5

     6

function dispatch_value_to_widget(widget, index, value, oldval) {

     7

    try {

     8

        let idxidx = widget.indexes.indexOf(index);

     9

        let d = widget.dispatch;

    10

        if(typeof(d) == "function" && idxidx == 0){

    11

            d.call(widget, value, oldval);

    12

        }else if(typeof(d) == "object" && d.length >= idxidx){

    13

            d[idxidx].call(widget, value, oldval);

    14

        }/* else dispatch_0, ..., dispatch_n ? */

    15

        /*else {

    16

            throw new Error("Dunno how to dispatch to widget at index = " + index);

    17

        }*/

    18

    } catch(err) {

    19

        console.log(err);

    20

    }

    21

}

    22

    23

function dispatch_value(index, value) {

    24

    let widgets = subscribers[index];

    25

    26

    let oldval = cache[index];

    27

    cache[index] = value;

    28

    29

    if(widgets.size > 0) {

    30

        for(let widget of widgets){

    31

            dispatch_value_to_widget(widget, index, value, oldval);

    32

        }

    33

    }

    34

};

    35

    36

function init_widgets() {

    37

    Object.keys(hmi_widgets).forEach(function(id) {

    38

        let widget = hmi_widgets[id];

    39

        let init = widget.init;

    40

        if(typeof(init) == "function"){

    41

            try {

    42

                init.call(widget);

    43

            } catch(err) {

    44

                console.log(err);

    45

            }

    46

        }

    47

    });

    48

};

    49

    50

// Open WebSocket to relative "/ws" address

    51

var ws = new WebSocket(window.location.href.replace(/^http(s?:\/\/[^\/]*)\/.*$/, 'ws$1/ws'));

    52

ws.binaryType = 'arraybuffer';

    53

    54

const dvgetters = {

    55

    INT: (dv,offset) => [dv.getInt16(offset, true), 2],

    56

    BOOL: (dv,offset) => [dv.getInt8(offset, true), 1],

    57

    STRING: (dv, offset) => {

    58

        size = dv.getInt8(offset);

    59

        return [

    60

            String.fromCharCode.apply(null, new Uint8Array(

    61

                dv.buffer, /* original buffer */

    62

                offset + 1, /* string starts after size*/

    63

                size /* size of string */

    64

            )), size + 1]; /* total increment */

    65

    }

    66

};

    67

    68

// Apply updates recieved through ws.onmessage to subscribed widgets

    70

    for(let index in updates){

    71

        // serving as a key, index becomes a string

    72

        // -> pass Number(index) instead

    73

        dispatch_value(Number(index), updates[index]);

    74

        delete updates[index];

    75

    }

    87

    requestAnimationFrameID = null;

    88

}

    89

    90

function requestHMIAnimation() {

    91

    if(requestAnimationFrameID == null){

    92

        requestAnimationFrameID = window.requestAnimationFrame(animate);

    93

    }

    94

}

    95

    96

// Message reception handler

    97

// Hash is verified and HMI values updates resulting from binary parsing

    98

// are stored until browser can compute next frame, DOM is left untouched

    99

ws.onmessage = function (evt) {

   100

   101

    let data = evt.data;

   102

    let dv = new DataView(data);

   103

    let i = 0;

   104

    try {

   105

        for(let hash_int of hmi_hash) {

   106

            if(hash_int != dv.getUint8(i)){

   107

                throw new Error("Hash doesn't match");

   108

            };

   109

            i++;

   110

        };

   111

   112

        while(i < data.byteLength){

   113

            let index = dv.getUint32(i, true);

   114

            i += 4;

   115

            let iectype = hmitree_types[index];

   116

            if(iectype != undefined){

   117

                let dvgetter = dvgetters[iectype];

   118

                let [value, bytesize] = dvgetter(dv,i);

   119

                updates[index] = value;

   120

                i += bytesize;

   121

            } else {

   122

                throw new Error("Unknown index "+index);

   123

            }

   124

        };

   125

        // register for rendering on next frame, since there are updates

   126

        requestHMIAnimation();

   127

    } catch(err) {

   128

        // 1003 is for "Unsupported Data"

   129

        // ws.close(1003, err.message);

   130

   131

        // TODO : remove debug alert ?

   132

        alert("Error : "+err.message+"\\\\nHMI will be reloaded.");

   133

   134

        // force reload ignoring cache

   135

        location.reload(true);

   136

    }

   137

};

   138

   139

   140

function send_blob(data) {

   141

    if(data.length > 0) {

   142

        ws.send(new Blob([new Uint8Array(hmi_hash)].concat(data)));

   143

    };

   144

};

   145

   146

const typedarray_types = {

   147

    INT: (number) => new Int16Array([number]),

   148

    BOOL: (truth) => new Int16Array([truth]),

   149

    STRING: (str) => {

   150

        // beremiz default string max size is 128

   151

        str = str.slice(0,128);

   152

        binary = new Uint8Array(str.length + 1);

   153

        binary[0] = str.length;

   154

        for(var i = 0; i < str.length; i++){

   155

            binary[i+1] = str.charCodeAt(i);

   156

        }

   157

        return binary;

   158

    }

   159

    /* TODO */

   160

};

   161

   162

function send_reset() {

   163

    send_blob(new Uint8Array([1])); /* reset = 1 */

   164

};

   165

   166

// subscription state, as it should be in hmi server

   167

// hmitree indexed array of integers

   168

var subscriptions =  hmitree_types.map(_ignored => 0);

   169

   170

// subscription state as needed by widget now

   171

// hmitree indexed array of Sets of widgets objects

   172

var subscribers = hmitree_types.map(_ignored => new Set());

   173

   174

// artificially subscribe the watchdog widget to "/heartbeat" hmi variable

   175

// Since dispatch directly calls change_hmi_value,

   176

// PLC will periodically send variable at given frequency

   177

subscribers[heartbeat_index].add({

   178

    /* type: "Watchdog", */

   179

    frequency: 1,

   180

    indexes: [heartbeat_index],

   181

    dispatch: function(value) {

   182

        // console.log("Heartbeat" + value);

   183

        change_hmi_value(heartbeat_index, "+1");

   184

    }

   185

});

   186

   187

function update_subscriptions() {

   188

    let delta = [];

   189

    for(let index = 0; index < subscribers.length; index++){

   190

        let widgets = subscribers[index];

   191

   192

        // periods are in ms

   193

        let previous_period = subscriptions[index];

   194

   195

        // subscribing with a zero period is unsubscribing

   196

        let new_period = 0;

   197

        if(widgets.size > 0) {

   198

            let maxfreq = 0;

   199

            for(let widget of widgets)

   200

                if(maxfreq < widget.frequency)

   201

                    maxfreq = widget.frequency;

   202

   203

            if(maxfreq != 0)

   204

                new_period = 1000/maxfreq;

   205

        }

   206

   207

        if(previous_period != new_period) {

   208

            subscriptions[index] = new_period;

   209

            delta.push(

   210

                new Uint8Array([2]), /* subscribe = 2 */

   211

                new Uint32Array([index]),

   212

                new Uint16Array([new_period]));

   213

        }

   214

    }

   215

    send_blob(delta);

   216

};

   217

   218

function send_hmi_value(index, value) {

   219

    let iectype = hmitree_types[index];

   220

    let tobinary = typedarray_types[iectype];

   221

    send_blob([

   222

        new Uint8Array([0]),  /* setval = 0 */

   223

        new Uint32Array([index]),

   224

        tobinary(value)]);

   225

   226

    cache[index] = value;

   227

};

   228

   229

function change_hmi_value(index, opstr) {

   230

    let op = opstr[0];

   231

    let given_val = opstr.slice(1);

   232

    let old_val = cache[index]

   233

    let new_val;

   234

    switch(op){

   235

      case "=":

   236

        eval("new_val"+opstr);

   237

        break;

   238

      case "+":

   239

      case "-":

   240

      case "*":

   241

      case "/":

   242

        if(old_val != undefined)

   243

            new_val = eval("old_val"+opstr);

   244

        break;

   245

    }

   246

    if(new_val != undefined && old_val != new_val)

   247

        send_hmi_value(index, new_val);

   248

    return new_val;

   249

}

   250

   251

var current_visible_page;

   252

var current_subscribed_page;

   253

   254

function prepare_svg() {

   255

    for(let eltid in detachable_elements){

   256

        let [element,parent] = detachable_elements[eltid];

   257

        parent.removeChild(element);

   258

    }

   259

};

   260

   261

function switch_page(page_name) {

   262

    if(current_subscribed_page != current_visible_page){

   263

        /* page switch already going */

   264

        /* TODO LOG ERROR */

   265

        return;

   266

    } else if(page_name == current_visible_page){

   267

        /* already in that page */

   268

        /* TODO LOG ERROR */

   269

        return;

   270

    }

   271

    switch_subscribed_page(page_name);

   272

};

   273

   274

function switch_subscribed_page(page_name) {

   275

    let old_desc = page_desc[current_subscribed_page];

   276

    let new_desc = page_desc[page_name];

   277

   278

    if(new_desc == undefined){

   279

        /* TODO LOG ERROR */

   280

        return;

   281

    }

   282

   283

    if(old_desc){

   284

        for(let widget of old_desc.widgets){

   285

            /* remove subsribers */

   286

            for(let index of widget.indexes){

   287

                subscribers[index].delete(widget);

   288

            }

   289

        }

   290

    }

   291

    for(let widget of new_desc.widgets){

   292

        /* add widget's subsribers */

   293

        for(let index of widget.indexes){

   294

            subscribers[index].add(widget);

   295

        }

   296

    }

   297

   298

    update_subscriptions();

   299

   300

    current_subscribed_page = page_name;

   301

   302

    requestHMIAnimation();

   303

}

   304

   305

function switch_visible_page(page_name) {

   306

   307

    let old_desc = page_desc[current_visible_page];

   308

    let new_desc = page_desc[page_name];

   309

   310

    if(old_desc){

   311

        for(let eltid in old_desc.required_detachables){

   312

            if(!(eltid in new_desc.required_detachables)){

   313

                let [element, parent] = old_desc.required_detachables[eltid];

   314

                parent.removeChild(element);

   315

            }

   316

        }

   317

        for(let eltid in new_desc.required_detachables){

   318

            if(!(eltid in old_desc.required_detachables)){

   319

                let [element, parent] = new_desc.required_detachables[eltid];

   320

                parent.appendChild(element);

   321

            }

   322

        }

   323

    }else{

   324

        for(let eltid in new_desc.required_detachables){

   325

            let [element, parent] = new_desc.required_detachables[eltid];

   326

            parent.appendChild(element);

   327

        }

   328

    }

   329

   330

    for(let widget of new_desc.widgets){

   331

        for(let index of widget.indexes){

   332

            /* dispatch current cache in newly opened page widgets */

   333

            let cached_val = cache[index];

   334

            if(cached_val != undefined)

   335

                dispatch_value_to_widget(widget, index, cached_val, cached_val);

   336

        }

   337

    }

   338

   339

    svg_root.setAttribute('viewBox',new_desc.bbox.join(" "));

   340

    current_visible_page = page_name;

   341

};

   342

   343

   344

// Once connection established

   345

ws.onopen = function (evt) {

   346

    init_widgets();

   347

    send_reset();

   348

    // show main page

   349

    prepare_svg();

   350

    switch_page(default_page);

   351

};

   352

   353

ws.onclose = function (evt) {

   354

    // TODO : add visible notification while waiting for reload

   355

    console.log("Connection closed. code:"+evt.code+" reason:"+evt.reason+" wasClean:"+evt.wasClean+" Reload in 10s.");

   356

    // TODO : re-enable auto reload when not in debug

   357

    //window.setTimeout(() => location.reload(true), 10000);

   358

    alert("Connection closed. code:"+evt.code+" reason:"+evt.reason+" wasClean:"+evt.wasClean+".");

   359

   360

};