measurement/measurement.html

<!--
| S88-niveau             | Primair (blokkleur) | Tekstkleur |
| ---------------------- | ------------------- | ---------- |
| **Area**               | `#0f52a5`           | wit        |
| **Process Cell**       | `#0c99d9`           | wit        |
| **Unit**               | `#50a8d9`           | zwart      |
| **Equipment (Module)** | `#86bbdd`           | zwart      |
| **Control Module**     | `#a9daee`           | zwart      |

-->
<script src="/measurement/menu.js"></script> <!-- Load the menu script for dynamic dropdowns --> 
<script src="/measurement/configData.js"></script> <!-- Load the config script for node information --> 

<script>
  RED.nodes.registerType("measurement", {
    category: "EVOLV",
    color: "#a9daee", // color for the node based on the S88 schema
    defaults: {

      // Define default properties
      name: { value: "" }, // use asset category as name

      // Input mode: 'analog' (scalar payload, default) or 'digital' (object payload, many channels)
      mode: { value: "analog" },
      channels: { value: "[]" },

      // Define specific properties (analog-mode pipeline defaults)
      scaling: { value: false },
      i_min: { value: 0, required: true },
      i_max: { value: 0, required: true },
      i_offset: { value: 0 },
      o_min: { value: 0, required: true },
      o_max: { value: 1, required: true },
      simulator: { value: false },
      smooth_method: { value: "" },
      count: { value: "10", required: true },
      stabilityThreshold: { value: 0.01 },
      processOutputFormat: { value: "process" },
      dbaseOutputFormat: { value: "influxdb" },

      //define asset properties
      uuid: { value: "" },
      supplier: { value: "" },
      category: { value: "" },
      assetType: { value: "" },
      model: { value: "" },
      unit: { value: "" },
      assetTagNumber: { value: "" },

      //logger properties
      enableLog: { value: false },
      logLevel: { value: "error" },

      //physicalAspect
      positionVsParent: { value: "" },
      positionIcon: { value: "" },
      hasDistance: { value: false },
      distance: { value: 0 },
      distanceUnit: { value: "m" },
      distanceDescription: { value: "" }

    },

    inputs: 1,
    outputs: 3,
    inputLabels: ["Input"],
    outputLabels: ["process", "dbase", "parent"],
    icon: "font-awesome/fa-sliders",

    label: function () {
      const modeTag = this.mode === 'digital' ? ' [digital]' : '';
      return (this.positionIcon || "") + " " + (this.assetType || "Measurement") + modeTag;
    },
    
    oneditprepare: function() {
        const node = this;

        // === Asset / logger / position placeholders (dynamic menus) ===
        // Kick these off FIRST so that any error in the downstream mode
        // logic can never block the shared menus. Historical regression:
        // a ReferenceError in the mode block aborted oneditprepare and
        // stopped the asset menu from rendering at all.
        const waitForMenuData = () => {
            if (window.EVOLV?.nodes?.measurement?.initEditor) {
                window.EVOLV.nodes.measurement.initEditor(node);
            } else {
                setTimeout(waitForMenuData, 50);
            }
        };
        waitForMenuData();

        // IMPORTANT: all DOM references are resolved up front so helper
        // functions called during initial applyMode() don't trip over the
        // Temporal Dead Zone on later `const` declarations.

        const modeSelect   = document.getElementById('node-input-mode');
        const analogBlock  = document.getElementById('analog-only-fields');
        const digitalBlock = document.getElementById('digital-only-fields');
        const modeHint     = document.getElementById('mode-hint');
        const channelsArea = document.getElementById('node-input-channels');
        const channelsHint = document.getElementById('channels-validation');

        // Initialise the mode <select> from the saved node.mode. Legacy
        // nodes (saved before the mode field existed) fall back to
        // 'analog' so they keep behaving exactly like before.
        const initialMode = (node.mode === 'digital' || node.mode === 'analog') ? node.mode : 'analog';
        if (modeSelect) modeSelect.value = initialMode;

        // Populate the channels textarea from the saved node.channels
        // (stored as a raw JSON string; parsing happens server-side).
        if (channelsArea && typeof node.channels === 'string') {
            channelsArea.value = node.channels;
        }

        function validateChannelsJson() {
            if (!channelsHint) return;
            if (!modeSelect || modeSelect.value !== 'digital') {
                channelsHint.textContent = '';
                return;
            }
            const raw = (channelsArea && channelsArea.value || '').trim();
            if (!raw || raw === '[]') {
                channelsHint.innerHTML = '<span style="color:#b45309;">Digital mode with no channels — no measurements will be emitted.</span>';
                return;
            }
            try {
                const parsed = JSON.parse(raw);
                if (!Array.isArray(parsed)) throw new Error('must be an array');
                const missing = parsed
                    .map((c, i) => (c && c.key && c.type ? null : 'entry ' + i + ': missing key or type'))
                    .filter(Boolean);
                if (missing.length) {
                    channelsHint.innerHTML = '<span style="color:#b45309;">' + missing.join('; ') + '</span>';
                } else {
                    channelsHint.innerHTML = '<span style="color:#047857;">' + parsed.length + ' channel(s) defined: ' + parsed.map((c) => c.key).join(', ') + '</span>';
                }
            } catch (e) {
                channelsHint.innerHTML = '<span style="color:#b91c1c;">Invalid JSON: ' + e.message + '</span>';
            }
        }

        function applyMode(mode) {
            const isDigital = mode === 'digital';
            if (analogBlock)  analogBlock.style.display  = isDigital ? 'none' : 'block';
            if (digitalBlock) digitalBlock.style.display = isDigital ? 'block' : 'none';
            if (modeHint) {
                modeHint.textContent = isDigital
                    ? 'msg.payload must be an OBJECT, e.g. {"temperature": 22.5, "humidity": 45}. Define each key below.'
                    : 'msg.payload must be a NUMBER (or numeric string). Configure scaling/smoothing below.';
            }
            validateChannelsJson();
        }

        if (modeSelect) modeSelect.addEventListener('change', (e) => applyMode(e.target.value));
        if (channelsArea) channelsArea.addEventListener('input', validateChannelsJson);
        try { applyMode(initialMode); } catch (e) {
            console.error('measurement: applyMode failed', e);
        }

        // === Smoothing method dropdown (analog only) ===
        const smoothMethodSelect = document.getElementById('node-input-smooth_method');
        const options = window.EVOLV?.nodes?.measurement?.config?.smoothing?.smoothMethod?.rules?.values || [];
        smoothMethodSelect.innerHTML = '';
        const emptyOption = document.createElement('option');
        emptyOption.value = '';
        emptyOption.textContent = 'Select method...';
        smoothMethodSelect.appendChild(emptyOption);
        options.forEach(option => {
            const optionElement = document.createElement('option');
            optionElement.value = option.value;
            optionElement.textContent = option.value;
            optionElement.title = option.description;
            smoothMethodSelect.appendChild(optionElement);
        });
        if (node.smooth_method) smoothMethodSelect.value = node.smooth_method;

        // === Scale rows toggle (analog only) ===
        const chk = document.getElementById('node-input-scaling');
        const rowMin = document.getElementById('row-input-i_min');
        const rowMax = document.getElementById('row-input-i_max');
        function toggleScalingRows() {
            const show = chk.checked;
            rowMin.style.display = show ? 'block' : 'none';
            rowMax.style.display = show ? 'block' : 'none';
        }
        chk.addEventListener('change', toggleScalingRows);
        toggleScalingRows();

        //------------------- END OF CUSTOM config UI ELEMENTS ------------------- //
    },
    oneditsave: function () {
      const node = this;

      // Validate asset properties using the asset menu
      if (window.EVOLV?.nodes?.measurement?.assetMenu?.saveEditor) {
        success = window.EVOLV.nodes.measurement.assetMenu.saveEditor(this);
      }

      // Validate logger properties using the logger menu
      if (window.EVOLV?.nodes?.measurement?.loggerMenu?.saveEditor) {
        success = window.EVOLV.nodes.measurement.loggerMenu.saveEditor(node);
      }

      // save position field
      if (window.EVOLV?.nodes?.measurement?.positionMenu?.saveEditor) {
        window.EVOLV.nodes.measurement.positionMenu.saveEditor(this);
      }

      // Mode is the top-level switch. Always save it first; its value
      // drives which other fields are meaningful.
      node.mode = document.getElementById('node-input-mode').value || 'analog';

      // Channels JSON (digital). We store the raw string and let the
      // server-side nodeClass.js parse it so we can surface parse errors
      // at deploy time instead of silently dropping bad config.
      node.channels = document.getElementById('node-input-channels').value || '[]';

      // Analog smoothing method.
      node.smooth_method = document.getElementById('node-input-smooth_method').value || '';

      // Save checkbox properties (always safe to read regardless of mode;
      // these elements exist in the DOM even when their section is hidden).
      ["scaling", "simulator"].forEach(
        (field) => (node[field] = document.getElementById(`node-input-${field}`).checked)
      );

      ["i_min", "i_max", "i_offset", "o_min", "o_max", "count"].forEach(
        (field) => (node[field] = parseFloat(document.getElementById(`node-input-${field}`).value) || 0)
      );

      // Calibration stability threshold: 0 is a valid (very strict) value, so
      // fall back to the default 0.01 only when the field is empty / NaN.
      const stRaw = document.getElementById('node-input-stabilityThreshold').value;
      const stParsed = parseFloat(stRaw);
      node.stabilityThreshold = Number.isFinite(stParsed) ? stParsed : 0.01;

      // Mode-dependent validation. In digital mode we don't care about
      // scaling completeness (the channels have their own per-channel
      // scaling); in analog mode we still warn about half-filled ranges.
      if (node.mode === 'analog' && node.scaling && (isNaN(node.i_min) || isNaN(node.i_max))) {
        RED.notify("Scaling enabled, but input range is incomplete!", "error");
      }
      if (node.mode === 'digital') {
        try {
          const parsed = JSON.parse(node.channels || '[]');
          if (!Array.isArray(parsed) || parsed.length === 0) {
            RED.notify("Digital mode: no channels defined. The node will emit nothing.", "warning");
          }
        } catch (e) {
          RED.notify("Digital mode: Channels JSON is invalid (" + e.message + ")", "error");
        }
      }
    },
  });
