node-red-contrib-uos-nats 0.1.52 → 0.1.53

package/nodes/datahub-input.html

@@ -357,77 +357,399 @@
   <div class="form-row">
     <label for="node-input-connection"><i class="fa fa-cube"></i> u-OS Config</label>
     <input type="text" id="node-input-connection">
-  </div>
-  <div class="form-row">
-    <label><i class="fa fa-id-badge"></i> Provider</label>
-    <div style="display:flex; align-items:center; flex:1; gap:5px;">
-      <select id="datahub-provider-select" style="flex:1;"></select>
-      <button type="button" id="datahub-provider-refresh" class="red-ui-button" title="Refresh Providers"><i class="fa fa-refresh"></i></button>
-      <input type="hidden" id="node-input-providerId">
-      <!-- Manual input fallback kept hidden/removed from flow per user request -->
-      <input type="text" id="datahub-provider-manual" style="display:none;" disabled>
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
     </div>
-  </div>
-  <div class="form-row">
-    <label></label>
-    <div id="datahub-provider-status" class="form-tips" style="display:none;"></div>
-  </div>
-  <div class="form-row" style="margin-bottom:0;">
-    <label for="datahub-input-variables" style="width: auto;"><i class="fa fa-list"></i> Variables</label>
-    <div style="display:inline-block; float:right;">
-        <div class="btn-group" style="margin-right: 5px;">
-            <button type="button" id="datahub-vars-all" class="red-ui-button red-ui-button-small" title="Select All"><i class="fa fa-check-square-o"></i></button>
-            <button type="button" id="datahub-vars-none" class="red-ui-button red-ui-button-small" title="Deselect All"><i class="fa fa-square-o"></i></button>
+    <div class="form-row">
+        <label for="node-input-connection"><i class="fa fa-globe"></i> Config</label>
+        <input type="text" id="node-input-connection">
+    </div>
+    <div class="form-row">
+        <label for="node-input-providerId"><i class="fa fa-server"></i> Provider</label>
+        <div style="display: inline-flex; width: 70%;">
+            <select id="node-input-providerId" style="flex-grow: 1;"></select>
+            <button id="node-input-check-custom-provider" class="red-ui-button" style="margin-left: 5px;">Refresh</button>
         </div>
-        <button type="button" id="datahub-vars-refresh" class="red-ui-button red-ui-button-small" title="Refresh Variables"><i class="fa fa-refresh"></i></button>
     </div>
