1

// svghmi.js

     2

     3

var updates = {};

     4

var need_cache_apply = []; 

     5

     6

     7

function dispatch_value(index, value) {

     8

    let widgets = subscribers(index);

     9

    10

    let oldval = cache[index];

    11

    cache[index] = value;

    12

    13

    if(widgets.size > 0) {

    14

        for(let widget of widgets){

    15

            widget.new_hmi_value(index, value, oldval);

    16

        }

    17

    }

    18

};

    19

    20

function init_widgets() {

    21

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

    22

        let widget = hmi_widgets[id];

    23

        let init = widget.init;

    24

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

    25

            try {

    26

                init.call(widget);

    27

            } catch(err) {

    28

                console.log(err);

    29

            }

    30

        }

    31

    });

    32

};

    33

    34

// Open WebSocket to relative "/ws" address

    35

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

    36

ws.binaryType = 'arraybuffer';

    37

    38

const dvgetters = {

    39

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

    40

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

    41

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

    42

    REAL: (dv,offset) => [dv.getFloat32(offset, true), 4],

    43

    STRING: (dv, offset) => {

    44

        size = dv.getInt8(offset);

    45

        return [

    46

            String.fromCharCode.apply(null, new Uint8Array(

    47

                dv.buffer, /* original buffer */

    48

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

    49

                size /* size of string */

    50

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

    51

    }

    52

};

    53

    54

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

    55

function apply_updates() {

    56

    for(let index in updates){

    57

        // serving as a key, index becomes a string

    58

        // -> pass Number(index) instead

    59

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

    60

        delete updates[index];

    61

    }

    62

}

    63

    64

// Called on requestAnimationFrame, modifies DOM

    65

var requestAnimationFrameID = null;

    66

function animate() {

    67

    // Do the page swith if any one pending

    68

    if(current_subscribed_page != current_visible_page){

    69

        switch_visible_page(current_subscribed_page);

    70

    }

    71

    72

    while(widget = need_cache_apply.pop()){

    73

        widget.apply_cache();

    74

    }

    75

    76

    if(jumps_need_update) update_jumps();

    77

    78

    apply_updates();

    79

    80

    pending_widget_animates.forEach(widget => widget._animate());

    81

    pending_widget_animates = [];

    82

    83

    requestAnimationFrameID = null;

    84

}

    85

    86

function requestHMIAnimation() {

    87

    if(requestAnimationFrameID == null){

    88

        requestAnimationFrameID = window.requestAnimationFrame(animate);

    89

    }

    90

}

    91

    92

// Message reception handler

    93

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

    94

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

    95

ws.onmessage = function (evt) {

    96

    97

    let data = evt.data;

    98

    let dv = new DataView(data);

    99

    let i = 0;

   100

    try {

   101

        for(let hash_int of hmi_hash) {

   102

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

   103

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

   104

            };

   105

            i++;

   106

        };

   107

   108

        while(i < data.byteLength){

   109

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

   110

            i += 4;

   111

            let iectype = hmitree_types[index];

   112

            if(iectype != undefined){

   113

                let dvgetter = dvgetters[iectype];

   114

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

   115

                updates[index] = value;

   116

                i += bytesize;

   117

            } else {

   118

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

   119

            }

   120

        };

   121

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

   122

        requestHMIAnimation();

   123

    } catch(err) {

   124

        // 1003 is for "Unsupported Data"

   125

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

   126

   127

        // TODO : remove debug alert ?

   128

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

   129

   130

        // force reload ignoring cache

   131

        location.reload(true);

   132

    }

   133

};

   134

   135

   136

function send_blob(data) {

   137

    if(data.length > 0) {

   138

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

   139

    };

   140

};

   141

   142

const typedarray_types = {

   143

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

   144

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

   145

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

   146

    STRING: (str) => {

   147

        // beremiz default string max size is 128

   148

        str = str.slice(0,128);

   149

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

   150

        binary[0] = str.length;

   151

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

   152

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

   153

        }

   154

        return binary;

   155

    }

   156

    /* TODO */

   157

};

   158

   159

function send_reset() {

   160

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

   161

};

   162

   163

var subscriptions = [];

   164

   165

function subscribers(index) {

   166

    let entry = subscriptions[index];

   167

    let res;

   168

    if(entry == undefined){

   169

        res = new Set();

   170

        subscriptions[index] = [res,0];

   171

    }else{

   172

        [res, _ign] = entry;

   173

    }

   174

    return res

   175

}

   176

   177

function get_subscription_period(index) {

   178

    let entry = subscriptions[index];

   179

    if(entry == undefined)

   180

        return 0;

   181

    let [_ign, period] = entry;

   182

    return period;

   183

}

   184

   185

function set_subscription_period(index, period) {

   186

    let entry = subscriptions[index];

   187

    if(entry == undefined){

   188

        subscriptions[index] = [new Set(), period];

   189

    } else {

   190

        entry[1] = period;

   191

    }

   192

}

   193

   194

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

   195

// Since dispatch directly calls change_hmi_value,

   196

// PLC will periodically send variable at given frequency

   197

subscribers(heartbeat_index).add({

   198

    /* type: "Watchdog", */

   199

    frequency: 1,

   200

    indexes: [heartbeat_index],

   201

    new_hmi_value: function(index, value, oldval) {

   202

        apply_hmi_value(heartbeat_index, value+1);

   203

    }

   204

});

   205

   206

   207

function update_subscriptions() {

   208

    let delta = [];

   209

    for(let index in subscriptions){

   210

        let widgets = subscribers(index);

   211

   212

        // periods are in ms

   213

        let previous_period = get_subscription_period(index);

   214

   215

        // subscribing with a zero period is unsubscribing

   216

        let new_period = 0;

   217

        if(widgets.size > 0) {

   218

            let maxfreq = 0;

   219

            for(let widget of widgets){

   220

                let wf = widget.frequency;

   221

                if(wf != undefined && maxfreq < wf)

   222

                    maxfreq = wf;

   223

            }

   224

   225

            if(maxfreq != 0)

   226

                new_period = 1000/maxfreq;

   227

        }

   228

   229

        if(previous_period != new_period) {

   230

            set_subscription_period(index, new_period);

   231

            if(index <= last_remote_index){

   232

                delta.push(

   233

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

   234

                    new Uint32Array([index]),

   235

                    new Uint16Array([new_period]));

   236

            }

   237

        }

   238

    }

   239

    send_blob(delta);

   240

};

   241

   242

function send_hmi_value(index, value) {

   243

    if(index > last_remote_index){

   244

        updates[index] = value;

   245

        requestHMIAnimation();

   246

        return;

   247

    }

   248

   249

    let iectype = hmitree_types[index];

   250

    let tobinary = typedarray_types[iectype];

   251

    send_blob([

   252

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

   253

        new Uint32Array([index]),

   254

        tobinary(value)]);

   255

   256

    // DON'T DO THAT unless read_iterator in svghmi.c modifies wbuf as well, not only rbuf

   257

    // cache[index] = value;

   258

};

   259

   260

function apply_hmi_value(index, new_val) {

   261

    let old_val = cache[index]

   262

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

   263

        send_hmi_value(index, new_val);

   264

    return new_val;

   265

}

   266

   267

quotes = {"'":null, '"':null};

   268

   269

function change_hmi_value(index, opstr) {

   270

    let op = opstr[0];

   271

    let given_val;

   272

    if(opstr.length < 2) 

   273

        return undefined; // TODO raise

   274

    if(opstr[1] in quotes){

   275

        if(opstr.length < 3) 

   276

            return undefined; // TODO raise

   277

        if(opstr[opstr.length-1] == opstr[1]){

   278

            given_val = opstr.slice(2,opstr.length-1);

   279

        }

   280

    } else {

   281

        given_val = Number(opstr.slice(1));

   282

    }

   283

    let old_val = cache[index];

   284

    let new_val;

   285

    switch(op){

   286

      case "=":

   287

        new_val = given_val;

   288

        break;

   289

      case "+":

   290

        new_val = old_val + given_val;

   291

        break;

   292

      case "-":

   293

        new_val = old_val - given_val;

   294

        break;

   295

      case "*":

   296

        new_val = old_val * given_val;

   297

        break;

   298

      case "/":

   299

        new_val = old_val / given_val;

   300

        break;

   301

    }

   302

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

   303

        send_hmi_value(index, new_val);

   304

    // TODO else raise

   305

    return new_val;

   306

}

   307

   308

var current_visible_page;

   309

var current_subscribed_page;

   310

var current_page_index;

   311

   312

function prepare_svg() {

   313

    for(let eltid in detachable_elements){

   314

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

   315

        parent.removeChild(element);

   316

    }

   317

};

   318

   319

function switch_page(page_name, page_index) {

   320

    if(current_subscribed_page != current_visible_page){

   321

        /* page switch already going */

   322

        /* TODO LOG ERROR */

   323

        return false;

   324

    }

   325

   326

    if(page_name == undefined)

   327

        page_name = current_subscribed_page;

   328

   329

   330

    let old_desc = page_desc[current_subscribed_page];

   331

    let new_desc = page_desc[page_name];

   332

   333

    if(new_desc == undefined){

   334

        /* TODO LOG ERROR */

   335

        return false;

   336

    }

   337

   338

    if(page_index == undefined){

   339

        page_index = new_desc.page_index;

   340

    }

   341

   342

    if(old_desc){

   343

        old_desc.widgets.map(([widget,relativeness])=>widget.unsub());

   344

    }

   345

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

   346

   347

    container_id = page_name + (page_index != undefined ? page_index : "");

   348

   349

    new_desc.widgets.map(([widget,relativeness])=>widget.sub(new_offset,relativeness,container_id));

   350

   351

    update_subscriptions();

   352

   353

    current_subscribed_page = page_name;

   354

    current_page_index = page_index;

   355

   356

    jumps_need_update = true;

   357

   358

    requestHMIAnimation();

   359

   360

    jump_history.push([page_name, page_index]);

   361

    if(jump_history.length > 42)

   362

        jump_history.shift();

   363

   364

    return true;

   365

};

   366

   367

function switch_visible_page(page_name) {

   368

   369

    let old_desc = page_desc[current_visible_page];

   370

    let new_desc = page_desc[page_name];

   371

   372

    if(old_desc){

   373

        for(let eltid in old_desc.required_detachables){

   374

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

   375

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

   376

                parent.removeChild(element);

   377

            }

   378

        }

   379

        for(let eltid in new_desc.required_detachables){

   380

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

   381

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

   382

                parent.appendChild(element);

   383

            }

   384

        }

   385

    }else{

   386

        for(let eltid in new_desc.required_detachables){

   387

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

   388

            parent.appendChild(element);

   389

        }

   390

    }

   391

   392

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

   393

    current_visible_page = page_name;

   394

};

   395

   396

