Node-RED Companion Integration
[![hacs][hacsbadge]][hacs] [![releasebadge]][release] [![Build Status][buildstatus-shield]][buildstatus-link] [![License][license-shield]](LICENSE.md)
[![BuyMeCoffee][buymecoffeebadge]][buymecoffee]
_Companion Component to node-red-contrib-home-assistant-websocket for seamless integration of Node-RED with Home Assistant._
Overview
The Node-RED Companion Integration bridges Node-RED and Home Assistant, allowing you to manage Home Assistant entities and automations directly from Node-RED. This integration enhances your smart home automation setup by enabling dynamic interaction between these two powerful tools.
Key Features
- Entity Management:
- Flow Control:
- Webhooks:
- Device Automation:
Minimum Requirements
- node-red-contrib-home-assistant-websocket v0.57+
- Home Assistant 2024.5+
Installation
Option 1: HACS (Home Assistant Community Store)
Navigate to the integration
Manual instructions
1. Navigate to HACS. 2. Search for "hass-node-red". 3. Click on the result.
Install the integration
1. Click the blue "Download" button on the bottom right. 2. Click "Download" in the version selection popup to download the latest version. 3. Restart Home Assistant. There will be a clickable repair item for this in "Settings".
Install the device
Manual instructions
1. Go to "Settings" in the Home Assistant sidebar, then select "Devices & Services".
2. Click the blue [+ Add Integration] button at the bottom right, search for "Node-RED Companion", and click it.
Follow any steps in the on-screen prompts.
Option 2: Manual Installation
For manual installation:
- Access your Home Assistant configuration directory (
configuration.yamllocation). - If it doesn’t already exist, create a
custom_componentsdirectory. - Within
custom_components, create a new folder namednodered. - Download all files from the
custom_components/nodered/directory in this repository. - Place these files in the newly created
nodereddirectory. - Restart Home Assistant.
- Refresh your browser window.
- From "Settings" in the Home Assistant sidebar, select "Devices & Services", click the blue [+ Add Integration] button, search for "Node-RED Companion", and install it.
Configuration
Once the Node-RED Companion Integration is installed and added via Home Assistant Integrations, all further configuration is managed from within Node-RED.
Contributing
Contributions are welcome! If you're interested in contributing, please review our Contribution Guidelines before submitting a pull request or issue.
Support
If you find this project helpful and want to support its development, consider buying me a coffee! [![Buy Me a Coffee][buymecoffeebadge]][buymecoffee]
[buymecoffee]: https://www.buymeacoffee.com/zachowj [buymecoffeebadge]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png [license-shield]: https://img.shields.io/github/license/zachowj/hass-node-red.svg?style=for-the-badge [hacs]: https://github.com/zachowj/hass-node-red [hacsbadge]: https://img.shields.io/badge/HACS-Default-orange.svg?style=for-the-badge [release]: https://github.com/zachowj/hass-node-red/releases [releasebadge]: https://img.shields.io/github/v/release/zachowj/hass-node-red?style=for-the-badge [buildstatus-shield]: https://img.shields.io/github/actions/workflow/status/zachowj/hass-node-red/push.yml?branch=main&style=for-the-badge [buildstatus-link]: https://github.com/zachowj/hass-node-red/actions