Add RevPi docs to Node-RED hardware section #3004

sumitshinde-84 · 2025-03-03T14:36:03Z

Description

Related Issue(s)

Checklist

I have read the contribution guidelines
I have considered the performance impact of these changes
Suitable unit/system level tests have been added and they pass
Documentation has been updated

src/node-red/hardware/revolutionary-pi.md

ZJvandeWeg · 2025-03-03T16:49:07Z

src/node-red/hardware/revolutionary-pi.md

+---
+eleventyNavigation:
+  key: Revolutionary Pi
+  parent: Hardware
+meta:
+   title: Setting Node-RED on Revolutionary Pi
+   description: Learn how to set up Node-RED on a Raspberry Pi 4, including installation, configuration, and integration with sensors and actuators.
+   keywords: node-red, raspberry pi, Revolutionary Pi
+---


Which make and model are we talking? I think this is too broad

I would say this will work on all Revolution Pi models with Compute Module 4, such as RevPi Connect 4 and RevPi Core S.

Which one do we have? Can someone test the guide with it?

src/node-red/hardware/revolutionary-pi.md

ZJvandeWeg · 2025-03-03T16:51:00Z

src/node-red/hardware/revolutionary-pi.md

+#### Step 4: Start the Device Agent
+


How to create a service?

Co-authored-by: Zeger-Jan van de Weg <[email protected]>

src/node-red/hardware/revolutionary-pi.md

ZJvandeWeg · 2025-03-04T08:16:16Z

src/node-red/hardware/revolutionary-pi.md

+To install the FlowFuse Device Agent and set it up as a service, download and execute the installation script from GitHub:
+
+```bash
+curl -O https://raw.githubusercontent.com/FlowFuse/device-agent/main/service/raspbian-install-device-agent.sh


Why not just execute right away, but split it into 3 commands?

ZJvandeWeg · 2025-03-04T14:11:10Z

src/node-red/hardware/revolutionary-pi.md

+#### Step 1: Update System Packages
+
+```bash
+sudo apt update && sudo apt upgrade -y
+```
+
+#### Step 2: Install Node.js
+
+You can install Node.js from the default APT repositories:
+
+```bash
+sudo apt install -y nodejs
+```
+
+#### Step 3: Verify Installation
+
+```bash
+node -v


sudo apt update && sudo apt upgrade -y sudo apt install -y nodejs node -v

You can continue with this guide if your version matches or is later then .....

ZJvandeWeg · 2025-03-04T14:14:17Z

src/node-red/hardware/revolutionary-pi.md

+After running the verification command, the installed Node.js version should be displayed in the terminal.
+
+> **Note:** Ensure that the installed version is **Node.js 18 or later**, as this is the recommended version for optimal compatibility with the device agent.
+


Suggested change

After running the verification command, the installed Node.js version should be displayed in the terminal.

> **Note:** Ensure that the installed version is **Node.js 18 or later**, as this is the recommended version for optimal compatibility with the device agent.

ZJvandeWeg · 2025-03-04T14:16:57Z

src/node-red/hardware/revolutionary-pi.md

+#### Step 1: Install Required Package (curl)
+
+If `curl` is not already installed on your system, you will need to install it first:
+
+```bash
+sudo apt install -y curl
+```
+
+#### Step 2: Execute the Installation Script


Suggested change

#### Step 1: Install Required Package (curl)

If `curl` is not already installed on your system, you will need to install it first:

```bash

sudo apt install -y curl

```

#### Step 2: Execute the Installation Script

ZJvandeWeg · 2025-03-04T14:19:56Z

src/node-red/hardware/revolutionary-pi.md

+
+#### Step 3: Restart the Device Agent
+
+Once the device is configured, restart it. The FlowFuse Device Agent will start automatically upon reboot.


sudo systemctl restart flowfuse-device-agent

ZJvandeWeg · 2025-03-04T14:22:00Z

src/node-red/hardware/revolutionary-pi.md