-  </div>
-  <div class="form-row">
-    <div style="border:1px solid #ccc; border-radius:4px; height:200px; overflow-y:scroll; padding:5px; width:100%; box-sizing:border-box;" id="datahub-variables-container">
-       <!-- Checkboxes will be inserted here -->
-       <div style="color:#aaa; font-style:italic; padding:5px;">Select a provider to load variables...</div>
+    <div class="form-row">
+        <label for="node-input-mode"><i class="fa fa-sliders"></i> Mode</label>
+        <select id="node-input-mode">
+            <option value="auto">Auto-Discovery (Select from List)</option>
+            <option value="manual_single">Manual: Single Variable</option>
+            <option value="manual_multi">Manual: Multi Variable (Table)</option>
+        </select>
+    </div>
+
+    <!-- Mode: Auto-Discovery -->
+    <div id="mode-auto-row" class="mode-row">
+        <div class="form-row" style="margin-bottom: 0px;">
+            <label><i class="fa fa-list"></i> Variables</label>
+            <div style="display: inline-block; width: 70%;">
+                <div style="margin-bottom: 5px;">
+                    <button id="node-input-refresh-vars" class="red-ui-button red-ui-button-small"><i class="fa fa-refresh"></i> Refresh</button>
+                    <button id="node-input-select-all" class="red-ui-button red-ui-button-small" style="margin-left: 5px;">Select All</button>
+                    <button id="node-input-select-none" class="red-ui-button red-ui-button-small" style="margin-left: 5px;">None</button>
+                    <span id="vars-status" style="margin-left: 10px; font-style: italic; color: #888;"></span>
+                </div>
+            </div>
+        </div>
+        <div class="form-row">
+            <input type="hidden" id="node-input-variablesText">
+            <div id="node-input-variables-container" style="border: 1px solid #ccc; border-radius: 4px; height: 250px; overflow-y: scroll; padding: 5px; background: #fff; width: 100%; box-sizing: border-box;">
+                <!-- Checkboxes will be injected here -->
+                <div style="padding: 10px; text-align: center; color: #888;">
+                    Select a Provider to load variables...
+                </div>
+            </div>
+            <div class="form-tips" style="margin-top: 5px;">
+                <i class="fa fa-info-circle"></i> Requires <b>Deploy</b> or active connection.
+            </div>
+        </div>
+    </div>
+
+    <!-- Mode: Manual Single -->
+    <div id="mode-manual-single-row" class="mode-row">
+        <div class="form-row">
+            <label for="node-input-singleName"><i class="fa fa-font"></i> Var Name</label>
+            <input type="text" id="node-input-singleName" placeholder="e.g. digital_nameplate.manufacturer_name">
+        </div>
+        <div class="form-row">
+            <label for="node-input-singleId"><i class="fa fa-hashtag"></i> Var ID</label>
+            <input type="number" id="node-input-singleId" placeholder="e.g. 0">
+        </div>
+        <div class="form-tips">
+            <i class="fa fa-info-circle"></i> <b>Manual Mode:</b> Use this if Auto-Discovery fails (Permissions/403). Enter the internal ID from your system.
+        </div>
+    </div>
+
+    <!-- Mode: Manual Multi -->
+    <div id="mode-manual-multi-row" class="mode-row">
+        <div class="form-row">
+            <label for="node-input-manualVariables-container"><i class="fa fa-table"></i> Mapping</label>
+            <div class="form-row node-input-manualVariables-container-row" style="width: 100%; margin-top: 8px;">
+                <ol id="node-input-manual-def-list"></ol>
+            </div>
+            <!-- Hidden field to store JSON string of definitions -->
+            <input type="hidden" id="node-input-manualVariables" />
+        </div>
+        <div class="form-tips">
+            <i class="fa fa-info-circle"></i> <b>Manual Table:</b> Map strictly "Name -> ID". Only variables listed here will be output.
+        </div>
+    </div>
+
+    <hr>
+    
+    <div class="form-row">
+        <label for="node-input-pollingInterval"><i class="fa fa-clock-o"></i> Poll (ms)</label>
+        <input type="number" id="node-input-pollingInterval" placeholder="0 (Disabled)">
     </div>
-    <input type="hidden" id="node-input-variablesText">
-  </div>
-  <div class="form-row">
-    <label></label>
-    <div id="datahub-variables-status" class="form-tips">Leave empty to listen to every variable.</div>
-  </div>
-  <div class="form-row" style="margin-bottom:0;">
-      <label style="width:auto;"><i class="fa fa-wrench"></i> Manual Definition Map</label>
-      <div style="float:right; font-size:12px; color:#888;">Map Variable Names to IDs manually (if Discovery fails)</div>
-  </div>
-  <div class="form-row node-input-manual-container-row">
-      <ol id="node-input-manual-defs-container"></ol>
-  </div>
-  <input type="hidden" id="node-input-manualVariables">
-  <div class="form-tips"><strong>Tip:</strong> If auto-discovery fails (permissions), enter the Name and ID exactly as configured in the server. See your Python config for reference.</div>
 </script>
 
 <script type="text/html" data-help-name="datahub-input">
