node-red-contrib-antenna-genius 0.2.5-beta → 0.3.0

package/Utils.js

@@ -1,6 +1,12 @@
-const encode = (protocol, method, command, revision, payload) => {
+const encode = (
+    protocol = 0,
+    method = 0,
+    command = 0,
+    revision = 0,
+    payload = ""
+) => {
     // !llll!bbbbbb!payload
-    // llll id the length, in hex of bit header, bbbbbb, and the payload, based on zero. 
+    // llll id the length, in hex of bit header, bbbbbb, and the payload, based on zero.
     // bbbbbb
     // gscph.protocol = 0xe00000 // 3 bits Protocol version
     // gscph.method   = 0x180000 // 2 bits 0 = Unicast request, 1 = Unicast response, 2 = Broadcast request, 3 = Broadcast response
@@ -8,6 +14,7 @@ const encode = (protocol, method, command, revision, payload) => {
     // gscph.revision = 0x00007c // 5 bits Command revision
     // gscph.erro     = 0x000003 // 2 bits 0 = No error, 1 = Command error, 2 = Protocol error, 3 = Not defined
     //
+
     let a;
     let bitheader;
 
@@ -20,43 +27,53 @@ const encode = (protocol, method, command, revision, payload) => {
     //node.warn("dbg01: a ="+a);
     a += revision << 2;
     //node.warn("dbg01: a ="+a.toString(16));
-    bitheader = (a.toString(16)).padStart(6,"0");
-    commandlength = ((bitheader.length + payload.length + 1).toString(16)).padStart(4,"0");
+    bitheader = a.toString(16).padStart(6, "0");
+    commandlength = (bitheader.length + payload.length + 1)
+        .toString(16)
+        .padStart(4, "0");
     let ret = "!" + commandlength + "!" + bitheader + "!" + payload;
 
     return ret;
 };
 
-const decodeheader = (msg) => {
-    //Perhaps some code to verify that we acctually got the initial '!', if not discard. 
-    //Same for the length, verify length in the header to the actual recived length, if no match discard. 
+const decodeheader = (msg = "!0007!000000!") => {
+    //Perhaps some code to verify that we acctually got the initial '!', if not discard.
+    //Same for the length, verify length in the header to the actual recived length, if no match discard.
     //
-    msg = msg.toString('utf8');
-    let response = msg.substring(1).split("!"); //skip first !  
+    msg = msg.toString("utf8");
+    let response = msg.substring(1).split("!"); //skip first !
 
     // Header masks
-    const gscph_protocol_mask = 0xe00000 // 3 bits Protocol version
-    const gscph_method_mask = 0x180000 // 2 bits 0 = Unicast request, 1 = Unicast response, 2 = Broadcast request, 3 = Broadcast response
-    const gscph_command_mask = 0x07FF80 // 12 bits Command number
-    const gscph_revision_mask = 0x00007c // 5 bits Command revision
-    const gscph_error_mask = 0x000003 // 2 bits 0 = No error, 1 = Command error, 2 = Protocol error, 3 = Not defined
-
-    let error = gscph_error_mask & parseInt(response[1],16);
-    let revision = (gscph_revision_mask & parseInt(response[1],16)) >> 2;
-    let command = (gscph_command_mask & parseInt(response[1],16)) >> 7;
-    let method = (gscph_method_mask & parseInt(response[1],16)) >> 19;
-    let protocol = (gscph_protocol_mask & parseInt(response[1],16)) >> 21;
+    const gscph_protocol_mask = 0xe00000; // 3 bits Protocol version
+    const gscph_method_mask = 0x180000; // 2 bits 0 = Unicast request, 1 = Unicast response, 2 = Broadcast request, 3 = Broadcast response
+    const gscph_command_mask = 0x07ff80; // 12 bits Command number
+    const gscph_revision_mask = 0x00007c; // 5 bits Command revision
+    const gscph_error_mask = 0x000003; // 2 bits 0 = No error, 1 = Command error, 2 = Protocol error, 3 = Not defined
+
+    let error = gscph_error_mask & parseInt(response[1], 16);
+    let revision = (gscph_revision_mask & parseInt(response[1], 16)) >> 2;
+    let command = (gscph_command_mask & parseInt(response[1], 16)) >> 7;
+    let method = (gscph_method_mask & parseInt(response[1], 16)) >> 19;
+    let protocol = (gscph_protocol_mask & parseInt(response[1], 16)) >> 21;
     let length = response[0];
-    let payload = response[2]
-
-    return {error: error, revision: revision, command: command, method: method, protocol: protocol, length: length, payload: payload}
+    let payload = response[2];
+
+    return {
+        error: error,
+        revision: revision,
+        command: command,
+        method: method,
+        protocol: protocol,
+        length: length,
+        payload: payload,
+    };
 };
 
 const decode = (msg) => {
     const header = decodeheader(msg);
     const params = header.payload.split(";");
     let data = {};
-    switch(header.command) {
+    switch (header.command) {
         case 24:
             data = decode24(params);
             break;
@@ -70,13 +87,13 @@ const decode = (msg) => {
             data = decode412(params);
             break;
     }
-    return {...header, ...data};
+    return { ...header, ...data };
 };
 
 const decode24 = (data) => {
     let msg = {};
 
-    msg.indentification = parseInt(data[0]);
+    msg.identification = parseInt(data[0]);
     msg.group = parseInt(data[1]);
     msg.name = data[2];
 
@@ -90,10 +107,10 @@ const decode82 = (data) => {
     // 2	band.name	string	Band name (20 characters maximum)
     // 3	band.cutoff.lower	int	Lower cutoff frequency (0 - 2147483647 hertz)
     // 4	band.cutoff.upper	int	Upper cutoff frequency (0 - 2147483647 hertz)
-    msg.band_index = parseInt(data[0]);
-    msg.band_name= data[1];
-    msg.band_cutoff_lower = parseInt(data[2]);
-    msg.band_cutoff_upper = parseInt(data[3]);
+    msg.index = parseInt(data[0]);
+    msg.name = data[1];
+    msg.cutoff_lower = parseInt(data[2]);
+    msg.cutoff_upper = parseInt(data[3]);
 
     return msg;
 };
@@ -106,13 +123,13 @@ const decode401 = (data) => {
     msg.portA_inhibit = parseInt(data[2]);
     msg.portA_antenna = parseInt(data[3]);
     msg.portA_profile = parseInt(data[4]);
-    msg.portA_tx = parseInt(data[5]);		
+    msg.portA_tx = parseInt(data[5]);
     msg.portB_mode = parseInt(data[6]);
     msg.portB_band = parseInt(data[7]);
     msg.portB_inhibit = parseInt(data[8]);
     msg.portB_antenna = parseInt(data[9]);
     msg.portB_profile = parseInt(data[10]);
-    msg.portB_tx = parseInt(data[11]);		
+    msg.portB_tx = parseInt(data[11]);
     msg.stackReach = parseInt(data[12]);
 
     return msg;
@@ -125,30 +142,30 @@ const decode412 = (data) => {
     // 1	antenna.name	string	Antenna name (20 characters maximum)
     // 2	antenna.mode	int	Antenna mode (1 = RX only, 2 = TX only, 3 = RX and TX)
     // 3	antenna.bands	string	Hex representation of bands bitfield (2 bytes)
-    msg.antenna_index = parseInt(data[0]);
-    msg.antenna_name= data[1];
-    msg.antenna_mode = parseInt(data[2]);
-    let parameters = parseInt(data[3],16);
-    msg.antenna_bands = [];
-    msg.antenna_bands.push(1 & (parameters));
-    msg.antenna_bands.push(1 & (parameters >> 1));
-    msg.antenna_bands.push(1 & (parameters >> 2));
-    msg.antenna_bands.push(1 & (parameters >> 3));
-    msg.antenna_bands.push(1 & (parameters >> 4));
-    msg.antenna_bands.push(1 & (parameters >> 5));
-    msg.antenna_bands.push(1 & (parameters >> 6));
-    msg.antenna_bands.push(1 & (parameters >> 7));
-    msg.antenna_bands.push(1 & (parameters >> 8));
-    msg.antenna_bands.push(1 & (parameters >> 9));
-    msg.antenna_bands.push(1 & (parameters >> 10));
-    msg.antenna_bands.push(1 & (parameters >> 11));
-    msg.antenna_bands.push(1 & (parameters >> 12));
-    msg.antenna_bands.push(1 & (parameters >> 13));
-    msg.antenna_bands.push(1 & (parameters >> 14));
-    msg.antenna_bands.push(1 & (parameters >> 15));
+    msg.index = parseInt(data[0]);
+    msg.name = data[1];
+    msg.mode = parseInt(data[2]);
+    let parameters = parseInt(data[3], 16);
+    msg.bands = [];
+    msg.bands.push(1 & parameters);
+    msg.bands.push(1 & (parameters >> 1));
+    msg.bands.push(1 & (parameters >> 2));
+    msg.bands.push(1 & (parameters >> 3));
+    msg.bands.push(1 & (parameters >> 4));
+    msg.bands.push(1 & (parameters >> 5));
+    msg.bands.push(1 & (parameters >> 6));
+    msg.bands.push(1 & (parameters >> 7));
+    msg.bands.push(1 & (parameters >> 8));
+    msg.bands.push(1 & (parameters >> 9));
+    msg.bands.push(1 & (parameters >> 10));
+    msg.bands.push(1 & (parameters >> 11));
+    msg.bands.push(1 & (parameters >> 12));
+    msg.bands.push(1 & (parameters >> 13));
+    msg.bands.push(1 & (parameters >> 14));
+    msg.bands.push(1 & (parameters >> 15));
 
     return msg;
-}
+};
 
 exports.encode = encode;
-exports.decode = decode;
+exports.decode = decode;

package/antenna-genius-activate-antenna.html

@@ -1,16 +1,16 @@
 <script type="text/javascript">
-    RED.nodes.registerType('antenna-genius-activate-antenna',{
-        category: 'antenna genius',
-        color: '#FFF0F0',
+    RED.nodes.registerType("antenna-genius-activate-antenna", {
+        category: "antenna genius",
+        color: "#FFF0F0",
         defaults: {
-            name: {value:""},
-            server: {value:"", type:"antenna-genius-server"},
+            name: { value: "" },
+            server: { value: "", type: "antenna-genius-server" },
         },
-        inputs:1,
-        outputs:0,
+        inputs: 1,
+        outputs: 0,
         icon: "font-awesome/fa-sliders",
-        label: function() {
-            return this.name||"antenna-genius-activate-antenna";
+        label: function () {
+            return this.name || "antenna-genius-activate-antenna";
         },
         paletteLabel: "activate-antenna",
         inputLabels: "Set antenna defined in topic as active",
@@ -20,11 +20,13 @@
 <script type="text/html" data-template-name="antenna-genius-activate-antenna">
     <div class="form-row">
         <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
-        <input type="text" id="node-input-name" placeholder="Name">
+        <input type="text" id="node-input-name" placeholder="Name" />
     </div>
     <div class="form-row">
-        <label for="node-input-server"><i class="fa fa-server"></i> Server</label>
-        <input type="text" id="node-input-server" placeholder="Server">
+        <label for="node-input-server"
+            ><i class="fa fa-server"></i> Server</label
+        >
+        <input type="text" id="node-input-server" placeholder="Server" />
     </div>
 </script>
 
@@ -42,5 +44,4 @@ Set the antenna defined in topic as active.
 ### Details
 
 See the `antenna-status` node for more information.
-
 </script>

package/antenna-genius-activate-antenna.js

@@ -1,40 +1,64 @@
-const Utils = require('./Utils');
+const Utils = require("./Utils");
 
 module.exports = (RED) => {
     class AntennaGeniusActivateAntenna {
         constructor(config) {
             RED.nodes.createNode(this, config);
 
-            var node = this;
+            let node = this;
             this.bandNameA = "";
             this.bandNameB = "";
             this.server = RED.nodes.getNode(config.server);
 
+            if(this.server == null) {
+                this.status({
+                    fill: "red",
+                    shape: "ring",
+                    text: "disconnected",
+                });
+                return;
+            }
+
             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",
+                });
             });
 
-            node.on('input', (msg, send, done) => {
-                if(msg.topic) {
-                    if(this.server.info.name) {
-                        this.status({ fill: "green", shape: "dot", text: this.server.info.name });
+            node.on("input", (msg, send, done) => {
+                if (msg.topic) {
+                    if (this.server.info.name) {
+                        this.status({
+                            fill: "green",
+                            shape: "dot",
+                            text: this.server.info.name,
+                        });
                     }
-    
+
                     let command = Utils.encode(0, 0, 415, 0, msg.topic);
 
                     this.server.client.write(command);
-                }
-                else {
-                    this.status({ fill: "red", shape: "ring", text: "topic is not set" });
+                } else {
+                    this.status({
+                        fill: "red",
+                        shape: "ring",
+                        text: "topic is not set",
+                    });
                     this.server.forceUpdate();
                 }
-                if(done) {
+                if (done) {
                     done();
                 }
             });
@@ -42,5 +66,8 @@ module.exports = (RED) => {
             this.server.connect();
         }
     }
-    RED.nodes.registerType("antenna-genius-activate-antenna", AntennaGeniusActivateAntenna);
-}
+    RED.nodes.registerType(
+        "antenna-genius-activate-antenna",
+        AntennaGeniusActivateAntenna
+    );
+};

package/antenna-genius-antenna-status.html

@@ -1,17 +1,21 @@
 <script type="text/javascript">
-    RED.nodes.registerType('antenna-genius-antenna-status',{
-        category: 'antenna genius',
-        color: '#FFF0F0',
+    RED.nodes.registerType("antenna-genius-antenna-status", {
+        category: "antenna genius",
+        color: "#FFF0F0",
         defaults: {
-            name: {value:""},
-            server: {value:"", type:"antenna-genius-server"},
-            antennaNb: {value: 1, required: true, validate: RED.validators.number()},
+            name: { value: "" },
+            server: { value: "", type: "antenna-genius-server" },
+            antennaNb: {
+                value: 1,
+                required: true,
+                validate: RED.validators.number(),
+            },
         },
-        inputs:0,
-        outputs:2,
+        inputs: 0,
+        outputs: 2,
         icon: "font-awesome/fa-wifi",
-        label: function() {
-            return this.name||"antenna-genius-antenna-status";
+        label: function () {
+            return this.name || "antenna-genius-antenna-status";
         },
         paletteLabel: "antenna-status",
         outputLabels: ["Antenna Radio A Status", "Antenna Radio B Status"],
@@ -21,15 +25,23 @@
 <script type="text/html" data-template-name="antenna-genius-antenna-status">
     <div class="form-row">
         <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
-        <input type="text" id="node-input-name" placeholder="Name">
+        <input type="text" id="node-input-name" placeholder="Name" />
     </div>
     <div class="form-row">
-        <label for="node-input-server"><i class="fa fa-server"></i> Server</label>
-        <input type="text" id="node-input-server" placeholder="Server">
+        <label for="node-input-server"
+            ><i class="fa fa-server"></i> Server</label
+        >
+        <input type="text" id="node-input-server" placeholder="Server" />
     </div>
     <div class="form-row">
-        <label for="node-input-antennaNb"><i class="fa fa-wifi"></i> Antenna Number</label>
-        <input type="text" id="node-input-antennaNb" placeholder="Antenna Number">
+        <label for="node-input-antennaNb"
+            ><i class="fa fa-wifi"></i> Antenna Number</label
+        >
+        <input
+            type="text"
+            id="node-input-antennaNb"
+            placeholder="Antenna Number"
+        />
     </div>
 </script>
 
@@ -46,7 +58,7 @@ Return Radio A & B status for an antenna.
 
 Port 1: Status for Radio A antenna.
 
-: payload.selected (boolean) : this is the currently selected antenna for Radio A on the current band. 
+: payload.selected (boolean) : this is the currently selected antenna for Radio A on the current band.
 
 : payload.enabled (boolean) : this antenna can be selected for use by Radio A on the current band.
 
@@ -60,7 +72,7 @@ Port 1: Status for Radio A antenna.
 
 Port 2: Status for Radio A antenna.
 
-: payload.selected (boolean) : this is the currently selected antenna for Radio B on the current band. 
+: payload.selected (boolean) : this is the currently selected antenna for Radio B on the current band.
 
 : payload.enabled (boolean) : this antenna can be selected for use by Radio B on the current band.
 
@@ -75,5 +87,4 @@ Port 2: Status for Radio A antenna.
 ### Details
 
 A typical workflow is to feed each output to a `button` and then map `payload.name` to the button's `label`, and `payload.background` to the button's `background`. Set the buttons `payload` to `true` and `Topic` to `msg.topic` when clicked and everything is setup to directly feed an `activate-antenna` node.
-
 </script>

package/antenna-genius-antenna-status.js

@@ -3,97 +3,129 @@ module.exports = (RED) => {
         constructor(config) {
             RED.nodes.createNode(this, config);
 
-            var node = this;
+            let node = this;
             this.antennaNumber = config.antennaNb;
             this.radioA = {
                 selected: false,
                 enabled: false,
                 name: "",
-                background: ""
+                background: "",
             };
             this.radioB = {
                 selected: false,
                 enabled: false,
                 name: "",
-                background: ""
+                background: "",
             };
             this.server = RED.nodes.getNode(config.server);
 
+            if(this.server == null) {
+                this.status({
+                    fill: "red",
+                    shape: "ring",
+                    text: "disconnected",
+                });
+                return;
+            }
+
             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", (forceUpdate) => {
-
                 let maxNumberOfAntennas = this.server.status.stackReach * 8;
-                if(this.antennaNumber < 1 || this.antennaNumber > maxNumberOfAntennas || this.antennaNumber > this.server.antennas.length) {
-                    this.status({ fill: "red", shape: "ring", text: "antenna number is out of range" });
+                if (
+                    this.antennaNumber < 1 ||
+                    this.antennaNumber > maxNumberOfAntennas ||
+                    this.antennaNumber > this.server.antennas.length
+                ) {
+                    this.status({
+                        fill: "red",
+                        shape: "ring",
+                        text: "antenna number is out of range",
+                    });
                     return;
                 }
 
                 let changed = forceUpdate;
 
                 // Selected?
-                let radioAselected = this.antennaNumber == this.server.status.portA_antenna;
+                let radioAselected =
+                    this.antennaNumber == this.server.status.portA_antenna;
                 if (radioAselected != this.radioA.selected) {
                     changed = true;
                     this.radioA.selected = radioAselected;
                 }
 
-                let radioBselected = this.antennaNumber == this.server.status.portB_antenna;
+                let radioBselected =
+                    this.antennaNumber == this.server.status.portB_antenna;
                 if (radioBselected != this.radioB.selected) {
                     changed = true;
                     this.radioB.selected = radioBselected;
                 }
 
                 // Enabled?
-                let radioAenabled = this.server.antennas[this.antennaNumber - 1].antenna_bands[this.server.status.portA_band] == 1;
+                let radioAenabled =
+                    this.server.antennas[this.antennaNumber - 1].bands[
+                        this.server.status.portA_band
+                    ] == 1;
                 if (radioAenabled != this.radioA.enabled) {
                     changed = true;
                     this.radioA.enabled = radioAenabled;
                 }
 
-                let radioBenabled = this.server.antennas[this.antennaNumber - 1].antenna_bands[this.server.status.portB_band] == 1;
+                let radioBenabled =
+                    this.server.antennas[this.antennaNumber - 1].bands[
+                        this.server.status.portB_band
+                    ] == 1;
                 if (radioBenabled != this.radioB.enabled) {
                     changed = true;
                     this.radioB.enabled = radioBenabled;
                 }
 
                 // Get name
-                let name = this.server.antennas[this.antennaNumber - 1].antenna_name;
+                let name = this.server.antennas[this.antennaNumber - 1].name;
                 if (this.radioA.name !== name) {
                     changed = true;
                     this.radioA.name = this.radioB.name = name;
-                    this.status({ fill: "green", shape: "dot", text: this.server.info.name + " - " + name});
+                    this.status({
+                        fill: "green",
+                        shape: "dot",
+                        text: this.server.info.name + " - " + name,
+                    });
                 }
 
                 if (radioAenabled) {
                     if (radioAselected) {
                         this.radioA.background = this.server.selectedColor;
-                    }
-                    else {
+                    } else {
                         this.radioA.background = this.server.activeColor;
                     }
-                }
-                else {
+                } else {
                     this.radioA.background = this.server.disabledColor;
                 }
 
                 if (radioBenabled) {
                     if (radioBselected) {
                         this.radioB.background = this.server.selectedColor;
-                    }
-                    else {
+                    } else {
                         this.radioB.background = this.server.activeColor;
                     }
-                }
-                else {
+                } else {
                     this.radioB.background = this.server.disabledColor;
                 }
 
@@ -101,12 +133,26 @@ module.exports = (RED) => {
                 let radioBTopic = "2;" + this.antennaNumber;
 
                 if (changed) {
-                    node.send([{ payload: this.radioA, enabled: this.radioA.enabled, topic: radioATopic }, { payload: this.radioB, enabled: this.radioB.enabled, topic: radioBTopic }]);
+                    node.send([
+                        {
+                            payload: this.radioA,
+                            enabled: this.radioA.enabled,
+                            topic: radioATopic,
+                        },
+                        {
+                            payload: this.radioB,
+                            enabled: this.radioB.enabled,
+                            topic: radioBTopic,
+                        },
+                    ]);
                 }
             });
 
             this.server.connect();
         }
     }
-    RED.nodes.registerType("antenna-genius-antenna-status", AntennaGeniusAntennaStatus);
-}
+    RED.nodes.registerType(
+        "antenna-genius-antenna-status",
+        AntennaGeniusAntennaStatus
+    );
+};

package/antenna-genius-band-labels.html

@@ -1,16 +1,16 @@
 <script type="text/javascript">
-    RED.nodes.registerType('antenna-genius-band-labels',{
-        category: 'antenna genius',
-        color: '#FFF0F0',
+    RED.nodes.registerType("antenna-genius-band-labels", {
+        category: "antenna genius",
+        color: "#FFF0F0",
         defaults: {
-            name: {value:""},
-            server: {value:"", type:"antenna-genius-server"},
+            name: { value: "" },
+            server: { value: "", type: "antenna-genius-server" },
         },
-        inputs:0,
-        outputs:1,
+        inputs: 0,
+        outputs: 1,
         icon: "font-awesome/fa-info",
-        label: function() {
-            return this.name||"antenna-genius-band-labels";
+        label: function () {
+            return this.name || "antenna-genius-band-labels";
         },
         paletteLabel: "band-labels",
         outputLabels: ["Band Labels"],
@@ -20,11 +20,13 @@
 <script type="text/html" data-template-name="antenna-genius-band-labels">
     <div class="form-row">
         <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
-        <input type="text" id="node-input-name" placeholder="Name">
+        <input type="text" id="node-input-name" placeholder="Name" />
     </div>
     <div class="form-row">
-        <label for="node-input-server"><i class="fa fa-server"></i> Server</label>
-        <input type="text" id="node-input-server" placeholder="Server">
+        <label for="node-input-server"
+            ><i class="fa fa-server"></i> Server</label
+        >
+        <input type="text" id="node-input-server" placeholder="Server" />
     </div>
 </script>