Gateway 2.0 and MQTT Support

Learn how to create the connection between MQTT and the most powerful gateway.

PHANTOM® Gateway 2.0 MQTT Support

The Gateway 2.0 used in the wireless sensor system ERBESSD INSTRUMENTS® PHANTOM® supports the MQTT IoT protocol. All sensor data is available  through MQTT, including temperature, RPM, etc. As well as full time wave forms from vibration sensors (the FFT must be processed by the user from the TWF).

The gateway acts as a MQTT client that will connect to a MQTT broker of your choice.

Enabling MQTT Support

To enable the MQTT support in the Gateway 2.0 admin console; you need to activate it in the MQTT config page by clicking the “Enable MQTT connection” checkbox.

Then fill your MQTT broker options accordingly. We support the following protocols for connecting to the MQTT broker:

  • mqtt://
  • mqtts:// (encrpyted)
  • ws:// (websocket)
  • wss:// (websocket encrypted)

You need to enter your MQTT broker hostname/ip address, the port, and optionally the user name and password for authentication.

If you wish to receive full time wave forms from vibration sensors please mark the corresponding checkbox. Time wave forms are large messages, so if you are not intending to use them you may leave the option unchecked.

The “Allow Gateway management though MQTT” option allows to use the full management API to control the gateway and its sensors using the MQTT connection. Please contact a ERBESSD INSTRUMENTS® support representative to receive a copy of the management API documentation.

MQTT screen

After you save the settings the Gateway 2.0 will restart. After it restarts it will try to connect to the MQTT broker and show an state on the same MQTT section at the top if there’s any issues.

You can use the MQTT support at the same time of all other protocols supported by the Gateway. Including EI-Analytic™, EI Monitor, OPC UA and Modbus.

The Gateway will start publishing messages every time a sensor updates it’s data (in it’s own internal update interval) or when a time waveform measurement is taken. The messages are in JSON format and contain the following standard fields:

Common Variables for All Sensors

Variable NameDescription
dataTypecan be either “collection” or “stateupdate”. “collection” refers for time waveforms for vibration sensor. Every other sensor dataType is “stateupdate”, vibration sensors report “stateupdate” for it’s internal rms meassurement.
typeSensor type (see table on the right).
phantomCodeSensor’s serial number.
gwSerialGateway’s serial number.
timestampThe time in seconds since 1970 where this meassurement was taken.
batteryBattery voltage in volts
batteryTypeBattery type. 1/6D (1), AAA(2), CR2032(3), CR2477(4).
temperatureSensor’s internal temperature (in Celsius).
versionFirmware version
rssiSensor’s signal strength
Sensor codeSensor type
3, 5 and 6Triaxial accelerometer.
10Thermal camera.
21Thermocouple temperature
25Infrared temperature
264-20mA sensor’s node
31Dry contact.
32Current module (4 channel).
50Low noise biaxial accelerometer.
60General purpose module
40Velocity (RPM module).

The following are the properties included for each sensor type:

Triaxial Accelerometer (3, 5 and 6)

Variable NameDescription
RMSThree float array with the Velocity RMS in mm/s corresponding to each axis.

Triaxial Accelerometer (3, 5 and 6) for dataType “collection”

Variable NameDescription
sampleRateThe sample rate at which this meassurement was taken.
dataThis will contain the time wave form data. It contains three arrays, one for each axis. Two of the axis arrays may be empty if a single axis mode was selected. The numbers in the array are in G’s (9.8m/s²)

Thermocouple temperature node message (20)

Variable NameDescription
tcTemperatureThree float array with the temperature of each thermocouple channels in celsius.

Infrared temperature node message (25)

Variable NameDescription
ambientTemperatureAmbient temperature as meassured by the infrarred sensor in celsius.
objectTemperatureThree float array with the temperature of each thermocouple channels in celsius.

4-20mA sensor (26)

Variable NameDescription
voltageA float array of size 4 with the voltage 4-20mA sensor.

Velocity (RPM) sensor (40)

Variable NameDescription
rpmFloat value with the current RPM speed.

Current sensor (32)

Variable NameDescription
instCurrentA float array size 4 with the Instantaneous current for each of the four channels of the sensor in amps.
averageCurrentA float array size 4 with the Average current for each of the four channels of the sensor in amps.
minCurrentA float array size 4 with the minimum current for each of the four channels of the sensor in amps.
maxCurrentA float array size 4 with the maximum current for each of the four channels of the sensor in amps.
accumulatedCurrentA float array size 4 with the accumulated current for each of the four channels of the sensor in amps.

Dry contacts Sensor (31)

Variable NameDescription
dryContactsStateA boolean array size 4 with the state of the input. True means the contact is closed and false means open.