Skip to content
main
Switch branches/tags
Code

Node-RED Companion Integration

hacs releasebadge buildbadge License

BuyMeCoffee

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

Features

  • Create and update binary sensors, buttons, sensors, and switches from Node-RED
  • 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

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" Open your Home Assistant instance and start setting up a new integration.

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" Open your Home Assistant instance and start setting up a new integration.

    Using your HA configuration directory (folder) as a starting point you should have this:

    custom_components/nodered/translations/en.json
    custom_components/nodered/__init__.py
    custom_components/nodered/binary_sensor.py
    custom_components/nodered/config_flow.py
    custom_components/nodered/const.py
    custom_components/nodered/discovery.py
    custom_components/nodered/manifest.json
    custom_components/nodered/sensor.py
    custom_components/nodered/services.yaml
    custom_components/nodered/switch.py
    custom_components/nodered/websocket.py
    

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


About

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

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages