@haydendonald/node-red-contrib-hass-stuff 1.1.6 → 1.2.0

package/README.md

@@ -511,7 +511,6 @@ A node that controls lights with general scenes that adjust throughout the day w
 2. [HASS Sun](https://www.home-assistant.io/integrations/sun/)
 
 ## PIR
-*TODO*
 
 A node that simplifies control of a PIR
 

package/dist/Connections/connectionsConfigNode.js

@@ -131,8 +131,10 @@ module.exports = function ConnectionsConfigNode(RED) {
                         }
                         currentState = state;
                         //Tell HASS that the button was pressed
-                        self.sendHASSAPI("http", "post", "/api/states/" + entityId, undefined, undefined, data(currentState));
-                        options.changedCallback(currentState, serviceData);
+                        self.sendHASSAPI("http", "post", "/api/states/" + entityId, (response) => {
+                            var _a;
+                            (_a = options.changedCallback) === null || _a === void 0 ? void 0 : _a.call(options, currentState, serviceData, response);
+                        }, undefined, data(currentState));
                     }
                 };
             }
@@ -173,8 +175,10 @@ module.exports = function ConnectionsConfigNode(RED) {
                     if (domain == "button" && service == "press" && (serviceData === null || serviceData === void 0 ? void 0 : serviceData.entity_id) == entityId) {
                         const state = new Date();
                         //Tell HASS that the button was pressed
-                        self.sendHASSAPI("http", "post", "/api/states/" + entityId, undefined, undefined, data(state));
-                        options.pressedCallback(state, serviceData);
+                        self.sendHASSAPI("http", "post", "/api/states/" + entityId, (response) => {
+                            var _a;
+                            (_a = options.pressedCallback) === null || _a === void 0 ? void 0 : _a.call(options, state, serviceData, response);
+                        }, undefined, data(state));
                     }
                 };
             }
@@ -218,8 +222,10 @@ module.exports = function ConnectionsConfigNode(RED) {
                         }
                         const state = new Date();
                         //Tell HASS that the scene was activated
-                        self.sendHASSAPI("http", "post", "/api/states/" + entityId, undefined, undefined, data(state));
-                        options.activatedCallback(state, serviceData);
+                        self.sendHASSAPI("http", "post", "/api/states/" + entityId, (response) => {
+                            var _a;
+                            (_a = options.activatedCallback) === null || _a === void 0 ? void 0 : _a.call(options, state, serviceData, response);
+                        }, undefined, data(state));
                     }
                 };
             }
@@ -263,16 +269,22 @@ module.exports = function ConnectionsConfigNode(RED) {
                             return;
                         }
                         if (service == "select_option") {
-                            self.sendHASSAPI("http", "post", "/api/states/" + entityId, undefined, undefined, data(serviceData.option));
-                            options.activatedCallback(serviceData.option, serviceData);
+                            self.sendHASSAPI("http", "post", "/api/states/" + entityId, (response) => {
+                                var _a;
+                                (_a = options.activatedCallback) === null || _a === void 0 ? void 0 : _a.call(options, serviceData.option, serviceData, response);
+                            }, undefined, data(serviceData.option));
                         }
                         else if (service == "select_first") {
-                            self.sendHASSAPI("http", "post", "/api/states/" + entityId, undefined, undefined, data(options.options[0] || "unknown"));
-                            options.activatedCallback(options.options[0] || "unknown", serviceData);
+                            self.sendHASSAPI("http", "post", "/api/states/" + entityId, (response) => {
+                                var _a;
+                                (_a = options.activatedCallback) === null || _a === void 0 ? void 0 : _a.call(options, options.options[0] || "unknown", serviceData, response);
+                            }, undefined, data(options.options[0] || "unknown"));
                         }
                         else if (service == "select_last") {
-                            self.sendHASSAPI("http", "post", "/api/states/" + entityId, undefined, undefined, data(options.options[options.options.length - 1] || "unknown"));
-                            options.activatedCallback(options.options[options.options.length - 1] || "unknown", serviceData);
+                            self.sendHASSAPI("http", "post", "/api/states/" + entityId, (response) => {
+                                var _a;
+                                (_a = options.activatedCallback) === null || _a === void 0 ? void 0 : _a.call(options, options.options[options.options.length - 1] || "unknown", serviceData, response);
+                            }, undefined, data(options.options[options.options.length - 1] || "unknown"));
                         }
                         else if (service == "select_previous" || service == "select_next") {
                             self.getHASSEntityState(entityId, (currentState) => {
@@ -295,8 +307,10 @@ module.exports = function ConnectionsConfigNode(RED) {
                                         index = options.options.length - 1;
                                     }
                                 }
-                                self.sendHASSAPI("http", "post", "/api/states/" + entityId, undefined, undefined, data(options.options[index] || "unknown"));
-                                options.activatedCallback(options.options[index] || "unknown", serviceData);
+                                self.sendHASSAPI("http", "post", "/api/states/" + entityId, (response) => {
+                                    var _a;
+                                    (_a = options.activatedCallback) === null || _a === void 0 ? void 0 : _a.call(options, options.options[index] || "unknown", serviceData, response);
+                                }, undefined, data(options.options[index] || "unknown"));
                             });
                         }
                     }
