Phantom Gateway Data Integrations
Modbus
The Erbessd Instruments Phantom solution supports Modbus TCP/IP integration. A Phantom gateway can operate as a
Modbus server , configured to store sensor data in registers in the gateway. Gateways configured for Modbus listen on
well-known TCP port 502 for incoming requests from Modbus clients. Gateways do not initiate contact with Modbus
clients, only respond to them. Upon request, they send their register contents to the client.
NOTE - Static IP addressing must be used on Phantom gateways with Modbus integration. The gateways are identified
to the Modbus client by IP address (not by hostname), therefore DHCP is not viable. ONLY the Main gateway in a
Repeater Network is configured as a Modbus server. All Modbus data from Subordinate gateways is stored in the Main
GW. For details regarding the data formats for all Phantom sensors , see the Erbessd website at: [Link]
[Link]/docs/phantom/modbus-integration/.
Modbus sensor triggering
Phantom Gateway Firmware version 56 supports the ability to trigger a V10/V11 vibration sensor waveform collection
based on communication from a Modbus server.
This is functionally the same as clicking the Collect Waveform Now button for a sensor in the Live State screen.
Modbus configuration example:
Create registers for each sensor in the Modbus tab of the Gateway Admin Console:
1
Select a Sensor value. Press ADD to include another register entry for this sensor.
When the Modbus server writes a “1” in register 0, it will trigger a waveform collection. If a “1” is written into
register 2, an RMS update will be sent.
Click SAVE to complete the configuration.
2
When employing a Gateway version 1 or when processed data such as Velocity (RMS of entire spectrum), Acceleration,
or Envelope Acceleration are desired, Erbessd EI-Monitoring software for Windows must be installed and configured.
MQTT
Phantom Gateway 2.0 supports MQTT protocol integration. The gateway acts as a MQTT client and can connect to any
compatible MQTT broker from version 3.1.1 up to MQTT 5. Note – In Repeater Networks, Subordinate gateways send
MQTT data to the Main gateway, where the interface to the MQTT broker is configured.
• Time Waveform data
• RMS velocity (3 axes)
• Temperature
• Battery voltage
• Signal strength
• Firmware version
• Client software needed to process time waveform data to obtain acceleration, acceleration envelope, FFT.
• MQTT can optionally manage all Gateway and Sensor settings, including on-demand waveform downloads
3
To set up MQTT, open the MQTT tab in the Gateway Admin Console and
click Enable MQTT connection.
Protocol: Can be either mqtt://, mqtts://, ws:// or wss:// depending on
the transport supported by your MQTT broker.
MQTT server: Is the hostname or IP address of your MQTT broker.
Port: The network port your MQTT broker is listening on.
Username: The (optional) username to connect to your MQTT broker.
Password:The (optional) password to connect to your MQTT broker.
Publish Topic: The topic where the gateway will be publishing the
sensor data and will subscribe for commands.
Publish QoS: A Quality Of Service (QoS) tag can be applied to the MQTT
data allowing management of the data packet priority on the network.
(Data packets with higher QoS tags get routed first) When in doubt, use
0.
Append Gateway and serial number as subtopics is an option for formatting the data.
Publish waveforms: Whether or not to publish complete time
waveforms to MQTT. These measurements represent about 160kB of
data per waveform. They require additional post processing to render
an FFT.
Allow Gateway management through MQTT: Allow full gateway
management so that clients connected to the same broker can change
all gateway and sensor settings.
Save: Will save the settings and the gateway will restart.
Reset: Will reset all settings to their previous values.
• After you save the settings the gateway will restart. After it restarts it will try to connect to the MQTT broker
and show a state in the MQTT section at the top.
• MQTT is supported at the same time as any other protocol supported by the gateway, including EI Analytic, EI
Monitor, OPC UA and Modbus.
• The gateway will start publishing messages every time a sensor updates its data (Sensor Update interval) or
whenever a time waveform measurement is taken, e.g., alarm or on-demand.
4
The JSON messages contain the following standard fields:
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
phantomCode Sensor's serial number
gwSerial Gateway serial number
timestamp The time in seconds since 1970 where this measurement was taken.
battery Battery level in volts
batteryType Battery type. 1/6D (1), AAA(2), CR2032(3), CR2477(4)
temperature Sensor internal temperature (in Celsius)
version Firmware version
rssi Sensor signal strength
Below is an example JSON message:
For more information regarding MQTT, visit the Erbessd website at :
[Link]
5
OPC UA
Phantom Gateway version 2 supports the OPC UA industrial protocol. All sensor processed data is available through
OPC. Subordinate gateways forward OPC data to the Main gateway for connection to the OPC UA server.
Note - Due to how the OPC UA protocol works, the full time waveform or FFT is not available.
The gateway acts as a OPC UA server and listens for TCP connections on port 4334.
To activate OPC UA, simply check the box in the General tab of the
Gateway Admin Console.
• The OPC UA server may be active at the same time as any other
protocol supported by the gateway, including EI Analytic, EI
Monitor, MQTT and Modbus.
• After the OPC UA server has been enabled, it can access the
server using the following URL format with a OPC UA client:
[Link]://[Link]:4334/UA/PhantomGW, where [Link] is
replaced by the IP Address of the gateway. Use Security Mode
none and Security Policy None.
6
• The OPC UA is organized in a tree like structure. For the Phantom Gateway Under the root folder is an Object
folder, under which all the sensor serial numbers will be shown. Under each serial number there will be a
number of different variables depending on the sensor type.
OPC messages contain the following standard fields:
Variable Name Description
type Sensor type
battery Battery level in volts
batteryType Battery type. 1/6D (1), AAA(2), CR2032(3), CR2477(4)
temperature Sensor internal temperature (in Celsius)
version Firmware version
OPC messages also contain the following metrics, calculated in the gateway for each full time waveform measurement
received:
Variable Name Description
ACF Acceleration crest factor
APEAK Max acceleration amplitude seen in the timewave form
ARMS RMS over the whole acceleration spectrum
DCOFFSET This is the acceleration constant, i.e., gravity, included in the acceleration
HIGHFREQ Acceleration measured from 5khz to 10khz
MAX FREQ Peak frequency in Hz
VRMS The Velocity RMS value measured from 10Hz to 1KHz
7
The VRMS value is derived from an in-sensor calculation of the spectrum from 10 to 1KHz (hard-coded). The interval is
set via the In-sensor settings Sensor Update interval as administered from the Gateway Admin Console.
For more details regarding OPC UA, visit the Erbessd website at:
[Link]
