1

// svghmi.js

     2

     3

var need_cache_apply = [];

     4

     5

function dispatch_value(index, value) {

     6

    let widgets = subscribers(index);

     7

     8

    let oldval = cache[index];

     9

    cache[index] = value;

    10

    11

    if(widgets.size > 0) {

    12

        for(let widget of widgets){

    13

            widget.new_hmi_value(index, value, oldval);

    14

        }

    15

    }

    16

};

    17

    18

function init_widgets() {

    19

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

    20

        let widget = hmi_widgets[id];

    22

    });

    23

};

    24

    25

// Open WebSocket to relative "/ws" address

    26

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

    27

    28

var ws_url = 

    29

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

    30

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

    31

    32

var ws = new WebSocket(ws_url);

    33

ws.binaryType = 'arraybuffer';

    34

    35

const dvgetters = {

    36

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

    37

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

    38

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

    39

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

    40

    STRING: (dv, offset) => {

    41

        const size = dv.getInt8(offset);

    42

        return [

    43

            String.fromCharCode.apply(null, new Uint8Array(

    44

                dv.buffer, /* original buffer */

    45

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

    46

                size /* size of string */

    47

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

    48

    }

    49

};

    50

    51

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

    52

function apply_updates() {

    53

    updates.forEach((value, index) => {

    54

        dispatch_value(index, value);

    55

    });

    56

    updates.clear();

    57

}

    58

    59

// Called on requestAnimationFrame, modifies DOM

    60

var requestAnimationFrameID = null;

    61

function animate() {

    62

    // Do the page swith if any one pending

    63

    if(current_subscribed_page != current_visible_page){

    64

        switch_visible_page(current_subscribed_page);

    65

    }

    66

    67

    while(widget = need_cache_apply.pop()){

    68

        widget.apply_cache();

    69

    }

    70

    71

    if(jumps_need_update) update_jumps();

    72

    73

    apply_updates();

    74

    75

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

    76

    pending_widget_animates = [];

    77

    78

    requestAnimationFrameID = null;

    79

}

    80

    81

function requestHMIAnimation() {

    82

    if(requestAnimationFrameID == null){

    83

        requestAnimationFrameID = window.requestAnimationFrame(animate);

    84

    }

    85

}

    86

    87

// Message reception handler

    88

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

    89

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

    90

ws.onmessage = function (evt) {

    91

    92

    let data = evt.data;

    93

    let dv = new DataView(data);

    94

    let i = 0;

    95

    try {

    96

        for(let hash_int of hmi_hash) {

    97

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

    98

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

    99

            };

   100

            i++;

   101

        };

   102

   103

        while(i < data.byteLength){

   104

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

   105

            i += 4;

   106

            let iectype = hmitree_types[index];

   107

            if(iectype != undefined){

   108

                let dvgetter = dvgetters[iectype];

   109

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

   110

                updates.set(index, value);

   111

                i += bytesize;

   112

            } else {

   113

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

   114

            }

   115

        };

   116

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

   117

        requestHMIAnimation();

   118

    } catch(err) {

   119

        // 1003 is for "Unsupported Data"

   120

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

   121

   122

        // TODO : remove debug alert ?

   123

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

   124

   125

        // force reload ignoring cache

   126

        location.reload(true);

   127

    }

   128

};

   129

   130

hmi_hash_u8 = new Uint8Array(hmi_hash);

   131

   132

function send_blob(data) {

   133

    if(data.length > 0) {

   134

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

   135

    };

   136

};

   137

   138

const typedarray_types = {

   139

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

   140

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

   141

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

   142

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

   143

    STRING: (str) => {

   144

        // beremiz default string max size is 128

   145

        str = str.slice(0,128);

   146

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

   147

        binary[0] = str.length;

   148

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

   149

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

   150

        }

   151

        return binary;

   152

    }

   153

    /* TODO */

   154

};

   155

   156

function send_reset() {

   157

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

   158

};

   159

   160

var subscriptions = [];

   161

   162

function subscribers(index) {

   163

    let entry = subscriptions[index];

   164

    let res;

   165

    if(entry == undefined){

   166

        res = new Set();

   167

        subscriptions[index] = [res,0];

   168

    }else{

   169

        [res, _ign] = entry;

   170

    }

   171

    return res

   172

}

   173

   174

function get_subscription_period(index) {

   175

    let entry = subscriptions[index];

   176

    if(entry == undefined)

   177

        return 0;

   178

    let [_ign, period] = entry;

   179

    return period;

   180

}

   181

   182

function set_subscription_period(index, period) {

   183

    let entry = subscriptions[index];

   184

    if(entry == undefined){

   185

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

   186

    } else {

   187

        entry[1] = period;

   188

    }

   189

}

   190

   191

if(has_watchdog){

   192

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

   193

    // Since dispatch directly calls change_hmi_value,

   194

    // PLC will periodically send variable at given frequency

   195

    subscribers(heartbeat_index).add({

   196

        /* type: "Watchdog", */

   197

        frequency: 1,

   198

        indexes: [heartbeat_index],

   199

        new_hmi_value: function(index, value, oldval) {

   200

            apply_hmi_value(heartbeat_index, value+1);

   201

        }

   202

    });

   203

}

   204

   205

// subscribe to per instance current page hmi variable

   206

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

   207

subscribers(current_page_var_index).add({

   208

    frequency: 1,

   209

    indexes: [current_page_var_index],

   210

    new_hmi_value: function(index, value, oldval) {

   211

        if(value.startsWith("!"))

   212

            switch_page(value.slice(1));

   213

    }

   214

});

   215

   216

function svg_text_to_multiline(elt) {

   217

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

   218

}

   219

   220

function multiline_to_svg_text(elt, str) {

   221

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

   222

}

   223

   224

function switch_langnum(langnum) {

   225

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

   226

   227

    for (let translation of translations) {

   228

        let [objs, msgs] = translation;

   229

        let msg = msgs[langnum];

   230

        for (let obj of objs) {

   231

            multiline_to_svg_text(obj, msg);

   232

            obj.setAttribute("lang",langnum);

   233

        }

   234

    }

   235

    return langnum;

   236

}

   237

   238

// backup original texts

   239

for (let translation of translations) {

   240

    let [objs, msgs] = translation;

   241

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

   242

}

   243

   244

var lang_local_index = hmi_local_index("lang");

   245

var langcode_local_index = hmi_local_index("lang_code");

   246

var langname_local_index = hmi_local_index("lang_name");

   247

subscribers(lang_local_index).add({

   248

    indexes: [lang_local_index],

   249

    new_hmi_value: function(index, value, oldval) {

   250

        let current_lang =  switch_langnum(value);

   251

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

   252

        apply_hmi_value(langcode_local_index, langcode);

   253

        apply_hmi_value(langname_local_index, langname);

   254

        switch_page();

   255

    }

   256

});

   257

   258

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

   259

function get_current_lang_code(){

   260

    return cache[langcode_local_index];

   261

}

   262

   263

function setup_lang(){

   264

    let current_lang = cache[lang_local_index];

   265

    let new_lang = switch_langnum(current_lang);

   266

    if(current_lang != new_lang){

   267

        apply_hmi_value(lang_local_index, new_lang);

   268

    }

   269

}

   270

   271

setup_lang();

   272

   273

function update_subscriptions() {

   274

    let delta = [];

   275

    for(let index in subscriptions){

   276

        let widgets = subscribers(index);

   277

   278

        // periods are in ms

   279

        let previous_period = get_subscription_period(index);

   280

   281

        // subscribing with a zero period is unsubscribing

   282

        let new_period = 0;

   283

        if(widgets.size > 0) {

   284

            let maxfreq = 0;

   285

            for(let widget of widgets){

   286

                let wf = widget.frequency;

   287

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

   288

                    maxfreq = wf;

   289

            }

   290

   291

            if(maxfreq != 0)

   292

                new_period = 1000/maxfreq;

   293

        }

   294

   295

        if(previous_period != new_period) {

   296

            set_subscription_period(index, new_period);

   297

            if(index <= last_remote_index){

   298

                delta.push(

   299

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

   300

                    new Uint32Array([index]),

   301

                    new Uint16Array([new_period]));

   302

            }

   303

        }

   304

    }

   305

    send_blob(delta);

   306

};

   307

   308

function send_hmi_value(index, value) {

   309

    if(index > last_remote_index){

   310

        updates.set(index, value);

   311

   312

        if(persistent_indexes.has(index)){

   313

            let varname = persistent_indexes.get(index);

   314

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

   315

        }

   316

   317

        requestHMIAnimation();

   318

        return;

   319

    }

   320

   321

    let iectype = hmitree_types[index];

   322

    let tobinary = typedarray_types[iectype];

   323

    send_blob([

   324

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

   325

        new Uint32Array([index]),

   326

        tobinary(value)]);

   327

   328

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

   329

    // cache[index] = value;

   330

};

   331

   332

function apply_hmi_value(index, new_val) {

   333

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

   334

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

   335

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

   336

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

   337

        send_hmi_value(index, new_val);

   338

    return new_val;

   339

}

   340

   341

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

   342

   343

function eval_operation_string(old_val, opstr) {

   344

    let op = opstr[0];

   345

    let given_val;

   346

    if(opstr.length < 2) 

   347

        return undefined;

   348

    if(opstr[1] in quotes){

   349

        if(opstr.length < 3) 

   350

            return undefined;

   351

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

   352

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

   353

        }

   354

    } else {

   355

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

   356

    }

   357

    let new_val;

   358

    switch(op){

   359

      case "=":

   360

        new_val = given_val;

   361

        break;

   362

      case "+":

   363

        new_val = old_val + given_val;

   364

        break;

   365

      case "-":

   366

        new_val = old_val - given_val;

   367

        break;

   368

      case "*":

   369

        new_val = old_val * given_val;

   370

        break;

   371

      case "/":

   372

        new_val = old_val / given_val;

   373

        break;

   374

    }

   375

    return new_val;

   376

}

   377

   378

