1

// svghmi.js

     2

     3

function dispatch_value(index, value) {

     4

    let widgets = subscribers(index);

     5

     6

    let oldval = cache[index];

     7

    cache[index] = value;

     8

     9

    if(widgets.size > 0) {

    10

        for(let widget of widgets){

    11

            widget.new_hmi_value(index, value, oldval);

    12

        }

    13

    }

    14

};

    15

    16

function init_widgets() {

    17

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

    18

        let widget = hmi_widgets[id];

    19

        widget.do_init();

    20

    });

    21

};

    22

    23

// Open WebSocket to relative "/ws" address

    24

var has_watchdog = window.location.hash == "#watchdog";

    25

    26

var ws_url = 

    27

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

    28

    + '?mode=' + (has_watchdog ? "watchdog" : "multiclient");

    29

    30

var ws = new WebSocket(ws_url);

    31

ws.binaryType = 'arraybuffer';

    32

    33

const dvgetters = {

    34

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

    35

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

    36

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

    37

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

    38

    STRING: (dv, offset) => {

    39

        const size = dv.getInt8(offset);

    40

        return [

    41

            String.fromCharCode.apply(null, new Uint8Array(

    42

                dv.buffer, /* original buffer */

    43

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

    44

                size /* size of string */

    45

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

    46

    }

    47

};

    48

    49

// Called on requestAnimationFrame, modifies DOM

    50

var requestAnimationFrameID = null;

    51

function animate() {

    52

    let rearm = true;

    53

    do{

    54

        if(page_fading == "pending" || page_fading == "forced"){

    55

            if(page_fading == "pending")

    56

                svg_root.classList.add("fade-out-page");

    57

            page_fading = "in_progress";

    58

            if(page_fading_args.length)

    59

                setTimeout(function(){

    60

                    switch_page(...page_fading_args);

    61

                },1);

    62

            break;

    63

        }

    64

    65

        // Do the page swith if pending

    66

        if(page_switch_in_progress){

    67

            if(current_subscribed_page != current_visible_page){

    68

                switch_visible_page(current_subscribed_page);

    69

            }

    70

    71

            page_switch_in_progress = false;

    72

    73

            if(page_fading == "in_progress"){

    74

                svg_root.classList.remove("fade-out-page");

    75

                page_fading = "off";

    76

            }

    77

        }

    78

    79

        if(jumps_need_update) update_jumps();

    80

    81

    82

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

    83

        pending_widget_animates = [];

    84

        rearm = false;

    85

    } while(0);

    86

    87

    requestAnimationFrameID = null;

    88

    89

    if(rearm) requestHMIAnimation();

    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);

   122

                i += bytesize;

   123

            } else {

   124

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

   125

            }

   126

        };

   127

   128

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

   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

hmi_hash_u8 = new Uint8Array(hmi_hash);

   142

   143

function send_blob(data) {

   144

    if(data.length > 0) {

   145

        ws.send(new Blob([hmi_hash_u8].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

    REAL: (number) => new Float32Array([number]),

   154

    STRING: (str) => {

   155

        // beremiz default string max size is 128

   156

        str = str.slice(0,128);

   157

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

   158

        binary[0] = str.length;

   159

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

   160

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

   161

        }

   162

        return binary;

   163

    }

   164

    /* TODO */

   165

};

   166

   167

function send_reset() {

   168

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

   169

};

   170

   171

var subscriptions = [];

   172

   173

function subscribers(index) {

   174

    let entry = subscriptions[index];

   175

    let res;

   176

    if(entry == undefined){

   177

        res = new Set();

   178

        subscriptions[index] = [res,0];

   179

    }else{

   180

        [res, _ign] = entry;

   181

    }

   182

    return res

   183

}

   184

   185

function get_subscription_period(index) {

   186

    let entry = subscriptions[index];

   187

    if(entry == undefined)

   188

        return 0;

   189

    let [_ign, period] = entry;

   190

    return period;

   191

}

   192

   193

function set_subscription_period(index, period) {

   194

    let entry = subscriptions[index];

   195

    if(entry == undefined){

   196

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

   197

    } else {

   198

        entry[1] = period;

   199

    }

   200

}

   201

   202

if(has_watchdog){

   203

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

   204

    // Since dispatch directly calls change_hmi_value,

   205

    // PLC will periodically send variable at given frequency

   206

    subscribers(heartbeat_index).add({

   207

        /* type: "Watchdog", */

   208

        frequency: 1,

   209

        indexes: [heartbeat_index],

   210

        new_hmi_value: function(index, value, oldval) {

   211

            apply_hmi_value(heartbeat_index, value+1);

   212

        }

   213

    });

   214

}

   215

   216

   217

var page_fading = "off";

   218

var page_fading_args = "off";

   219

function fading_page_switch(...args){

   220

    if(page_fading == "in_progress")

   221

        page_fading = "forced";

   222

    else

   223

        page_fading = "pending";

   224

    page_fading_args = args;

   225

   226

    requestHMIAnimation();

   227

   228

}

   229

document.body.style.backgroundColor = "black";

   230

   231

// subscribe to per instance current page hmi variable

   232

// PLC must prefix page name with "!" for page switch to happen

   233

subscribers(current_page_var_index).add({

   234

    frequency: 1,

   235

    indexes: [current_page_var_index],

   236

    new_hmi_value: function(index, value, oldval) {

   237

        if(value.startsWith("!"))

   238

            fading_page_switch(value.slice(1));

   239

    }

   240

});

   241

   242

function svg_text_to_multiline(elt) {

   243

    return(Array.prototype.map.call(elt.children, x=>x.textContent).join("\\\\n")); 

   244

}

   245

   246

function multiline_to_svg_text(elt, str, blank) {

   247

    str.split('\\\\n').map((line,i) => {elt.children[i].textContent = blank?"":line;});

   248

}

   249

   250

function switch_langnum(langnum) {

   251

    langnum = Math.max(0, Math.min(langs.length - 1, langnum));

   252

   253

    for (let translation of translations) {

   254

        let [objs, msgs] = translation;

   255

        let msg = msgs[langnum];

   256

        for (let obj of objs) {

   257

            multiline_to_svg_text(obj, msg);

   258

            obj.setAttribute("lang",langnum);

   259

        }

   260

    }

   261

    return langnum;

   262

}

   263

   264

// backup original texts

   265

for (let translation of translations) {

   266

    let [objs, msgs] = translation;

   267

    msgs.unshift(svg_text_to_multiline(objs[0])); 

   268

}

   269

   270

var lang_local_index = hmi_local_index("lang");

   271

var langcode_local_index = hmi_local_index("lang_code");

   272

var langname_local_index = hmi_local_index("lang_name");

   273

subscribers(lang_local_index).add({

   274

    indexes: [lang_local_index],

   275

    new_hmi_value: function(index, value, oldval) {

   276

        let current_lang =  switch_langnum(value);

   277

        let [langname,langcode] = langs[current_lang];

   278

        apply_hmi_value(langcode_local_index, langcode);

   279

        apply_hmi_value(langname_local_index, langname);

   280

        switch_page();

   281

    }

   282

});

   283

   284

// returns en_US, fr_FR or en_UK depending on selected language

   285

function get_current_lang_code(){

   286

    return cache[langcode_local_index];

   287

}

   288

   289

function setup_lang(){

   290

    let current_lang = cache[lang_local_index];

   291

    let new_lang = switch_langnum(current_lang);

   292

    if(current_lang != new_lang){

   293

        apply_hmi_value(lang_local_index, new_lang);

   294

    }

   295

}

   296

   297

setup_lang();

   298

   299

function update_subscriptions() {

   300

    let delta = [];

   301

    for(let index in subscriptions){

   302

        let widgets = subscribers(index);

   303

   304

        // periods are in ms

   305

        let previous_period = get_subscription_period(index);

   306

   307

        // subscribing with a zero period is unsubscribing

   308

        let new_period = 0;

   309

        if(widgets.size > 0) {

   310

            let maxfreq = 0;

   311

            for(let widget of widgets){

   312

                let wf = widget.frequency;

   313

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

   314

                    maxfreq = wf;

   315

            }

   316

   317

            if(maxfreq != 0)

   318

                new_period = 1000/maxfreq;

   319

        }

   320

   321

        if(previous_period != new_period) {

   322

            set_subscription_period(index, new_period);

   323

            if(index <= last_remote_index){

   324

                delta.push(

   325

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

   326

                    new Uint32Array([index]),

   327

                    new Uint16Array([new_period]));

   328

            }

   329

        }

   330

    }

   331

    send_blob(delta);

   332

};

   333

   334

function send_hmi_value(index, value) {

   335

    if(index > last_remote_index){

   336

        dispatch_value(index, value);

   337

   338

        if(persistent_indexes.has(index)){

   339

            let varname = persistent_indexes.get(index);

   340

            document.cookie = varname+"="+value+"; max-age=3153600000";

   341

        }

   342

   343

        return;

   344

    }

   345

   346

    let iectype = hmitree_types[index];

   347

    let tobinary = typedarray_types[iectype];

   348

    send_blob([

   349

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

   350

        new Uint32Array([index]),

   351

        tobinary(value)]);

   352

   353

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

   354

    // cache[index] = value;

   355

};

   356

   357

function apply_hmi_value(index, new_val) {

   358

    // Similarly to previous comment, taking decision to update based 

   359

    // on cache content is bad and can lead to inconsistency

   360

    /*let old_val = cache[index];*/

   361

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

   362

        send_hmi_value(index, new_val);

   363

    return new_val;

   364

}

   365

   366

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

   367

   368

function eval_operation_string(old_val, opstr) {

   369

    let op = opstr[0];

   370

    let given_val;

   371

    if(opstr.length < 2) 

   372

        return undefined;

   373

    if(opstr[1] in quotes){

   374

        if(opstr.length < 3) 

   375

            return undefined;

   376

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

   377

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

   378

        }

   379

    } else {

   380

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

   381

    }

   382

    let new_val;

   383

    switch(op){

   384

      case "=":

   385

        new_val = given_val;

   386

        break;

   387

      case "+":

   388

        new_val = old_val + given_val;

   389

        break;

   390

      case "-":

   391

        new_val = old_val - given_val;

   392

        break;

   393

      case "*":

   394

        new_val = old_val * given_val;

   395

        break;

   396

      case "/":

   397

        new_val = old_val / given_val;

   398

        break;

   399

    }

   400

    return new_val;

   401

}

   402

   403

var current_visible_page;

   404

var current_subscribed_page;

   405

var current_page_index;

   406

var page_node_local_index = hmi_local_index("page_node");

   407

var page_switch_in_progress = false;

   408

   409

function toggleFullscreen() {

   410

  let elem = document.documentElement;

   411

   412

  if (!document.fullscreenElement) {

   413

    elem.requestFullscreen().catch(err => {

   414

      console.log("Error attempting to enable full-screen mode: "+err.message+" ("+err.name+")");

   415

    });

   416

  } else {

   417

    document.exitFullscreen();

   418

  }

   419

}

   420

   421

function prepare_svg() {

   422

    // prevents context menu from appearing on right click and long touch

   423

    document.body.addEventListener('contextmenu', e => {

   424

        toggleFullscreen();

   425

        e.preventDefault();

   426

    });

   427

   428

    for(let eltid in detachable_elements){

   429

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

   430

        parent.removeChild(element);

   431

    }

   432

};

   433

   434

function switch_page(page_name, page_index) {

   435

    if(page_switch_in_progress){

   436

        /* page switch already going */

   437

        /* TODO LOG ERROR */

   438

        return false;

   439

    }

   440

    page_switch_in_progress = true;

   441

   442

    if(page_name == undefined)

   443

        page_name = current_subscribed_page;

   444

    else if(page_index == undefined){

   445

        [page_name, page_index] = page_name.split('@')

   446

    }

   447

   448

    let old_desc = page_desc[current_subscribed_page];

   449

    let new_desc = page_desc[page_name];

   450

   451

    if(new_desc == undefined){

   452

        /* TODO LOG ERROR */

   453

        return false;

   454

    }

   455

   456

    if(page_index == undefined)

   457

        page_index = new_desc.page_index;

   458

    else if(typeof(page_index) == "string") {

   459

        let hmitree_node = hmitree_nodes[page_index];

   460

        if(hmitree_node !== undefined){

   461

            let [int_index, hmiclass] = hmitree_node;

   462

            if(hmiclass == new_desc.page_class)

   463

                page_index = int_index;

   464

            else

   465

                page_index = new_desc.page_index;

   466

        } else {

   467

            page_index = new_desc.page_index;

   468

        }

   469

    }

   470

   471

    if(old_desc){

   472

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

   473

    }

   474

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

   475

   476

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

   477

   478

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

   479

   480

    update_subscriptions();

   481

   482

    current_subscribed_page = page_name;

   483

    current_page_index = page_index;

   484

    let page_node;