node-red-contrib-room-tools 1.9.3 → 1.9.5

package/native-binding-plan.js

@@ -1,6 +1,8 @@
 const { configuredRoutes } = require('./control-bound-protocol')
 const { meterRoute } = require('./meter-route')
 const { xySeriesRoute } = require('./xy-series-route')
+const { targetStates, isMeterTarget } = require('./control-type-model')
+const { availabilityRoute } = require('./device-availability')
 
 const supportedTypes = {
   boolean: { eventType: 'Boolean', eventOptions: { boolParamFilter: 'Any' } },
@@ -32,21 +34,23 @@ function compileNativeBindingPlan ({ panel, targets, scopeId }) {
   const writeTargets = new Map()
   const meterStreams = new Map()
   const xySeriesStreams = new Map()
+  const healthTargets = new Map()
   const commandRules = []
   const commandWires = []
 
-  function metadata (device, path, type, access) {
+  function metadata (device, path, type, access, adapter) {
     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 (!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' &&
+    if (['mute', 'power'].includes(type) && !targetStates(target) &&
       !(target.type === 'integer' && target.booleanEncoding === 'integer01')) {
       throw new Error(`Boolean control bound to ${target.type}: ${path}`)
     }
-    if (['level', 'dimmer', 'position'].includes(type) && !['integer', 'float'].includes(target.type)) {
+    if (['level', 'dimmer', 'position'].includes(type) &&
+      (!['integer', 'float'].includes(target.type) || (adapter === 'range' && isMeterTarget(target)))) {
       throw new Error(`Numeric control bound to ${target.type}: ${path}`)
     }
     if (type === 'text' && !['string', 'dstring'].includes(target.type)) {
@@ -55,7 +59,7 @@ function compileNativeBindingPlan ({ panel, targets, scopeId }) {
     if (['source', 'preset'].includes(type) && !['enum', 'integer', 'string'].includes(target.type)) {
       throw new Error(`Choice control bound to ${target.type}: ${path}`)
     }
-    if (type === 'meter' && (!target.meter || !['integer', 'float'].includes(target.type) || target.access !== 'ro')) {
+    if (type === 'meter' && !isMeterTarget(target)) {
       throw new Error(`Meter control must bind to a readonly Meter target: ${path}`)
     }
     if (type === 'xy-series' && (!target.xySeries || target.access !== 'ro')) {
@@ -70,6 +74,34 @@ function compileNativeBindingPlan ({ panel, targets, scopeId }) {
     if (typeof target.onebased !== 'boolean') {
       throw new Error(`Target numbering mode is required: ${path}`)
     }
+    if (target.availability) {
+      for (const point of Object.values(availabilityRoute(target.availability, target.onebased))) {
+        const key = JSON.stringify([device, point.path])
+        if (healthTargets.has(key)) {
+          if (healthTargets.get(key).onebased !== point.onebased) throw Error('Conflicting availability numbering')
+          continue
+        }
+        const index = healthTargets.size + 1
+        const statusId = `${scopeId}-health-read-${index}`
+        const eventId = `${scopeId}-health-watch-${index}`
+        const tagId = `${scopeId}-health-tag-${index}`
+        healthTargets.set(key, { statusId, tagId, onebased: point.onebased })
+        nodes.push({ id: statusId, type: 'Status', z: subflowId,
+          name: `Read availability ${device} ${point.path}`, x: 440, y: 340 + index * 170,
+          mojo: { version: '1.0', device: [device], parameter: point.path, onebased: point.onebased }, wires: [[tagId]] })
+        nodes.push({ id: eventId, type: 'Event', z: subflowId,
+          name: `Watch availability ${device} ${point.path}`, x: 440, y: 400 + index * 170,
+          mojo: { version: '1.0', device: [device], event: point.path, eventKind: 'Parameter',
+            paramType: 'Boolean', boolParamFilter: 'Any', onebased: point.onebased }, wires: [[tagId]] })
+        nodes.push({ id: tagId, type: 'change', z: subflowId,
+          name: `Identify availability ${device} ${point.path}`, x: 900, y: 370 + index * 170,
+          rules: [
+            { t: 'set', p: 'kind', pt: 'msg', to: 'device-availability', tot: 'str' },
+            { t: 'set', p: 'device', pt: 'msg', to: device, tot: 'str' },
+            { t: 'set', p: 'path', pt: 'msg', to: point.path, tot: 'str' }
+          ], wires: [[]] })
+      }
+    }
     return target
   }
 
@@ -77,7 +109,7 @@ function compileNativeBindingPlan ({ panel, targets, scopeId }) {
     if (!binding?.device) throw new Error(`Missing device binding: ${id}`)
     if (control.mode !== 'read') {
       if (!binding.writePath) throw new Error(`Missing write path: ${id}`)
-      const target = metadata(binding.device, binding.writePath, control.type, 'w')
+      const target = metadata(binding.device, binding.writePath, control.type, 'w', control.adapter)
       const key = JSON.stringify([target.device, target.path])
       if (!writeTargets.has(key)) {
         const nodeId = `${scopeId}-write-${writeTargets.size + 1}`
@@ -97,7 +129,7 @@ function compileNativeBindingPlan ({ panel, targets, scopeId }) {
 
     if (control.mode !== 'write') {
       if (!binding.readPath) throw new Error(`Missing read path: ${id}`)
-      const target = metadata(binding.device, binding.readPath, control.type, 'r')
+      const target = metadata(binding.device, binding.readPath, control.type, 'r', control.adapter)
       if (target.meter) {
         const meter = meterRoute(target.meter)
         if (control.mode !== 'read' || control.adapter !== 'meter') throw Error(`Meter is read-only: ${id}`)
@@ -222,10 +254,14 @@ function compileNativeBindingPlan ({ panel, targets, scopeId }) {
   }
 
   const commandSwitchId = `${scopeId}-commands`
-  // Meter lanes follow ordinary feedback lanes without overlapping their labels.
+  // Ordinary feedback, Meter, and XY-series each get a separate vertical band.
   for (const node of nodes) {
+    if (node.id.startsWith(`${scopeId}-health-`)) {
+      node.y += readTargets.size * 170 + (meterStreams.size + xySeriesStreams.size) * 280
+    }
     if (node.id.startsWith(`${scopeId}-meter-`) || node.id.startsWith(`${scopeId}-xy-series-`)) {
       node.y += readTargets.size * 170
+      if (node.id.startsWith(`${scopeId}-xy-series-`)) node.y += meterStreams.size * 280
     }
   }
   const routerId = `${scopeId}-router`
@@ -248,18 +284,20 @@ function compileNativeBindingPlan ({ panel, targets, scopeId }) {
     ],
     checkall: 'false', repair: false, outputs: 2,
     wires: [commandRules.length ? [commandSwitchId] : [],
-      [...readTargets.values(), ...meterStreams.values(), ...xySeriesStreams.values()].map(target => target.statusId)]
+      [...readTargets.values(), ...meterStreams.values(), ...xySeriesStreams.values(), ...healthTargets.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 || xySeriesStreams.size
-      ? [{ x: meterStreams.size ? 1600 : 1290, y: Math.round((390 + (readTargets.size + meterStreams.size + 1) * 85) / 10) * 10,
+    out: readTargets.size || meterStreams.size || xySeriesStreams.size || healthTargets.size
+      ? [{ x: meterStreams.size || xySeriesStreams.size ? 1600 : 1290,
+        y: Math.round((390 + (readTargets.size + meterStreams.size + xySeriesStreams.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([...xySeriesStreams.values()].flatMap(target => target.tagIds.map(id => ({ id, port: 0 })))) }]
+          .concat([...xySeriesStreams.values()].flatMap(target => target.tagIds.map(id => ({ id, port: 0 }))))
+          .concat([...healthTargets.values()].map(target => ({ id: target.tagId, port: 0 }))) }]
       : [],
     env: [], meta: {}, color: '#96bca7'
   }
@@ -268,7 +306,8 @@ function compileNativeBindingPlan ({ panel, targets, scopeId }) {
     manifest: {
       subflowId,
       controls: routes.size,
-      nativeReads: readTargets.size + meterStreams.size + xySeriesStreams.size,
+      nativeReads: readTargets.size + meterStreams.size + xySeriesStreams.size + healthTargets.size,
+      ...(healthTargets.size ? { nativeAvailabilityReads: healthTargets.size } : {}),
       nativeMeterStreams: meterStreams.size,
       nativeXYSeriesStreams: xySeriesStreams.size,
       nativeWrites: writeTargets.size,

package/npm-shrinkwrap.json

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

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "node-red-contrib-room-tools",
-  "version": "1.9.3",
+  "version": "1.9.5",
   "description": "Authenticated visual control panel binding for Node-RED and MUSE Automator",
   "license": "UNLICENSED",
+  "scripts": {
+    "test": "node --test test-*.cjs"
+  },
   "engines": {
     "node": ">=18.16.0"
   },
@@ -23,9 +26,11 @@
     "control-catalog.js",
     "control-type-contract.json",
     "control-type-model.js",
+    "device-availability.js",
     "meter-route.js",
     "meter-frame.js",
     "panel-meter.js",
+    "panel-telemetry-send.js",
     "panel-meter-client.js",
     "xy-series-route.js",
     "xy-series-frame.js",