// Once connection established

   397

ws.onopen = function (evt) {

   398

    init_widgets();

   399

    send_reset();

   400

    // show main page

   401

    prepare_svg();

   402

    switch_page(default_page);

   403

};

   404

   405

ws.onclose = function (evt) {

   406

    // TODO : add visible notification while waiting for reload

   407

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

   408

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

   409

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

   410

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

   411

   412

};

   413

   414

var xmlns = "http://www.w3.org/2000/svg";

   415

var edit_callback;

   416

function edit_value(path, valuetype, callback, initial, size) {

   417

   418

    let [keypadid, xcoord, ycoord] = keypads[valuetype];

   419

    edit_callback = callback;

   420

    let widget = hmi_widgets[keypadid];

   421

    widget.start_edit(path, valuetype, callback, initial, size);

   422

};

   423

   424

var current_modal; /* TODO stack ?*/

   425

   426

function show_modal(size) {

   427

    let [element, parent] = detachable_elements[this.element.id];

   428

   429

    tmpgrp = document.createElementNS(xmlns,"g");

   430

    tmpgrpattr = document.createAttribute("transform");

   431

    let [xcoord,ycoord] = this.coordinates;

   432

    let [xdest,ydest] = page_desc[current_visible_page].bbox;

   433

    if (typeof size === 'undefined'){

   434

        tmpgrpattr.value = "translate("+String(xdest-xcoord)+","+String(ydest-ycoord)+")";

   435

    }

   436

    else{

   437

        tmpgrpattr.value = "translate("+String(xdest-xcoord+size.x)+","+String(ydest-ycoord+size.y)+")";

   438

    }

   439

   440

    tmpgrp.setAttributeNode(tmpgrpattr);

   441

   442

    tmpgrp.appendChild(element);

   443

    parent.appendChild(tmpgrp);

   444

   445

    current_modal = [this.element.id, tmpgrp];

   446

};

   447

   448

function end_modal() {

   449

    let [eltid, tmpgrp] = current_modal;

   450

    let [element, parent] = detachable_elements[this.element.id];

   451

   452

    parent.removeChild(tmpgrp);

   453

   454

    current_modal = undefined;

   455

};

   456

   457

function widget_active_activable(eltsub) {

   458

    if(eltsub.inactive_style === undefined)

   459

        eltsub.inactive_style = eltsub.inactive.getAttribute("style");

   460

    eltsub.inactive.setAttribute("style", "display:none");

   461

    if(eltsub.active_style !== undefined)

   462

            eltsub.active.setAttribute("style", eltsub.active_style);

   463

};

   464

function widget_inactive_activable(eltsub) {

   465

    if(eltsub.active_style === undefined)

   466

        eltsub.active_style = eltsub.active.getAttribute("style");

   467

    eltsub.active.setAttribute("style", "display:none");

   468

    if(eltsub.inactive_style !== undefined)

   469

            eltsub.inactive.setAttribute("style", eltsub.inactive_style);

   470

};