Eugenio Gateway Node-RED

Eugenio is a IoT end-to-end platform (hardware and software-as-a-service) created by Logicalis for simplifying the building of custom IoT solution.

Node-RED is a programming tool for wiring together hardware devices, APIs and online services.

Together, this two tecnologies can simulate the whole proccess of create, connect, send messages and streaming data in our IoT plataform.

Links

More information about Node-RED:

• Node-RED: https://github.com/node-red

More information about Eugenio:

• Eugenio: https://eugenio.io/
• Eugenio Documentation: https://portal.stg.eugenio.io/docs

Docker Images:

• NodeRED: https://hub.docker.com/r/nodered/node-red-docker
• SWLogiclais/Eugenio-Gateway-Nodered: https://hub.docker.com/r/swlogicalis/eugenio-gateway-nodered

Installing

See https://docs.docker.com/get-started/part2/#build-the-app for details about how to build a Dockerfile, after that, see https://docs.docker.com/get-started/ for details about running a docker container.

First of all, you can build the local image with the Dockerfile in the repository. Run the followed command (inside the directory):

docker build . --tag swlogicalis/eugenio-gateway-nodered:latest

It's importante to build a new image using the DockerHub's Eugenio-Gateway-Nodered image, because during the local building there are some configurations of device registration in Eugenio that haven't be done in the official DockerHub image (you can use the official image and make the device registration by yourself).

You can run the container exposing the port 1880 to access the Node-RED running in it. To do this, you just need to run the command below:

• Running the image passing the APIKEY environment variable (used to register the device):

  docker run -p 1880:1880 -d --name EugenioNodeRED -e APIKEY="apikey" swlogicalis/eugenio-gateway-nodered:latest

• Running the image without APIKEY (you will need to register the device mannualy and replace "null" fields with the id of your device):

  docker run -p 1880:1880 -d --name EugenioNodeRED swlogicalis/eugenio-gateway-nodered:latest

If you are running the oficial image, please follow the next steps to register a new device and configure manualy your Node-RED, otherwise everthing is already done, you can just click the Injection's node button to start sending messages!

Creating a Device in Eugenio

You will need to use the Eugenio APIs to register a new device. This is necessary to get the ID of your device, and then configure the MQTT node in Node-RED flow.

The API used is described in Eugenio Documentation, but you can access directly by the links below:

• Swagger: https://portal.stg.eugenio.io/api/v1/apis/devicemanager?swagger-ui#/Generic%20Devices%20(Things)/post_things
• Redoc: https://portal.stg.eugenio.io/api/v1/apis/devicemanager?doc#tag/Generic-Devices-(Things)/paths/~1things/post

Configuring Node-RED

After get up the EugenioNodeRED container and register a new device (obtaining in this way your device ID), you can access your container in your server link at the port 1880 (in case of running localy, you can access http://localhost:1880 for example) in your browser.

A flow with an Inject, Trigger, Function and MQTT nodes will be already prepared.

Accessing the MQTT node, replace every field containing the string {deviceId} by your device ID. The list of fields where is necessary to replace are listed below:

• Topic field in MQTT Properties (accessed by double clicking in the MQTT node)
• Client ID field in Connection Tab at MQTT-Broker Properties (accessed by editing the Server field in MQTT node)
• Username field in Security Tab at MQTT-Broker Properties (accessed by editing the Server field in MQTT node)
• Topic field in Messages Tab at MQTT-Broker Properties (accessed by editing the Server field in MQTT node)

Doing this, you can update all the modifications and deploy your flow. The MQTT node will connect in a few seconds, and your device will be prepared to send the messages.

You can modify the json object that will be send by double clicking the Funcion node.

If you are ready to send messages, just click in Injection's node button, and done.