smithtek-mako-rf 3.4.1 → 3.5.1

package/channel-map.mjs

@@ -1,54 +1,56 @@
-const hasOwn=(o,k)=>Object.prototype.hasOwnProperty.call(o,k);
-// Shared by the V-net exporter and the local Node-RED node. No transport dependencies.
-export const widths={float32:2,int32:2,uint32:2,int16:1,uint16:1,boolean:1};
-export function identity(map){return 'passport-link-v1:'+JSON.stringify([map.unitId,map.channels.map(c=>[c.kind,c.index,c.name,c.dataType,c.address,c.slot,!!c.pulseOnWrite,c.pulseMs||250])]);}
-export function validateMap(map){
- if(!map||map.schema!=='smithtek.passport-channels'||map.version!==1||!Number.isInteger(map.unitId)||map.unitId<1||map.unitId>247||!Array.isArray(map.channels)||map.channels.length<1||map.channels.length>64)throw Error('Invalid PassPort channel mapping');
- const names=new Set(),slots=new Set(),used=new Set(),indices={analog:0,switches:0};
- for(const c of map.channels){
-  if(!['analog','switches'].includes(c.kind)||c.index!==indices[c.kind]++||typeof c.name!=='string'||!c.name.trim()||c.name.length>40||names.has(c.name)||['__proto__','constructor','prototype'].includes(c.name)||!Number.isInteger(c.slot)||c.slot<0||c.slot>63||slots.has(c.slot)||!hasOwn(widths,c.dataType)||(c.kind==='switches')!==(c.dataType==='boolean')||!Number.isInteger(c.address)||c.address<0||c.address+widths[c.dataType]>65536)throw Error('Invalid channel name, order, type or address');
-  if(c.pulseOnWrite&&(c.kind!=='switches'||!Number.isInteger(c.pulseMs)||c.pulseMs<1||c.pulseMs>1000))throw Error('Invalid Digital pulse settings');
-  names.add(c.name);slots.add(c.slot);for(let i=0;i<widths[c.dataType];i++){const key=c.kind+':'+(c.address+i);if(used.has(key))throw Error('Overlapping channel addresses');used.add(key);}
- }
- if(map.mappingId!==identity(map))throw Error('Mapping identity does not match its channels');return map;
-}
-export function createMap(unitId,rows){const indices={analog:0,switches:0};const map={schema:'smithtek.passport-channels',version:1,unitId,channels:rows.map(r=>{const kind=r.area==='coil'?'switches':'analog';return {kind,index:indices[kind]++,name:r.name.trim(),slot:r.slot,address:r.address,dataType:kind==='switches'?'boolean':r.dataType||'float32',...(r.pulseOnWrite?{pulseOnWrite:true,pulseMs:r.pulseMs??250}:{})};})};map.mappingId=identity(map);return validateMap(map);}
-export function encode(c,value){
- if(c.dataType==='boolean'){if(value===true||value===1)return [true];if(value===false||value===0)return [false];throw Error(c.name+': use TRUE/FALSE or 1/0');}
- const limits={int16:[-32768,32767],uint16:[0,65535],int32:[-2147483648,2147483647],uint32:[0,4294967295],float32:[-3.4028234663852886e38,3.4028234663852886e38]};
- if(typeof value!=='number'||!Number.isFinite(value)||value<limits[c.dataType][0]||value>limits[c.dataType][1]||(c.dataType!=='float32'&&!Number.isInteger(value)))throw Error(c.name+': value does not fit '+c.dataType);
- if(widths[c.dataType]===1)return [value&65535];const b=new DataView(new ArrayBuffer(4));if(c.dataType==='float32')b.setFloat32(0,value);else if(c.dataType==='int32')b.setInt32(0,value);else b.setUint32(0,value);return [b.getUint16(2),b.getUint16(0)];
-}
-export function decode(c,values){if(c.dataType==='boolean'){if(![true,false,0,1].includes(values[0]))throw Error('Invalid Digital reply');return !!values[0];}if(values.length!==widths[c.dataType]||values.some(v=>!Number.isInteger(v)||v<0||v>65535))throw Error('Invalid Analog reply');if(widths[c.dataType]===1)return c.dataType==='int16'&&values[0]>32767?values[0]-65536:values[0];const b=new DataView(new ArrayBuffer(4));b.setUint16(0,values[1]);b.setUint16(2,values[0]);const v=c.dataType==='float32'?b.getFloat32(0):c.dataType==='int32'?b.getInt32(0):b.getUint32(0);if(!Number.isFinite(v))throw Error('Non-finite Analog reply');return v;}
-export function groups(map){validateMap(map);const result=[];for(const kind of ['analog','switches']){let g;for(const c of map.channels.filter(c=>c.kind===kind).sort((a,b)=>a.address-b.address)){if(!g||c.address!==g.end||c.address+widths[c.dataType]-g.address>32){g={kind,address:c.address,end:c.address,channels:[]};result.push(g);}g.channels.push(c);g.end+=widths[c.dataType];}}return result;}
-export function plan(map,mode,payload){const all=groups(map);if(!['read','write'].includes(mode))throw Error('Choose Read or Write');let encoded;
- if(mode==='write'){
-  if(!payload||typeof payload!=='object'||Array.isArray(payload)||payload.mappingId!==map.mappingId)throw Error('Write needs the matching mappingId and analog and/or switches arrays');
-  if(Object.keys(payload).some(k=>!['mappingId','analog','switches'].includes(k)))throw Error('Unknown channel array');
-  encoded=new Map();let provided=false;
-  for(const kind of ['analog','switches'])if(hasOwn(payload,kind)){provided=true;const channels=map.channels.filter(c=>c.kind===kind);if(!Array.isArray(payload[kind])||payload[kind].length!==channels.length)throw Error(kind+' array must contain exactly '+channels.length+' values');for(const c of channels)encoded.set(c.slot,encode(c,payload[kind][c.index]));}
-  if(!provided||!encoded.size)throw Error('Provide at least one non-empty channel array');
- }
- return all.filter(g=>mode==='read'||hasOwn(payload,g.kind)).map(g=>({group:g,req:{mode,unitid:map.unitId,fc:mode==='read'?(g.kind==='switches'?1:3):(g.kind==='switches'?15:16),address:g.address,...(mode==='read'?{quantity:g.end-g.address}:{value:g.channels.flatMap(c=>encoded.get(c.slot))})}}));
-}
-export function emptyResult(map){return {mappingId:map.mappingId,analog:[],switches:[]};}
-export function applyRead(result,group,data){
- const expected=group.end-group.address;
- // Coil replies are packed into whole bytes. modbus-serial expands the last
- // byte too, so unused trailing bits are valid but are not mapped channels.
- const padded=group.kind==='switches'?Math.ceil(expected/8)*8:expected;
- if(!Array.isArray(data)||(data.length!==expected&&data.length!==padded))throw Error('Incomplete channel reply: expected '+expected+' '+(group.kind==='switches'?'digital values':'registers')+', received '+(Array.isArray(data)?data.length:'no data'));
-for(const c of group.channels)result[c.kind][c.index]=decode(c,data.slice(c.address-group.address,c.address-group.address+widths[c.dataType]));return result;}
-
-export function namedValues(map,result){return Object.fromEntries(map.channels.map(c=>[c.name,result[c.kind][c.index]]));}
-// Resolve only supplied names. Never fill omitted channels with stale/default values.
-export function planNamed(map,values){
- validateMap(map);if(!values||typeof values!=='object'||Array.isArray(values)||!Object.keys(values).length)throw Error('Provide a named channel object');
- const selected=new Map();for(const name of Object.keys(values)){const c=map.channels.find(c=>c.name===name);if(!c)throw Error('Unknown channel: '+name);selected.set(c.slot,encode(c,values[name]));}
- const ops=[];for(const kind of ['analog','switches']){let op;for(const c of map.channels.filter(c=>c.kind===kind&&selected.has(c.slot)).sort((a,b)=>a.address-b.address)){
-  const v=selected.get(c.slot);if(!op||c.address!==op.req.address+op.req.value.length||op.req.value.length+v.length>32){op={req:{mode:'write',unitid:map.unitId,fc:kind==='switches'?15:16,address:c.address,value:[]}};ops.push(op);}op.req.value.push(...v);
- }}return ops;
-}
-
-export function planSingle(map,name,value){validateMap(map);if(typeof name!=='string'||!map.channels.some(c=>c.name===name))throw Error('Choose a channel from this node table');return planNamed(map,{[name]:value});}
-export function prefixValues(values,prefix){const label=String(prefix==null?'':prefix).trim();return Object.fromEntries(Object.entries(values).map(([name,value])=>[label?label+' '+name:name,value]));}
+// Copyright (c) Smithtek Pty Ltd. Smithtek Software Licence (LICENSE.txt).
+// Original Smithtek helper, shared with the Smithtek V-NET2 exporter.
+const hasOwn=(o,k)=>Object.prototype.hasOwnProperty.call(o,k);
+// Shared by the V-net exporter and the local Node-RED node. No transport dependencies.
+export const widths={float32:2,int32:2,uint32:2,int16:1,uint16:1,boolean:1};
+export function identity(map){return 'passport-link-v1:'+JSON.stringify([map.unitId,map.channels.map(c=>[c.kind,c.index,c.name,c.dataType,c.address,c.slot,!!c.pulseOnWrite,c.pulseMs||250])]);}
+export function validateMap(map){
+ if(!map||map.schema!=='smithtek.passport-channels'||map.version!==1||!Number.isInteger(map.unitId)||map.unitId<1||map.unitId>247||!Array.isArray(map.channels)||map.channels.length<1||map.channels.length>128)throw Error('Invalid PassPort channel mapping');
+ const names=new Set(),slots=new Set(),used=new Set(),indices={analog:0,switches:0};
+ for(const c of map.channels){
+  if(!['analog','switches'].includes(c.kind)||c.index!==indices[c.kind]++||typeof c.name!=='string'||!c.name.trim()||c.name.length>40||names.has(c.name)||['__proto__','constructor','prototype'].includes(c.name)||!Number.isInteger(c.slot)||c.slot<0||c.slot>127||slots.has(c.slot)||!hasOwn(widths,c.dataType)||(c.kind==='switches')!==(c.dataType==='boolean')||!Number.isInteger(c.address)||c.address<0||c.address+widths[c.dataType]>65536)throw Error('Invalid channel name, order, type or address');
+  if(c.pulseOnWrite&&(c.kind!=='switches'||!Number.isInteger(c.pulseMs)||c.pulseMs<1||c.pulseMs>1000))throw Error('Invalid Digital pulse settings');
+  names.add(c.name);slots.add(c.slot);for(let i=0;i<widths[c.dataType];i++){const key=c.kind+':'+(c.address+i);if(used.has(key))throw Error('Overlapping channel addresses');used.add(key);}
+ }
+ if(map.mappingId!==identity(map))throw Error('Mapping identity does not match its channels');return map;
+}
+export function createMap(unitId,rows){const indices={analog:0,switches:0};const map={schema:'smithtek.passport-channels',version:1,unitId,channels:rows.map(r=>{const kind=r.area==='coil'?'switches':'analog';return {kind,index:indices[kind]++,name:r.name.trim(),slot:r.slot,address:r.address,dataType:kind==='switches'?'boolean':r.dataType||'float32',...(r.pulseOnWrite?{pulseOnWrite:true,pulseMs:r.pulseMs??250}:{})};})};map.mappingId=identity(map);return validateMap(map);}
+export function encode(c,value){
+ if(c.dataType==='boolean'){if(value===true||value===1)return [true];if(value===false||value===0)return [false];throw Error(c.name+': use TRUE/FALSE or 1/0');}
+ const limits={int16:[-32768,32767],uint16:[0,65535],int32:[-2147483648,2147483647],uint32:[0,4294967295],float32:[-3.4028234663852886e38,3.4028234663852886e38]};
+ if(typeof value!=='number'||!Number.isFinite(value)||value<limits[c.dataType][0]||value>limits[c.dataType][1]||(c.dataType!=='float32'&&!Number.isInteger(value)))throw Error(c.name+': value does not fit '+c.dataType);
+ if(widths[c.dataType]===1)return [value&65535];const b=new DataView(new ArrayBuffer(4));if(c.dataType==='float32')b.setFloat32(0,value);else if(c.dataType==='int32')b.setInt32(0,value);else b.setUint32(0,value);return [b.getUint16(2),b.getUint16(0)];
+}
+export function decode(c,values){if(c.dataType==='boolean'){if(![true,false,0,1].includes(values[0]))throw Error('Invalid Digital reply');return !!values[0];}if(values.length!==widths[c.dataType]||values.some(v=>!Number.isInteger(v)||v<0||v>65535))throw Error('Invalid Analog reply');if(widths[c.dataType]===1)return c.dataType==='int16'&&values[0]>32767?values[0]-65536:values[0];const b=new DataView(new ArrayBuffer(4));b.setUint16(0,values[1]);b.setUint16(2,values[0]);const v=c.dataType==='float32'?b.getFloat32(0):c.dataType==='int32'?b.getInt32(0):b.getUint32(0);if(!Number.isFinite(v))throw Error('Non-finite Analog reply');return v;}
+export function groups(map){validateMap(map);const result=[];for(const kind of ['analog','switches']){let g;for(const c of map.channels.filter(c=>c.kind===kind).sort((a,b)=>a.address-b.address)){if(!g||c.address!==g.end||c.address+widths[c.dataType]-g.address>32){g={kind,address:c.address,end:c.address,channels:[]};result.push(g);}g.channels.push(c);g.end+=widths[c.dataType];}}return result;}
+export function plan(map,mode,payload){const all=groups(map);if(!['read','write'].includes(mode))throw Error('Choose Read or Write');let encoded;
+ if(mode==='write'){
+  if(!payload||typeof payload!=='object'||Array.isArray(payload)||payload.mappingId!==map.mappingId)throw Error('Write needs the matching mappingId and analog and/or switches arrays');
+  if(Object.keys(payload).some(k=>!['mappingId','analog','switches'].includes(k)))throw Error('Unknown channel array');
+  encoded=new Map();let provided=false;
+  for(const kind of ['analog','switches'])if(hasOwn(payload,kind)){provided=true;const channels=map.channels.filter(c=>c.kind===kind);if(!Array.isArray(payload[kind])||payload[kind].length!==channels.length)throw Error(kind+' array must contain exactly '+channels.length+' values');for(const c of channels)encoded.set(c.slot,encode(c,payload[kind][c.index]));}
+  if(!provided||!encoded.size)throw Error('Provide at least one non-empty channel array');
+ }
+ return all.filter(g=>mode==='read'||hasOwn(payload,g.kind)).map(g=>({group:g,req:{mode,unitid:map.unitId,fc:mode==='read'?(g.kind==='switches'?1:3):(g.kind==='switches'?15:16),address:g.address,...(mode==='read'?{quantity:g.end-g.address}:{value:g.channels.flatMap(c=>encoded.get(c.slot))})}}));
+}
+export function emptyResult(map){return {mappingId:map.mappingId,analog:[],switches:[]};}
+export function applyRead(result,group,data){
+ const expected=group.end-group.address;
+ // Coil replies are packed into whole bytes. modbus-serial expands the last
+ // byte too, so unused trailing bits are valid but are not mapped channels.
+ const padded=group.kind==='switches'?Math.ceil(expected/8)*8:expected;
+ if(!Array.isArray(data)||(data.length!==expected&&data.length!==padded))throw Error('Incomplete channel reply: expected '+expected+' '+(group.kind==='switches'?'digital values':'registers')+', received '+(Array.isArray(data)?data.length:'no data'));
+for(const c of group.channels)result[c.kind][c.index]=decode(c,data.slice(c.address-group.address,c.address-group.address+widths[c.dataType]));return result;}
+
+export function namedValues(map,result){return Object.fromEntries(map.channels.map(c=>[c.name,result[c.kind][c.index]]));}
+// Resolve only supplied names. Never fill omitted channels with stale/default values.
+export function planNamed(map,values){
+ validateMap(map);if(!values||typeof values!=='object'||Array.isArray(values)||!Object.keys(values).length)throw Error('Provide a named channel object');
+ const selected=new Map();for(const name of Object.keys(values)){const c=map.channels.find(c=>c.name===name);if(!c)throw Error('Unknown channel: '+name);selected.set(c.slot,encode(c,values[name]));}
+ const ops=[];for(const kind of ['analog','switches']){let op;for(const c of map.channels.filter(c=>c.kind===kind&&selected.has(c.slot)).sort((a,b)=>a.address-b.address)){
+  const v=selected.get(c.slot);if(!op||c.address!==op.req.address+op.req.value.length||op.req.value.length+v.length>32){op={req:{mode:'write',unitid:map.unitId,fc:kind==='switches'?15:16,address:c.address,value:[]}};ops.push(op);}op.req.value.push(...v);
+ }}return ops;
+}
+
+export function planSingle(map,name,value){validateMap(map);if(typeof name!=='string'||!map.channels.some(c=>c.name===name))throw Error('Choose a channel from this node table');return planNamed(map,{[name]:value});}
+export function prefixValues(values,prefix){const label=String(prefix==null?'':prefix).trim();return Object.fromEntries(Object.entries(values).map(([name,value])=>[label?label+' '+name:name,value]));}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smithtek-mako-rf",
-  "version": "3.4.1",
+  "version": "3.5.1",
   "description": "Smithtek Mako RF and PassPort Connect nodes for Mako and Solaris readings and controls",
   "keywords": [
     "node-red",
@@ -13,8 +13,8 @@
     "mako",
     "solaris"
   ],
