Skip to main content

Quick Start

Build your first flow in 5 minutes.

Welcome to EdgeFlow! This guide will walk you through creating your first automation flow. By the end, you'll understand the basics of building, connecting, and deploying flows.

1 Open Editor
2 Add Nodes
3 Connect
4 Deploy
5 Test

What You'll Build

A simple automation that triggers on a schedule and logs output to the debug panel.

Inject
ƒ Function
🔍 Debug
Step 1

Open the Flow Editor

After installing EdgeFlow, open your browser and navigate to the web interface:

http://localhost:8080
💡
Remote Access

If accessing from another device, use your device's IP address: http://<device-ip>:8080

You'll see the EdgeFlow interface with three main areas:

📦
Node Palette

Left panel with available nodes

🎨
Canvas

Center area where you build flows

📊
Debug Panel

Right panel showing debug output

Step 2

Add an Inject Node

The Inject node is your flow's trigger. It can fire manually, on a schedule, or when EdgeFlow starts.

1
Find the Inject node

In the left palette, look under "Input" category or search for "inject"

2
Drag to canvas

Click and drag the Inject node onto the canvas area

3
Configure the node

Double-click the node to open settings, set payload to timestamp

Inject Node Settings
Payload timestamp
Topic (optional)
Repeat none
Step 3

Add a Debug Node

The Debug node displays message payloads in the debug panel. It's essential for testing and troubleshooting.

1
Find the Debug node

In the palette, look under "Output" category or search for "debug"

2
Drag to canvas

Place the Debug node to the right of the Inject node

Step 4

Connect the Nodes

Nodes communicate by passing messages through wires. Connect the output of one node to the input of another.

Inject
Debug
1
Start from output port

Click on the small circle on the right side of the Inject node

2
Drag to input port

While holding, drag to the input port on the left side of Debug node

3
Release to connect

A wire will appear connecting the two nodes

💡
Wire Tips

To delete a wire, select it and press Delete. To add a bend, double-click the wire.

Step 5

Deploy Your Flow

Deploying activates your flow on the server. Until deployed, your changes only exist in the editor.

Click the Deploy button in the top-right corner

After deployment, you'll see a success notification confirming your flow is now active.

Step 6

Test Your Flow

Now let's trigger the flow and see the output!

1
Click the Inject button

Click the small button on the left side of the Inject node

2
Check the Debug panel

Look at the right side panel to see the timestamp output

🔍 Debug Output
14:32:15 node: Inject msg.payload : number
1706534535000
🎉
Congratulations!

You've created your first EdgeFlow automation! The timestamp value represents milliseconds since January 1, 1970 (Unix epoch).

Enhance Your Flow

Let's make the flow more useful by adding a Function node to format the timestamp.

1

Add a Function Node

Drag a Function node between Inject and Debug

2

Rewire the Flow

Connect: Inject → Function → Debug

3

Add Code

Double-click Function and add the code below

Function Node Code
// Format the timestamp as a readable date
const date = new Date(msg.payload);
msg.payload = {
    formatted: date.toLocaleString(),
    timestamp: msg.payload,
    iso: date.toISOString()
};
return msg;

Now when you trigger the flow, you'll see a nicely formatted date in the debug panel:

🔍 Enhanced Debug Output
14:35:22 node: Function msg.payload : object
{
  "formatted": "1/29/2024, 2:35:22 PM",
  "timestamp": 1706534122000,
  "iso": "2024-01-29T14:35:22.000Z"
}

Real-World Example

Here's how you might extend this for a real IoT project - reading sensor data and sending alerts:

🌡️ DHT22
ƒ Check Temp
📱 Telegram
📊 Dashboard
📡
Read Sensors

Use GPIO nodes to read from DHT22, BME280, or other sensors

Process Data

Use Function or Switch nodes to check conditions

📤
Send Alerts

Send notifications via Telegram, Email, or other services