Articles in this section

See more

Data source - SMTP

  • Updated
Supported hardware
IXrouter3, firmware 3.10 and up (upgrade)

For Live data, Historical data, Datalogging to MQTT broker, and Alarming you'll need to set up a data source and add variables. This article shows you how to do this for communication via SMTP.

How does it work?

The machine sends an e-mail to the SMTP catcher inside the IXrouter instead of to a public cloud SMTP server. The SMTP catcher will then pass on a part of this e-mail to the IXON Cloud. You can configure what you'd like to pass on. This value can then be used for Live data, Historical data, and Alarming.

For example, let's say you configured a variable to search for a text pattern (e.g. "Description:") and the original e-mail contains the following text:

Alarm triggered
Description: Valve C6 opened during operation. Machine has entered error state.
Code: 153

The SMTP catcher will search for the pattern "Description:" and get the text after this pattern until the end of that line. This means the following value will be passed on:

Valve C6 opened during operation. Machine has entered error state.

If Alarming will be used, the e-mail in your inbox will look as follows:

E-mail

Prepare the machine

Instead of sending an e-mail to a public cloud SMTP server, the machine will have to send the e-mail to the IXrouter's SMTP catcher.

  1. Open the SMTP server settings on your machine and enter the IXrouter's LAN IP address as the SMTP server address.

Add a data source

The machine will need to be added as an SMTP data source.

  1. Go to Fleet Manager > Devices and click on your device name.
  2. In the left menu, at Services, click on the add.svg icon and select Data source > SMTP/GPIO.
  3. Enter the requested information (details below) and click on Add.
    Field Description / instructions
    Name Enter a name for the data source.
    Identifier The identifier is entered automatically and ensures that every data source remains unique, even if they share the same name.
    IP address Leave this field empty.

Add variables

Once you've added a data source, you can add the variables.

  1. Under your data_source_outline.svg Data source, go to Variables and click onadd.svgAdd variable.
  2. Enter the requested information (details below) and click on Add.
    Field Description
    Name Enter a name for the variable.
    Identifier The identifier is entered automatically and ensures that every variable remains unique, even if they share the same name.
    Type

    Boolean
    Turns TRUE briefly when an e-mail has been received.

    String
    Use content from the original e-mail. For example the subject or a specific part of the e-mail. Configurable at Action.
    Length (for String data types only) The String length.
    Protocol Select SMTP.
    Action Select the content from the original e-mail you want to use.
    Text pattern (only for "Text pattern"-action) The e-mail will be searched for this text pattern (e.g. "Description:"). If found, everything after "Description:" until the end of the line is used.
    Keywords Only e-mails containing these keywords are handled. Other e-mails are ignored.
  3. A single variable is all you need to handle all your e-mails. If the configured text pattern or keywords do not match with all e-mails that you want to use, then repeat step 5 to add more variables. Alternatively, you can also click Import from CSV-file near the top right corner to add variables in bulk instead.
    • The structure of the CSV file is explained here: Import variables: CSV file structure.
    • Using Export to CSV-file and Import from CSV-file enables you to easily copy variables from one device to another device. Alternatively, you can also use device templates.

You have now made the changes in the IXON Cloud, but these are not yet active in your device. You will need to push your changes to your device for them to take effect.

Temporary disconnect

After this next step, the config push, the device may temporarily disconnect and LAN communication may be temporarily interrupted while it's applying the new settings. This only takes a moment.
  1. Click on Push config to device in the top right corner.

Test variables

The variables test is recommended to check if all added variables are configured correctly. It shows the value of all variables if everything is configured correctly and shows an error if something is not configured correctly.

  1. Click on Run test near the top right corner.
    • The test will attempt to update values every 0.5 seconds.
    • Is the test showing unexpected values? Check the addresses and data types of the variables.
    • Is the test showing a timeout error? Check that the data source is configured correctly and the machine is connected and powered on. If you are still not getting any values, contact your IT to make sure the test is not blocked. The test sets up an outgoing connection from your computer to the IXrouter using:
      Port Transport protocol Application protocol
      443 TCP WebSocket

Live data, Historical data, Alarming

Now that the data source and variables have been set up, you can continue below.

  1. Click below to continue in the feature specific articles.