-  "license": "GPL-3.0-only",
-  "author": "Smithtek",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "author": "Smithtek Pty Ltd",
   "homepage": "https://www.smithtek.com.au",
   "dependencies": {
     "modbus-serial": "8.0.23-no-serial-port",
@@ -42,6 +42,9 @@
     "UPSTREAM.md",
     "channel-transform.js",
     "PASSPORT-CONNECT.md",
-    "MAKO-RF.md"
+    "MAKO-RF.md",
+    "LICENSE.txt",
+    "LICENSING.md",
+    "THIRD-PARTY-NOTICES.md"
   ]
 }

package/passport-link-node.js

@@ -2,32 +2,53 @@
 module.exports=function(RED,engine){
  const mapping=import('./channel-map.mjs'),transform=require('./channel-transform');
  function PassPortLink(config){
-  RED.nodes.createNode(this,config);const node=this,states=new Set();node._makoClosed=false;let tail=Promise.resolve(),pending=0;
+  RED.nodes.createNode(this,config);const node=this,states=new Set();node._makoClosed=false;let pending=0;
   node.on('input',(msg,send,done)=>{
    send=send||node.send.bind(node);done=done||function(err){if(err)node.error(err,msg);};
-   if(pending>=16){done(Error('PassPort Connect queue full'));return;}pending++;
-   const input=RED.util.cloneMessage(msg);
-   const run=async()=>{let completed=0,total=0,writing=false;
-    try{
-     const m=await mapping;if(node._makoClosed)throw Object.assign(Error('Node closed'),{code:'ECANCELLED'});
+   let completed=0,total=0,settled=false,counted=false;
+   const writing=config.mode==='write',input=RED.util.cloneMessage(msg);
+   const item={node,req:{mode:writing?'write':'read'},...(writing?{retries:0}:{}),
+    run:async(request,check)=>{
+     const m=await mapping;check();
      const map=m.validateMap(typeof config.mapping==='string'?JSON.parse(config.mapping):config.mapping);
-     const converters=config.mode==='write'?null:transform.converters(map);
-     const operations=config.mode==='write'&&config.inputMode==='single'?m.planSingle(map,config.writeChannel,input.payload):config.mode==='write'&&config.inputMode==='named'?m.planNamed(map,input.payload):m.plan(map,config.mode||'read',input.payload);total=operations.length;writing=config.mode==='write';
-     const bus=RED.nodes.getNode(config.bus);if(!bus||!bus._makoState)throw Error('Choose a PassPort connection');states.add(bus._makoState);
+     item.req.unitid=map.unitId;
+     const converters=writing?null:transform.converters(map);
+     const operations=writing&&config.inputMode==='single'?m.planSingle(map,config.writeChannel,input.payload):writing&&config.inputMode==='named'?m.planNamed(map,input.payload):m.plan(map,config.mode||'read',input.payload);
+     total=operations.length;
      const payload=m.emptyResult(map);node.status({fill:'blue',shape:'dot',text:writing?'Writing channels':'Reading channels'});
      for(const operation of operations){
-      if(node._makoClosed)throw Object.assign(Error('Node closed'),{code:'ECANCELLED'});
-      const res=await new Promise((resolve,reject)=>engine.enqueue(bus._makoState,{node,req:operation.req,...(writing?{retries:0}:{}),complete:(err,value)=>err?reject(err):resolve(value)}));
+      check();const res=await request(operation.req);check();
       if(!writing)m.applyRead(payload,operation.group,res&&res.data);completed++;
      }
-     if(node._makoClosed)throw Object.assign(Error('Node closed'),{code:'ECANCELLED'});
-     const output={...input,payload:writing?input.payload:m.prefixValues(transform.apply(m.namedValues(map,payload),converters),config.prefix),...(!writing?{channels:payload,ts:Date.now()}:{}),passport:{ok:true,source:config.bus+':'+map.unitId,unitId:map.unitId,mode:config.mode||'read',completed,total}};
-     send([output,null]);node.status({fill:'green',shape:'dot',text:'ID '+map.unitId+' complete'});done();
-    }catch(err){if(!node._makoClosed){node.status({fill:'red',shape:'ring',text:err.message});send([null,{...input,payload:{ok:false,error:err.message,completed,total,writeMayHaveApplied:writing&&total>0},passport:{ok:false}}]);}done(err);}
+     check();
+     return {...input,payload:writing?input.payload:m.prefixValues(transform.apply(m.namedValues(map,payload),converters),config.prefix),...(!writing?{channels:payload,ts:Date.now()}:{}),passport:{ok:true,source:config.bus+':'+map.unitId,unitId:map.unitId,mode:config.mode||'read',completed,total}};
+    },
+    complete:(err,output)=>{
+     if(settled)return;settled=true;if(counted)pending--;
+     try{
+      if(!node._makoClosed){
+       if(err){
+        node.status({fill:'red',shape:'ring',text:err.message});
+        const code=err.code||'ECOMM';
+        send([null,{...input,payload:{ok:false,error:err.message,code,completed,total,writeMayHaveApplied:writing&&(!!item.writeMayHaveApplied||completed>0)},passport:{ok:false,code}}]);
+       }else{send([output,null]);node.status({fill:'green',shape:'dot',text:'ID '+item.req.unitid+' complete'});}
+      }
+     }catch(e){err=e;}
+     done(err||undefined);
+    }
    };
-   tail=tail.then(run,run).finally(()=>{pending--;});
+   try{
+    const bus=RED.nodes.getNode(config.bus);if(!bus||!bus._makoState)throw Error('Choose a PassPort connection');
+    const state=bus._makoState;states.add(state);
+    const unavailable=engine.available(state);
+    if(unavailable){item.complete(unavailable);return;}
+    // Preserve the existing per-node bound. Accepted messages now live in the
+    // shared FIFO, so a bus reset also cancels every pending PPC read/write.
+    if(pending>=16){done(Object.assign(Error('PassPort Connect queue full'),{code:'EQUEUEFULL'}));return;}
+    pending++;counted=true;engine.enqueue(state,item);
+   }catch(err){item.complete(err);}
   });
-  node.on('close',(_removed,done)=>{node._makoClosed=true;states.forEach(state=>engine.detach(state,node));tail.finally(()=>{node.status({});done();});});
+  node.on('close',(_removed,done)=>{node._makoClosed=true;states.forEach(state=>engine.detach(state,node));states.clear();node.status({});done();});
  }
  RED.nodes.registerType('smithtek-passport-link',PassPortLink);
-};
+};