node-red-contrib-room-tools 1.8.16 → 1.9.1

package/control-panel.js

@@ -11,6 +11,7 @@ const { applyVisualBindings, editorConfig, getSnapshot } = require('./panel-visu
 const { createGateway } = require('./gateway.cjs')
 const { managedBridgeRevision } = require('./managed-bridge-revision')
 const { createMeterRoom, createPanelMeter } = require('./panel-meter')
+const { createXYSeriesRoom, createPanelXYSeries } = require('./panel-xy-series')
 
 let statestore
 const authHandoffKey = crypto.randomBytes(32)
@@ -71,6 +72,7 @@ module.exports = function (RED) {
   const activePanels = new Map()
   const activeEditors = new Map()
   const meterRooms = new Map()
+  const xySeriesRooms = new Map()
   RED.httpAdmin.get('/ui-control-panel/editor-sync.js', RED.auth.needsPermission('nodes.read'), (_req, res) => {
     res.setHeader('Cache-Control', 'no-store')
     res.sendFile(path.join(__dirname, 'panel-flow-editor-sync.js'))
@@ -159,6 +161,16 @@ module.exports = function (RED) {
       } catch (error) { node.error(error) }
     }
 
+    let xySeries
+    if ([...routes.values()].some(route => route.binding.readMeta?.xySeries) && /^[a-zA-Z0-9_-]+$/.test(boundRoom || '')) {
+      try {
+        let hub = xySeriesRooms.get(boundRoom)
+        if (!hub) { hub = createXYSeriesRoom({ room: boundRoom }); xySeriesRooms.set(boundRoom, hub) }
+        xySeries = createPanelXYSeries({ panelId: node.id, room: boundRoom, bindings: visualBindings, hub,
+          onSubscribe: () => { if (bridgeReady) node.send({ kind: 'read-all', room: boundRoom }) } })
+      } catch (error) { node.error(error) }
+    }
+
     let gateway
     let gatewayAuthKey
     if (visualBinding && /^[a-zA-Z0-9_-]+$/.test(boundRoom || '')) {
@@ -173,7 +185,8 @@ module.exports = function (RED) {
           secureCookie: config.secureCookie === true,
           restoredSessions: takeSessions(gatewayHandoffs, node.id, gatewayAuthKey),
           onAuthenticatedRequest: (req, res, identity) => meter?.ticket(req, res, identity,
-            () => gateway?.sessionActive(identity.token)) || false,
+            () => gateway?.sessionActive(identity.token)) || xySeries?.ticket(req, res, identity,
+              () => gateway?.sessionActive(identity.token)) || false,
           onBoundCommand: (message, identity) => {
             if (!bridgeReady) return false
             node.send({ ...resolveBoundCommand(routes, message), room: identity.room, user: identity.user })
@@ -203,7 +216,8 @@ module.exports = function (RED) {
         secureCookie: config.secureCookie === true,
         restoredSessions: takeSessions(editorHandoffs, node.id, editorAuthKey),
         onAuthenticatedRequest: (req, res, identity) => meter?.ticket(req, res, identity,
-          () => editor?.sessionActive(identity.token)) || false,
+          () => editor?.sessionActive(identity.token)) || xySeries?.ticket(req, res, identity,
+            () => editor?.sessionActive(identity.token)) || false,
         getConfig: async req => editorConfig(await getSnapshot(req.socket.localPort, fetch,
           RED.settings.httpAdminRoot ?? '/'), node.id),
         getDevices: async () => {
@@ -230,7 +244,7 @@ module.exports = function (RED) {
     }
 
     const panelConfig = () => (boundMode || visualBinding) ? {
-      endpoint, room: boundRoom, meter: Boolean(meter),
+      endpoint, room: boundRoom, meter: Boolean(meter), xySeries: Boolean(xySeries),
       ...(visualBinding ? { visual: {
         panelId: node.id,
         editorEndpoint: `/control-panel-edit/panels/${node.id}`,
@@ -241,7 +255,7 @@ module.exports = function (RED) {
 
     const events = {
       onAction: !boundMode,
-      ...(meter ? { onSocket: meter.hooks } : {}),
+      ...((meter || xySeries) ? { onSocket: { ...(meter?.hooks || {}), ...(xySeries?.hooks || {}) } } : {}),
       beforeSend (msg) {
         if (msg?._controlPanel?.kind === 'command') throw new Error('Bound commands require authenticated HTTP')
         if (['device-meter-frame', 'device-meter-manifest'].includes(msg?.kind)) {
@@ -250,6 +264,10 @@ module.exports = function (RED) {
           // should be emitted. `false` is property-safe and suppresses emit.
           return false
         }
+        if (['device-xy-series-frame', 'device-xy-series-manifest'].includes(msg?.kind)) {
+          if (bridgeReady) xySeries?.accept(msg)
+          return false
+        }
         if (boundMode) {
           if (msg?.kind === 'device-feedback' && gateway) {
             gateway.boundFeedback(resolveBoundFeedback(routes, msg))
@@ -325,7 +343,9 @@ module.exports = function (RED) {
       gateway?.close()
       editor?.close()
       meter?.close()
+      xySeries?.close()
       if (meterRooms.get(boundRoom)?.stats().panels === 0) meterRooms.delete(boundRoom)
+      if (xySeriesRooms.get(boundRoom)?.stats().panels === 0) xySeriesRooms.delete(boundRoom)
       if (activePanels.get(node.id) === gateway) activePanels.delete(node.id)
       if (activeEditors.get(node.id) === editor) activeEditors.delete(node.id)
     })

package/control-policy.js

@@ -5,6 +5,8 @@ const { fetchWithTimeout } = require('./panel-http')
 const { createTargetMatcher } = require('./control-type-model')
 const { createRoomMeterReceiver, createMeterRenderer } = require('./meter-frame')
 const { createPanelMeterClient } = require('./panel-meter-client')
+const { createRoomXYSeriesReceiver, createXYSeriesRenderer } = require('./xy-series-frame')
+const { createPanelXYSeriesClient } = require('./panel-xy-series-client')
 
 const CONTROL_POLICY_MARKER = '/* ui-control-panel-control-api-v1 */'
 
@@ -164,6 +166,11 @@ function buildDashboardPolicyOptionsSource (controls = [], boundPanel = null) {
     __createMeterRenderer: ${createMeterRenderer.toString()},
     __createPanelMeterClient: ${createPanelMeterClient.toString()},`
     : ''
+  const xySeriesMethods = boundPanel?.xySeries
+    ? `__createXYSeriesReceiver: ${createRoomXYSeriesReceiver.toString()},
+    __createXYSeriesRenderer: ${createXYSeriesRenderer.toString()},
+    __createPanelXYSeriesClient: ${createPanelXYSeriesClient.toString()},`
+    : ''
   const visualMethods = boundPanel?.visual
     ? `__createTargetMatcher: ${createTargetMatcher.toString()},
     __initializeVisualBinding: ${initializeVisualBinding.toString()},
@@ -188,6 +195,7 @@ export default {
   },
   methods: {
     ${meterMethods}
+    ${xySeriesMethods}
     ${visualMethods}
     __panelFetch: ${fetchWithTimeout.toString()},
     __boundPanelConfig () {

package/control-type-contract.json

@@ -5,6 +5,7 @@
     "level": { "family": "number", "delivery": "continuous" },
     "volume": { "family": "number", "delivery": "continuous" },
     "meter": { "family": "number", "delivery": "realtime", "access": "ro" },
+    "xy-series": { "family": "xy-series", "delivery": "realtime", "access": "ro" },
     "dimmer": { "family": "number", "delivery": "continuous" },
     "position": { "family": "number", "delivery": "continuous" },
     "toggle": { "family": "boolean", "delivery": "discrete" },

package/control-type-model.js

@@ -6,10 +6,11 @@ const { meterRoute } = require('./meter-route')
 // Used by both server validation and the injected editor; keep it self-contained.
 function createTargetMatcher (typeContract) {
   const families = {
-    range: ['number'], switch: ['boolean'], meter: ['number'],
+    range: ['number'], switch: ['boolean'], meter: ['number'], 'xy-series': ['xy-series'],
     'text-display': ['text', 'number', 'enum', 'boolean'], 'text-input': ['text'], select: ['enum']
   }
   function family (target) {
+    if (target.xySeries) return 'xy-series'
     if (target.controlSchemaVersion !== typeContract.schemaVersion) return null
     const definition = typeContract.types[String(target.controlType || '').toLowerCase()]
     if (!definition) return null
@@ -24,9 +25,11 @@ function createTargetMatcher (typeContract) {
   }
   function compatible (adapter, target, direction, candidate = {}) {
     if (adapter === 'meter' && !target.meter) return false
+    if (adapter === 'xy-series' && !target.xySeries) return false
     if (target.meter && (adapter !== 'meter' || direction !== 'read' || target.access !== 'ro')) return false
+    if (target.xySeries && (adapter !== 'xy-series' || direction !== 'read' || target.access !== 'ro')) return false
     if (target.kind !== 'param' || !families[adapter]?.includes(family(target))) return false
-    if (direction === 'write' && ['meter', 'text-display'].includes(adapter)) return false
+    if (direction === 'write' && ['meter', 'xy-series', 'text-display'].includes(adapter)) return false
     if (!['read', 'write'].includes(direction)) return false
     if (!(direction === 'write' ? ['wo', 'rw'] : ['ro', 'rw']).includes(target.access)) return false
     if (candidate.unit && candidate.unit !== target.unit) return false
@@ -42,6 +45,7 @@ function controlTypeForAdapter (adapter, target) {
     throw new Error('Target is incompatible with this control')
   }
   if (adapter === 'meter' && target.meter) return 'meter'
+  if (adapter === 'xy-series' && target.xySeries) return 'xy-series'
   const family = targetFamily(target)
   if (family === 'number') return 'level'
   if (family === 'boolean') return 'mute'
@@ -60,7 +64,8 @@ function targetMeta (target, onebased) {
     min: target.min, max: target.max, enums: target.enums,
     ...(target.booleanEncoding ? { booleanEncoding: target.booleanEncoding } : {}),
     controlType: target.controlType, controlSchemaVersion: target.controlSchemaVersion,
-    ...(target.meter ? { meter: meterRoute(target.meter), unit: target.unit || '' } : {})
+    ...(target.meter ? { meter: meterRoute(target.meter), unit: target.unit || '' } : {}),
+    ...(target.xySeries ? { xySeries: require('./xy-series-route').xySeriesRoute(target.xySeries) } : {})
   }
 }
 

package/managed-native-bridge.js

@@ -25,7 +25,8 @@ function panelTargets (panel) {
         device: binding.device, path, kind: meta.kind, type: meta.type,
         access: meta.access, onebased: meta.onebased,
         ...(meta.booleanEncoding ? { booleanEncoding: meta.booleanEncoding } : {}),
-        ...(meta.meter ? { meter: meta.meter } : {})
+        ...(meta.meter ? { meter: meta.meter } : {}),
+        ...(meta.xySeries ? { xySeries: meta.xySeries } : {})
       }
       const key = JSON.stringify([target.device, target.path])
       const previous = targets.get(key)

package/native-binding-plan.js

@@ -1,5 +1,6 @@
 const { configuredRoutes } = require('./control-bound-protocol')
 const { meterRoute } = require('./meter-route')
+const { xySeriesRoute } = require('./xy-series-route')
 
 const supportedTypes = {
   boolean: { eventType: 'Boolean', eventOptions: { boolParamFilter: 'Any' } },
@@ -30,6 +31,7 @@ function compileNativeBindingPlan ({ panel, targets, scopeId }) {
   const readTargets = new Map()
   const writeTargets = new Map()
   const meterStreams = new Map()
+  const xySeriesStreams = new Map()
   const commandRules = []
   const commandWires = []
 
@@ -37,7 +39,7 @@ function compileNativeBindingPlan ({ panel, targets, scopeId }) {
     const target = targetIndex.get(JSON.stringify([device, path]))
     if (!target) throw new Error(`Missing target descriptor: ${device} ${path}`)
     if (target.kind !== 'param') throw new Error(`Only parameter targets are supported: ${path}`)
-    if (!Object.hasOwn(supportedTypes, target.type)) {
+    if (!target.xySeries && !Object.hasOwn(supportedTypes, target.type)) {
       throw new Error(`Unsupported native parameter type: ${path} (${target.type})`)
     }
     if (['mute', 'power'].includes(type) && target.type !== 'boolean' &&
@@ -56,7 +58,10 @@ function compileNativeBindingPlan ({ panel, targets, scopeId }) {
     if (type === 'meter' && (!target.meter || !['integer', 'float'].includes(target.type) || target.access !== 'ro')) {
       throw new Error(`Meter control must bind to a readonly Meter target: ${path}`)
     }
-    if (!['mute', 'power', 'level', 'dimmer', 'position', 'meter', 'text', 'source', 'preset'].includes(type)) {
+    if (type === 'xy-series' && (!target.xySeries || target.access !== 'ro')) {
+      throw new Error(`XY-series control must bind to a readonly XY-series target: ${path}`)
+    }
+    if (!['mute', 'power', 'level', 'dimmer', 'position', 'meter', 'xy-series', 'text', 'source', 'preset'].includes(type)) {
       throw new Error(`Control type requires a separate command adapter: ${type}`)
     }
     if (!['ro', 'wo', 'rw'].includes(target.access) || !target.access.includes(access)) {
@@ -134,6 +139,49 @@ function compileNativeBindingPlan ({ panel, targets, scopeId }) {
         }
         continue
       }
+      if (target.xySeries) {
+        const series = xySeriesRoute(target.xySeries)
+        if (control.mode !== 'read' || control.adapter !== 'xy-series') {
+          throw Error(`XY-series is read-only: ${id}`)
+        }
+        const key = JSON.stringify([target.device, series.streamId])
+        const previous = xySeriesStreams.get(key)
+        if (previous) {
+          if (JSON.stringify(previous.series) !== JSON.stringify(series) || previous.onebased !== target.onebased) {
+            throw Error(`Conflicting xy-series stream: ${series.streamId}`)
+          }
+          continue
+        }
+        const index = xySeriesStreams.size + 1
+        const statusId = `${scopeId}-xy-series-read-${index}`
+        const tagIds = []
+        xySeriesStreams.set(key, { series, onebased: target.onebased, statusId, tagIds })
+        for (const [role, path] of [['manifest', series.manifestPath], ['frame', series.eventPath]]) {
+          const eventId = `${scopeId}-xy-series-${role}-${index}`
+          const tagId = `${eventId}-tag`
+          tagIds.push(tagId)
+          const y = 540 + (index - 1) * 280 + (role === 'frame' ? 140 : 0)
+          if (role === 'manifest') nodes.push({
+            id: statusId, type: 'Status', z: subflowId, name: `Read xy-series manifest ${target.device}`,
+            x: 440, y: y - 60, mojo: { version: '1.0', device: [target.device],
+              parameter: path, onebased: target.onebased }, wires: [[tagId]]
+          })
+          nodes.push({ id: eventId, type: 'Event', z: subflowId,
+            name: `Watch xy-series ${role} ${target.device} ${series.streamId}`, x: 440, y,
+            mojo: { version: '1.0', device: [target.device], event: path,
+              eventKind: role === 'frame' ? 'Event' : 'Parameter', paramType: 'String',
+              onebased: target.onebased }, wires: [[tagId]] })
+          nodes.push({ id: tagId, type: 'change', z: subflowId,
+            name: `Identify xy-series ${role} ${target.device}`, x: 1000, y,
+            rules: [
+              { t: 'set', p: 'kind', pt: 'msg', to: 'device-xy-series-' + role, tot: 'str' },
+              { t: 'set', p: 'device', pt: 'msg', to: target.device, tot: 'str' },
+              { t: 'set', p: 'path', pt: 'msg', to: path, tot: 'str' },
+              { t: 'set', p: 'streamId', pt: 'msg', to: series.streamId, tot: 'str' }
+            ], wires: [[]] })
+        }
+        continue
+      }
       const key = JSON.stringify([target.device, target.path])
       if (readTargets.has(key)) continue
       const index = readTargets.size + 1
@@ -175,7 +223,11 @@ function compileNativeBindingPlan ({ panel, targets, scopeId }) {
 
   const commandSwitchId = `${scopeId}-commands`
   // Meter lanes follow ordinary feedback lanes without overlapping their labels.
-  for (const node of nodes) if (node.id.startsWith(`${scopeId}-meter-`)) node.y += readTargets.size * 170
+  for (const node of nodes) {
+    if (node.id.startsWith(`${scopeId}-meter-`) || node.id.startsWith(`${scopeId}-xy-series-`)) {
+      node.y += readTargets.size * 170
+    }
+  }
   const routerId = `${scopeId}-router`
   if (commandRules.length) {
     nodes.push({
@@ -196,17 +248,18 @@ function compileNativeBindingPlan ({ panel, targets, scopeId }) {
     ],
     checkall: 'false', repair: false, outputs: 2,
     wires: [commandRules.length ? [commandSwitchId] : [],
-      [...readTargets.values(), ...meterStreams.values()].map(target => target.statusId)]
+      [...readTargets.values(), ...meterStreams.values(), ...xySeriesStreams.values()].map(target => target.statusId)]
   })
   const subflow = {
     id: subflowId, type: 'subflow', name: `Binding bridge ${scopeId}`,
     info: 'Generated panel binding bridge. Requires a Controller node and authenticated command source.',
     category: 'panel binding',
     in: [{ x: 170, y: 150, wires: [{ id: routerId }] }],
-    out: readTargets.size || meterStreams.size
+    out: readTargets.size || meterStreams.size || xySeriesStreams.size
       ? [{ x: meterStreams.size ? 1600 : 1290, y: Math.round((390 + (readTargets.size + meterStreams.size + 1) * 85) / 10) * 10,
         wires: [...readTargets.values()].map(target => ({ id: target.tagId, port: 0 }))
-          .concat([...meterStreams.values()].flatMap(target => target.tagIds.map(id => ({ id, port: 0 })))) }]
+          .concat([...meterStreams.values()].flatMap(target => target.tagIds.map(id => ({ id, port: 0 }))))
+          .concat([...xySeriesStreams.values()].flatMap(target => target.tagIds.map(id => ({ id, port: 0 })))) }]
       : [],
     env: [], meta: {}, color: '#96bca7'
   }
@@ -215,8 +268,9 @@ function compileNativeBindingPlan ({ panel, targets, scopeId }) {
     manifest: {
       subflowId,
       controls: routes.size,
-      nativeReads: readTargets.size + meterStreams.size,
+      nativeReads: readTargets.size + meterStreams.size + xySeriesStreams.size,
       nativeMeterStreams: meterStreams.size,
+      nativeXYSeriesStreams: xySeriesStreams.size,
       nativeWrites: writeTargets.size,
       requiresController: true,
       initialReadMessage: { kind: 'read-all' }

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "node-red-contrib-room-tools",
-  "version": "1.8.16",
+  "version": "1.9.1",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "node-red-contrib-room-tools",
-      "version": "1.8.16",
+      "version": "1.9.1",
       "license": "UNLICENSED",
       "dependencies": {
         "@vue/compiler-sfc": "3.5.42",

package/package.json

@@ -1,9 +1,11 @@
 {
   "name": "node-red-contrib-room-tools",
-  "version": "1.8.16",
+  "version": "1.9.1",
   "description": "Authenticated visual control panel binding for Node-RED and MUSE Automator",
   "license": "UNLICENSED",
-  "engines": { "node": ">=18.16.0" },
+  "engines": {
+    "node": ">=18.16.0"
+  },
   "keywords": [
     "node-red"
   ],
@@ -25,6 +27,10 @@
     "meter-frame.js",
     "panel-meter.js",
     "panel-meter-client.js",
+    "xy-series-route.js",
+    "xy-series-frame.js",
+    "panel-xy-series.js",
+    "panel-xy-series-client.js",
     "panel-template-instrumentation.js",
     "panel-visual-bindings.js",
     "panel-visual-apply.js",