Flow-based programming for the Internet of Things.
Node-RED is a programming tool for wiring together hardware devices, APIs and online services in new and interesting ways.
It provides a browser-based editor that makes it easy to wire together flows using the wide range of nodes in the palette that can be deployed to its runtime in a single click.
This add-on is actually a minimized version of the official community addon. It can only be managed through ingress, does not support serial devices and is unable to expose HTTP nodes on your network.
If you require such functionality, please use the above mentioned official addon.
The installation of this add-on is pretty straightforward and not different in comparison to installing any other Home Assistant add-on.
Warning: The docker image isn't prebuild (yet), which means you currently need decent hardware and/or patience to have your local Home Assistant build the image.
Warning: By default this addon uses the same configuration location as the official community Node-Red addon. You can use this addon as a replacement, but should not run both simultaneously without configuring separate configuration paths.
- Add this repository to your Supervisor Add-On store.
- Search for the "Node-RED-Minimal" add-on in the Home Assistant add-on store and install it.
- Set a
credential_secret, which is used to encrypt sensitive data. This is just a "password", which you should save in a secondary location. - Start the "Node-RED-Minimal" add-on.
- Check the logs of "Node-RED-Minimal" to see if everything went well.
- Click on the "OPEN WEB UI" button to jump into Node-RED.
- The add-on works straight out the box! No need to configure a server!
Note: The add-on is pre-configured out of the box! There is no need to add/change/update the server connection settings!
Please read the rest of this document further instructions.
Note: Remember to restart the add-on when the configuration is changed.
Example add-on configuration:
log_level: info
credential_secret: KJHhfdhiFRENCKfsdfdsDHFHDJS
system_packages:
- ffmpeg
npm_packages:
- node-red-admin
init_commands:
- echo 'This is a test'
- echo 'So is this...'Note: This is just an example, don't copy and paste it! Create your own!
The log_level option controls the level of log output by the addon and can
be changed to be more or less verbose, which might be useful when you are
dealing with an unknown issue. Possible values are:
trace: Show every detail, like all called internal functions.debug: Shows detailed debug information.info: Normal (usually) interesting events.warning: Exceptional occurrences that are not errors.error: Runtime errors that do not require immediate action.fatal: Something went terribly wrong. Add-on becomes unusable.
Please note that each level automatically includes log messages from a
more severe level, e.g., debug also shows info messages. By default,
the log_level is set to info, which is the recommended setting unless
you are troubleshooting.
Credentials are encrypted by Node-RED in storage, using a secret key. This option allows you to specify your secret key. This can be anything you like, it is just like a password. Be sure to store it somewhere safe. You might need it in the future! (e.g., When restoring a backup).
Note: Once you set this property, do not change it - doing so will prevent Node-RED from being able to decrypt your existing credentials and they will be lost.
Note: This option support secrets, e.g., !secret red_secret.
When set to true, the Midnight Node-RED theme by Mauricio Bonani
will be enabled. For more information and a glance at how it looks,
see the GitHub repository of this theme:
https://github.com/node-red-contrib-themes/midnight-red
Allows you to specify additional Alpine packages to be
installed to your Node-RED setup (e.g., g++. make, ffmpeg).
Note: Adding many packages will result in a longer start-up time for the add-on.
Allows you to specify additional NPM packages or
Node-RED nodes to be installed to your Node-RED setup
(e.g., node-red-dashboard, node-red-contrib-ccu).
Note: Adding many packages will result in a longer start-up time for the add-on.
Customize your Node-RED environment even more with the init_commands option.
Add one or more shell commands to the list, and they will be executed every
single time this add-on starts.
The addon will store most of its configuration in the config/node-red folder,
including the flows.json. Please ensure this is included in your backup. It is
also important to note that this will not be removed on uninstalling the addon.
The addon will use the configured time zone of the underlying operating system.
If this is incorrect (for example with the Home Assistant Operating System it
will be UTC), this can be configured in the /config/node-red/settings.js file.
To do so, open the file with a text editor and add the following above the
module.exports = { line.
process.env.TZ = "America/Toronto";
The time zone will need to reflect your environment.
Save the file and restart the Node-RED add-on.
-
Since this minimzed add-on only supports ingress, and Node-Red Dashboard currently does not support accessing the dashboard via Ingress, you cannot install and use Node-RED Dashboard.
-
HTTP nodes and static HTTP content cannot be made available on your network. Please use the official Node Red addon if you wish to do so.
-
The docker image isn't prebuild (yet), which means you currently need decent hardware and/or patience to have your local Home Assistant build the image.
-
If the following error is seen after an update
WARNING (MainThread) [hassio.api.proxy] Unauthorized WebSocket access!please validate the configuration of the Home Assistant server setup in Node-RED. This can be found by double-clicking any Home Assistant node and selecting the pencil icon by the server name. The checkbox that statesI use the Home Assistant Add-Onshould be checked.
Got questions?
You have several options to get them answered:
- The Home Assistant Discord chat server for general Home Assistant discussions and questions.
- The Home Assistant Community Forum.
- Join the Reddit subreddit in /r/homeassistant
You could also open an issue here GitHub.
Feel free to suggest improvements or fork to your liking.
I would also suggest you to read the official contribution guidelines.
The original work was done by Franck Nijhof.
For a full list of all authors and contributors, check the contributor's page.
MIT License
Copyright (c) 2018-2020 Franck Nijhof
Copyright (c) 2020 IceEyz
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.