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

    STRING: (dv, offset) => {

    61

        size = dv.getInt8(offset);

    62

        return [

    63

            String.fromCharCode.apply(null, new Uint8Array(

    64

                dv.buffer, /* original buffer */

    65

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

    66

                size /* size of string */

    67

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

    68

    }

    69

};

    70

    71

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

    72

function apply_updates() {

    73

    for(let index in updates){

    74

        // serving as a key, index becomes a string

    75

        // -> pass Number(index) instead

    76

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

    77

        delete updates[index];

    78

    }

    79

}

    80

    81

// Called on requestAnimationFrame, modifies DOM

    82

var requestAnimationFrameID = null;

    83

function animate() {

    84

    // Do the page swith if any one pending

    85

    if(current_subscribed_page != current_visible_page){

    86

        switch_visible_page(current_subscribed_page);

    87

    }

    88

    apply_updates();

    89

    requestAnimationFrameID = null;

    90

}

    91

    92

function requestHMIAnimation() {

    93

    if(requestAnimationFrameID == null){

    94

        requestAnimationFrameID = window.requestAnimationFrame(animate);

    95

    }

    96

}

    97

    98

// Message reception handler

    99

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

   100

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

   101

ws.onmessage = function (evt) {

   102

   103

    let data = evt.data;

   104

    let dv = new DataView(data);

   105

    let i = 0;

   106

    try {

   107

        for(let hash_int of hmi_hash) {

   108

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

   109

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

   110

            };

   111

            i++;

   112

        };

   113

   114

        while(i < data.byteLength){

   115

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

   116

            i += 4;

   117

            let iectype = hmitree_types[index];

   118

            if(iectype != undefined){

   119

                let dvgetter = dvgetters[iectype];

   120

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

   121

                updates[index] = value;

   122

                i += bytesize;

   123

            } else {

   124

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

   125

            }

   126

        };

   127

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

   128

        requestHMIAnimation();

   129

    } catch(err) {

   130

        // 1003 is for "Unsupported Data"

   131

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

   132

   133

        // TODO : remove debug alert ?

   134

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

   135

   136

        // force reload ignoring cache

   137

        location.reload(true);

   138

    }

   139

};

   140

   141

   142

function send_blob(data) {

   143

    if(data.length > 0) {

   144

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

   145

    };

   146

};

   147

   148

const typedarray_types = {

   149

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

   150

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

   151

    STRING: (str) => {

   152

        // beremiz default string max size is 128

   153

        str = str.slice(0,128);

   154

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

   155

        binary[0] = str.length;

   156

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

   157

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

   158

        }

   159

        return binary;

   160

    }

   161

    /* TODO */

   162

};

   163

   164

function send_reset() {

   165

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

   166

};

   167

   168

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

   169

// hmitree indexed array of integers

   170

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

   171

   172

// subscription state as needed by widget now

   173

// hmitree indexed array of Sets of widgets objects

   174

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

   175

   176

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

   177

// Since dispatch directly calls change_hmi_value,

   178

// PLC will periodically send variable at given frequency

   179

subscribers[heartbeat_index].add({

   180

    /* type: "Watchdog", */

   181

    frequency: 1,

   182

    indexes: [heartbeat_index],

   183

    dispatch: function(value) {

   184

        change_hmi_value(heartbeat_index, "+1");

   185

    }

   186

});

   187

   188

function update_subscriptions() {

   189

    let delta = [];

   190

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

   191

        let widgets = subscribers[index];

   192

   193

        // periods are in ms

   194

        let previous_period = subscriptions[index];

   195

   196

        // subscribing with a zero period is unsubscribing

   197

        let new_period = 0;

   198

        if(widgets.size > 0) {

   199

            let maxfreq = 0;

   200

            for(let widget of widgets)

   201

                if(maxfreq < widget.frequency)

   202

                    maxfreq = widget.frequency;

   203

   204

            if(maxfreq != 0)

   205

                new_period = 1000/maxfreq;

   206

        }

   207

   208

        if(previous_period != new_period) {

   209

            subscriptions[index] = new_period;

   210

            delta.push(

   211

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

   212

                new Uint32Array([index]),

   213

                new Uint16Array([new_period]));

   214

        }

   215

    }

   216

    send_blob(delta);

   217

};

   218

   219

