Accessing Node-RED

Overview

To access Node-RED, you must first enable it (see Node-RED Settings, below). Once Node-RED has been enabled, you can access it the Node-RED editor at the following URL: https://controlleraddress/dist/#/nodered/nodered

controlleraddress is either the IP or hostname.local address of the controller. Refer to the controller's installation guide for detailed instructions on how to get the hostname and default login credentials of its embedded webserver.

It cannot be accessed from the embedded web server GUI directly.

Note: Unlike the Embedded Web login, the username for Node-RED login is case-sensitive. If you receive the error "Login failed", ensure you are entering the username as "admin", not "Admin":

From the Node-RED page, you can modify some Node-RED settings (see below for more information) .

Node-RED Settings

Node-RED Settings page: https://controlleraddress/dist/#/red5/noderedsettings

Node-RED Status

The Node-RED status is displayed at the top of the page for your information and is not configurable.

Node-RED Status options:

• Stopped: Displays when Node-RED is disabled.
• Starting: Momentarily displays when Node-RED is enabled.
• Started: Displays when Node-RED is configured and ready to use.
• Error: Displays when there is an error.

Enable Node-RED

To enable Node-RED, click the Start Node-RED button.

To start Node-RED in Safe Mode, click the drop-down button next to the Start Node-RED button and select Safe Mode. When Node-RED is started in Safe Mode, all flows are stopped. Flows are restarted after deploying any changes.

To disable Node-RED, click the Stop Node-RED button.

Synchronize Node-RED on Database Save

To enable or disable Node-RED database synchronization, toggle the Synchronize Node-RED on Database Save slider so that it changes color, then click Save.

When Node-RED database synchronization is enabled, Node-RED flows are synced to the device's database. Flows are cleared on a database clear and are updated on a database load.

When Node-RED database synchronization is disabled, Node-RED flows are stored separate from the device's database. Flows are not cleared on a database clear and do not get updated on a database load.

Flows are deleted after a factory reset, regardless of the Node-RED database synchronization state.