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 idx = widget.offset ? index - widget.offset : index;

     9

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

    10

        let d = widget.dispatch;

    11

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

    12

            d.call(widget, value, oldval);

    13

        }

    14

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

    15

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

    16

        }

    17

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

    18

        /*else {

    19

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

    20

        }*/

    21

    } catch(err) {

    22

        console.log(err);

    23

    }

    24

}

    25

    26

function dispatch_value(index, value) {

    27

    let widgets = subscribers[index];

    28

    29

    let oldval = cache[index];

    30

    cache[index] = value;

    31

    32

    if(widgets.size > 0) {

    33

        for(let widget of widgets){

    34

            dispatch_value_to_widget(widget, index, value, oldval);

    35

        }

    36

    }

    37

};

    38

    39

function init_widgets() {

    40

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

    41

        let widget = hmi_widgets[id];

    42

        let init = widget.init;

    43

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

    44

            try {

    45

                init.call(widget);

    46

            } catch(err) {

    47

                console.log(err);

    48

            }

    49

        }

    50

    });

    51

};

    52

    53

// Open WebSocket to relative "/ws" address

    54

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

    55

ws.binaryType = 'arraybuffer';

    56

    57

const dvgetters = {

    58

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

    59

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

    60

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

    61

    STRING: (dv, offset) => {

    62

        size = dv.getInt8(offset);

    63

        return [

    64

            String.fromCharCode.apply(null, new Uint8Array(

    65

                dv.buffer, /* original buffer */

    66

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

    67

                size /* size of string */

    68

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

    69

    }

    70

};

    71

    72

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

    73

function apply_updates() {

    74

    for(let index in updates){

    75

        // serving as a key, index becomes a string

    76

        // -> pass Number(index) instead

    77

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

    78

        delete updates[index];

    79

    }

    80

}

    81

    82

// Called on requestAnimationFrame, modifies DOM

    83

var requestAnimationFrameID = null;

    84

function animate() {

    85

    // Do the page swith if any one pending

    86

    if(current_subscribed_page != current_visible_page){

    87

        switch_visible_page(current_subscribed_page);

    88

    }

    89

    apply_updates();

    90

    requestAnimationFrameID = null;

    91

}

    92

    93

function requestHMIAnimation() {

    94

    if(requestAnimationFrameID == null){

    95

        requestAnimationFrameID = window.requestAnimationFrame(animate);

    96

    }

    97

}

    98

    99

// Message reception handler

   100

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

   101

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

   102

ws.onmessage = function (evt) {

   103

   104

    let data = evt.data;

   105

    let dv = new DataView(data);

   106

    let i = 0;

   107

    try {

   108

        for(let hash_int of hmi_hash) {

   109

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

   110

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

   111

            };

   112

            i++;

   113

        };

   114

   115

        while(i < data.byteLength){

   116

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

   117

            i += 4;

   118

            let iectype = hmitree_types[index];

   119

            if(iectype != undefined){

   120

                let dvgetter = dvgetters[iectype];

   121

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

   122

                updates[index] = value;

   123

                i += bytesize;

   124

            } else {

   125

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

   126

            }

   127

        };

   128

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

   129

        requestHMIAnimation();

   130

    } catch(err) {

   131

        // 1003 is for "Unsupported Data"

   132

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

   133

   134

        // TODO : remove debug alert ?

   135

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

   136

   137

        // force reload ignoring cache

   138

        location.reload(true);

   139

    }

   140

};

   141

   142

   143

function send_blob(data) {

   144

    if(data.length > 0) {

   145

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

   146

    };

   147

};

   148

   149

const typedarray_types = {

   150

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

   151

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

   152

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

   153

    STRING: (str) => {

   154

        // beremiz default string max size is 128

   155

        str = str.slice(0,128);

   156

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

   157

        binary[0] = str.length;

   158

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

   159

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

   160

        }

   161

        return binary;

   162

    }

   163

    /* TODO */

   164

};

   165

   166

function send_reset() {

   167

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

   168

};

   169

   170

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

   171

// hmitree indexed array of integers

   172

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

   173

   174

// subscription state as needed by widget now

   175

// hmitree indexed array of Sets of widgets objects

   176

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

   177

   178

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

   179

// Since dispatch directly calls change_hmi_value,

   180

// PLC will periodically send variable at given frequency

   181

subscribers[heartbeat_index].add({

   182

    /* type: "Watchdog", */

   183

    frequency: 1,

   184

    indexes: [heartbeat_index],

   185

    dispatch: function(value) {

   186

        change_hmi_value(heartbeat_index, "+1");

   187

    }

   188

});

   189

   190

function update_subscriptions() {

   191

    let delta = [];

   192

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

   193

        let widgets = subscribers[index];

   194

   195

        // periods are in ms

   196

        let previous_period = subscriptions[index];

   197

   198

        // subscribing with a zero period is unsubscribing

   199

        let new_period = 0;

   200

        if(widgets.size > 0) {

   201

            let maxfreq = 0;

   202

            for(let widget of widgets)

   203

                if(maxfreq < widget.frequency)

   204

                    maxfreq = widget.frequency;

   205

   206

            if(maxfreq != 0)

   207

                new_period = 1000/maxfreq;

   208

        }

   209

   210

        if(previous_period != new_period) {

   211

            subscriptions[index] = new_period;

   212

            delta.push(

   213

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

   214

                new Uint32Array([index]),

   215

                new Uint16Array([new_period]));

   216

        }

   217

    }

   218

    send_blob(delta);

   219

};

   220

   221

