homebridge-smartsystem 6.3.4 → 6.4.1

package/README.md

@@ -245,42 +245,46 @@ Homebridge UI version
  added "restart plugin" to settings, 
  set lock target state to "locked"
 
- ### v6.1.0 - 15-07-2022
- - global debug, log, err functions in types.ts
- - split smappee.ts in PowerBase + smappee/p1/shelly
-
- ### v6.1.x - 21-07-2022 - P1 release
- - 0: implemented P1 power meter telegram
- - 1: bugfixes, timeout mgt, etc...
- - 2: try fixing logfunction errors
- - 3: reverting to console.log
- - 4: errors when starting power mgrs from platform.ts
- - 5: v6.1.3 changes were gone... restored them.
- - 6: added login with pw in config + http.get with on-error
- - 6: allow + and - in power rules expressions
- - 7: allow NaN in bindings compare for update
+### v6.1.0 - 15-07-2022
+- global debug, log, err functions in types.ts
+- split smappee.ts in PowerBase + smappee/p1/shelly
+
+### v6.1.x - 21-07-2022 - P1 release
+- 0: implemented P1 power meter telegram
+- 1: bugfixes, timeout mgt, etc...
+- 2: try fixing logfunction errors
+- 3: reverting to console.log
+- 4: errors when starting power mgrs from platform.ts
+- 5: v6.1.3 changes were gone... restored them.
+- 6: added login with pw in config + http.get with on-error
+- 6: allow + and - in power rules expressions
+- 7: allow NaN in bindings compare for update
 
 ### v6.2.0 - 10-08-2022 - fully use Homebridge UI (login, config)
- - receive config through Platform on startup, 
- - moved all config to global variable, keep in sync through API of HB-UI
- - implemented login page, use HB-UI api -> bearer jwt token
- - added upgrade method from 6.1.x to v6.2.x (adding files from /home/homebridge/duotecno/config.*.json to global config.*)
- - homebridge config is saved by UI in: /var/lib/homebridge/config.json (as well as the logfile: homebridge.log)
- - smartapp calls Homebridge UI API to save changes
-
- ### v6.2.x - 11-08-2022 - P1 release
- - 1: always write config to file too (next to sending through the HB-UI API)
- - 2: added headers to http calls from switches, dimmers and up/down's (including OH stuff)
- - 3: fixed bug in Sanitizer of UnitConfig preventing from publishing units to homebridge
- - 4: fixed empty name bug in unit-def / new accessory()
- - 5: fixed bad displayNames in published units
- - 6: power: 5% instead of 10% for power rules
-
- ### v6.3.x - 23-09-2022 - Shelly PM release
- - 1: first test Shelly PM - allow address or addresses, example: "192.168.0.95,102.168.0.96"
- - 2: logging now more according to debug true/false in the config file
- - 3: power bindings now when: 5% change < 1000W, 2% change > 1000W
- - 4: added if in set-plug if smappee not (yet) connected.
+- receive config through Platform on startup, 
+- moved all config to global variable, keep in sync through API of HB-UI
+- implemented login page, use HB-UI api -> bearer jwt token
+- added upgrade method from 6.1.x to v6.2.x (adding files from /home/homebridge/duotecno/config.*.json to global config.*)
+- homebridge config is saved by UI in: /var/lib/homebridge/config.json (as well as the logfile: homebridge.log)
+- smartapp calls Homebridge UI API to save changes
+
+### v6.2.x - 11-08-2022 - P1 release
+- 1 : always write config to file too (next to sending through the HB-UI API)
+- 2: added headers to http calls from switches, dimmers and up/down's (including OH stuff)
+- 3: fixed bug in Sanitizer of UnitConfig preventing from publishing units to homebridge
+- 4: fixed empty name bug in unit-def / new accessory()
+- 5: fixed bad displayNames in published units
+- 6: power: 5% instead of 10% for power rules
+
+### v6.3.x - 23-09-2022 - Shelly PM release
+- 1: first test Shelly PM - allow address or addresses, example: "192.168.0.95,102.168.0.96"
+- 2: logging now more according to debug true/false in the config file
+- 3: power bindings now when: 5% change < 1000W, 2% change > 1000W
+- 4: added if in set-plug if smappee not (yet) connected.
+
+### v6.4.x - 28-11-2022 - Binding to registers
+- 0: writing to registers
+- 1: ask/show protocol version -> publish
 
 ## Hardware 
 A Raspberry Pi that connects to a Duotecno IP Node 

package/config.json

@@ -35,17 +35,17 @@
             "logicalNodeAddress": 3
           }
         ],