-  <p><strong>DataHub Input</strong> subscribes to a provider via the u-OS Data Hub and emits JSON messages.</p>
-  <p><em>Note: This node is developed by <strong>iotueli</strong> and is NOT an official Weidmüller product.</em></p>
-  <dl>
-    <dt>u-OS Config</dt>
-    <dd>Pick the connection node that holds host, port and OAuth credentials.</dd>
-    <dt>Provider ID</dt>
-    <dd>Provider to read. The drop-down lists every provider returned by the Data Hub API.</dd>
-  </dl>
-  <p><strong>Attributes:</strong></p>
-  <dl>
-    <dt>Provider & Variables</dt>
-    <dd>Click the <strong>Refresh</strong> button to load the lists. Use the Input Port (e.g. inject node) to trigger manual snapshots.</dd>
-  </dl>
-  <p><strong>Troubleshooting:</strong></p>
-  <ul>
-      <li><strong>Empty Variable List:</strong> Ensure the Config Node is <strong>DEPLOYED</strong>. The "Test Connection" button only checks basic connectivity, but reading variable schemas requires a running flow.</li>
-      <li><strong>Permission Information:</strong> If you don't see a specific provider, your OAuth Client might lack read permissions for it.</li>
-  </ul>
-  <p>Each message has <code>msg.payload</code> shaped like:</p>
-<pre>{
-  "type": "snapshot" | "change",
-  "variables": [
-    { "name": "diagnostics.status_text", "value": "ready" }
-  ]
-}</pre>
-</script>
+    <p>Reads variables from the u-OS Data Hub (Snapshot or Subscription).</p>
+    
+    <h3>Configuration</h3>
+    <dl class="message-properties">
+        <dt>Mode</dt>
+        <dd>
+            <ul>
+                <li><b>Auto-Discovery:</b> Connects to the hub, downloads the variable list, and lets you select variables via checkboxes. Requires correct permissions (`hub.variables.readonly`).</li>
+                <li><b>Manual (Single):</b> For reading a single variable when Discovery is blocked. Enter Name and ID manually.</li>
+                <li><b>Manual (Multi):</b> For reading multiple variables when Discovery is blocked. Use the table to map Names to IDs.</li>
+            </ul>
+        </dd>
+        
+        <dt>Provider</dt>
+        <dd>The Data Hub Provider ID (e.g. `u_os_sbm`).</dd>
+        
+        <dt>Polling</dt>
+        <dd>Interval in ms to force-read values. 0 = Disabled (Wait for Change Events).</dd>
+    </dl>
+    
+    <h3>Important: Permission Issues / 403</h3>
+    <p>
+        If you see "Empty List" or "Permission Violation", you must use one of the <b>Manual Modes</b>.
+        Auto-Discovery relies on endpoints that are often restricted. 
+        In Manual Mode, you provide the `ID` (Number) which works even without Discovery permissions.
+    </p>
+
+    <div style="margin-top: 10px; font-size: 0.8em; color: #666; border-top: 1px solid #eee; padding-top: 5px;">
+        Developed by <a href="https://github.com/iotueli" target="_blank">iotueli</a>. Not an official Weidmüller product.
+    </div>
+</script>
+
+<script type="text/javascript">
+  RED.nodes.registerType('datahub-input', {
+    category: 'u-OS',
+    color: '#ff9900',
+    defaults: {
+      name: { value: "" },
+      connection: { type: "uos-config", required: true },
+      providerId: { value: "", required: true },
+      variablesText: { value: "" }, // Legacy / Auto-Mode list
+      manualVariables: { value: "" }, // Manual Table JSON/CSV
+      singleName: { value: "" }, // Manual Single Name
+      singleId: { value: "" }, // Manual Single ID
+      mode: { value: "auto" }, // auto | manual_single | manual_multi
+      pollingInterval: { value: 0, validate: RED.validators.number() }
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "datahub-input.svg",
+    label: function () {
+      if (this.name) return this.name;
+      if (this.mode === 'manual_single' && this.singleName) return this.singleName;
+      return "u-OS " + (this.providerId || "Data Hub");
+    },
+    paletteLabel: "u-OS Data Hub",
+    oneditprepare: function () {
+      const node = this;
+
+      // --- 1. Mode Visibility Logic ---
+      const modeSelect = $('#node-input-mode');
+      const autoRow = $('#mode-auto-row');
+      const manualSingleRow = $('#mode-manual-single-row');
+      const manualMultiRow = $('#mode-manual-multi-row');
+
+      // Set default if missing (backward compat)
+      if (!$('#node-input-mode').val()) {
+        $('#node-input-mode').val('auto');
+      }
+
+      const updateVisibility = () => {
+        const mode = modeSelect.val();
+        autoRow.hide();
+        manualSingleRow.hide();
+        manualMultiRow.hide();
+
+        if (mode === 'auto') autoRow.show();
+        else if (mode === 'manual_single') manualSingleRow.show();
+        else if (mode === 'manual_multi') manualMultiRow.show();
+      };
+
+      modeSelect.on('change', updateVisibility);
+      updateVisibility(); // Initial trigger
+
+      // --- 2. Existing "Auto" Logic (Providers & Checkboxes) ---
+      const $config = $('#node-input-connection');
+      const $providerRefresh = $('#node-input-check-custom-provider');
+      const $variables = $('input[type="checkbox"]');
+      const $variablesHidden = $('#node-input-variablesText');
+      const $varsRefresh = $('#node-input-refresh-vars');
+
+      let initialProvider = node.providerId;
+      let providerRequest = 0;
+
+      // Define Helpers (providerValue, providerLabel etc) from original code
+      const providerValue = (p) => p.id || p.providerId || p.name;
+      const providerLabel = (p) => p.name || p.displayName || p.providerId || p.id;
+
+      // --- 3. Existing Loading Logic ---
+      const setProviderStatus = (msg) => { /* No-op or custom div if needed */ };
+      const setProviderValue = (val) => { $('#node-input-providerId').val(val); };
+
+      const setVariableStatus = (msg) => { $('#vars-status').text(msg); };
+
+      const normalizeVariables = (payload) => {
+        if (Array.isArray(payload)) return payload;
+        if (payload && Array.isArray(payload.variables)) return payload.variables;
+        return [];
+      };
+
+      const normalizeProviders = (payload) => {
+        if (Array.isArray(payload)) return payload;
+        if (payload && Array.isArray(payload.providers)) return payload.providers;
+        return [];
+      };
+
+      const variableValue = (v) => v.key || v.name || v.path || v.id;
+      const variableLabel = (v) => v.tagName || v.key || v.name || v.path || v.id;
+
+      const syncVariablesField = () => {
+        const selected = [];
+        varsContainer.find('input[type="checkbox"]:checked').each(function () {
+          selected.push($(this).val());
+        });
+        varsHiddenInput.val(selected.join(','));
+        setVariableStatus(`${selected.length} selected`);
+      };
+
+      const loadVariables = (providerId, force = false) => {
+        const configId = $config.val();
+        if (!configId || !providerId) return;
+
+        setVariableStatus('Loading...');
+        varsContainer.empty().append('<div style="padding:10px; text-align:center; color:#888;"><i class="fa fa-spinner fa-spin"></i> Loading variables...</div>');
+
+        $.getJSON(`uos/providers/${configId}/${providerId}/variables`)
+          .done((payload) => {
+            const list = normalizeVariables(payload);
+            varsContainer.empty();
+            if (!list.length) {
+              varsContainer.append('<div style="padding:10px; text-align:center; color:#888;">No variables found for this provider.</div>');
+              setVariableStatus('No variables found');
+              return;
+            }
+
+            const currentVal = varsHiddenInput.val().split(',');
+            // Sort by name/key
+            list.sort((a, b) => (variableLabel(a) || '').localeCompare(variableLabel(b) || ''));
+
+            list.forEach((v) => {
+              const val = variableValue(v);
+              const lbl = variableLabel(v);
+              const checked = currentVal.includes(val) ? 'checked' : '';
+              const row = $('<div/>').appendTo(varsContainer);
+              $('<label/>').css({ display: 'block', cursor: 'pointer' })
+                .append($('<input type="checkbox"/>').val(val).prop('checked', !!checked).on('change', syncVariablesField))
+                .append($('<span/>').text(' ' + lbl))
+                .appendTo(row);
+            });
+            syncVariablesField();
+          })
+          .fail((xhr) => {
+            const error = xhr?.responseJSON?.error;
+            let msg = error || xhr.statusText || 'Failed to load variables.';
+            if (xhr.status === 404 && error === 'config not found') {
+              msg = 'Config not deployed yet. Please Deploy first.';
+            }
+            varsContainer.empty().append(`<div style="padding:10px; color:#d66;">${msg}</div>`);
+            setVariableStatus('Error loading variables');
+          });
+      };
+
+      const populateProviders = (payload) => {
+        const list = normalizeProviders(payload);
+        providerSelect.empty();
+        if (!list.length) {
+          providerSelect.append('<option value="">No providers found</option>').prop('disabled', true);
+          return;
+        }
+        let foundInitial = false;
+        list.forEach((prov) => {
+          const val = providerValue(prov);
+          if (!val) return;
+          const opt = $('<option/>').val(val).text(providerLabel(prov));
+          providerSelect.append(opt);
+          if (val === initialProvider) foundInitial = true;
+        });
+        providerSelect.prop('disabled', false);
+
+        if (initialProvider && foundInitial) {
+          providerSelect.val(initialProvider);
+        } else if (initialProvider) {
+          // Preserve unknown provider (e.g. from manual entry or offline)
+          providerSelect.append($('<option/>').val(initialProvider).text(initialProvider + ' (unknown)'));
+          providerSelect.val(initialProvider);
+        }
+
+        if (!providerSelect.val()) {
+          providerSelect.val(providerSelect.find('option:first').val());
+        }
+
+        // Trigger variable load for selected
+        const selected = providerSelect.val();
+        if (selected) loadVariables(selected);
+      };
+
+      const loadProviders = (force = false) => {
+        const configId = $config.val();
+        if (!configId) {
+          providerSelect.empty().append('<option value="">Select Config Node first</option>').prop('disabled', true);
+          return;
+        }
+
+        const seq = ++providerRequest;
+        // Cache logic omitted for brevity/safety - simplified direct load
+        providerSelect.prop('disabled', true);
+
+        $.getJSON(`uos/providers/${configId}`)
+          .done((payload) => {
+            if (seq !== providerRequest) return;
+            populateProviders(payload);
+          })
+          .fail((xhr) => {
+            const error = xhr?.responseJSON?.error;
+            const msg = error || 'Failed to load providers';
+            providerSelect.empty().append('<option value="">Error loading providers</option>').prop('disabled', true);
+          });
+      };
+
+      // Event Listeners
+      providerSelect.on('change', () => {
+        const val = providerSelect.val();
+        varsHiddenInput.val('');
+        syncVariablesField();
+        loadVariables(val);
+      });
+
+      $providerRefresh.on('click', () => loadProviders(true));
+      $varsRefresh.on('click', () => {
+        const v = providerSelect.val();
+        if (v) loadVariables(v, true);
+      });
+
+      $('#node-input-select-all').on('click', () => {
+        varsContainer.find('input[type="checkbox"]').prop('checked', true).trigger('change');
+      });
+      $('#node-input-select-none').on('click', () => {
+        varsContainer.find('input[type="checkbox"]').prop('checked', false).trigger('change');
+      });
+
+      $config.on('change', () => {
+        setTimeout(() => loadProviders(false), 50);
+      });
+
+      // Initial Load
+      setTimeout(() => loadProviders(false), 100);
+
+
+      // --- 4. Manual Table Logic ---
+      const $manualList = $('#node-input-manual-def-list');
+      const $manualHidden = $('#node-input-manualVariables');
+
+      $manualList.editableList({
+        addItem: function (row, index, data) {
+          row.css({ display: 'flex', alignItems: 'center', gap: '5px' });
+
+          $('<input/>', { class: 'node-input-manual-name', type: 'text', placeholder: 'Name', style: 'flex:1;' })
+            .val(data.name || '')
+            .appendTo(row);
+
+          $('<input/>', { class: 'node-input-manual-id', type: 'number', placeholder: 'ID', style: 'width:80px;' })
+            .val(data.id || '')
+            .appendTo(row);
+        },
+        removable: true,
+        header: $('<div></div>').append(
+          $.parseHTML('<div style="display:flex; gap:5px; padding-left:5px;"><div style="flex:1;">Name (String)</div><div style="width:80px;">ID (Int)</div></div>')
+        ),
+        addButton: 'Add Mapping'
+      });
+
+      // Populate Table
+      const currentManual = $manualHidden.val() || '';
+      if (currentManual) {
+        currentManual.split(',').forEach(entry => {
+          const parts = entry.split(':');
+          if (parts.length === 2) {
+            const n = parts[0].trim();
+            const i = parts[1].trim();
+            if (n && i) $manualList.editableList('addItem', { name: n, id: i });
+          }
+        });
+      }
+
+    },
+    oneditsave: function () {
+      const $manualList = $('#node-input-manual-def-list');
+      const items = [];
+      $manualList.editableList('items').each(function () {
+        const name = $(this).find('.node-input-manual-name').val().trim();
+        const id = $(this).find('.node-input-manual-id').val().trim();
+        if (name && id) {
+          items.push(`${name}:${id}`);
+        }
+      });
+      $('#node-input-manualVariables').val(items.join(','));
+    }

package/nodes/datahub-input.js

@@ -27,30 +27,53 @@ module.exports = function (RED) {
     }
 
     this.providerId = config.providerId || 'sampleprovider';
-    this.pollingInterval = parseInt(config.pollingInterval, 10) || 0; // ms, 0 = disabled (default)
+    this.providerId = config.providerId || 'sampleprovider';
+    this.pollingInterval = parseInt(config.pollingInterval, 10) || 0; // ms
+    this.mode = config.mode || 'auto';
+
     const text = config.variablesText || '';
     const manualText = config.manualVariables || '';
+    const singleName = config.singleName || '';
+    const singleId = config.singleId || '';
 
-    // Parse variables: Standard list of names to filter
-    this.variables = text
-      .split(',')
-      .map((entry) => (entry ? String(entry).trim() : ''))
-      .filter((entry) => entry.length > 0);
-
-    // Parse Manual Definitions "Name:ID"
+    // Initialize containers
+    this.variables = [];
     this.manualDefs = [];
-    if (manualText) {
-      manualText.split(',').forEach(entry => {
-        let trimmed = entry ? String(entry).trim() : '';
-        if (trimmed.includes(':')) {
-          const parts = trimmed.split(':');
-          const name = parts[0].trim();
-          const id = parseInt(parts[1].trim(), 10);
-          if (name && !isNaN(id)) {
-            this.manualDefs.push({ id, key: name });
-          }
+
+    // --- Mode-Based Initialization ---
+    if (this.mode === 'manual_single') {
+      // Mode: Manual Single
+      // Strictly use Single Name/ID. Ignore others.
+      if (singleName && singleId !== '') {
+        const id = parseInt(singleId, 10);
+        if (!isNaN(id)) {
+          this.manualDefs.push({ id, key: String(singleName).trim() });
         }
-      });
+      }
+    }
+    else if (this.mode === 'manual_multi') {
+      // Mode: Manual Multi (Table)
+      if (manualText) {
+        manualText.split(',').forEach(entry => {
+          let trimmed = entry ? String(entry).trim() : '';
+          if (trimmed.includes(':')) {
+            const parts = trimmed.split(':');
+            const name = parts[0].trim();
+            const id = parseInt(parts[1].trim(), 10);
+            if (name && !isNaN(id)) {
+              this.manualDefs.push({ id, key: name });
+            }
+          }
+        });
+      }
+    }
+    else {
+      // Mode: Auto (Default)
+      // Use the standard checkbox list
+      this.variables = text
+        .split(',')
+        .map((entry) => (entry ? String(entry).trim() : ''))
+        .filter((entry) => entry.length > 0);
     }
 
     let nc;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-uos-nats",
-  "version": "0.1.52",
+  "version": "0.1.53",
   "description": "Node-RED nodes for u-OS Data Hub via NATS",
   "repository": {
     "type": "git",