</script>

<!-- Main UI -->

<script type="text/html" data-template-name="measurement">

  <!-- Input mode -->
  <div class="form-row">
    <label for="node-input-mode"><i class="fa fa-exchange"></i> Input Mode</label>
    <select id="node-input-mode" style="width:60%;">
      <option value="analog">analog — one scalar per msg.payload (classic PLC)</option>
      <option value="digital">digital — object payload with many channel keys (MQTT/IoT)</option>
    </select>
  </div>
  <div class="form-row" id="mode-hint" style="margin-left:105px; font-size:12px; color:#666;"></div>

  <!-- ===================== DIGITAL MODE FIELDS ===================== -->
  <div id="digital-only-fields">
    <div class="form-row" id="row-input-channels">
      <label for="node-input-channels"><i class="fa fa-list"></i> Channels (JSON)</label>
      <textarea id="node-input-channels" rows="6" style="width:60%; font-family:monospace;" placeholder='[{"key":"temperature","type":"temperature","position":"atEquipment","unit":"C","scaling":{"enabled":false,"inputMin":0,"inputMax":1,"absMin":-50,"absMax":150,"offset":0},"smoothing":{"smoothWindow":5,"smoothMethod":"mean"}}]'></textarea>
      <div class="form-tips">One entry per payload key. Each channel has its own type / position / unit / scaling / smoothing / outlier detection. See README for the full schema.</div>
    </div>
    <div class="form-row" id="channels-validation" style="margin-left:105px; font-size:12px;"></div>
  </div>

  <!-- ===================== ANALOG MODE FIELDS ===================== -->
  <div id="analog-only-fields">
    <hr>
    <!-- Scaling Checkbox -->
    <div class="form-row">
      <label for="node-input-scaling"
        ><i class="fa fa-compress"></i> Scaling</label>
      <input type="checkbox" id="node-input-scaling" style="width:20px; vertical-align:baseline;"/>
      <span>Enable input scaling?</span>
    </div>

    <!-- Source Min/Max (only if scaling is true) -->
    <div class="form-row" id="row-input-i_min">
      <label for="node-input-i_min"><i class="fa fa-arrow-down"></i> Source Min</label>
      <input type="number" id="node-input-i_min" placeholder="0" />
    </div>

    <div class="form-row" id="row-input-i_max">
      <label for="node-input-i_max"><i class="fa fa-arrow-up"></i> Source Max</label>
      <input type="number" id="node-input-i_max" placeholder="3000" />
    </div>

    <!-- Offset -->
    <div class="form-row">
      <label for="node-input-i_offset"><i class="fa fa-adjust"></i> Input Offset</label>
      <input type="number" id="node-input-i_offset" placeholder="0" />
    </div>

    <!-- Output / Process Min/Max -->
    <div class="form-row">
      <label for="node-input-o_min"><i class="fa fa-tag"></i> Process Min</label>
      <input type="number" id="node-input-o_min" placeholder="0" />
    </div>
    <div class="form-row">
      <label for="node-input-o_max"><i class="fa fa-tag"></i> Process Max</label>
      <input type="number" id="node-input-o_max" placeholder="1" />
    </div>

    <!-- Simulator Checkbox -->
    <div class="form-row">
      <label for="node-input-simulator"><i class="fa fa-cog"></i> Simulator</label>
      <input type="checkbox" id="node-input-simulator" style="width:20px; vertical-align:baseline;"/>
      <span>Activate internal simulation?</span>
    </div>

    <!-- Smoothing Method -->
    <div class="form-row">
      <label for="node-input-smooth_method"><i class="fa fa-line-chart"></i> Smoothing</label>
      <select id="node-input-smooth_method" style="width:60%;">
      </select>
    </div>

    <!-- Smoothing Window -->
    <div class="form-row">
      <label for="node-input-count">Window</label>
      <input type="number" id="node-input-count" placeholder="10" style="width:60px;"/>
      <div class="form-tips">Number of samples for smoothing</div>
    </div>

    <!-- Calibration Stability Threshold -->
    <div class="form-row">
      <label for="node-input-stabilityThreshold"><i class="fa fa-balance-scale"></i> Stability Threshold</label>
      <input type="number" id="node-input-stabilityThreshold" placeholder="0.01" step="any" style="width:100px;"/>
      <span style="margin-left:6px; color:#666;">(scaling-units)</span>
      <div class="form-tips">Maximum stdDev of the rolling window for calibrate() and evaluateRepeatability() to accept the buffer as stable. Default 0.01.</div>
    </div>
  </div>

  <hr>
  <h3>Output Formats</h3>
  <div class="form-row">
    <label for="node-input-processOutputFormat"><i class="fa fa-random"></i> Process Output</label>
    <select id="node-input-processOutputFormat" style="width:60%;">
      <option value="process">process</option>
      <option value="json">json</option>
      <option value="csv">csv</option>
    </select>
  </div>
  <div class="form-row">
    <label for="node-input-dbaseOutputFormat"><i class="fa fa-database"></i> Database Output</label>
    <select id="node-input-dbaseOutputFormat" style="width:60%;">
      <option value="influxdb">influxdb</option>
      <option value="json">json</option>
      <option value="csv">csv</option>
    </select>
  </div>

  <!-- Optional Extended Fields: supplier, cat, type, model, unit -->
  <!-- Asset fields will be injected here -->
  <div id="asset-fields-placeholder"></div>

  <!-- loglevel checkbox -->
  <div id="logger-fields-placeholder"></div>

  <!-- Position fields will be injected here -->
  <div id="position-fields-placeholder"></div>

