node-red-contrib-antenna-genius 0.2.3-beta → 0.2.7-beta

package/antenna-genius-band-labels.js

@@ -3,43 +3,49 @@ module.exports = (RED) => {
         constructor(config) {
             RED.nodes.createNode(this, config);
 
-            var node = this;
+            let node = this;
             this.bandNameA = "";
             this.bandNameB = "";
             this.server = RED.nodes.getNode(config.server);
 
             this.server.updatesEventEmitter.on("connected", () => {
-                if(this.server.info.name) {
-                    this.status({ fill: "green", shape: "dot", text: this.server.info.name });
+                if (this.server.info.name) {
+                    this.status({
+                        fill: "green",
+                        shape: "dot",
+                        text: this.server.info.name,
+                    });
                 }
             });
 
-            this.server.updatesEventEmitter.on('closed', () => {
-                this.status({ fill: "red", shape: "ring", text: "disconnected" });
+            this.server.updatesEventEmitter.on("closed", () => {
+                this.status({
+                    fill: "red",
+                    shape: "ring",
+                    text: "disconnected",
+                });
             });
 
-            this.server.updatesEventEmitter.on("status", () => {
+            this.server.updatesEventEmitter.on("status", (forceUpdate) => {
                 let bandIndexA = this.server.status.portA_band;
                 let bandIndexB = this.server.status.portB_band;
 
-                if(bandIndexA === undefined || bandIndexB === undefined) {
+                if (bandIndexA === undefined || bandIndexB === undefined) {
                     return;
                 }
 
-                if(bandIndexA < 0 || bandIndexA >= this.server.bands.length)
-                {
+                if (bandIndexA < 0 || bandIndexA >= this.server.bands.length) {
                     return;
                 }
 
-                if(bandIndexB < 0 || bandIndexB >= this.server.bands.length)
-                {
+                if (bandIndexB < 0 || bandIndexB >= this.server.bands.length) {
                     return;
                 }
 
-                let bandNameA = this.server.bands[bandIndexA].band_name;
-                let bandNameB = this.server.bands[bandIndexB].band_name;
+                let bandNameA = this.server.bands[bandIndexA].name;
+                let bandNameB = this.server.bands[bandIndexB].name;
 
-                let changed = true;
+                let changed = forceUpdate;
                 if (bandNameA !== this.bandNameA) {
                     changed = true;
                     this.bandNameA = bandNameA;
@@ -49,13 +55,30 @@ module.exports = (RED) => {
                     this.bandNameB = bandNameB;
                 }
                 if (changed) {
-                    node.send({ payload: { bandLabelA: bandNameA, bandLabelB: bandNameB } });
-                    this.status({ fill: "green", shape: "dot", text: this.server.info.name + " - " + bandNameA + "/" + bandNameB });
+                    node.send({
+                        payload: {
+                            bandLabelA: bandNameA,
+                            bandLabelB: bandNameB,
+                        },
+                    });
+                    this.status({
+                        fill: "green",
+                        shape: "dot",
+                        text:
+                            this.server.info.name +
+                            " - " +
+                            bandNameA +
+                            "/" +
+                            bandNameB,
+                    });
                 }
             });
 
             this.server.connect();
         }
     }
-    RED.nodes.registerType("antenna-genius-band-labels", AntennaGeniusBandLabels);
-}
+    RED.nodes.registerType(
+        "antenna-genius-band-labels",
+        AntennaGeniusBandLabels
+    );
+};

package/antenna-genius-server.html

@@ -1,41 +1,55 @@
 <script type="text/javascript">
-    RED.nodes.registerType('antenna-genius-server',{
-        category: 'config',
-        color: '#FFF0F0',
+    RED.nodes.registerType("antenna-genius-server", {
+        category: "config",
+        color: "#FFF0F0",
         defaults: {
-            host: {value:"localhost",required:true},
-            port: {value:9007,required:true,validate:RED.validators.number()},
-            disabledColor: {value:"Black", required:true},
-            activeColor: {value:"Green", required:true},
-            selectedColor: {value:"Blue", required:true},
-            autoConnect: {value:true},
+            host: { value: "localhost", required: true },
+            port: {
+                value: 9007,
+                required: true,
+                validate: RED.validators.number(),
+            },
+            disabledColor: { value: "Black", required: true },
+            activeColor: { value: "Green", required: true },
+            selectedColor: { value: "Blue", required: true },
+            autoConnect: { value: true },
         },
-        label: function() {
+        label: function () {
             return "antenna genius at " + this.host + ":" + this.port;
-        }
+        },
     });
 </script>
 
 <script type="text/html" data-template-name="antenna-genius-server">
     <div class="form-row">
-        <label for="node-config-input-host"><i class="fa fa-bookmark"></i> Host</label>
-        <input type="text" id="node-config-input-host">
+        <label for="node-config-input-host"
+            ><i class="fa fa-bookmark"></i> Host</label
+        >
+        <input type="text" id="node-config-input-host" />
     </div>
     <div class="form-row">
-        <label for="node-config-input-port"><i class="fa fa-bookmark"></i> Port</label>
-        <input type="text" id="node-config-input-port">
+        <label for="node-config-input-port"
+            ><i class="fa fa-bookmark"></i> Port</label
+        >
+        <input type="text" id="node-config-input-port" />
     </div>
     <div class="form-row">
-        <label for="node-config-input-disabledColor"><i class="fa fa-bookmark"></i> Disabled Background</label>
-        <input type="text" id="node-config-input-disabledColor">
+        <label for="node-config-input-disabledColor"
+            ><i class="fa fa-bookmark"></i> Disabled Background</label
+        >
+        <input type="text" id="node-config-input-disabledColor" />
     </div>
     <div class="form-row">
-        <label for="node-config-input-activeColor"><i class="fa fa-bookmark"></i> Active Background</label>
-        <input type="text" id="node-config-input-activeColor">
+        <label for="node-config-input-activeColor"
+            ><i class="fa fa-bookmark"></i> Active Background</label
+        >
+        <input type="text" id="node-config-input-activeColor" />
     </div>
     <div class="form-row">
-        <label for="node-config-input-selectedColor"><i class="fa fa-bookmark"></i> Selected Background</label>
-        <input type="text" id="node-config-input-selectedColor">
+        <label for="node-config-input-selectedColor"
+            ><i class="fa fa-bookmark"></i> Selected Background</label
+        >
+        <input type="text" id="node-config-input-selectedColor" />
     </div>
 </script>
 

package/antenna-genius-server.js

@@ -1,7 +1,7 @@
-const Net = require('net');
-const {PromiseSocket} = require("promise-socket");
-const EventEmitter = require('events');
-const Utils = require('./Utils');
+const Net = require("net");
+const { PromiseSocket } = require("promise-socket");
+const EventEmitter = require("events");
+const Utils = require("./Utils");
 
 class UpdatesEventEmitter extends EventEmitter {}
 
@@ -22,6 +22,7 @@ module.exports = (RED) => {
             this.bands = [];
             this.interval = null;
             this.timer = null;
+            this.refresh = -1;
 
             this.updatesEventEmitter = new UpdatesEventEmitter();
             this.updatesEventEmitter.setMaxListeners(0);
@@ -29,30 +30,34 @@ module.exports = (RED) => {
             this.client = new Net.Socket();
             this.connected = false;
 
-            this.client.on('close', () => {
-                this.log('TCP connection disconnected with the server.');
+            this.client.on("close", () => {
+                this.log("TCP connection disconnected with the server.");
                 clearInterval(this.interval);
                 clearTimeout(this.timer);
 
-                if(this.updatesEventEmitter.listenerCount('closed') == 0) {
-                    this.log('Stop retrying. No nodes are refering this connection anymore.');
+                if (this.updatesEventEmitter.listenerCount("closed") == 0) {
+                    this.log(
+                        "Stop retrying. No nodes are refering this connection anymore."
+                    );
                     return;
                 }
 
-                if(this.autoConnect) {
-                    this.log('TCP connection failed with the server. Will try to reconnect in 5 seconds');
+                if (this.autoConnect) {
+                    this.log(
+                        "TCP connection failed with the server. Will try to reconnect in 5 seconds"
+                    );
                     this.timer = setTimeout(() => {
-                        this.log('Reconnecting...');
+                        this.log("Reconnecting...");
                         this.connect();
                     }, 5000);
                     this.updatesEventEmitter.emit("closed");
                 }
             });
 
-            this.client.on('connect', async () => {
-                this.log('TCP connection established with the server.');
+            this.client.on("connect", async () => {
+                this.log("TCP connection established with the server.");
                 this.connected = true;
-    
+
                 const promiseClient = new PromiseSocket(this.client);
 
                 let command = Utils.encode(0, 0, 401, 0, "");
@@ -65,7 +70,7 @@ module.exports = (RED) => {
                 packet = await promiseClient.read();
                 this.info = Utils.decode(packet);
 
-                var numAntennas = 8 * this.status.stackReach;
+                let numAntennas = 8 * this.status.stackReach;
                 for (let index = 1; index <= numAntennas; ++index) {
                     let command = Utils.encode(0, 0, 412, 0, index.toString());
                     await promiseClient.write(command);
@@ -84,11 +89,18 @@ module.exports = (RED) => {
                 }
                 this.updatesEventEmitter.emit("bands");
 
-                this.client.on('data', (packet) => {
+                this.client.on("data", (packet) => {
                     let decoded = Utils.decode(packet);
-                    if(decoded.command == 401) {
-                        this.status = { ...this.status, ...Utils.decode(packet) };
-                        this.updatesEventEmitter.emit("status");
+                    if (decoded.command == 401) {
+                        this.status = {
+                            ...this.status,
+                            ...Utils.decode(packet),
+                        };
+                        this.refresh = (this.refresh + 1) % 1500;
+                        this.updatesEventEmitter.emit(
+                            "status",
+                            this.refresh == 0
+                        );
                     }
                 });
 
@@ -98,29 +110,35 @@ module.exports = (RED) => {
                     this.client.write(command);
                 }, 400);
 
+                this.forceUpdate();
                 this.updatesEventEmitter.emit("connected");
-            })
+            });
 
-            this.client.on('error', (err) => {
+            this.client.on("error", (err) => {
                 this.warn(err);
             });
 
-            this.on('close', (done) => {
+            this.on("close", (done) => {
                 clearInterval(this.interval);
                 clearTimeout(this.timer);
                 this.autoConnect = false;
                 this.connected = false;
                 this.client.end();
+                this.forceUpdate();
                 done();
             });
         }
 
         connect() {
-            if(this.autoConnect && !this.connected & !this.client.connecting) {
+            if (this.autoConnect && !this.connected & !this.client.connecting) {
                 this.client.connect(this.port, this.host);
             }
         }
+
+        forceUpdate() {
+            this.refresh = -1;
+        }
     }
 
-    RED.nodes.registerType("antenna-genius-server",AntennaGeniusServerNode);
-}
+    RED.nodes.registerType("antenna-genius-server", AntennaGeniusServerNode);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-antenna-genius",
-  "version": "0.2.3-beta",
+  "version": "0.2.7-beta",
   "description": "Antenna Genius Control and Monitoring Nodes",
   "keywords": [
     "node-red"

package/test/Utils.spec.js

@@ -0,0 +1,141 @@
+const { encode, decode } = require("../Utils.js");
+
+describe("Utils", () => {
+    it("should encode null input gracefully", (done) => {
+        let data = encode();
+        expect(data).toBeDefined();
+        expect(data).toBe("!0007!000000!");
+        done();
+    });
+
+    it("should encode input correctly", (done) => {
+        let data = encode(7, 3, 4095, 31, "1");
+        expect(data).toBeDefined();
+        expect(data).toBe("!0008!fffffc!1");
+        done();
+    });
+
+    it("should decode null input gracefully", (done) => {
+        let data = decode();
+        expect(data).toBeDefined();
+        expect(data).toStrictEqual({
+            command: 0,
+            error: 0,
+            length: "0007",
+            method: 0,
+            payload: "",
+            protocol: 0,
+            revision: 0,
+        });
+        done();
+    });
+
+    it("should decode 24 input correctly", (done) => {
+        let command = encode(0, 0, 24, 0, "") + "1;2;Name";
+        let data = decode(command);
+        expect(data).toBeDefined();
+        expect(data).toStrictEqual({
+            command: 24,
+            error: 0,
+            length: "0007",
+            method: 0,
+            payload: "1;2;Name",
+            protocol: 0,
+            revision: 0,
+            identification: 1,
+            group: 2,
+            name: "Name",
+        });
+        done();
+    });
+
+    it("should decode 82 input correctly", (done) => {
+        let command = encode(0, 0, 82, 0, "") + "1;Name;2;3";
+        let data = decode(command);
+        expect(data).toBeDefined();
+        expect(data).toStrictEqual({
+            command: 82,
+            cutoff_lower: 2,
+            cutoff_upper: 3,
+            error: 0,
+            index: 1,
+            length: "0007",
+            method: 0,
+            name: "Name",
+            payload: "1;Name;2;3",
+            protocol: 0,
+            revision: 0,
+        });
+        done();
+    });
+
+    it("should decode 82 input correctly", (done) => {
+        let command = encode(0, 0, 82, 0, "") + "1;Name;2;3";
+        let data = decode(command);
+        expect(data).toBeDefined();
+        expect(data).toStrictEqual({
+            command: 82,
+            cutoff_lower: 2,
+            cutoff_upper: 3,
+            error: 0,
+            index: 1,
+            length: "0007",
+            method: 0,
+            name: "Name",
+            payload: "1;Name;2;3",
+            protocol: 0,
+            revision: 0,
+        });
+        done();
+    });
+
+    it("should decode 401 input correctly", (done) => {
+        let command =
+            encode(0, 0, 401, 0, "") + "1;2;3;4;5;6;7;8;9;10;11;12;13";
+        let data = decode(command);
+        expect(data).toBeDefined();
+        expect(data).toStrictEqual({
+            command: 401,
+            error: 0,
+            length: "0007",
+            method: 0,
+            payload: "1;2;3;4;5;6;7;8;9;10;11;12;13",
+            portA_antenna: 4,
+            portA_band: 2,
+            portA_inhibit: 3,
+            portA_mode: 1,
+            portA_profile: 5,
+            portA_tx: 6,
+            portB_antenna: 10,
+            portB_band: 8,
+            portB_inhibit: 9,
+            portB_mode: 7,
+            portB_profile: 11,
+            portB_tx: 12,
+            protocol: 0,
+            revision: 0,
+            stackReach: 13,
+        });
+        done();
+    });
+
+    it("should decode 412 input correctly", (done) => {
+        let command = encode(0, 0, 412, 0, "") + "1;Name;3;FFFF";
+        let data = decode(command);
+        expect(data).toBeDefined();
+        expect(data).toStrictEqual({
+            bands: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
+            command: 412,
+            error: 0,
+            index: 1,
+            length: "0007",
+            method: 0,
+            mode: 3,
+            name: "Name",
+            payload: "1;Name;3;FFFF",
+            protocol: 0,
+            revision: 0,
+        });
+        done();
+    });
+});

package/test/antenna-genius-activate-antenna.spec.js

@@ -4,85 +4,123 @@ const serverNode = require("../antenna-genius-server.js");
 
 const nodes = [activateAntennaNode, serverNode];
 
-describe('antenna-genius-activate-antenna Node', () => {
-  const flow = [
-    { id: "n1", type: "antenna-genius-server", name: "test name", hostname: "localhost", port: 9007, disabledColor: "Black", activeColor: "Green", selectedColor: "Blue", autoConnect: false},
-    { id: "n2", type: "antenna-genius-activate-antenna", name: "test name", server: "n1", wires:[["n3"]]},
-    { id: "n3", type: "helper" }
-  ];
+describe("antenna-genius-activate-antenna Node", () => {
+    const flow = [
+        {
+            id: "n1",
+            type: "antenna-genius-server",
+            name: "test name",
+            hostname: "localhost",
+            port: 9007,
+            disabledColor: "Black",
+            activeColor: "Green",
+            selectedColor: "Blue",
+            autoConnect: false,
+        },
+        {
+            id: "n2",
+            type: "antenna-genius-activate-antenna",
+            name: "test name",
+            server: "n1",
+            wires: [["n3"]],
+        },
+        { id: "n3", type: "helper" },
+    ];
 
-    beforeEach(() => {
-  });
+    beforeEach(() => {});
 
-  afterEach(() => {
-    helper.unload();
-  });
+    afterEach(() => {
+        helper.unload();
+    });
 
-  it('should be loaded', done => {
-    helper.load(nodes, flow, () => {
-        var n2 = helper.getNode("n2");
-        expect(n2).toBeDefined();
-        done();
-      });
-  });
-
-  it('should have properties', done => {
-    helper.load(nodes, flow, () => {
-        var n2 = helper.getNode("n2");
-        expect(n2).toHaveProperty('name', 'test name');
-        done();
-      });
-  });
+    it("should be loaded", (done) => {
+        helper.load(nodes, flow, () => {
+            let n2 = helper.getNode("n2");
+            expect(n2).toBeDefined();
+            done();
+        });
+    });
 
-  it('should not provide connected status', done => {
-    helper.load(nodes, flow, () => {
-        var n2 = helper.getNode("n2");
-        n2.server.updatesEventEmitter.emit("connected");
-        expect(n2.status.notCalled).toBeTruthy();
-        done();
-      });
-  });
+    it("should have properties", (done) => {
+        helper.load(nodes, flow, () => {
+            let n2 = helper.getNode("n2");
+            expect(n2).toHaveProperty("name", "test name");
+            done();
+        });
+    });
 
-  it('should provide connected status', done => {
-    helper.load(nodes, flow, () => {
-        var n2 = helper.getNode("n2");
-        n2.server.info = { name: "Name" };
-        n2.server.updatesEventEmitter.emit("connected");
-        expect(n2.status.calledOnceWithExactly({ fill: "green", shape: "dot", text: "Name" })).toBeTruthy();
-        done();
-      });
-  });
+    it("should not provide connected status", (done) => {
+        helper.load(nodes, flow, () => {
+            let n2 = helper.getNode("n2");
+            n2.server.updatesEventEmitter.emit("connected");
+            expect(n2.status.notCalled).toBeTruthy();
+            done();
+        });
+    });
 
-  it('should provide disconnected status', done => {
-    helper.load(nodes, flow, () => {
-        var n2 = helper.getNode("n2");
-        n2.server.info = { name: "Name" };
-        n2.server.updatesEventEmitter.emit("closed");
-        expect(n2.status.calledOnceWithExactly({ fill: "red", shape: "ring", text: "disconnected" })).toBeTruthy();
-        done();
-      });
-  });
+    it("should provide connected status", (done) => {
+        helper.load(nodes, flow, () => {
+            let n2 = helper.getNode("n2");
+            n2.server.info = { name: "Name" };
+            n2.server.updatesEventEmitter.emit("connected");
+            expect(
+                n2.status.calledOnceWithExactly({
+                    fill: "green",
+                    shape: "dot",
+                    text: "Name",
+                })
+            ).toBeTruthy();
+            done();
+        });
+    });
 
-  it('should provide for invalid input', done => {
-    helper.load(nodes, flow, () => {
-        var n2 = helper.getNode("n2");
-        n2.server.info = { name: "Name" };
-        n2.receive({ payload: true });
-        n2.on("call:status", call => {
-          expect(n2.status.calledOnceWithExactly({ fill: "red", shape: "ring", text: "topic is not set" })).toBeTruthy();
-          done();
+    it("should provide disconnected status", (done) => {
+        helper.load(nodes, flow, () => {
+            let n2 = helper.getNode("n2");
+            n2.server.info = { name: "Name" };
+            n2.server.updatesEventEmitter.emit("closed");
+            expect(
+                n2.status.calledOnceWithExactly({
+                    fill: "red",
+                    shape: "ring",
+                    text: "disconnected",
+                })
+            ).toBeTruthy();
+            done();
         });
-      });
-  });
+    });
 
-  it('should provide for valid input', done => {
-    helper.load(nodes, flow, () => {
-        var n2 = helper.getNode("n2");
-        n2.server.info = { name: "Name" };
-        n2.receive({ payload: true, topic: "1;1" });
-        expect(n2.status.calledOnceWithExactly({ fill: "green", shape: "dot", text: "Name" })).toBeTruthy();
-        done();
-      });
-  });
+    it("should provide for invalid input", (done) => {
+        helper.load(nodes, flow, () => {
+            let n2 = helper.getNode("n2");
+            n2.server.info = { name: "Name" };
+            n2.receive({ payload: true });
+            n2.on("call:status", (call) => {
+                expect(
+                    n2.status.calledOnceWithExactly({
+                        fill: "red",
+                        shape: "ring",
+                        text: "topic is not set",
+                    })
+                ).toBeTruthy();
+                done();
+            });
+        });
+    });
 
-});
+    it("should provide for valid input", (done) => {
+        helper.load(nodes, flow, () => {
+            let n2 = helper.getNode("n2");
+            n2.server.info = { name: "Name" };
+            n2.receive({ payload: true, topic: "1;1" });
+            expect(
+                n2.status.calledOnceWithExactly({
+                    fill: "green",
+                    shape: "dot",
+                    text: "Name",
+                })
+            ).toBeTruthy();
+            done();
+        });
+    });
+});