+### Registering the Device Agent to FlowFuse and Running It
+
+After installing the FlowFuse Device Agent, the next step is to link the Revolutionary Pi to your [FlowFuse team](/docs/user/team/). This allows the device to be managed remotely and receive Node-RED deployments.
+
+#### Step 1: Add a New Device to Your FlowFuse Team
+
+Follow the instructions in the official documentation to add your device to your FlowFuse team: [Add a Remote Instance](/docs/device-agent/register/#add-remote-instance).
+
+Once you register the device, you will receive the configuration details required to connect device to your team. Copy the provided command.
+
+![Image showing command device configuration dialog and the command placeholder, where you will find the command to link the device to your FlowFuse team.](./images/how-to-setup-node-red-on-raspberry-pi-device-configuration-dialog.png "Image showing command device configuration dialog and the command placeholder, where you will find the command to link the device to your FlowFuse team."){data-zoomable}
+
+#### Step 2: Configuring the Device
+
+Execute the command you copied to complete the device configuration.
+
+#### Step 3: Restart the Device Agent
+
+Once the device is configured, restart it. The FlowFuse Device Agent will start automatically upon reboot.


<obtain connection command, link to external docs page>

flowfuse-device-agent --quick-connect <insert-your-three-word-token> sudo systemctl start flowfuse-device-agent

Verify in FlowFuse that your device is connected.

ZJvandeWeg · 2025-03-04T14:22:20Z

src/node-red/hardware/revolutionary-pi.md

+#### Step 4: Verifying the Device Agent is Running
+
+After the device restarts, you can check if the FlowFuse Device Agent is running by using the following command:
+
+```bash
+sudo systemctl status flowfuse-device-agent
+```
+
+This should display the status of the FlowFuse Device Agent, showing whether it's active and running.
+
+> **Note:** If you encounter any issues with the agent not starting automatically, you can manually start it with the following command:
+
+```bash
+sudo systemctl start flowfuse-agent
+```
+
+#### Step 5: Monitor and Manage Device from FlowFuse
+
+Once the device is successfully registered and running, you can monitor and manage it from the FlowFuse platform remotly. Any changes you make to the device’s configuration or Node-RED flows will be reflected on the device immediately.
+
+To access the device editor, go to your FlowFuse team, where you will see the Revolutionary Pi listed under remote instances. Click on it to enable the device editor, then open the editor. For more information, refer to [Deploy Flows to Remote Instances](https://flowfuse.com/docs/device-agent/quickstart/#deploy-flows-to-remote-instances).


Suggested change

#### Step 4: Verifying the Device Agent is Running

After the device restarts, you can check if the FlowFuse Device Agent is running by using the following command:

```bash

sudo systemctl status flowfuse-device-agent

```

This should display the status of the FlowFuse Device Agent, showing whether it's active and running.

> **Note:** If you encounter any issues with the agent not starting automatically, you can manually start it with the following command:

```bash

sudo systemctl start flowfuse-agent

```

#### Step 5: Monitor and Manage Device from FlowFuse

Once the device is successfully registered and running, you can monitor and manage it from the FlowFuse platform remotly. Any changes you make to the device’s configuration or Node-RED flows will be reflected on the device immediately.

To access the device editor, go to your FlowFuse team, where you will see the Revolutionary Pi listed under remote instances. Click on it to enable the device editor, then open the editor. For more information, refer to [Deploy Flows to Remote Instances](https://flowfuse.com/docs/device-agent/quickstart/#deploy-flows-to-remote-instances).

sumitshinde-84 and others added 2 commits March 3, 2025 20:04

Add RevPi docs to Node-RED hardware section

f75614a

Update revolutionary-pi.md

ba6168c

sumitshinde-84 requested a review from ZJvandeWeg March 3, 2025 14:50

ZJvandeWeg reviewed Mar 3, 2025

View reviewed changes

src/node-red/hardware/revolutionary-pi.md Outdated Show resolved Hide resolved

ZJvandeWeg requested changes Mar 3, 2025

View reviewed changes

sumitshinde-84 and others added 2 commits March 4, 2025 09:18

Update src/node-red/hardware/revolutionary-pi.md

d62118d

Co-authored-by: Zeger-Jan van de Weg <[email protected]>

Update revolutionary-pi.md

9d7733d

ZJvandeWeg requested changes Mar 4, 2025

View reviewed changes

src/node-red/hardware/revolutionary-pi.md Show resolved Hide resolved

ZJvandeWeg reviewed Mar 4, 2025

View reviewed changes

sumitshinde-84 added 2 commits March 4, 2025 16:02

Update revolutionary-pi.md

b55228a

Update revolutionary-pi.md

82ab31a

ZJvandeWeg reviewed Mar 4, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add RevPi docs to Node-RED hardware section #3004

Add RevPi docs to Node-RED hardware section #3004

sumitshinde-84 commented Mar 3, 2025

ZJvandeWeg Mar 3, 2025

sumitshinde-84 Mar 4, 2025

sumitshinde-84 Mar 4, 2025 •

edited

Loading

ZJvandeWeg Mar 3, 2025

ZJvandeWeg Mar 4, 2025

ZJvandeWeg Mar 4, 2025 •

edited

Loading

ZJvandeWeg Mar 4, 2025

ZJvandeWeg Mar 4, 2025

ZJvandeWeg Mar 4, 2025

ZJvandeWeg Mar 4, 2025

ZJvandeWeg Mar 4, 2025

		After running the verification command, the installed Node.js version should be displayed in the terminal.

		> Note: Ensure that the installed version is Node.js 18 or later, as this is the recommended version for optimal compatibility with the device agent.


		#### Step 3: Restart the Device Agent

		Once the device is configured, restart it. The FlowFuse Device Agent will start automatically upon reboot.

Add RevPi docs to Node-RED hardware section #3004

Are you sure you want to change the base?

Add RevPi docs to Node-RED hardware section #3004

Conversation

sumitshinde-84 commented Mar 3, 2025

Description

Related Issue(s)

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sumitshinde-84 Mar 4, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ZJvandeWeg Mar 4, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sumitshinde-84 Mar 4, 2025 •

edited

Loading

ZJvandeWeg Mar 4, 2025 •

edited

Loading