Node-Red - Installation

Introduction

Node-RED is the open-source software that is used as a event programming for Zenitel Connect Pro.

The benefits of Node-RED are

Easy to use – Low code platform, graphical way of programming
Although low code: still powerful
Ideally with many existing integrations and programming examples
Easy to re-use (export and import capability)
Intuitive debug possibilities

There are three locations where Node-RED can be installed and run:

On a virtual installation of Zenitel Connect Pro
On an ICX-510 running Zenitel Connect Pro
On a 3rd party server

One installation of Node-RED can connect to multiple Zenitel Connect Pro servers, there is no need for each having their own.

For How To get started with Node-RED you can go to this article: Node-Red - Getting Started

License

Node-Red connects to Zenitel Connect Pro as a Zenitel Link user. This requires an

Integration license (ZCL-API) - 1002720900

Installation

To install Node-RED you have to install an additional .swu package.

If the Zenitel Connect is running in a Virtual environment download the file Zenitel_Connect_VM_x.x.x-node-red.swu
If the Zenitel Connect is running on an ICX-510 unit download the file Zenitel_Connect_ICX_x.x.x-node-red.swu

The x.x.x denotes the version of Zenitel Connect you are running.

To install the additional package use the standard upgrade procedure for the Zenitel Connect.

Additional Node-RED package loading

Enable TCP port 1880

If the Zenitel Connect is running version 1.10 or older, one have to add TCP port 1880 in the firewall of Zenitel Connect Pro.

As from version 1.11 this is no longer required.

Zenitel advises to close port 1880 again once Node-RED has been setup and the flows operate as intended. This way it is not possible to re-program any flows until the port is opened again in the firewall by an administrator.

Open port 1880. Required only in version 1.10 or older

Installation on a 3rd party server

For installation on a 3rd party server we direct you to the installation guide from Node-RED: https://nodered.org/docs/getting-started/local

Accessing the Node-RED web interface

How you access the Node-RED web interface depends on the firmware installed on the Zenitel Connect:

Version 1.11 or newer: https://[Zenitel Connect IP]/nodered/. You need to log in using the same credentials as when accessing the Zenitel Connect web interface.
Version 1.10 or older: https://[Zenitel Connect IP]:1880

Zenitel Connect IP is the IP Address of the Zenitel Connect server.

This article explains how to start programming: Node-Red - Getting Started