@@ -334,10 +348,10 @@ module.exports = function ConnectionsConfigNode(RED) {
                 } : undefined);
             });
             return (state) => {
-                self.sendHASSAPI("http", "post", "/api/states/" + entityId, undefined, undefined, data(state));
-                if (options.changedCallback) {
-                    options.changedCallback(state);
-                }
+                self.sendHASSAPI("http", "post", "/api/states/" + entityId, (response) => {
+                    var _a;
+                    (_a = options.changedCallback) === null || _a === void 0 ? void 0 : _a.call(options, state, response);
+                }, undefined, data(state));
             };
         };
         self.sendCompanionNotification = function (options) {

package/dist/LightControl/lightControlConfigNode.js

@@ -134,7 +134,7 @@ module.exports = function LightControlConfigNode(RED) {
                     friendlyName: `${self.name} - ${sceneValue.friendlyName}`,
                     id: (0, utility_1.getEntityId)("scene", `${self.name}_${sceneKey}`),
                     creationCallback: (response) => { },
-                    activatedCallback: (serviceData) => {
+                    activatedCallback: (state, serviceData, response) => {
                         //Set our scene
                         connectionsConfigNode.sendHASSAction("select.select_option", { entity_id: [(0, utility_1.getEntityId)("select", `${self.name}_current_scene`)] }, {
                             option: sceneValue.friendlyName
@@ -148,7 +148,7 @@ module.exports = function LightControlConfigNode(RED) {
                 friendlyName: `${self.name} - Adaptive`,
                 id: (0, utility_1.getEntityId)("scene", `${self.name}_adaptive`),
                 creationCallback: (response) => { },
-                activatedCallback: (serviceData) => {
+                activatedCallback: (state, serviceData, response) => {
                     //Set our scene to adaptive
                     connectionsConfigNode.sendHASSAction("select.select_option", { entity_id: [(0, utility_1.getEntityId)("select", `${self.name}_current_scene`)] }, {
                         option: "Adaptive"
@@ -161,7 +161,7 @@ module.exports = function LightControlConfigNode(RED) {
                 friendlyName: `${self.name} - Turn On`,
                 id: (0, utility_1.getEntityId)("scene", `${self.name}_turn_on`),
                 creationCallback: (response) => { },
-                activatedCallback: (serviceData) => {
+                activatedCallback: (state, serviceData, response) => {
                     runLights(serviceData.transition || 1, true);
                 }
             });
@@ -170,7 +170,7 @@ module.exports = function LightControlConfigNode(RED) {
                 friendlyName: `${self.name} - Turn Off`,
                 id: (0, utility_1.getEntityId)("scene", `${self.name}_turn_off`),
                 creationCallback: (response) => { },
-                activatedCallback: (serviceData) => {
+                activatedCallback: (state, serviceData, response) => {
                     connectionsConfigNode.sendHASSAction("light.turn_off", { entity_id: [config.groupEntityId] }, {
                         transition: serviceData.transition || 1
                     });
@@ -181,7 +181,7 @@ module.exports = function LightControlConfigNode(RED) {
                 friendlyName: `${self.name} - Toggle`,
                 id: (0, utility_1.getEntityId)("scene", `${self.name}_toggle`),
                 creationCallback: (response) => { },
-                activatedCallback: (serviceData) => {
+                activatedCallback: (state, serviceData, response) => {
                     if (currentState.state == "off") {
                         runLights(serviceData.transition || 1, true);
                     }
@@ -201,11 +201,11 @@ module.exports = function LightControlConfigNode(RED) {
                     "Adaptive"
                 ],
                 defaultState: "Adaptive",
-                creationCallback: (state) => {
+                creationCallback: (state, response) => {
                     currentSceneState = state;
                     runLights(300, false);
                 },
-                activatedCallback: (state, serviceData) => {
+                activatedCallback: (state, serviceData, response) => {
                     currentSceneState = state;
                 }
             });

package/dist/PIRControl/PIRControlConfigNode.html

@@ -0,0 +1,68 @@
+<script type="text/javascript" id="node-PIR-control-config-node">
+    RED.nodes.registerType("PIR-control-config-node", {
+        category: "config",
+        defaults: {
+            name: { value: "", required: true },
+            connectionsConfigNode: { value: "", type: "connections-config-node", required: true },
+            PIROccupancyEntity: { value: "", required: true },
+            luminanceEntity: { value: "", required: false },
+            minBrightnessLevel: { value: "", required: false },
+            maxBrightnessLevel: { value: "", required: false },
+            turnOffAfterMs: { value: "0", default: "0", required: true },
+            turnOnAfterMs: { value: "0", default: "0", required: true },
+            enabledByDefault: { value: true, default: true, required: true }
+        },
+        label: function () {
+            return this.name || "PIR Control Config"
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="PIR-control-config-node">
+    <div class="form-row">
+        <label for="node-config-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-config-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-connectionsConfigNode">Config</label>
+        <input type="text" id="node-config-input-connectionsConfigNode" />
+    </div>
+    <div class="form-row">
+        <p>The entity id of the PIR occupancy sensor</p>
+        <label for="node-config-input-PIROccupancyEntity">PIR Occupancy Entity</label>
+        <input type="text" id="node-config-input-PIROccupancyEntity" />
+    </div>
+    <div class="form-row">
+        <p>The entity id of the luminance sensor. If not set will disable this feature</p>
+        <label for="node-config-input-luminanceEntity">Luminance Entity</label>
+        <input type="text" id="node-config-input-luminanceEntity" />
+    </div>
+    <div class="form-row">
+        <p>The minimum brightness level of the luminance sensor to trigger the PIR. If not set will disable this feature</p>
+        <label for="node-config-input-minBrightnessLevel">Min Brightness Level</label>
+        <input type="number" id="node-config-input-minBrightnessLevel" />
+    </div>
+    <div class="form-row">
+        <p>The maximum brightness level of the luminance sensor to trigger the PIR. If not set will disable this feature</p>
+        <label for="node-config-input-maxBrightnessLevel">Max Brightness Level</label>
+        <input type="number" id="node-config-input-maxBrightnessLevel" />
+    </div>
+    <div class="form-row">
+        <p>The minimum time in milliseconds of no detection before triggering the "not detected" output</p>
+        <label for="node-config-input-turnOffAfterMs">Turn Off After (ms)</label>
+        <input type="number" id="node-config-input-turnOffAfterMs" />
+    </div>
+    <div class="form-row">
+        <p>The minimum time in milliseconds of detection before triggering the "detected" output</p>
+        <label for="node-config-input-turnOnAfterMs">Turn On After (ms)</label>
+        <input type="number" id="node-config-input-turnOnAfterMs" />
+    </div>
+    <div class="form-row">
+        <p>The default state of the enabled boolean entity when it's added to Home Assistant</p>
+        <label for="node-config-input-enabledByDefault">Enabled By Default</label>
+        <input type="checkbox" id="node-config-input-enabledByDefault" />
+    </div>
+</script>
+
+<script type="text/html" data-help-name="PIR-control-config-node">
+</script>

package/dist/PIRControl/PIRControlConfigNode.js

@@ -0,0 +1,123 @@
+"use strict";
+const baseConfigNode_1 = require("../baseConfigNode");
+const utility_1 = require("../utility");
+module.exports = function PIRControlConfigNode(RED) {
+    const register = function (config) {
+        const self = this;
+        let PIROccupancyState;
+        let luminanceState;
+        let enabledState;
+        let detectedTimeout;
+        let notDetectedTimeout;
+        RED.nodes.createNode(this, config);
+        (0, baseConfigNode_1.assignBaseConfigNode)(this);
+        const connectionsConfigNode = RED.nodes.getNode(config.connectionsConfigNode);
+        let errored = false;
+        if (!config.connectionsConfigNode || !connectionsConfigNode) {
+            this.error("Connections Config Node is required");
+            errored = true;
+        }
+        if (!config.PIROccupancyEntity) {
+            this.error("PIR occupancy entity is required");
+            errored = true;
+        }
+        if (!config.enabledByDefault) {
+            this.error("Enabled by default is required");
+            errored = true;
+        }
+        if (errored) {
+            return;
+        }
+        //When HASS is ready
+        connectionsConfigNode.hassEventReadyCallbacks[this.id] = function (msg) {
+            //Get the current state of the occupancy sensor
+            connectionsConfigNode.getHASSEntityState(config.PIROccupancyEntity, (payload, data) => {
+                PIROccupancyState = data.data;
+            });
+            //If there is a luminance entity get it's state
+            if (config.luminanceEntity && config.luminanceEntity != "") {
+                connectionsConfigNode.getHASSEntityState(config.luminanceEntity, (payload, data) => {
+                    luminanceState = data.data;
+                });
+            }
+            //Add the enabled input boolean
+            connectionsConfigNode.addHASSInputBoolean({
+                friendlyName: `${self.name} - Enabled`,
+                id: (0, utility_1.getEntityId)("input_boolean", `${self.name}_enabled`),
+                defaultState: config.enabledByDefault ? "on" : "off",
+                creationCallback: (state, response) => {
+                    enabledState = state;
+                },
+                changedCallback: (state, serviceData) => {
+                    enabledState = state;
+                }
+            });
+        };
+        //When a state change happens in home assistant
+        connectionsConfigNode.hassEventStateChangeCallbacks[this.id] = function (entityId, oldState, newState) {
+            switch (entityId) {
+                case config.PIROccupancyEntity: {
+                    PIROccupancyState = newState;
+                    handle();
+                    break;
+                }
+                case config.luminanceEntity: {
+                    luminanceState = newState;
+                    break;
+                }
+            }
+        };
+        function handle() {
+            //Don't do anything if the PIR is disabled
+            if (enabledState == "off") {
+                return;
+            }
+            //Don't do anything if the luminance is not enough
+            if (config.minBrightnessLevel && parseInt(luminanceState.state) < parseInt(config.minBrightnessLevel)) {
+                return;
+            }
+            //Don't do anything if the luminance is too much
+            if (config.maxBrightnessLevel && parseInt(luminanceState.state) > parseInt(config.maxBrightnessLevel)) {
+                return;
+            }
+            const msg = {
+                payload: {
+                    PIROccupancyState,
+                    enabledState,
+                    luminanceState
+                }
+            };
+            //Send the detected event
+            if (PIROccupancyState.state == "on") {
+                clearTimeout(notDetectedTimeout);
+                if (config.turnOnAfterMs) {
+                    detectedTimeout = setTimeout(() => {
+                        sendDetectedMsg(msg);
+                    }, parseInt(config.turnOnAfterMs));
+                }
+                else {
+                    sendDetectedMsg(msg);
+                }
+            }
+            //Send the not detected event
+            if (PIROccupancyState.state == "off") {
+                clearTimeout(detectedTimeout);
+                if (config.turnOffAfterMs) {
+                    notDetectedTimeout = setTimeout(() => {
+                        sendNotDetectedMsg(msg);
+                    }, parseInt(config.turnOffAfterMs));
+                }
+                else {
+                    sendNotDetectedMsg(msg);
+                }
+            }
+        }
+        function sendDetectedMsg(msg) {
+            self.sendMsg([msg]);
+        }
+        function sendNotDetectedMsg(msg) {
+            self.sendMsg([undefined, msg]);
+        }
+    };
+    RED.nodes.registerType("PIR-control-config-node", register);
+};

package/dist/PIRControl/PIRControlNode.html

@@ -0,0 +1,32 @@
+<script type="text/javascript" id="node-PIR-control-node">
+    RED.nodes.registerType("PIR-control-node", {
+        category: "HASS Stuff",
+        color: "#ffcc00",
+        inputs: 0,
+        outputs: 2,
+        outputLabels: ["detected", "not detected"],
+        icon: "alert.svg",
+        paletteLabel: "PIR Control",
+        defaults: {
+            name: { value: "" },
+            PIRControlConfigNode: { value: '', type: "PIR-control-config-node", required: true }
+        },
+        label: function () {
+            return this.name || "PIR Control"
+        }
+    });
+</script>
+
+
+<script type="text/html" data-template-name="PIR-control-node">
+    <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">
+    </div>
+    <div class="form-row">
+        <label for="node-input-PIRControlConfigNode">Config</label>
+        <input type="text" id="node-input-PIRControlConfigNode" />
+    </div>
+</script>
+<script type="text/html" data-help-name="PIR-control-node">
+</script>

package/dist/PIRControl/PIRControlNode.js

@@ -0,0 +1,18 @@
+"use strict";
+const baseNode_1 = require("../baseNode");
+module.exports = function PIRControlNode(RED) {
+    function register(config) {
+        RED.nodes.createNode(this, config);
+        (0, baseNode_1.assignBaseNode)(this);
+        const PIRControlConfigNode = RED.nodes.getNode(config.PIRControlConfigNode);
+        //When a config node wants to send a message to the output
+        PIRControlConfigNode.addMsgCallback(this.id, (msg) => {
+            this.send(msg);
+        });
+        //When an input message is received
+        this.on("input", (msg, send, done) => {
+            PIRControlConfigNode.msgReceived(msg, [this.id]);
+        });
+    }
+    RED.nodes.registerType("PIR-control-node", register);
+};

package/dist/PIRControl/PIRControlTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@haydendonald/node-red-contrib-hass-stuff",
-  "version": "1.1.6",
+  "version": "1.2.0",
   "description": "A collection of stuff I use on my Node Red + Home Assistant server. This could be of use for others, i don't know..",
   "devDependencies": {
     "@types/node": "^18.14.0",
@@ -28,7 +28,9 @@
       "ConnectionsNode": "dist/Connections/connectionsNode.js",
       "LightControlConfigNode": "dist/LightControl/lightControlConfigNode.js",
       "LightControlNode": "dist/LightControl/lightControlNode.js",
-      "EVChargingPriceNode": "dist/EVChargingPrice/EVChargingPriceNode.js"
+      "EVChargingPriceNode": "dist/EVChargingPrice/EVChargingPriceNode.js",
+      "PIRControlConfigNode": "dist/PIRControl/PIRControlConfigNode.js",
+      "PIRControlNode": "dist/PIRControl/PIRControlNode.js"
     }
   },
   "publishConfig": {