-        "power": 146,
-        "current": 1
+        "power": -758,
+        "current": 0
       },
       {
         "type": "power",
         "channel": "7+8+9",
-        "low": 100,
+        "low": 500,
         "high": 10000,
         "actions": [
           {
-            "name": "",
+            "name": "Blue LED",
             "value": false,
             "masterAddress": "192.168.0.97",
             "masterPort": 5001,
@@ -53,7 +53,7 @@
             "logicalNodeAddress": 3
           },
           {
-            "name": "",
+            "name": "Blue LED",
             "value": true,
             "masterAddress": "192.168.0.97",
             "masterPort": 5001,
@@ -61,16 +61,14 @@
             "logicalNodeAddress": 3
           },
           {
-            "name": "0;0",
+            "name": "--",
             "value": true,
             "masterAddress": "192.168.0.97",
             "masterPort": 5001,
             "logicalAddress": 0,
             "logicalNodeAddress": 0
           }
-        ],
-        "power": 446,
-        "current": 1
+        ]
       },
       {
         "type": "power",
@@ -102,55 +100,37 @@
             "logicalAddress": 0,
             "logicalNodeAddress": 0
           }
-        ]
+        ],
+        "power": 266,
+        "current": 0
       }
     ],
-    "address": "192.168.0.184",
+    "address": "192.168.0.183",
     "uid": "57e3e0d8-bb05-4b04-8662-1a9871998f3f",
     "bindings": [
       {
-        "logicalNodeAddress": 252,
-        "logicalAddress": 102,
+        "channel": "0+1",
         "masterAddress": "192.168.0.97",
         "masterPort": 5001,
-        "name": "unit 252:102",
-        "displayName": "unit 252:102",
-        "extendedType": 0,
-        "channel": "0+1",
-        "power": 1706
+        "register": 1
       },
       {
-        "logicalNodeAddress": 252,
-        "logicalAddress": 100,
+        "channel": "2+3",
         "masterAddress": "192.168.0.97",
         "masterPort": 5001,
-        "name": "unit 252:100",
-        "displayName": "unit 252:100",
-        "extendedType": 0,
-        "channel": "2+3",
-        "power": 2494
+        "register": 2
       },
       {
-        "logicalNodeAddress": 252,
-        "logicalAddress": 103,
+        "channel": "4+5",
         "masterAddress": "192.168.0.97",
         "masterPort": 5001,
-        "name": "unit 252:103",
-        "displayName": "unit 252:103",
-        "extendedType": 0,
-        "channel": "4+5",
-        "power": null
+        "register": 7
       },
       {
-        "logicalNodeAddress": 252,
-        "logicalAddress": 101,
+        "channel": "8",
         "masterAddress": "192.168.0.97",
         "masterPort": 5001,
-        "name": "unit 252:101",
-        "displayName": "unit 252:101",
-        "extendedType": 0,
-        "channel": "8",
-        "power": null
+        "register": 8
       }
     ]
   },
@@ -159,36 +139,33 @@
     "rules": [],
     "bindings": [
       {
-        "logicalNodeAddress": 252,
-        "logicalAddress": 102,
+        "channel": "0+1+2",
         "masterAddress": "192.168.0.97",
         "masterPort": 5001,
-        "name": "unit 252:102",
-        "displayName": "unit 252:102",
-        "extendedType": 0,
-        "channel": "0+1+2",
-        "power": null
+        "register": 11
       },
       {
-        "logicalNodeAddress": 252,
-        "logicalAddress": 100,
+        "channel": "3+4+5",
         "masterAddress": "192.168.0.97",
         "masterPort": 5001,
-        "name": "unit 252:100",
-        "displayName": "unit 252:100",
-        "extendedType": 0,
-        "channel": "3+4+5",
-        "power": null
+        "register": 12
       }
     ],
-    "address": "192.168.0.207"
+    "address": "192.168.0.206"
   },
   "shelly": {
     "debug": false,
     "address": "192.168.0.95",
     "addresses": "192.168.0.95,192.168.0.95",
     "rules": [],
-    "bindings": []
+    "bindings": [
+      {
+        "channel": "0+1+2+3+4+5+6+7+8",
+        "masterAddress": "192.168.0.97",
+        "masterPort": 5001,
+        "register": 5
+      }
+    ]
   },
   "smartapp": {
     "apiPort": 8581,
@@ -310,6 +287,21 @@
           "252": " 20211003"
         },
         "debug": false