var current_visible_page;

   379

var current_subscribed_page;

   380

var current_page_index;

   381

var page_node_local_index = hmi_local_index("page_node");

   382

   383

function toggleFullscreen() {

   384

  let elem = document.documentElement;

   385

   386

  if (!document.fullscreenElement) {

   387

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

   388

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

   389

    });

   390

  } else {

   391

    document.exitFullscreen();

   392

  }

   393

}

   394

   395

function prepare_svg() {

   396

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

   397

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

   398

        toggleFullscreen();

   399

        e.preventDefault();

   400

    });

   401

   402

    for(let eltid in detachable_elements){

   403

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

   404

        parent.removeChild(element);

   405

    }

   406

};

   407

   408

function switch_page(page_name, page_index) {

   409

    if(current_subscribed_page != current_visible_page){

   410

        /* page switch already going */

   411

        /* TODO LOG ERROR */

   412

        return false;

   413

    }

   414

   415

    if(page_name == undefined)

   416

        page_name = current_subscribed_page;

   417

    else if(page_index == undefined){

   418

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

   419

    }

   420

   421

    let old_desc = page_desc[current_subscribed_page];

   422

    let new_desc = page_desc[page_name];

   423

   424

    if(new_desc == undefined){

   425

        /* TODO LOG ERROR */

   426

        return false;

   427

    }

   428

   429

    if(page_index == undefined)

   430

        page_index = new_desc.page_index;

   431

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

   432

        let hmitree_node = hmitree_nodes[page_index];

   433

        if(hmitree_node !== undefined){

   434

            let [int_index, hmiclass] = hmitree_node;

   435

            if(hmiclass == new_desc.page_class)

   436

                page_index = int_index;

   437

            else

   438

                page_index = new_desc.page_index;

   439

        } else {

   440

            page_index = new_desc.page_index;

   441

        }

   442

    }

   443

   444

    if(old_desc){

   445

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

   446

    }

   447

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

   448

   449

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

   450

   451

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

   452

   453

    update_subscriptions();

   454

   455

    current_subscribed_page = page_name;

   456

    current_page_index = page_index;

   457

    let page_node;

   458

    if(page_index != undefined){

   459

        page_node = hmitree_paths[page_index];

   460

    }else{

   461

        page_node = "";

   462

    }

   463

    apply_hmi_value(page_node_local_index, page_node);

   464

   465

    jumps_need_update = true;

   466

   467

    requestHMIAnimation();

   468

    jump_history.push([page_name, page_index]);

   469

    if(jump_history.length > 42)

   470

        jump_history.shift();

   471

   472

    apply_hmi_value(current_page_var_index, page_index == undefined

   473

        ? page_name

   474

        : page_name + "@" + hmitree_paths[page_index]);

   475

   476

    return true;

   477

};

   478

   479

function switch_visible_page(page_name) {

   480

   481

    let old_desc = page_desc[current_visible_page];

   482

    let new_desc = page_desc[page_name];

   483

   484

    if(old_desc){