Available nodes in the Platform's FlowEngine

Introduction

The Flow Engine module is the flow engine that allows to perform data intake, and is build through the programming tool Node-RED, with which you can connect both hardware devices, APIs and online services. One of the advantages on the use of the flow created through Node-RED, is that the information is storage in JSON format, which can be is easily imported or exported.

To create flows using Node-RED, it uses individual units called nodes, and the connection between these nodes is simple and intuitive. In the tool viewer, you can find a description of the node, its inputs and outputs. Next, we show a list of the nodes that have been incorporated into the platform's Flow Engine module along with the library to which each corresponds to, a short description of it, and the official relative documentation.

Component List

INPUT

INPUT

INPUT

Node Name

Library

Description

Technical documentation

Node-RED's own node

Activates the flow manually or at regular intervals.

Node-RED's own node

Catches errors thrown by nodes in the same tab.

Node-RED's own node

Reports about messages from other nodes in the same tab.

Node-RED's own node

Creates virtual links between flows.

Node-RED's own node

Connects to a MQTT broker, and subscribes to the messages of a specific topic.

Node-RED's own node

Create a HTTP endpoint for creating web services.

Node-RED-contrib-websocket

WebSocket entry node.


Node-RED-bluemix-nodes

Provides TCP inputs. It can be connected to a remote port or accept incoming connections.

 

Input node that generates a message that contains an encrypted buffer, string or string.

 

Onesait Platform's own node

Create a HTTP endpoint for creating web services.

 

 

Performs an insertion of data in the target ontology.

Onesait Platform's own node

 

Input node for notifications.

Node-RED-contrib-ttn

Receive events from devices connected to The Things Network.

Receive information from devices connected to The Things Network.

Node-RED-node-stomp

Connects to a Stomp server to receive messages.

Node-RED-contrib-pubnub

Subscribes to a specific PubNub channel and receive its content.

OUTPUT

OUTPUT

OUTPUT

Node Name

Library

Description

Technical documentation

Node-RED's own node

Monitors messages in an editor. Sends messages within the editor for debugging purposes.

Node-RED's own node

Creates virtual links between flows.

Node-RED's own node

Connects to a MQTT broker, and subscribes the messages of a specific topic.

Node-RED's own node

Sends responses back to requests received from an HTTP input node.

Node-RED-contrib-websocket

WebSocket exit node.

 

Node-RED-bluemix-nodes

Provides TCP output options.

 

Sends the corresponding message to the host and the assigned UDP port.

Onesait Platform's own node

Send responses back to requests received from an HTTP input node.

Node-RED-contrib-ttn

Sends information to a device connected to The Things Network.

 

Node-RED-node-stomp

Connects to a Stomp server to send messages.

 

Node-RED-contrib-pubnub

Posts messages on the specified PubNub channel.

FUNCTION

FUNCTION

FUNCTION

Node Name

Library

Description

Technical documentation

 

Node-RED's own node

JavaScript method that works against the messages received by the node.

Sets properties based on the template that is added.

 

Node-RED's own node

Delays message entry at set intervals.

Creates a timeout within the flow so a first message is sent, and optionally, depending on the chosen value, a second message will also be sent.

Node-RED's own node

Allows to insert a comment.

 

Node-RED's own node

Sends a HTTP request, and return a response.

 

Node-RED'-bluemix-nodes

Connects to a remote TCP port, and answers messages from an input client.

 

 

 

 

 

 

Node-RED's own node

Routes messages based on their property values or sequential position.

Adds, changes, deletes or moves properties of a message. You can specify multiple rules that apply, in the defined order.

Scales linearly the received value.

Splits a message into a sequence of messages.

Joins a sequence of messages into a single message. The way to join them can be automatic, manual or reduced sequence.

Sorts a sequence of messages, or the properties of one.

Creates message sequences based on different rules, such as: number of messages, time intervals and concatenated sequences.

 

 

 

 

Node-RED's own node

Converts between the CSV format and the JavaScript object that represents it. The process can be done in either direction.

Extracts elements from an HTML document using a CSS selector.

Converts between the JSON format and the JavaScript object that represents it. The process can be done in either direction.

Converts between the XML format and the JavaScript object that represents it. The process can be done in either direction.

Converts between the YAML format and the JavaScript object that represents it. The process can be done in either direction.

Onesait Platform's own node

Invokes an operation of a REST API from Platform.

 

Onesait Platform's own node

Convert any message into an action for a Digital Twin.

 

Represents a Digital Twin from Platform.

Onesait Platform's own node

Node with integration in Firebase for the development of web and mobile applications.

Onesait Platform's own node

Insert values in an ontology.

Onesait Platform's own node

Node that is responsible for sending mails.

 

Onesait Platform's own node

Makes a query on dynamic bases.

 

Makes a query on static bases.

 

 

 

 

 

Node-RED-contrib-crypto-js