function send_hmi_value(index, value) {

   220

    let iectype = hmitree_types[index];

   221

    let tobinary = typedarray_types[iectype];

   222

    send_blob([

   223

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

   224

        new Uint32Array([index]),

   225

        tobinary(value)]);

   226

   227

    cache[index] = value;

   228

};

   229

   230

function change_hmi_value(index, opstr) {

   231

    let op = opstr[0];

   232

    let given_val = opstr.slice(1);

   233

    let old_val = cache[index]

   234

    let new_val;

   235

    switch(op){

   236

      case "=":

   237

        eval("new_val"+opstr);

   238

        break;

   239

      case "+":

   240

      case "-":

   241

      case "*":

   242

      case "/":

   243

        if(old_val != undefined)

   244

            new_val = eval("old_val"+opstr);

   245

        break;

   246

    }

   247

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

   248

        send_hmi_value(index, new_val);

   249

    return new_val;

   250

}

   251

   252

var current_visible_page;

   253

var current_subscribed_page;

   254

   255

function prepare_svg() {

   256

    for(let eltid in detachable_elements){

   257

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

   258

        parent.removeChild(element);

   259

    }

   260

};

   261

   262

function switch_page(page_name, page_index) {

   263

    if(current_subscribed_page != current_visible_page){

   264

        /* page switch already going */

   265

        /* TODO LOG ERROR */

   266

        return;

   267

    } else if(page_name == current_visible_page){

   268

        /* already in that page */

   269

        /* TODO LOG ERROR */

   270

        return;

   271

    }

   272

    switch_subscribed_page(page_name, page_index);

   273

};

   274

   275

function* chain(a,b){

   276

    yield* a;

   277

    yield* b;

   278

};

   279

   300

function switch_subscribed_page(page_name, page_index) {

   301

    let old_desc = page_desc[current_subscribed_page];

   302

    let new_desc = page_desc[page_name];

   303

   304

    if(new_desc == undefined){

   305

        /* TODO LOG ERROR */

   306

        return;

   307

    }

   308

   309

    if(page_index == undefined){

   310

        page_index = new_desc.page_index;

   311

    }

   312

   313

    if(old_desc){

   318

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

   320

   321

    update_subscriptions();

   322

   323

    current_subscribed_page = page_name;

   324

   325

    requestHMIAnimation();

   326

}

   327

   328

function switch_visible_page(page_name) {

   329

   330

    let old_desc = page_desc[current_visible_page];

   331

    let new_desc = page_desc[page_name];

   332

   333

    if(old_desc){

   334

        for(let eltid in old_desc.required_detachables){

   335

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

   336

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

   337

                parent.removeChild(element);

   338

            }

   339

        }

   340

        for(let eltid in new_desc.required_detachables){

   341

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

   342

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

   343

                parent.appendChild(element);

   344

            }

   345

        }

   346

    }else{

   347

        for(let eltid in new_desc.required_detachables){

   348

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

   349

            parent.appendChild(element);

   350

        }

   351

    }

   352

   353

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

   354

        for(let index of widget.indexes){

   355

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

   356

            let cached_val = cache[index];

   357

            if(cached_val != undefined)

   358

                dispatch_value_to_widget(widget, index, cached_val, cached_val);

   359

        }

   360

    }

   361

   362

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

   363

    current_visible_page = page_name;

   364

};

   365

   366

   367

// Once connection established

   368

ws.onopen = function (evt) {

   369

    init_widgets();

   370

    send_reset();

   371

    // show main page

   372

    prepare_svg();

   373

    switch_page(default_page);

   374

};

   375

   376

ws.onclose = function (evt) {

   377

    // TODO : add visible notification while waiting for reload

   378

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

   379

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

   380

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

   381

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

   382

   383

};