Using the Node-RED Editor

Description

The Editor Window (see below) consists of the following main components:

• Header: Contains the deploy button and main menu.
• Palette: Contains the nodes available to use, including Delta Controls nodes.
• Main Worksplace: Space where you create your flows.

Editor components

Editor window

What are nodes and what do they do?

Nodes are used to wire together flows, which are then deployed for a number of different functions.

Node elements

Creating your first flow

The following procedures contain the basic steps to creating a flow, which comprise a single set of connected nodes.

Flows are created in the Flow properties in the Flow tab (located in the Sidebar).

Add an inject node

The Inject node allows you to inject messages into a flow, either by clicking the button on the node, or setting a time interval between injects.

Drag one onto the workspace from the palette.

Add a debug node

The Debug node causes any message to be displayed in the Debug sidebar. By default, it just displays the payload of the message, but it is possible to display the entire message object.

Add Delta node(s), where applicable

Add Delta node(s) from the palette as required.

Wire them together

Connect the Inject and Debug nodes together by dragging between the output port of one to the input port of the other.

Deploy

At this point, the nodes only exist in the editor and must be deployed to the server.

Click the Deploy button.

Additional Procedures

Deleting a Flow

1. Login to Node-RED editor.
2. Click on the flow you want to delete.
3. Go to the main menu and select Flows > Delete.

Or right-click on existing flow:

TIP: To restore your deleted flow, press Ctrl + Z on your keyboard.

Renaming a Flow

1. Login to Node-RED editor.
2. Double-click on the flow you want to rename.
3. Under Name enter the new flow name.
4. Click Done.

Hiding a Flow

1. Login to Node-RED editor.
2. Right-click on the flow you want to hide and select Hide flow.

Displaying a Hidden Flow

1. Login to Node-RED editor.
2. Click on the down arrow in the top right corner.
3. Select List flows.

4. Find your flow on the list and select it.

5. The flow is displayed with an orange flashing border.

Exporting a Flow

1. Login to Node-RED editor.
2. Select a node/group of nodes that you want to export (note the orange frame).

3. Navigate to the main menu and select Export.

4. Select if you want to export selected nodes, current flow or all flows then click Download or Copy to clipboard.

5. Your flow has been exported in JSON format.

Importing a Flow

1. Prepare the flow content you want to import (JSON file or copy in clipboard).
2. Login to Node-RED editor.
3. Select flow to which you want to import the new content.
4. Go to the main menu and select Import.

5. Paste flow content or import JSON file, then click Import.

6. Locate new flow content on your flow.

For more information about Node-RED functionality, refer to the Node-RED documentation.