node-red-contrib-uos-nats 0.1.1 → 0.1.3

package/README.md

@@ -1,27 +1,25 @@
 # node-red-contrib-uos-nats
 
-**Note:** This custom Node-RED package is built and maintained by [IoTUeli](https://www.iotueli.ch) and is **not** an official Weidmüller product. For questions, feature requests, or support please contact IoTUeli directly.
+**Note:** This custom Node-RED package is built and maintained by [IoTUeli](https://www.linkedin.com/in/iotueli/) and is **not** an official Weidmüller product. For questions, feature requests, or support please contact IoTUeli directly. Repository: <https://github.com/uiff/nats-NodeRed-Node-uc20>
 
 Node-RED nodes to read and write u-OS Data Hub variables via NATS. This package exposes three building blocks:
 
 1. **u-OS Config** – stores host, OAuth client credentials and manages the shared NATS connection.
-2. **DataHub Input** – subscribes to an existing provider, lets you pick individual variables and emits JSON messages.
+2. **DataHub Input** – subscribes to an existing provider and emits JSON messages. Enter the provider ID and optional comma-separated variable names.
 3. **DataHub Output** – automatically registers a provider (default `nodered`), flattens incoming JSON structures and publishes them to the Data Hub.
 
 The nodes reuse the FlatBuffer helpers from the standalone Node sample, so they speak the native NATS API.
 
 ## Installation
 
+### From npm (recommended)
 ```bash
-cd ~/App/NATS-NodeRED
-npm install
+cd ~/.node-red
+npm install node-red-contrib-uos-nats
 ```
-
-Then install the nodes into your Node-RED user directory (e.g. `~/.node-red`):
-
+### From local folder (if you want to test before publishing)
 ```bash
-cd ~/.node-red
-npm install ~/App/NATS-NodeRED
+npm install /path/to/local/NATS-NodeRED
 ```
 
 Restart Node-RED. You will find the nodes under the *u-OS Data Hub* category.
@@ -40,8 +38,8 @@ The config node automatically fetches tokens via Client Credentials flow and exp
 
 ## DataHub Input Node
 
-- Select the u-OS config node and pick a provider from the drop-down. The node queries `/datahub/v1/providers` and lists all registry entries.
-- Choose whether you want **all variables**, **single variable**, or **multi selection**. The variable selector is populated from `/datahub/v1/providers/<provider>/variables`.
+- Select the u-OS config node and enter the provider ID (e.g. `u_os_adm`).
+- Optionally provide a comma-separated list of variable keys (leave empty to receive all).
 - The node outputs messages with the structure:
   ```json
   {
@@ -70,7 +68,7 @@ The config node automatically fetches tokens via Client Credentials flow and exp
 ## Example Flow
 
 1. Drop a **u-OS Config** node, fill in host/port and OAuth credentials from the Control Center.
-2. Add a **DataHub Input** node, select the config, pick an existing provider (e.g. `u_os_adm`) and choose the variables you want to observe. Connect the output to a Debug node.
+2. Add a **DataHub Input** node, select the config, enter the provider ID and optional comma-separated variable list. Connect the output to a Debug node.
 3. Add a **DataHub Output** node, leave provider ID = `nodered` and send structured JSON (e.g. from a Function node). The values instantly appear in the Data Hub under the provider `nodered`.
 
 > Tip: Because both nodes rely on the Control Center HTTP API for metadata they inherit the same permissions as your OAuth client. Make sure the client has at least `hub.variables.readonly` for the input node and `hub.variables.provide hub.variables.readwrite` for the output node.

package/nodes/datahub-input.html

@@ -1,131 +1,37 @@
 <script type="text/javascript">
-(function() {
-  function fetchProviders(configId) {
-    if (!configId) return Promise.resolve([]);
-    return $.getJSON(`uos/providers/${configId}`);
-  }
-  function fetchVariables(configId, providerId) {
-    if (!configId || !providerId) return Promise.resolve([]);
-    return $.getJSON(`uos/providers/${configId}/${providerId}/variables`);
-  }
-
   RED.nodes.registerType('datahub-input', {
-    category: 'input',
+    category: 'DataHub-NATS',
     color: '#ff9f43',
     defaults: {
       name: { value: '' },
       connection: { type: 'uos-config', required: true },
-      providerId: { value: '', required: true },
-      variableMode: { value: 'all' },
-      variables: { value: '[]' }
+      providerId: { value: 'sampleprovider', required: true },
+      variablesText: { value: '' }
     },
     inputs: 0,
     outputs: 1,
-    icon: 'white/datahub-input.svg',
-    label: function() {
-      return this.name || `DataHub Input ${this.providerId || ''}`;
-    },
-    labelStyle: function() {
-      return this.name ? 'node_label_italic' : '';
-    },
+    icon: "white/datahub-input.svg",
     oneditprepare: function() {
-      const providerField = $('#node-input-providerId');
-      const modeField = $('#node-input-variableMode');
-      const singleField = $('#node-input-variableSingle');
-      const multiField = $('#node-input-variableMulti');
-      const multiContainer = $('#node-input-variableMulti-container');
-      const singleContainer = $('#node-input-variableSingle-container');
-      const configField = $('#node-input-connection');
-      let cachedVariables = [];
-
-      function applyMode() {
-        const mode = modeField.val();
-        if (mode === 'single') {
-          singleContainer.show();
-          multiContainer.hide();
-        } else if (mode === 'multi') {
-          singleContainer.hide();
-          multiContainer.show();
-        } else {
-          singleContainer.hide();
-          multiContainer.hide();
-        }
-      }
-
-      function populateVariables(list) {
-        cachedVariables = list;
-        singleField.empty();
-        multiField.empty();
-        list.forEach(v => {
-          $('<option>').val(v.key).text(v.key).appendTo(singleField);
-          $('<option>').val(v.key).text(v.key).appendTo(multiField);
-        });
-        const stored = [];
-        try { stored.push(...JSON.parse($('#node-input-variables').val() || '[]')); } catch(e) {}
-        if (stored.length) {
-          singleField.val(stored[0] || '');
-          multiField.val(stored);
-        }
-      }
-
-      function loadVariables() {
-        const cfg = configField.val();
-        const provider = providerField.val();
-        if (!cfg || !provider) {
-          populateVariables([]);
-          return;
-        }
-        fetchVariables(cfg, provider).then((vars) => {
-          const normalized = (vars || []).map(v => ({ key: v.key || v.id }));
-          populateVariables(normalized);
-        }).catch(() => populateVariables([]));
-      }
-
-      function loadProviders() {
-        const node = this;
-        const cfg = configField.val();
-        providerField.empty();
-        if (!cfg) {
-          providerField.append('<option value="">-- select config first --</option>');
-          return;
-        }
-        fetchProviders(cfg).then((providers) => {
-          providerField.append('<option value="">-- choose provider --</option>');
-          (providers || []).forEach((p) => {
-            $('<option>').val(p.id).text(p.id).appendTo(providerField);
-          });
-          if (node.providerId) {
-            providerField.val(node.providerId);
-          }
-          loadVariables();
-        }).catch(() => {
-          providerField.append('<option value="">(error loading providers)</option>');
-        });
-      }
-
-      modeField.on('change', applyMode);
-      providerField.on('change', loadVariables);
-      configField.on('change', loadProviders.bind(this));
-
-      applyMode();
-      loadProviders.call(this);
+      const help = `
+      <b>DataHub Input node</b><br>
+      <ul>
+        <li><b>u-OS Config</b>: choose the config node with host and OAuth credentials.</li>
+        <li><b>Provider ID</b>: e.g. <code>sampleprovider</code> or <code>u_os_adm</code>.</li>
+        <li><b>Variables</b>: leave empty for all variables or enter comma-separated keys like <code>diagnostics.status_text,diagnostics.error_count</code>.</li>
+      </ul>
+      The node outputs messages of the form <code>{ type: 'snapshot'|'change', variables: [...] }</code>.
+      `;
+      $('#datahub-input-help').html(help);
+    },
+    label: function () {
+      return this.name || `Input ${this.providerId || ''}`;
     },
-    oneditsave: function() {
-      const mode = $('#node-input-variableMode').val();
-      let selected = [];
-      if (mode === 'single') {
-        const val = $('#node-input-variableSingle').val();
-        if (val) selected = [val];
-      } else if (mode === 'multi') {
-        selected = $('#node-input-variableMulti').val() || [];
-      }
-      $('#node-input-variables').val(JSON.stringify(selected));
+    labelStyle: function () {
+      return this.name ? 'node_label_italic' : '';
     }
   });
-})();
 </script>
 
-<input type="hidden" id="node-input-variables">
 <div class="form-row">
   <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
   <input type="text" id="node-input-name">
@@ -135,23 +41,11 @@
   <input type="text" id="node-input-connection">
 </div>
 <div class="form-row">
-  <label for="node-input-providerId"><i class="fa fa-list"></i> Provider</label>
-  <select id="node-input-providerId"></select>
+  <label for="node-input-providerId"><i class="fa fa-id-badge"></i> Provider ID</label>
+  <input type="text" id="node-input-providerId" placeholder="sampleprovider">
 </div>
 <div class="form-row">
-  <label for="node-input-variableMode"><i class="fa fa-filter"></i> Variables</label>
-  <select id="node-input-variableMode">
-    <option value="all">All variables</option>
-    <option value="single">Single variable</option>
-    <option value="multi">Multi selection</option>
-  </select>
-</div>
-<div class="form-row" id="node-input-variableSingle-container" style="display:none;">
-  <label><i class="fa fa-bullseye"></i> Variable</label>
-  <select id="node-input-variableSingle" style="width:100%"></select>
-</div>
-<div class="form-row" id="node-input-variableMulti-container" style="display:none;">
-  <label><i class="fa fa-list-ul"></i> Variables</label>
-  <select id="node-input-variableMulti" multiple size="8" style="width:100%"> </select>
+  <label for="node-input-variablesText"><i class="fa fa-list"></i> Variables (comma separated)</label>
+  <input type="text" id="node-input-variablesText" placeholder="diagnostics.status_text,diagnostics.error_count">
 </div>
-<p>Outputs messages with <code>{{payload.type}}</code> = <code>snapshot</code> or <code>change</code> and a <code>variables</code> array containing the selected Data Hub values.</p>
+<div id="datahub-input-help" class="form-tips"></div>

package/nodes/datahub-input.js

@@ -27,13 +27,11 @@ module.exports = function (RED) {
     }
 
     this.providerId = config.providerId || 'sampleprovider';
-    this.variableMode = config.variableMode || 'all';
-    try {
-      this.variables = JSON.parse(config.variables || '[]').map(normalizeKey).filter((k) => k);
-    }
-    catch (err) {
-      this.variables = [];
-    }
+    const text = config.variablesText || '';
+    this.variables = text
+      .split(',')
+      .map((entry) => (entry ? String(entry).trim() : ''))
+      .filter((entry) => entry.length > 0);
 
     let nc;
     let sub;
@@ -41,13 +39,10 @@ module.exports = function (RED) {
     const defMap = new Map();
 
     const shouldInclude = (key) => {
-      if (this.variableMode === 'all' || !this.variables.length) {
+      if (!this.variables.length) {
         return true;
       }
       const needle = normalizeKey(key);
-      if (this.variableMode === 'single') {
-        return needle === this.variables[0];
-      }
       return this.variables.includes(needle);
     };
 

package/nodes/datahub-output.html

@@ -1,7 +1,6 @@
 <script type="text/javascript">
-(function() {
   RED.nodes.registerType('datahub-output', {
-    category: 'output',
+    category: 'DataHub-NATS',
     color: '#ff9f43',
     defaults: {
       name: { value: '' },
@@ -10,15 +9,25 @@
     },
     inputs: 1,
     outputs: 1,
-    icon: 'white/datahub-output.svg',
-    label: function() {
-      return this.name || `DataHub Output ${this.providerId || ''}`;
+    icon: "white/datahub-output.svg",
+    oneditprepare: function() {
+      const help = `
+      <b>DataHub Output node</b><br>
+      <ul>
+        <li><b>u-OS Config</b>: select the config node.</li>
+        <li><b>Provider ID</b>: defaults to <code>nodered</code> (will be registered automatically).</li>
+      </ul>
+      Send any JSON payload → nested objects become dot-separated keys (e.g. <code>{ diagnostics: { status_text: 'ok' } }</code> ⇢ <code>diagnostics.status_text</code>).
+      `;
+      $('#datahub-output-help').html(help);
     },
-    labelStyle: function() {
+    label: function () {
+      return this.name || `Output ${this.providerId || ''}`;
+    },
+    labelStyle: function () {
       return this.name ? 'node_label_italic' : '';
     }
   });
-})();
 </script>
 
 <div class="form-row">
@@ -33,4 +42,4 @@
   <label for="node-input-providerId"><i class="fa fa-id-badge"></i> Provider ID</label>
   <input type="text" id="node-input-providerId" placeholder="nodered">
 </div>
-<p>Send JSON payloads (including nested structures). The node auto-registers variables based on the object keys and publishes them to the configured provider. Nested objects become dot-separated keys (e.g. <code>folder.status</code>).</p>
+<div id="datahub-output-help" class="form-tips"></div>

package/package.json

@@ -1,7 +1,15 @@
 {
   "name": "node-red-contrib-uos-nats",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Node-RED nodes for u-OS Data Hub via NATS",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/uiff/nats-NodeRed-Node-uc20.git"
+  },
+  "homepage": "https://github.com/uiff/nats-NodeRed-Node-uc20",
+  "bugs": {
+    "url": "https://github.com/uiff/nats-NodeRed-Node-uc20/issues"
+  },
   "license": "MIT",
   "main": "nodes/uos-provider.js",
   "keywords": [