+      },
+      {
+        "address": "192.168.0.5",
+        "port": 5005,
+        "password": "duotecno",
+        "name": "GM",
+        "active": true,
+        "nodenames": {
+          "3": "IP Server",
+          "4": "Sonos",
+          "16": "Smartbox Living",
+          "17": "Switch Living",
+          "252": " 20220925"
+        },
+        "debug": false
       }
     ],
     "cunits": [
@@ -450,7 +442,7 @@
       "units": []
     }
   ],
-  "debug": false,
+  "debug": true,
   "settings": {
     "network": {
       "ip1": "1.2.3.4",

package/duotecno/master.js

@@ -134,6 +134,9 @@ class Master extends base_1.Base {
     */
     constructor(system, config) {
         super("master", types_1.Sanitizers.masterConfig(config));
+        this.protocol = 0; // major * 100 + minor
+        this.version = 0; // idem
+        this.registers = {};
         this.resolveLogin = null;
         this.Q = new Q_1.Q();
         // save my eco system
@@ -150,6 +153,9 @@ class Master extends base_1.Base {
         this.closing = false;
         // incoming data
         this.buffer = "";
+        // init to v1.00
+        this.version = 100;
+        this.protocol = 100;
     }
     getName() {
         return this.config.name || "master";
@@ -360,8 +366,8 @@ class Master extends base_1.Base {
             return false;
         }
         else {
-            if ((next.cmd != protocol_1.Rec.TimeDateStatus) &&
-                (next.cmd != protocol_1.Rec.Sensor))
+            // don't log all incoming (no time, no sensor status messages)
+            if ((next.cmd != protocol_1.Rec.TimeDateStatus) && (next.cmd != protocol_1.Rec.Sensor))
                 this.info("received -> " + (0, protocol_1.recName)(next.cmd) + " -> " + ((!next.message) ?
                     "--" : ((next.message instanceof Array) ? next.message.join(",") : next.message)));
             this.Q.do();
@@ -384,6 +390,12 @@ class Master extends base_1.Base {
             else if (next.cmd === protocol_1.Rec.ScheduleStatus) {
                 this.receiveSchedule(next.message);
             }
+            else if (next.cmd === protocol_1.Rec.NodeMgtInfo) {
+                this.receiveNodeMgtInfo(next.message);
+            }
+            else if (next.cmd === protocol_1.Rec.Register) {
+                this.receiveRegister(next.message);
+            }
             else {
                 this.info("not handled: " + next.message);
             }
@@ -398,6 +410,10 @@ class Master extends base_1.Base {
         if (this.resolveLogin) {
             this.resolveLogin(this.isLoggedIn);
             this.resolveLogin = null;
+            // if logged in, ask protocol version
+            if (this.isLoggedIn) {
+                this.send(protocol_1.Protocol.buildRequestNodeMgt(protocol_1.reqNodeAttributes.nodeProtocol));
+            }
         }
         else {
             this.err("unexpected ConnectStatus ?");
@@ -406,7 +422,45 @@ class Master extends base_1.Base {
     ///////////////////
     // Info messages //
     ///////////////////
-    receiveHeartbeat(next) {
+    receiveNodeMgtInfo(message) {
+        if (message[1] === protocol_1.reqNodeAttributes.isMaster) {
+            this.log("NodeMgtInfo - master " + this.getName() + " is set to master: " + message[2]);
+        }
+        else if (message[1] === protocol_1.reqNodeAttributes.nodeInfo) {
+            // should be the same as the one from the DBInfo (64)
+            this.log("NodeMgtInfo - node info for " + this.getName() + ": " + message);
+        }
+        else if (message[1] === protocol_1.reqNodeAttributes.masterSupported) {
+            this.log("NodeMgtInfo - master " + this.getName() + " can be master: " + message[2]);
+        }
+        else if (message[1] === protocol_1.reqNodeAttributes.nodeVersion) {
+            console.log("*** -> " + message);
+            this.log("NodeMgtInfo - version " + this.getName() + ", version: " + message[2] + "." + message[3]);
+            this.version = message[2] * 100 + message[3];
+            //BUG - TODO: remove
+            this.protocol = message[2] * 100 + message[3];
+        }
+        else if (message[1] === protocol_1.reqNodeAttributes.nodeProtocol) {
+            console.log("*** -> " + message);
+            this.log("NodeMgtInfo - protocol " + this.getName() + ", protocol: " + message[2] + "." + message[3]);
+            this.protocol = message[2] * 100 + message[3];
+        }
+        else {
+            this.err("dropped NodeMgtInfo info message = " + message[1] + ", message: " + message);
+        }
+    }
+    receiveRegister(message) {
+        const register = protocol_1.Protocol.makeWord(message, 2);
+        const value = protocol_1.Protocol.makeSigned(message, 4);
+        if ((register >= 0) && (register < 1024)) {
+            this.registers[register] = value;
+            this.log("receiveRegister(" + register + ") = " + value);
+        }
+        else {
+            this.err("Received register out of bound: " + register);
+        }
+    }
+    receiveHeartbeat(message) {
         this.lastHeartbeat = new Date().getTime();
         //console.log("*HB* Received HB");
         this.log("Received heartbeat at " + (new Date()));
@@ -486,6 +540,9 @@ class Master extends base_1.Base {
         }
         this.system.setActiveState(unit);
     }
+    //////////////////
+    // request info //
+    //////////////////
     fetchAllUnits(node) {
         return __awaiter(this, void 0, void 0, function* () {
             for (let unitInx = 0; unitInx < node.nrUnits; unitInx++) {
@@ -694,6 +751,20 @@ class Master extends base_1.Base {
             this.info("get value of " + unit.node.getName() + "-" + unit.getName());
         });
     }
+    requestRegisterValue(register) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.version >= 209) {
+                yield this.send(protocol_1.Protocol.buildRegister(register));
+                this.info("request register: " + register);
+            }
+            else {
+                this.err("FC_REGISTERMAP not available before protocol v2.09");
+            }
+        });
+    }
+    /////////////////////
+    // Settings values //
+    /////////////////////
     setUnitStatus(unit, value) {
         return __awaiter(this, void 0, void 0, function* () {
             const params = protocol_1.Protocol.buildSetCmd(unit.node, unit, value);
@@ -702,6 +773,17 @@ class Master extends base_1.Base {
             }
         });
     }
+    setRegisterValue(register, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.version >= 209) {
+                yield this.send(protocol_1.Protocol.buildRegister(register, value));
+                this.info("set register: " + register + ", to: " + value);
+            }
+            else {
+                this.err("FC_REGISTERMAP not available before protocol v2.09");
+            }
+        });
+    }
     setSensorValue(unit, value) {
         return __awaiter(this, void 0, void 0, function* () {
             this.info("SetSensorValue of " + unit.node.logicalAddress + "/" + unit.logicalAddress + " to " + value);

package/duotecno/master.ts

@@ -1,4 +1,4 @@
-import { Node, Protocol, Unit, recName, Rec, TempPreset } from "./protocol";
+import { Node, Protocol, Unit, recName, Rec, TempPreset, reqNodeAttributes } from "./protocol";
 import { MasterConfig, WriteError, CommRecord, Message, Sanitizers } from "./types";
 import { log, debug } from "./logger";
 import { System } from "./system";
@@ -15,6 +15,10 @@ export class Master extends Base {
   public schedule: number;
   public date: Date;
   public lastHeartbeat: number;
+  public protocol: number = 0;  // major * 100 + minor
+  public version: number = 0;   // idem
+
+  public registers: {[register: number]: number} = {};
 
   public isOpen: boolean;
   public isLoggedIn: boolean;
@@ -166,6 +170,10 @@ export class Master extends Base {
   
     // incoming data
     this.buffer = "";
+
+    // init to v1.00
+    this.version = 100;
+    this.protocol = 100;
   }
 
   getName() {
@@ -398,8 +406,8 @@ export class Master extends Base {
       return false;
 
     } else {
-      if ((next.cmd != Rec.TimeDateStatus) &&
-          (next.cmd != Rec.Sensor))
+      // don't log all incoming (no time, no sensor status messages)
+      if ((next.cmd != Rec.TimeDateStatus) && (next.cmd != Rec.Sensor))
         this.info("received -> " + recName(next.cmd) + " -> " + ((!next.message) ? 
           "--" : ((next.message instanceof Array) ? next.message.join(",") : next.message)));
 
@@ -423,6 +431,12 @@ export class Master extends Base {
       
       } else if (next.cmd === Rec.ScheduleStatus) {
         this.receiveSchedule(next.message);
+      
+      } else if (next.cmd === Rec.NodeMgtInfo) {
+        this.receiveNodeMgtInfo(next.message);
+
+      } else if (next.cmd === Rec.Register) {
+        this.receiveRegister(next.message);
 
       } else {
         this.info("not handled: " + next.message);
@@ -442,6 +456,12 @@ export class Master extends Base {
     if (this.resolveLogin) {
       this.resolveLogin(this.isLoggedIn);
       this.resolveLogin = null;
+
+      // if logged in, ask protocol version
+      if (this.isLoggedIn) {
+        this.send(Protocol.buildRequestNodeMgt(reqNodeAttributes.nodeProtocol));
+      }
+
     } else {
       this.err("unexpected ConnectStatus ?");
     }
@@ -451,7 +471,48 @@ export class Master extends Base {
   // Info messages //
   ///////////////////
 
-  receiveHeartbeat(next: Message) {
+  receiveNodeMgtInfo(message: Message) {
+    if (message[1] === reqNodeAttributes.isMaster) {
+      this.log("NodeMgtInfo - master " + this.getName() + " is set to master: " + message[2]);
+
+    } else if (message[1] === reqNodeAttributes.nodeInfo) {
+      // should be the same as the one from the DBInfo (64)
+      this.log("NodeMgtInfo - node info for " + this.getName() + ": " + message);
+
+    } else if (message[1] === reqNodeAttributes.masterSupported) {
+      this.log("NodeMgtInfo - master " + this.getName() + " can be master: " + message[2]);
+
+    } else if (message[1] === reqNodeAttributes.nodeVersion) {
+      console.log("*** -> " + message);
+      this.log("NodeMgtInfo - version " + this.getName() + ", version: " + message[2] + "." + message[3]);
+      this.version = message[2] * 100 + message[3];
+      //BUG - TODO: remove
+      this.protocol = message[2] * 100 + message[3];
+
+    } else if (message[1] === reqNodeAttributes.nodeProtocol) {
+      console.log("*** -> " + message);
+      this.log("NodeMgtInfo - protocol " + this.getName() + ", protocol: " + message[2] + "." + message[3]);
+      this.protocol = message[2] * 100 + message[3];
+
+
+    } else {
+      this.err("dropped NodeMgtInfo info message = " + message[1] + ", message: " + message);
+    }
+  }
+
+  receiveRegister(message: Message) {
+    const register = Protocol.makeWord(message, 2);
+    const value = Protocol.makeSigned(message, 4);
+
+    if ((register >=0) && (register < 1024)) {
+      this.registers[register] = value;
+      this.log("receiveRegister(" + register + ") = " + value);
+    } else {
+      this.err("Received register out of bound: " + register);
+    }
+  }
+
+  receiveHeartbeat(message: Message) {
     this.lastHeartbeat = new Date().getTime();
     //console.log("*HB* Received HB");
     this.log("Received heartbeat at " + (new Date()));
@@ -478,6 +539,7 @@ export class Master extends Base {
     this.info("received week schedule = " + this.schedule);
   }
 
+
   receiveDateTime(message: Message) {
     // 71,0,9,37,3,3,4,3,21,20 -> 09:37:03 Wednesday(3) 4 march 2120
     this.date = new Date( (message[8]-1) * 100 + message[9], message[7]-1, message[6], 
@@ -540,7 +602,9 @@ export class Master extends Base {
     this.system.setActiveState(unit);
   }
 
-
+  //////////////////
+  // request info //
+  //////////////////
   async fetchAllUnits(node: Node) {
     for (let unitInx=0; unitInx < node.nrUnits; unitInx++) {
       await this.fetchUnit(node, unitInx);
@@ -755,6 +819,18 @@ export class Master extends Base {
     this.info("get value of " + unit.node.getName() + "-" + unit.getName());
   }
 
+  async requestRegisterValue(register: number) {
+    if (this.version >= 209) {
+      await this.send(Protocol.buildRegister(register));
+      this.info("request register: " + register);
+    } else {
+      this.err("FC_REGISTERMAP not available before protocol v2.09")
+    }
+  }
+
+  /////////////////////
+  // Settings values //
+  /////////////////////
   async setUnitStatus(unit: Unit, value: number) {
     const params = Protocol.buildSetCmd(unit.node, unit, value);
     if (params.cmd) {
@@ -762,6 +838,15 @@ export class Master extends Base {
     }
   }
 
+  async setRegisterValue(register: number, value: number) {
+    if (this.version >= 209) {
+      await this.send(Protocol.buildRegister(register, value));
+      this.info("set register: " + register + ", to: " + value);
+    } else {
+      this.err("FC_REGISTERMAP not available before protocol v2.09")
+    }
+  }
+
   async setSensorValue(unit: Unit, value: number) {
     this.info("SetSensorValue of " + unit.node.logicalAddress + "/" + unit.logicalAddress + " to " + value);
     await this.send(Protocol.buildSetPreset(unit.node, unit, TempPreset.sun, Math.trunc(value / 100 / 100 / 100) % 100));
@@ -798,5 +883,4 @@ export class Master extends Base {
     this.info("set temp preset of " + unit.node.getName() + "-" + unit.getName() + ": " + (inc ? "up" : "down"));
   }
 
-
 }