Encrypts the message using a given algorithm.

 

 

 

 

 

Decrypts the message using a given algorithm.

Creates a message authentication code with a hash key.

Generates an encrypted message using a given algorithm.

Encodes information using a set of specific characters.

Decodes information using a set of specific characters. Generates an array of words.

Node-RED-node-rbe

Provides reports if an exception happens. It will not send information unless the data has changed. It works with both numbers and strings.

Node-RED-ontrib-file-function

This node loads the script to be executed from a current document on the disk. It is the same functionality as the "function" node.

Node-RED-contrib-soap

It allows the user to send a SOAP request. It will be necessary to create a new configuration. It is very important to enter the method name correctly.

SOCIAL

SOCIAL

SOCIAL

Node Name

Library

Description

Technical documentation

 

Node-RED-node-email

It allows to periodically receive emails through the IMAP protocol. Files added to the email are treated using an array of objects where each object represents an attachment. The data update time can be chosen.

 

Node-RED-node-twitter

It can be used to search for tweets with a specific term, retrieving all tweets by user, or to view direct messages received from an authenticated user.

Node-RED-node-email

It offers the possibility of sending emails. You can send attachments, which will be contained in an array in nodemailer format.

 

Node-RED-node-twitter

It allows to send tweets and direct messages.

 

Node-RED-node-instagram

Retrieves Instagram photos by updating the user's account every 15 minutes. Each message sent contains a single photo. If the metadata is available, the location and time of the photo capture can be obtained.

 

 

 

Check the Instagram content every time the user receives a message. Each message will be accompanied by a single photo; if the metadata is available, a capture of the spatial and temporal location can be made.

STORAGE

STORAGE

STORAGE

Node Name

Library

Description

Technical documentation

Node-RED-node-tail

Injects contents of a file into the flow. It can only be used on Linux/Mac environments.

Node-RED-contrib-file-function

Reads the contents of a file parsed as a string or binary buffer.

 

Writes a file, adding or replacing existing content. It can be used to delete the document.

ANALYSIS

ANALYSIS

ANALYSIS

Node Name

Library

Description

Technical documentation

Node-RED-node-sentiment

It allows to make a feeling score, positive or negative, in a passed message. To do this, this node analyzes the words that are entered using the AFINN-165. Usually the scores range from -5 to 5, a score above zero is positive, and below it is negative.

ADVANCED

ADVANCED

ADVANCED

Node Name

Library

Description

Technical documentation

 

The node allows you to search for changes in a directory or file. You can perform a multiple search by adding commas to separate documents or addresses.

 

Node-RED-node-feedparser

Monitorizes the RSS or Atom Feed of a website to give updated information. By default, an information request is made every 15 minutes.

 

Allows to enter a command line in the background of the Pi that works as if communicating directly with it. The node can be configured to launch the output once the command is finished, or while it is being generated.

 

RASPBERRY PI

RASPBERRY PI

RASPBERRY PI

Node Name

Library

Description

Technical documentation

 

 

 

 

Node-RED-node-pi-gpio

Node used to establish the connection with the GPIO pins on the Raspberry Pi. It generates 0 or 1 variation of the pin state in the input.

 

 

 

Output node, can be used in digital or PWM modes. In the first case, values ​​of 0 or 1 are set, while in the second case, they range in a threshold from 0 to 100.

Detects the buttons of a mouse. It requires that the use of the mouse is by USB.

Detects keystrokes. It requires that the use of the keyboard is by USB.

WEATHER

WEATHER

WEATHER

Node Name

Library

Description

Technical documentation

 

Node-RED-node-openweathermap

Makes a check of the data of the web openweathermap.org and establishes a 5-day forecast that is included in an array. An API key must be used.

 

 

Makes a periodic survey of openweathermap.org data and generates a 5-day forecast whenever there is a change in the information. An API key must be used.

UTILITIES

UTILITIES

UTILITIES

Node Name

Library

Description

Technical documentation

Node-RED-contrib-uuid

Sets a unique universal identifier in different ways.

SPREADSHEET

SPREADSHEET

SPREADSHEET

Node Name

Library

Description

Technical documentation

 

 

Node-RED-contrib-spreadsheet-in

Transforms the contents of a spreadsheet to a work object.

Selects a sheet object from a work object.

Selects the value of a cell on a sheet.

Transforms the sheet object into an array of JSON objects.

ONESAIT PLATFORM DATAFLOWS

Onesait Platform Dataflows

Onesait Platform Dataflows

Node Name

Library

Description

Technical documentation

 

 

 

 

Onesait Platform's own node

Starts a DataFlow in the platform.

Onesait Platform Developer Portal (Start dataflow)

Stops a DataFlow in the platform.

Onesait Platform Developer Portal (Stop dataflow)

Checks the status of a dataflow in the platform.

Onesait Platform Developer Portal (Check dataflow status)

Â