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 sensors data is available trought 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.
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.
Common variables for all sensors
| Variable Name | Description |
|---|---|
|
dataType |
can 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. |
|
type |
Sensor type (see table on the right). |
|
phantomCode |
Sensor's serial number. |
|
gwSerial |
Gateway's serial number. |
|
timestamp |
The time in seconds since 1970 where this meassurement was taken. |
|
battery |
Battery voltage in volts |
|
batteryType |
Battery type. 1/6D (1), AAA(2), CR2032(3), CR2477(4). |
|
temperature |
Sensor's internal temperature (in Celsius). |
|
version |
Firmware version |
|
rssi |
Sensor's signal strength |
| Sensor code | Sensor type |
|---|---|
|
3, 5 and 6 |
Triaxial accelerometer. |
|
10 |
Thermal camera. |
|
21 |
Thermocouple temperature |
|
25 |
Infrared temperature |
|
26 |
4-20mA sensor's node |
|
31 |
Dry contact. |
|
32 |
Current module (4 channel). |
|
50 |
Low noise biaxial accelerometer. |
|
60 |
General purpose module |
|
40 |
Velocity (RPM module). |
The following are the properties included for each sensor type:
Triaxial Accelerometer (3, 5 and 6)
| Variable Name | Description |
|---|---|
|
RMS |
Three float array with the Velocity RMS in mm/s corresponding to each axis. |
Triaxial Accelerometer (3, 5 and 6) for dataType "collection"
| Variable Name | Description |
|---|---|
|
sampleRate |
The sample rate at which this meassurement was taken. |
|
data |
This 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.8mm/s²) |
Thermocouple temperature node message (20)
| Variable Name | Description |
|---|---|
|
tcTemperature |
Three float array with the temperature of each thermocouple channels in celsius. |
Infrared temperature node message (25)
| Variable Name | Description |
|---|---|
|
ambientTemperature |
Ambient temperature as meassured by the infrarred sensor in celsius. |
|
objectTemperature |
Three float array with the temperature of each thermocouple channels in celsius. |
4-20mA sensor (26)
| Variable Name | Description |
|---|---|
|
voltage |
A float array of size 4 with the voltage 4-20mA sensor. |
Velocity (RPM) sensor (40)
| Variable Name | Description |
|---|---|
|
rpm |
Float value with the current RPM speed. |
Current sensor (32)
| Variable Name | Description |
|---|---|
|
instCurrent |
A float array size 4 with the Instantaneous current for each of the four channels of the sensor in amps. |
|
averageCurrent |
A float array size 4 with the Average current for each of the four channels of the sensor in amps. |
|
minCurrent |
A float array size 4 with the minimum current for each of the four channels of the sensor in amps. |
|
maxCurrent |
A float array size 4 with the maximum current for each of the four channels of the sensor in amps. |
|
accumulatedCurrent |
A float array size 4 with the accumulated current for each of the four channels of the sensor in amps. |
Dry contacts Sensor (31)
| Variable Name | Description |
|---|---|
|
dryContactsState |
A boolean array size 4 with the state of the input. True means the contact is closed and false means open. |