function send_hmi_value(index, value) {

   222

    let iectype = hmitree_types[index];

   223

    let tobinary = typedarray_types[iectype];

   224

    send_blob([

   225

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

   226

        new Uint32Array([index]),

   227

        tobinary(value)]);

   228

   229

    cache[index] = value;

   230

};

   231

   232

function change_hmi_value(index, opstr) {

   233

    let op = opstr[0];

   234

    let given_val = opstr.slice(1);

   235

    let old_val = cache[index]

   236

    let new_val;

   237

    switch(op){

   238

      case "=":

   239

        eval("new_val"+opstr);

   240

        break;

   241

      case "+":

   242

      case "-":

   243

      case "*":

   244

      case "/":

   245

        if(old_val != undefined)

   246

            new_val = eval("old_val"+opstr);

   247

        break;

   248

    }

   249

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

   250

        send_hmi_value(index, new_val);

   251

    return new_val;

   252

}

   253

   254

var current_visible_page;

   255

var current_subscribed_page;

   256

   257

function prepare_svg() {

   258

    for(let eltid in detachable_elements){

   259

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

   260

        parent.removeChild(element);

   261

    }

   262

};

   263

   264

function switch_page(page_name, page_index) {

   265

    if(current_subscribed_page != current_visible_page){

   266

        /* page switch already going */

   267

        /* TODO LOG ERROR */

   268

        return;

   269

    } else if(page_name == current_visible_page){

   270

        /* already in that page */

   271

        /* TODO LOG ERROR */

   272

        return;

   273

    }

   274

    switch_subscribed_page(page_name, page_index);

   275

};

   276

   277

function* chain(a,b){

   278

    yield* a;

   279

    yield* b;

   280

};

   281

   282

function unsubscribe(){

   283

    widget = this;

   284

    /* remove subsribers */

   285

    for(let index of widget.indexes){

   286

        let idx = index + widget.offset;

   287

        subscribers[idx].delete(widget);

   288

    }

   289

    widget.offset = 0;

   290

}

   291

   292

function subscribe(new_offset=0){

   293

    widget = this;

   294

    /* set the offset because relative */

   295

    widget.offset = new_offset;

   296

    /* add widget's subsribers */

   297

    for(let index of widget.indexes){

   298

        subscribers[index + new_offset].add(widget);

   299

    }

   300

}

   301

   302

function switch_subscribed_page(page_name, page_index) {

   303

    let old_desc = page_desc[current_subscribed_page];

   304

    let new_desc = page_desc[page_name];

   305

   306

    if(new_desc == undefined){

   307

        /* TODO LOG ERROR */

   308

        return;

   309

    }

   310

   311

    if(page_index == undefined){

   312

        page_index = new_desc.page_index;

   313

    }

   314

   315

    if(old_desc){

   316

        old_desc.absolute_widgets.map(w=>w.unsub());

   317

        old_desc.relative_widgets.map(w=>w.unsub());

   318

    }

   319

    new_desc.absolute_widgets.map(w=>w.sub());

   320

    var new_offset = page_index == undefined ? 0 : page_index - new_desc.page_index;

   321

    new_desc.relative_widgets.map(w=>w.sub(new_offset));

   322

   323

    update_subscriptions();

   324

   325

    current_subscribed_page = page_name;

   326

   327

    requestHMIAnimation();

   328

}

   329

   330

function switch_visible_page(page_name) {

   331

   332

    let old_desc = page_desc[current_visible_page];

   333

    let new_desc = page_desc[page_name];

   334

   335

    if(old_desc){

   336

        for(let eltid in old_desc.required_detachables){

   337

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

   338

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

   339

                parent.removeChild(element);

   340

            }

   341

        }

   342

        for(let eltid in new_desc.required_detachables){

   343

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

   344

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

   345

                parent.appendChild(element);

   346

            }

   347

        }

   348

    }else{

   349

        for(let eltid in new_desc.required_detachables){

   350

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

   351

            parent.appendChild(element);

   352

        }

   353

    }

   354

   355

    for(let widget of chain(new_desc.absolute_widgets,new_desc.relative_widgets)){

   356

        for(let index of widget.indexes){

   357

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

   358

            let cached_val = cache[index];

   359

            if(cached_val != undefined)

   360

                dispatch_value_to_widget(widget, index, cached_val, cached_val);

   361

        }

   362

    }

   363

   364

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

   365

    current_visible_page = page_name;

   366

};

   367

   368

   369

// Once connection established

   370

ws.onopen = function (evt) {

   371

    init_widgets();

   372

    send_reset();

   373

    // show main page

   374

    prepare_svg();

   375

    switch_page(default_page);

   376

};

   377

   378

ws.onclose = function (evt) {

   379

    // TODO : add visible notification while waiting for reload

   380

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

   381

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

   382

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

   383

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

   384

   385

};