</script>


<script type="text/html" data-help-name="measurement">
  <p><b>Measurement</b>: signal conditioning for a sensor or a bundle of sensors. Runs offset → scaling → smoothing → outlier filtering on each incoming value and publishes into the shared <code>MeasurementContainer</code>.</p>

  <h3>Input modes</h3>
  <ul>
    <li><b>analog</b> (default) — <code>msg.payload</code> is a single number (PLC / 4-20 mA style). One pipeline, one output measurement.</li>
    <li><b>digital</b> — <code>msg.payload</code> is an object with many keys (MQTT / JSON IoT). Each key maps to its own <i>channel</i> with independent scaling, smoothing, outlier detection, type, position, unit. One message → N measurements.</li>
  </ul>

  <h3>Topics (<code>msg.topic</code>)</h3>
  <ul>
    <li><code>measurement</code> — main input. analog: number; digital: object keyed by channel names.</li>
    <li><code>simulator</code> — toggle the internal random-walk source.</li>
    <li><code>outlierDetection</code> — toggle the outlier filter.</li>
    <li><code>calibrate</code> — set offset so current output matches <code>Source Min</code> (scaling on) / <code>Process Min</code> (scaling off). Requires a stable window.</li>
  </ul>

  <h3>Output ports</h3>
  <ol>
    <li><b>process</b> — delta-compressed payload. analog: <code>{mAbs, mPercent, totalMinValue, totalMaxValue, totalMinSmooth, totalMaxSmooth}</code>. digital: <code>{channels: { key: {...} }}</code>.</li>
    <li><b>dbase</b> — InfluxDB line-protocol telemetry.</li>
    <li><b>parent</b> — <code>registerChild</code> handshake for the parent equipment node.</li>
  </ol>

  <h3>Analog configuration</h3>
  <ul>
    <li><b>Scaling</b>: enables linear interpolation from <code>[Source Min, Source Max]</code> to <code>[Process Min, Process Max]</code>.</li>
    <li><b>Input Offset</b>: additive bias applied before scaling.</li>
    <li><b>Smoothing</b>: <code>none</code> | <code>mean</code> | <code>min</code> | <code>max</code> | <code>sd</code> | <code>lowPass</code> | <code>highPass</code> | <code>weightedMovingAverage</code> | <code>bandPass</code> | <code>median</code> | <code>kalman</code> | <code>savitzkyGolay</code>.</li>
    <li><b>Window</b>: sample count for the smoothing window.</li>
    <li><b>Outlier detection</b> (via <code>outlierDetection</code> topic toggle): <code>zScore</code>, <code>iqr</code>, <code>modifiedZScore</code>.</li>
  </ul>

  <h3>Digital configuration</h3>
  <p>Populate the <b>Channels (JSON)</b> field with an array. Each entry:</p>
  <pre>{
  "key":      "temperature",
  "type":     "temperature",
  "position": "atEquipment",
  "unit":     "C",
  "scaling":  { "enabled": false, "inputMin": 0, "inputMax": 1, "absMin": -50, "absMax": 150, "offset": 0 },
  "smoothing": { "smoothWindow": 5, "smoothMethod": "mean" },
  "outlierDetection": { "enabled": true, "method": "zScore", "threshold": 3 }
}</pre>
  <p><code>scaling</code>, <code>smoothing</code>, <code>outlierDetection</code> are optional — missing sections fall back to the analog-mode fields above.</p>
  <p>Unknown <code>type</code> values (anything not in <code>pressure/flow/power/temperature/volume/length/mass/energy</code>) are accepted without unit compatibility checks, so user-defined channels like <code>humidity</code>, <code>co2</code>, <code>voc</code> work out of the box.</p>
</script>