@edgeberry/device-node-red-contrib 3.5.3

Node-RED node to interact with the Edgeberry Device Software over DBus

npm install @edgeberry/device-node-red-contrib

The Edgeberry Node-RED nodes let your on-device Node-RED flows communicate with the Edgeberry Device Software over DBus. This package registers three nodes — device, button and status — all under the Edgeberry Device palette category. Internally they all use @edgeberry/device-sdk.

Nodes

device

The "everything" device node. Send telemetry to the Device Hub, publish application info/status, trigger device identification, and receive cloud-to-device messages. See "Quick Start" below.

button

Emits a message for every hardware button event on the device. Each output message has:

• msg.topic — the event type (click, pressrelease, apToggle, longpress, verylongpress)
• msg.payload — { event, timestamp }

An optional Events field on the node lets you filter to a comma-separated subset (e.g. click,longpress). Leave it empty to receive every event.

status

Two-way node for device status:

• Output: emits messages whenever any part of the device state changes. msg.payload is the selected slice (system / connection / application) or the full state; msg.state always contains the full DeviceState. Options include restricting to a section and suppressing duplicates.
• Input: sets this application's status on the device. Canonical format:

  msg.topic   = "status";
  msg.payload = { level: "ok" | "warning" | "error" | "critical", message: "string" };
  

  A critical level makes the device flash red rapidly and emit continuous short beeps until the status is cleared.

Features

• Send Telemetry Data - Send sensor readings and device data to Device Hub
• Receive Cloud Messages - Receive commands and data from cloud applications
• Hardware Button - React to physical button presses (short / long / very long / AP toggle)
• Device Status - Observe device state changes and set the application's status
• Device Identification - Trigger device's physical identification (LED blink + beep sound)
• D-Bus Integration - Talks to the Edgeberry Device Software via @edgeberry/device-sdk

Installation

Option 1: Install via Node-RED Palette Manager

1. Open Node-RED in your browser
2. Click the menu (☰) → Manage palette
3. Go to the Install tab
4. Search for @edgeberry/device-node-red-contrib
5. Click Install

Option 2: Manual Install

On your Edgeberry device:

cd ~/.node-red
npm install @edgeberry/device-node-red-contrib

Restart Node-RED after installation.

Quick Start

Send Telemetry Data

1. Add an Inject node (trigger every 10 seconds)
2. Add a Function node with this code:

msg.topic = "telemetry";
msg.payload = {
    temperature: 22.5,
    humidity: 45,
    status: "ok"
};
return msg;

3. Add an Edgeberry node
4. Connect: Inject → Function → Edgeberry
5. Deploy and watch the data flow to Device Hub!

Receive Data on Device Hub

On your Device Hub server with Node-RED:

1. Install @edgeberry/devicehub-node-red-contrib
2. Add a Device Hub Device node
3. Configure it with your device name (e.g., EDGB-A096)
4. Connect it to a Debug or Dashboard node
5. You'll receive your telemetry data in real-time

Receive Cloud-to-Device Messages

The Edgeberry node automatically receives messages from the cloud:

Device Flow:

[Edgeberry] → [Switch: topic=cloudMessage] → [Process Message]

Switch Node Configuration:

• Property: msg.topic
• Rule: == cloudMessage

Cloud Flow (on Device Hub):

[Inject] → [Function] → [Device Hub Device: EDGB-A096]

Function Node:

msg.action = "sendMessage";
msg.payload = {
    command: "updateConfig",
    interval: 30
};
return msg;

The device will receive the message and output it with topic: 'cloudMessage'.

Processing Cloud Messages on Device:

// In a Function node after the Edgeberry node
if (msg.topic === "cloudMessage") {
    const command = msg.payload.command;
    
    switch(command) {
        case "updateConfig":
            // Update device configuration
            flow.set("updateInterval", msg.payload.interval);
            node.warn(`Config updated: ${msg.payload.interval}s interval`);
            break;
        case "restart":
            // Handle restart command
            break;
    }
}
return msg;

License & Collaboration

Copyright© 2025 Sanne 'SpuQ' Santens. The Edgeberry NodeRED node is licensed under the MIT License. The Rules & Guidelines apply to the usage of the Edgeberry™ brand.

Collaboration

If you'd like to contribute to this project, please follow these guidelines:

1. Fork the repository and create your branch from main.
2. Make your changes and ensure they adhere to the project's coding style and conventions.
3. Test your changes thoroughly.
4. Ensure your commits are descriptive and well-documented.
5. Open a pull request, describing the changes you've made and the problem or feature they address.