Skip to content

ncdcommunity/ncd-nodered-ui-sensor-monitor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 

Repository files navigation

ncd-nodered-ui-sensor-monitor

A Node-RED Dashboard tool to monitor NCD Sensors

This project is a basic subflow developed by the NCD IoT team based on Node-RED and the new Dashboard 2.0 framework, which allows you to visualize the data provided by the NCD sensors, such as MAC Address, Type, Mode, RSSI (DigiMesh), and the date and time of the last incoming message in an intuitive way.

Screenshot from 2024-12-10 09-01-07

Requirements/Dependencies:

Before you begin using the NCD-Dashboard, you’ll need to have the following software installed:

  • Node-RED
  • @ncd-io/node-red-enterprise-sensors Library
  • @flowfuse/node-red-dashboard

Node-RED

Node-RED, is a visual programming tool, It provides a browser-based editor that allows creating applications by wiring predefined black box functions (nodes) . Despite its technical nature, Node-RED offers a user-friendly interface. Node-RED is an open-source project under the OpenJS Foundation. This means it’s free to use, without any monthly subscription fees. You can install and run Node-RED locally on your PC, or, in the case of our Enterprise IIoT Gateway, it comes pre-installed and runs as a service.

NCD Enterprise Sensor Library

This library handles communication to, and configuration of, the NCD Wireless Sensor Line. It can be used in conjunction with Node-RED to create and manage a Wireless Sensor Network using the Node-RED flow-based development tool on any platform.

Note

This library is pre-installed on the Enterprise IIoT Gateway and ready to use.

FlowFuse Dashboard 2

FlowFuse Dashboard 2.0 is an easy to use collection of nodes for Node-RED that allows you to create data-driven Dashboards & data visualizations. Installation procedure is similar to the previous one, FlowFuse’s Node-RED Dashboard 2.0 is also available in the Node-RED Palette Manager.

Source: https://dashboard.flowfuse.com/

Instalation Procedure

Step 1.- Open the menu in the top-right of Node-RED, then Click “Manage Palette”:

nodered-menu-1

Step 2.- Switch to the “Install” tab, Search “@flowfuse/node-red-dashboard”, Install the package:

flow-fuse-dashboard-installation-install

Step 3.- You must confirm the installation by clicking on the Install button in the pop-up window.

flow-fuse-dashboard-installation-confirm

Step 4.- You will see a list of the dashboard 2 nodes that have been installed.

flow-fuse-dashboard-installation-nodes-installed

Step 5.- In workspace you can see the available nodes in the nodes palette, as shown in the following image:

flow-fuse-dashboard-installation-nodes-pallete

See the following GIF for a visual demonstration of the installation process:

nodered-install-flow-fuse-dashboard-2

Importing

After successfully installing Dashboard 2.0, you’re ready to import the NCD UI Sensor Monitor. The process is straightforward, but be sure to follow these steps carefully:

Copy the JSON: Locate the "ncd-ui-sensor-monitor" JSON file. Import the JSON: Within Node-RED, use the import function to bring in the copied JSON file.

This will import the NCD Dashboard elements into your Node-RED workspace, allowing you to visualize and interact with your NCD sensor data.

Copy JSON File

  1. Go to "https://github.com/ncdcommunity/ncd-nodered-ui-sensor-monitor/blob/main/Node-RED/ncd-ui-sensor-monitor.json" in this repository: copy_raw_file

Import NCD-UI-Monitor

With the NCD Dashboard source code copied, head back to the Node-RED node editor and follow these next steps carefully.

  1. Go to the Main Menu (icon in the upper right corner) then click on “Import” option, as shown in picture:

manage_palette_

  1. A text-box will be opened. Right click and paste the code you just copied from GitHub, as shown in picture:

Screenshot from 2024-09-20 15-03-59

  1. You should see the JSON code in text-box, now you can press the red “Import” button at the bottom right (by default the “current flow” option is selected):

Screenshot from 2024-09-20 15-04-11

  1. In the top of the Node-RED editor, you will see information of the NCD-UI-Monitor you just imported, and automatically you will have the node available inside the node editor, now you can position it inside the editor or workspace by left clicking:

Screenshot from 2024-09-20 15-05-19

Note

You will need to connect the output of the "Wireless Gateway" node to the input fo the "UI Monitor" node.

ncd-ui-monitor-sensor-connection

  1. This flow includes a Wireless Gateway node pre-configured with the Enterprise IIoT Gateway port, you should click on "Deploy" button in order to save and apply the changes:

Screenshot from 2024-09-20 15-06-04

  1. Then go to "Dashboard 2.0" tab:

Screenshot from 2024-09-20 15-06-34

  1. And click on "Open Dashboard" button, in order to open the Dashboard in a new Web Explorer Tab:

Screenshot from 2024-09-20 15-06-44

  1. You should see something like this, and as soon as a new NCD Sensor data arrive, you should see the info:

ncd-ui-monitor-sensor-init

Example: ncd-ui-monitor-sensor-inspect

ncd-ui-monitor-sensor-inspect-data

ncd-ui-monitor-sensor-last-transmisions-window


© 2019-2024 National Control Devices, LLC. All rights reserved.

About

A Node-RED Dashboard tool to monitor NCD Sensors

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published