node-red-contrib-smarthome-helper
node-red-contrib-smarthome-helper is a Node-RED module designed to provide utility functions and tools that simplify the development of smart home automations. It includes helper functions to manage device states, handle complex calculations, and facilitate communication between nodes in a Node-RED flow.
Features
- Provides helper functions to support smart home automation.
- Facilitates the integration of complex logic into Node-RED flows.
- Built with reusability and simplicity in mind.
Installation
To install the module, run the following command in your Node-RED user directory (typically ~/.node-red):
npm install node-red-contrib-smarthome-helper
After installation, restart Node-RED to load the new helper functions.
Available Nodes
Automation Gate
The Automation Gate node is used to control the flow of messages based on specified conditions. It acts as a gate that opens or closes depending on the defined automation logic. This allows users to create flows that only pass messages when certain criteria are met, such as time of day, device state, or other environmental conditions.
Features:
- Configurable conditions to control message flow.
- Useful for creating more complex automation logic where actions depend on multiple factors.
Example Use Case:
- Use the Automation Gate to allow motion sensor events to trigger a light only during nighttime hours.
Control Gate
The Control Gate node provides a mechanism to enable or disable the flow of messages manually or based on an external trigger. It can be used to create manual overrides or to temporarily pause parts of an automation flow.
Features:
- Manual control to enable or disable the flow of messages.
- External input can be used to dynamically change the state of the gate.
Example Use Case:
- Use the Control Gate to temporarily disable an automation, such as preventing notifications during certain times (e.g., when guests are over).
Usage
- Open Node-RED.
- Use the provided nodes (
Automation Gate and Control Gate) to enhance your smart home automations.
- Configure the nodes to interact with your smart devices effectively.
Example Usage
Here is an example of how you might use the provided nodes to manage a smart lighting system:
- Add an Automation Gate to ensure lights only turn on when motion is detected and it is nighttime.
- Use a Control Gate to manually disable the lighting automation during specific situations, such as when you are hosting guests.
Contributing
Feel free to contribute by opening issues or creating pull requests. Contributions are always welcome to make this project even better.
License
This project is licensed under the MIT License.
Links
For more information and documentation, please visit the GitHub repository.
