node-red-contrib-power-genius 0.1.0 → 1.0.0

package/power-genius-control.html

@@ -1,69 +1,69 @@
-<script type="text/javascript">
-    RED.nodes.registerType("power-genius-control", {
-        category: "Power Genius",
-        color: "#a6bbcf",
-        defaults: {
-            name: { value: "" },
-            server: { type: "power-genius-server", required: true },
-            action: { value: "" },
-        },
-        inputs: 1,
-        outputs: 1,
-        icon: "bridge.svg",
-        label: function () {
-            return this.name || "pg control";
-        },
-    });
-</script>
-
-<script type="text/html" data-template-name="power-genius-control">
-    <div class="form-row">
-        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
-        <input type="text" id="node-input-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" />
-    </div>
-    <div class="form-row">
-        <label for="node-input-action"><i class="fa fa-cog"></i> Action</label>
-        <select id="node-input-action">
-            <option value="">msg.topic</option>
-            <option value="operate">operate</option>
-            <option value="antenna">antenna</option>
-            <option value="fanmode">fanmode</option>
-            <option value="command">command</option>
-        </select>
-    </div>
-</script>
-
-<script type="text/markdown" data-help-name="power-genius-control">
-Controls the Power Genius XL.
-
-### Input
-
-: topic (string) : `operate`, `antenna`, `fanmode` or `command`. Only used when the node's Action is set to `msg.topic`; a fixed action in the node always takes precedence.
-
-: payload (boolean|number|string) : Depends on the action:
-
-| Action | Payload | Command sent |
-|---|---|---|
-| `operate` | `true`, `1`, `"1"` or `"on"` for operate, `false`, `0`, `"0"` or `"off"` for standby. Anything else is an error and nothing is sent. | `operate=<1\|0>` |
-| `antenna` | The antenna number, 1-3. Only for amplifiers with the antenna switch; the SO2R version answers with an error | `antenna=<n>` |
-| `fanmode` | `STANDARD`, `CONTEST` or `BROADCAST` (any case). Shows up as `fanmode` in the status | `setup fanmode=<mode>` |
-| `command` | The command, on a single line, for example `setup read` or `ping` | The payload as it is |
-
-### Output
-
-: topic (string) : The action.
-: payload (string) : The reply message from the amplifier, for example `key=value key=value ...`. Empty when the command has no reply message.
-
-A failed command is reported as an error on the node, with the result code from the amplifier. For example
-`0x50000015` means that the amplifier does not know the command, and `0x50000013` that the hardware has no antenna switch.
-
-### Details
-
-`command` is for trying out commands that the API documentation does not cover. Commands that change the
-configuration, such as `ifconf`, `catradio` and `flexradio`, take effect after `save`, which reboots the amplifier. Use with care.
-The effect of `operate` shows up in the status `state` (`STANDBY`, or `IDLE` when operating).
-</script>
+<script type="text/javascript">
+    RED.nodes.registerType("power-genius-control", {
+        category: "Power Genius",
+        color: "#a6bbcf",
+        defaults: {
+            name: { value: "" },
+            server: { type: "power-genius-server", required: true },
+            action: { value: "" },
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: "bridge.svg",
+        label: function () {
+            return this.name || "pg control";
+        },
+    });
+</script>
+
+<script type="text/html" data-template-name="power-genius-control">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-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" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-action"><i class="fa fa-cog"></i> Action</label>
+        <select id="node-input-action">
+            <option value="">msg.topic</option>
+            <option value="operate">operate</option>
+            <option value="antenna">antenna</option>
+            <option value="fanmode">fanmode</option>
+            <option value="command">command</option>
+        </select>
+    </div>
+</script>
+
+<script type="text/markdown" data-help-name="power-genius-control">
+Controls the Power Genius XL.
+
+### Input
+
+: topic (string) : `operate`, `antenna`, `fanmode` or `command`. Only used when the node's Action is set to `msg.topic`; a fixed action in the node always takes precedence.
+
+: payload (boolean|number|string) : Depends on the action:
+
+| Action | Payload | Command sent |
+|---|---|---|
+| `operate` | `true`, `1`, `"1"` or `"on"` for operate, `false`, `0`, `"0"` or `"off"` for standby. Anything else is an error and nothing is sent. | `operate=<1\|0>` |
+| `antenna` | The antenna number, 1-3. Only for amplifiers with the antenna switch; the SO2R version answers with an error | `antenna=<n>` |
+| `fanmode` | `STANDARD`, `CONTEST` or `BROADCAST` (any case). Shows up as `fanmode` in the status | `setup fanmode=<mode>` |
+| `command` | The command, on a single line, for example `setup read` or `ping` | The payload as it is |
+
+### Output
+
+: topic (string) : The action.
+: payload (string) : The reply message from the amplifier, for example `key=value key=value ...`. Empty when the command has no reply message.
+
+A failed command is reported as an error on the node, with the result code from the amplifier. For example
+`0x50000015` means that the amplifier does not know the command, and `0x50000013` that the hardware has no antenna switch.
+
+### Details
+
+`command` is for trying out commands that the API documentation does not cover. Commands that change the
+configuration, such as `ifconf`, `catradio` and `flexradio`, take effect after `save`, which reboots the amplifier. Use with care.
+The effect of `operate` shows up in the status `state` (`STANDBY`, or `IDLE` when operating).
+</script>

package/power-genius-control.js

@@ -1,94 +1,94 @@
-const FAN_MODES = ["STANDARD", "CONTEST", "BROADCAST"];
-
-// Builds the command to send from the payload. "command" sends the payload as it is, to try commands that
-// are not documented; the amplifier answers an unknown one with an error.
-const COMMANDS = {
-    operate: (payload) => `operate=${parseSwitch(payload)}`,
-    fanmode: (payload) => {
-        const mode = String(payload === undefined || payload === null ? "" : payload).trim().toUpperCase();
-        if (!FAN_MODES.includes(mode)) {
-            throw new Error(`payload must be one of: ${FAN_MODES.join(", ")}`);
-        }
-        return `setup fanmode=${mode}`;
-    },
-    antenna: (payload) => {
-        const n = Number(payload);
-        if (payload === "" || payload === null || !Number.isInteger(n) || n < 1 || n > 3) {
-            throw new Error("payload must be the antenna number, 1-3");
-        }
-        return `antenna=${n}`;
-    },
-    command: (payload) => {
-        const cmd = String(payload === undefined || payload === null ? "" : payload).trim();
-        if (!cmd) throw new Error("payload must be the command to send");
-        if (/[\r\n]/.test(cmd)) throw new Error("payload must be a single line");
-        return cmd;
-    },
-};
-const ACTIONS = Object.keys(COMMANDS);
-
-// true/false, 1/0, "1"/"0" and "on"/"off" (any case). Anything else is rejected, so that a stray payload
-// can never switch the amplifier by accident.
-const parseSwitch = (payload) => {
-    if (payload === true || payload === 1) return 1;
-    if (payload === false || payload === 0) return 0;
-    switch (String(payload).trim().toLowerCase()) {
-        case "1":
-        case "on":
-        case "true":
-            return 1;
-        case "0":
-        case "off":
-        case "false":
-            return 0;
-        default:
-            throw new Error("payload must be true/false, 1/0 or on/off");
-    }
-};
-
-module.exports = (RED) => {
-    class PowerGeniusControl {
-        constructor(config) {
-            RED.nodes.createNode(this, config);
-            this.server = RED.nodes.getNode(config.server);
-
-            if (this.server == null) {
-                this.status({ fill: "red", shape: "ring", text: "disconnected" });
-                return;
-            }
-
-            const emitter = this.server.updatesEventEmitter;
-            const onConnected = () => {
-                this.status({ fill: "green", shape: "dot", text: this.server.info.name || "connected" });
-            };
-            const onClosed = () => {
-                this.status({ fill: "red", shape: "ring", text: "disconnected" });
-            };
-            emitter.on("connected", onConnected);
-            emitter.on("closed", onClosed);
-
-            this.on("close", () => {
-                emitter.removeListener("connected", onConnected);
-                emitter.removeListener("closed", onClosed);
-            });
-
-            this.on("input", async (msg, send, done) => {
-                const action = String(config.action || msg.topic || "").toLowerCase();
-                try {
-                    if (!ACTIONS.includes(action)) {
-                        throw new Error(`topic must be one of: ${ACTIONS.join(", ")}`);
-                    }
-                    const reply = await this.server.command(COMMANDS[action](msg.payload));
-                    send({ ...msg, topic: action, payload: reply });
-                    if (done) done();
-                } catch (err) {
-                    this.status({ fill: "red", shape: "ring", text: err.message });
-                    if (done) done(err); else this.error(err, msg);
-                }
-            });
-
-            this.server.connect();
-        }
-    }
-    RED.nodes.registerType("power-genius-control", PowerGeniusControl);
-};
+const FAN_MODES = ["STANDARD", "CONTEST", "BROADCAST"];
+
+// Builds the command to send from the payload. "command" sends the payload as it is, to try commands that
+// are not documented; the amplifier answers an unknown one with an error.
+const COMMANDS = {
+    operate: (payload) => `operate=${parseSwitch(payload)}`,
+    fanmode: (payload) => {
+        const mode = String(payload === undefined || payload === null ? "" : payload).trim().toUpperCase();
+        if (!FAN_MODES.includes(mode)) {
+            throw new Error(`payload must be one of: ${FAN_MODES.join(", ")}`);
+        }
+        return `setup fanmode=${mode}`;
+    },
+    antenna: (payload) => {
+        const n = Number(payload);
+        if (payload === "" || payload === null || !Number.isInteger(n) || n < 1 || n > 3) {
+            throw new Error("payload must be the antenna number, 1-3");
+        }
+        return `antenna=${n}`;
+    },
+    command: (payload) => {
+        const cmd = String(payload === undefined || payload === null ? "" : payload).trim();
+        if (!cmd) throw new Error("payload must be the command to send");
+        if (/[\r\n]/.test(cmd)) throw new Error("payload must be a single line");
+        return cmd;
+    },
+};
+const ACTIONS = Object.keys(COMMANDS);
+
+// true/false, 1/0, "1"/"0" and "on"/"off" (any case). Anything else is rejected, so that a stray payload
+// can never switch the amplifier by accident.
+const parseSwitch = (payload) => {
+    if (payload === true || payload === 1) return 1;
+    if (payload === false || payload === 0) return 0;
+    switch (String(payload).trim().toLowerCase()) {
+        case "1":
+        case "on":
+        case "true":
+            return 1;
+        case "0":
+        case "off":
+        case "false":
+            return 0;
+        default:
+            throw new Error("payload must be true/false, 1/0 or on/off");
+    }
+};
+
+module.exports = (RED) => {
+    class PowerGeniusControl {
+        constructor(config) {
+            RED.nodes.createNode(this, config);
+            this.server = RED.nodes.getNode(config.server);
+
+            if (this.server == null) {
+                this.status({ fill: "red", shape: "ring", text: "disconnected" });
+                return;
+            }
+
+            const emitter = this.server.updatesEventEmitter;
+            const onConnected = () => {
+                this.status({ fill: "green", shape: "dot", text: this.server.info.name || "connected" });
+            };
+            const onClosed = () => {
+                this.status({ fill: "red", shape: "ring", text: "disconnected" });
+            };
+            emitter.on("connected", onConnected);
+            emitter.on("closed", onClosed);
+
+            this.on("close", () => {
+                emitter.removeListener("connected", onConnected);
+                emitter.removeListener("closed", onClosed);
+            });
+
+            this.on("input", async (msg, send, done) => {
+                const action = String(config.action || msg.topic || "").toLowerCase();
+                try {
+                    if (!ACTIONS.includes(action)) {
+                        throw new Error(`topic must be one of: ${ACTIONS.join(", ")}`);
+                    }
+                    const reply = await this.server.command(COMMANDS[action](msg.payload));
+                    send({ ...msg, topic: action, payload: reply });
+                    if (done) done();
+                } catch (err) {
+                    this.status({ fill: "red", shape: "ring", text: err.message });
+                    if (done) done(err); else this.error(err, msg);
+                }
+            });
+
+            this.server.connect();
+        }
+    }
+    RED.nodes.registerType("power-genius-control", PowerGeniusControl);
+};

package/power-genius-info.html

@@ -1,105 +1,105 @@
-<script type="text/javascript">
-    RED.nodes.registerType("power-genius-info", {
-        category: "Power Genius",
-        color: "#a6bbcf",
-        defaults: {
-            name: { value: "" },
-            server: { type: "power-genius-server", required: true },
-            property: { value: "*" },
-            startDelay: { value: 1000, validate: function (v) { return v === "" || v === undefined || (!isNaN(v) && Number(v) >= 0); } },
-        },
-        inputs: 1,
-        outputs: 1,
-        icon: "bridge.svg",
-        label: function () {
-            if (this.name) return this.name;
-            return this.property && this.property !== "*" ? "pg " + this.property : "pg info";
-        },
-        oneditprepare: function () {
-            const select = $("#node-input-property-select");
-            const input = $("#node-input-property");
-            const known = select.find("option").map(function () { return this.value; }).get();
-            const current = input.val() || "*";
-            select.val(known.includes(current) ? current : "__custom__");
-            const sync = () => {
-                if (select.val() !== "__custom__") input.val(select.val());
-                input.toggle(select.val() === "__custom__");
-            };
-            select.on("change", sync);
-            sync();
-        },
-        oneditsave: function () {
-            if (!$("#node-input-property").val().trim()) $("#node-input-property").val("*");
-        },
-    });
-</script>
-
-<script type="text/html" data-template-name="power-genius-info">
-    <div class="form-row">
-        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
-        <input type="text" id="node-input-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" />
-    </div>
-    <div class="form-row">
-        <label for="node-input-property-select"><i class="fa fa-filter"></i> Property</label>
-        <select id="node-input-property-select" style="width:70%">
-            <option value="*">(all, as an object)</option>
-            <option value="name">name</option>
-            <option value="nickname">nickname</option>
-            <option value="firmware">firmware</option>
-            <option value="authRequired">authRequired</option>
-            <option value="ifconf">ifconf</option>
-            <option value="catradioA">catradioA</option>
-            <option value="catradioB">catradioB</option>
-            <option value="flexradioA">flexradioA</option>
-            <option value="flexradioB">flexradioB</option>
-            <option value="__custom__">other (type the name)...</option>
-        </select>
-        <input type="text" id="node-input-property" style="display:none; margin-top:5px; width:70%; margin-left:105px" />
-    </div>
-    <div class="form-row">
-        <label for="node-input-startDelay"><i class="fa fa-hourglass-start"></i> Start delay</label>
-        <input type="number" id="node-input-startDelay" min="0" step="100" style="width:100px" />
-        <span style="margin-left:5px">ms before the first output after deploy</span>
-    </div>
-</script>
-
-<script type="text/markdown" data-help-name="power-genius-info">
-Emits the Power Genius XL device information and configuration, or a single item of it.
-
-### Input
-
-Any message re-reads the info from the device and emits it.
-
-### Output
-
-: payload (string | number | boolean | object) : The selected item, or the whole info object when `*` is selected.
-: topic (string) : The property name, or `info` when `*` is selected.
-
-### Details
-
-The info is collected with the read-only commands `setup read`, `ifconf read`, `catradio read=A|B` and
-`flexradio read=A|B`; each reply is parsed as `key=value` pairs. Use `*` to get everything.
-
-| Item | Meaning |
-|---|---|
-| `name` | Device name (the `nickname`, with `_` replaced by a space) |
-| `nickname` | Device name as reported |
-| `firmware` | Firmware version, from the banner the device sends on connect |
-| `authRequired` | `true` when the device asked for authentication (only outside the local network; not supported yet) |
-| `ledintens` | LED intensity |
-| `txdelay` | TX delay |
-| `inactivity-timeout` | Inactivity timeout, 0 = off |
-| `authcode` | Authentication code for WAN access. Treat it as a secret: it is part of the whole info object |
-| `ants`, `ant1name`..`ant3name` | Antenna switch setup: `ants` (0 on the SO2R version, which has no switch) and the names of antennas 1-3 (empty when not set) |
-| `ifconf` | Object with the network configuration: `address`, `netmask`, `gateway`, `dhcp`, `dhcpstatus` and the active `address-status`, `netmask-status`, `gateway-status` |
-| `catradioA`, `catradioB` | Objects with the CAT radio configuration of slice A / B, used with legacy radios (CAT or CI-V): `type`, `baud`, `parity`, `stopbits`, `civ`, `active` |
-| `flexradioA`, `flexradioB` | Objects with the FlexRadio configuration of slice A / B: `serial`, `txant`, `ptt`, `active` |
-
-The info is emitted once after the connection is established, and again after every reconnect.
-The *Start delay* holds back output for that many milliseconds after the flow is deployed,
-giving downstream nodes such as dashboard widgets time to initialize.
-</script>
+<script type="text/javascript">
+    RED.nodes.registerType("power-genius-info", {
+        category: "Power Genius",
+        color: "#a6bbcf",
+        defaults: {
+            name: { value: "" },
+            server: { type: "power-genius-server", required: true },
+            property: { value: "*" },
+            startDelay: { value: 1000, validate: function (v) { return v === "" || v === undefined || (!isNaN(v) && Number(v) >= 0); } },
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: "bridge.svg",
+        label: function () {
+            if (this.name) return this.name;
+            return this.property && this.property !== "*" ? "pg " + this.property : "pg info";
+        },
+        oneditprepare: function () {
+            const select = $("#node-input-property-select");
+            const input = $("#node-input-property");
+            const known = select.find("option").map(function () { return this.value; }).get();
+            const current = input.val() || "*";
+            select.val(known.includes(current) ? current : "__custom__");
+            const sync = () => {
+                if (select.val() !== "__custom__") input.val(select.val());
+                input.toggle(select.val() === "__custom__");
+            };
+            select.on("change", sync);
+            sync();
+        },
+        oneditsave: function () {
+            if (!$("#node-input-property").val().trim()) $("#node-input-property").val("*");
+        },
+    });
+</script>
+
+<script type="text/html" data-template-name="power-genius-info">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-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" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-property-select"><i class="fa fa-filter"></i> Property</label>
+        <select id="node-input-property-select" style="width:70%">
+            <option value="*">(all, as an object)</option>
+            <option value="name">name</option>
+            <option value="nickname">nickname</option>
+            <option value="firmware">firmware</option>
+            <option value="authRequired">authRequired</option>
+            <option value="ifconf">ifconf</option>
+            <option value="catradioA">catradioA</option>
+            <option value="catradioB">catradioB</option>
+            <option value="flexradioA">flexradioA</option>
+            <option value="flexradioB">flexradioB</option>
+            <option value="__custom__">other (type the name)...</option>
+        </select>
+        <input type="text" id="node-input-property" style="display:none; margin-top:5px; width:70%; margin-left:105px" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-startDelay"><i class="fa fa-hourglass-start"></i> Start delay</label>
+        <input type="number" id="node-input-startDelay" min="0" step="100" style="width:100px" />
+        <span style="margin-left:5px">ms before the first output after deploy</span>
+    </div>
+</script>
+
+<script type="text/markdown" data-help-name="power-genius-info">
+Emits the Power Genius XL device information and configuration, or a single item of it.
+
+### Input
+
+Any message re-reads the info from the device and emits it.
+
+### Output
+
+: payload (string | number | boolean | object) : The selected item, or the whole info object when `*` is selected.
+: topic (string) : The property name, or `info` when `*` is selected.
+
+### Details
+
+The info is collected with the read-only commands `setup read`, `ifconf read`, `catradio read=A|B` and
+`flexradio read=A|B`; each reply is parsed as `key=value` pairs. Use `*` to get everything.
+
+| Item | Meaning |
+|---|---|
+| `name` | Device name (the `nickname`, with `_` replaced by a space) |
+| `nickname` | Device name as reported |
+| `firmware` | Firmware version, from the banner the device sends on connect |
+| `authRequired` | `true` when the device asked for authentication (only outside the local network; not supported yet) |
+| `ledintens` | LED intensity |
+| `txdelay` | TX delay |
+| `inactivity-timeout` | Inactivity timeout, 0 = off |
+| `authcode` | Authentication code for WAN access. Treat it as a secret: it is part of the whole info object |
+| `ants`, `ant1name`..`ant3name` | Antenna switch setup: `ants` (0 on the SO2R version, which has no switch) and the names of antennas 1-3 (empty when not set) |
+| `ifconf` | Object with the network configuration: `address`, `netmask`, `gateway`, `dhcp`, `dhcpstatus` and the active `address-status`, `netmask-status`, `gateway-status` |
+| `catradioA`, `catradioB` | Objects with the CAT radio configuration of slice A / B, used with legacy radios (CAT or CI-V): `type`, `baud`, `parity`, `stopbits`, `civ`, `active` |
+| `flexradioA`, `flexradioB` | Objects with the FlexRadio configuration of slice A / B: `serial`, `txant`, `ptt`, `active` |
+
+The info is emitted once after the connection is established, and again after every reconnect.
+The *Start delay* holds back output for that many milliseconds after the flow is deployed,
+giving downstream nodes such as dashboard widgets time to initialize.
+</script>