README.md

Node-RED Companion Integration

Companion Component to node-red-contrib-home-assistant-websocket to integrate Node-RED with Home Assistant.

Features

• Create and update entities from Node-RED
  • binary sensor
  • button
  • number
  • select
  • sensor
  • switch
  • text
• Disable and enable Node-RED flows from Home Assistant UI
• Create Home Assistant webhooks and handle them in Node-RED
• Use Device triggers and action from Node-RED

Minimum Requirements

• node-red-contrib-home-assistant-websocket v0.57+
• Home Assistant 2023.7.0+

Installation

HACS

Install via HACS (Home Assistant Community Store)

1. Go to HACS -> Integrations -> "+ Explore & Download Repos"
2. Find "Node-RED Companion".
3. Open the search result and click "Download this Repository with HACS".
4. Refresh your browser window (bug in HA where it doesn't update the integration list after a reboot)
5. In the Home Assistant UI go to "Configuration" -> "Integrations" click "+" and search for "Node-RED"

Manual

1. Using your tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
2. If you do not have a custom_components directory (folder) there, you need to create it.
3. In the custom_components directory (folder) create a new folder called nodered.
4. Download all the files from the custom_components/nodered/ directory (folder) in this repository.
5. Place the files you downloaded in the new directory (folder) you created.
6. Restart Home Assistant
7. Refresh your browser window (bug in HA where it doesn't update the integration list after a reboot)
8. In the Home Assistant UI go to "Configuration" -> "Integrations" click "+" and search for "Node-RED"

Configuration

Once installed and added via Home-Assistant Integrations all configuration is done from within Node-RED.

Contributions are welcome!

If you want to contribute please read the Contribution guidelines

---