@yarkivaev/scada 2.3.90 → 2.3.112

package/src/infrastructure/ingest/mqtt/registerPublish.js

@@ -0,0 +1,84 @@
+import { decodePoint } from './registerPoint.js';
+
+/**
+ * Measurement name for one mapped parameter.
+ *
+ * A stream path plus the parameter id is the document path. An empty
+ * stream keeps the parameter id, which is the generic fallback name.
+ *
+ * @example
+ *   measurementPath('mill/electrical', 'voltage');
+ *
+ * @param {string} stream - document path
+ * @param {string} key - parameter id
+ * @returns {string} MQTT topic
+ */
+export function measurementPath(stream, key) {
+    if (typeof stream === 'string' && stream.length > 0) {
+        return `${stream}/${key}`;
+    }
+    return String(key);
+}
+
+/**
+ * Publish plan for one device map.
+ *
+ * @example
+ *   measurementPlans('mill/electrical', { voltage: 'holding:4000:cdab' });
+ *
+ * @param {string} stream - document path
+ * @param {object} mapping - parameter id to register point
+ * @returns {Array<{point: string, topic: string}>} publish plan
+ */
+export function measurementPlans(stream, mapping) {
+    return Object.keys(mapping || {}).map((key) => {
+        return {
+            point: String(mapping[key]),
+            topic: measurementPath(stream, key)
+        };
+    });
+}
+
+/**
+ * Publishes one MQTT record per holding-register point.
+ *
+ * Each record is `{topic, payload}` and the payload is JSON `{ts, value}`.
+ *
+ * @example
+ *   const transformer = registerPublish(plans, 4000, collector);
+ *   transformer.accept([0, 16256]);
+ *
+ * @param {Array<{point: string, topic: string}>} plans - publish plan
+ * @param {number} origin - first PDU address in the window
+ * @param {object} collector - collector with accept()
+ * @returns {object} transformer with accept(registers)
+ */
+export default function registerPublish(plans, origin, collector) {
+    if (!collector || typeof collector.accept !== 'function') {
+        throw new Error('Collector must have an accept() method');
+    }
+    const rows = (plans || []).map((item) => {
+        return Object.freeze({
+            point: item.point,
+            topic: item.topic
+        });
+    });
+    return {
+        /**
+         * Decodes the window and publishes one record per point.
+         *
+         * @param {Array<number>} registers - uint16 window
+         */
+        accept(registers) {
+            rows.forEach((item) => {
+                collector.accept({
+                    payload: JSON.stringify({
+                        ts: Date.now(),
+                        value: decodePoint(item.point, origin, registers)
+                    }),
+                    topic: item.topic
+                });
+            });
+        }
+    };
+}