LogoLogo
OverviewDemos and ResourcesContact
  • What is Engine?
  • Key Concepts
    • Drivers
    • Modules
    • Systems
    • Zones
    • Settings
    • Interfaces
    • Triggers
  • Security
  • Deployment
    • System Architecture
    • Single Sign-On
      • Configuring Engine for SAML2
      • SAML2 with Azure AD
      • SAML2 with ADFS
      • SAML2 with Auth0
      • SAML2 with GSuite
      • OAuth2
  • Integrations
    • Supported Integrations
    • Directory Services
      • Microsoft Office365
    • IoT
      • Device Drivers
      • Node-RED
      • Azure IOT Hub
    • Location Services
      • Locating Users on a Network
      • SVG Map Creation
      • Cisco CMX
      • Cisco Meraki RTLS
      • Desk Sensors
  • Administration
    • Backoffice
      • Systems
      • Devices
      • Drivers
      • Zones
      • Triggers
      • Metrics
      • Users
      • Domains
        • Applications
  • Developer Guide
    • Development Environment
    • Building Drivers
      • Discovery and Metadata
      • State
      • Scheduling Actions
      • Response Tokenisation
      • Device Drivers
      • SSH Drivers
      • Service Drivers
      • Logic Drivers
      • Testing
      • Live Monitoring
      • Logging
      • Security
      • Utilities and Helpers
    • User Interfaces
      • Composer
      • Virtual Systems
      • Widgets
      • Settings.json
  • API
    • Authentication
    • Control
      • Systems
      • Modules
      • Dependencies
      • Zones
      • Websocket
        • Commands
          • bind
          • unbind
          • exec
          • debug
          • ignore
        • Heartbeat
        • Errors
  • Support
    • Service Desk
Powered by GitBook
On this page
  • Access to Node-RED web interface
  • Installing nodes
  • Connecting Engine to Node-RED
  • Node-RED Websocket output
  • Engine websocket input

Was this helpful?

  1. Integrations
  2. IoT

Node-RED

PreviousDevice DriversNextAzure IOT Hub

Last updated 5 years ago

Was this helpful?

To enable rapid connectivity, experimentation / prototyping, or re-use of existing integrations may be deployed alongside Engine.

Access to Node-RED web interface

By default, the Node-RED web interface is exposed locally only on the machine that is running Engine, at . If accessing the Node-RED web interface from a remote client, use methods such as SSH port forwarding to securely mirror the Engine server's 127.0.0.1:1880 to your machine's 127.0.0.1:1880.

Installing nodes

Additional Node-RED nodes can be installed by running the below command on the machine running Engine:

docker exec -it node-red npm install <package-name>

For example, to install the , run:

docker exec -it node-red npm install node-red-contrib-azure-iot-hub

Connecting Engine to Node-RED

Node-RED Websocket output

Engine connects to Node-RED via Node-RED's websockets modules (one for input and one for output). Drag an output websocket module into the Flow, double-click it and set the Type to Listen on and the Path to /ws/.

Engine websocket input

  • Now in any System, add a module of that driver and set:

    • IP: node-red

    • Port: 1880

Messages coming out of the Node-RED websocket output should appear as console log output when debugging the Engine "Node-RED Websocket" module. The status variable "message_received" will also update to show the last string recieved. Simple strings may be used as inputs for Triggers.

On the Drivers page of Backoffice, import the driver by searching for it and clicking "Import".

After creating the module, start it and then monitor the .

The "Node-RED Websocket" driver can be used as a template for creating new drivers that take actions upon receiving messages from Node-RED, or send websocket messages to a Node-RED Websocket Input module. One example of this is the , which uses Node-RED to subscribe to real time updates from Azure IOT Hub.

Node-RED Websocket
debug messages
Pressac desk sensor driver
Node-RED
http://127.0.0.1:1880
connector for Azure IOT Hub
Node-RED Websocket output module