Configure the IFM VSE Connector
Connect SIA Connect to an ifm VSE condition-monitoring unit, discover objects and sensors, collect raw vibration data, and troubleshoot communication errors.
The IFM VSE Connector reads condition-monitoring data from an ifm VSE unit over TCP. It can read configured measurement objects, RPM objects, sensor states, alarm states, and raw vibration samples.
The Connector supports instance and item discovery. Discovery is recommended because it reads the configuration from the VSE unit and creates the corresponding items automatically.
The IFM VSE Connector is read-only. It does not write values or configuration to the VSE unit.
Before you begin
- Install the IFM VSE Connector. See Install and manage Connectors.
- Activate a license that includes the Connector.
- Connect SIA Connect and the VSE unit to networks that can communicate with each other.
- Confirm the IP address of the VSE unit.
- Allow TCP communication to the VSE port. The default port is
3321. - Configure the required objects and sensors in the VSE unit before discovering items.
If the VSE unit is already enabled as an instance in SIA Connect, disable the instance before running discovery. An active connection can prevent discovery from identifying or browsing the unit.
Discover and add an IFM VSE instance
- In the sidebar, expand Workspace and select Instances.
- Select Discover instances.
- Select the IFM VSE Connector.
- Configure the discovery parameters described below.
- Start the discovery.
- Select the VSE unit from the results.
- Add the selected instance.
| Discovery parameter | Default | Description |
|---|---|---|
| Scan duration (ms) | 30000 |
Maximum time for the network scan. Increase the duration for a large target range or a slow network. |
| Ports | 3321 |
TCP ports to scan. Enter individual port numbers separated by commas. Port ranges are not supported. The scan uses no more than the first eight valid ports. |
| Subnets | Empty | IPv4 addresses or CIDR ranges separated by commas, for example 192.168.1.0/24,10.0.0.25. Leave this field empty to scan the connected IPv4 networks. |
Discovery identifies an IFM VSE unit through its communication handshake. When available, the result includes the unit's serial number, firmware version, and hardware version.
For a detailed explanation of discovery sessions, candidates, import results, and warnings, see Discover instances and items.
Create an instance manually
- In the sidebar, expand Workspace and select Instances.
- Select Create instance.
- Select the IFM VSE Connector.
- Enter a unique name for the instance.
- Enter the IP address of the VSE unit in Address.
- Configure the instance parameters described below.
- Create the instance.
| Parameter | Default | Description |
|---|---|---|
| Port | 3321 |
TCP port used by the VSE unit. Valid port numbers are 1 through 65535. An invalid value falls back to 3321. |
| Use RTC | No | When set to Yes, the Connector can use the VSE real-time clock to set the SIA Connect system time during initialization. |
| External storage | None | Select a detected external storage device if raw samples must be written to CSV files instead of being stored in the item value. The current Connector lists detected Samsung T5 storage devices. |
When Use RTC is set to Yes, the Connector compares the VSE time with the current SIA Connect time. If the difference is more than five minutes, it sets the SIA Connect system date and time from the VSE clock. It does not set the clock in the VSE unit.
After a successful connection, the Connector also provides identity information for the VSE unit, including vendor, model, serial number, firmware, and hardware revision.
Discover and add items
Item discovery reads the objects and sensors configured in the VSE unit. The instance must be reachable, but it should be disabled before discovery to prevent the normal polling connection from blocking the browse connection.
- Open the IFM VSE instance.
- Disable the instance if it is enabled.
- Open the Items section.
- Select Add item.
- Select Discover items.
- Start the discovery.
- Select the required candidates.
- Add the selected items.
- Enable the instance.
Discovery can create the following read-only items:
| Discovered item | Value |
|---|---|
| Configured object | The calculated result for the object, with the unit reported by the VSE unit. |
| Object alarm state |
0 for normal, 1 for warning, or 2 for damage. |
| Global alarm state | The highest active alarm state among the enabled object alarm items. |
| Sensor raw data | A raw-sample result for each of the four sensor inputs. Discovered raw-data items use 20 samples and a sample-rate divisor of 1. |
| Sensor state |
0 for not connected, 1 for connected, or 2 for defective. |
Per-object alarm items are created by discovery. If you need these alarm items, use Discover items instead of creating the items manually.
Create an item manually
- Open the IFM VSE instance.
- Open the Items section.
- Select Add item.
- Select the manual item option.
- Enter a name for the item.
- Set the item to read-only operation.
- Configure the Connector parameters described below.
- Create the item.
| Parameter | Default | Description |
|---|---|---|
| Type | Object 0 | Selects the value to read. Available choices are Raw data, Sensor enabled, Alarm, Object 0 through Object 24, and RPM Object 0 through RPM Object 24. |
| Sensor | Sensor 1 | Selects Sensor 1 through Sensor 4. This setting is used by Raw data and Sensor enabled items. |
| Divide sample rate time | 1 |
Reduces the 100,000 samples-per-second input rate for a Raw data item. Use an effective value from 1 through 100. A value of 0 is treated as 1. |
| Raw data samples | 0 |
Number of samples collected for each Raw data reading. Enter a positive value that is appropriate for the polling interval, storage capacity, and network performance. |
The item Type determines the returned value:
- Object 0 through Object 24: Reads the calculated result of an object that exists in the VSE configuration.
- RPM Object 0 through RPM Object 24: Reads the RPM value for the selected object number.
- Raw data: Collects samples from the selected sensor.
-
Sensor enabled: Returns the connection state of the selected sensor as
0,1, or2. -
Alarm: Returns the global alarm state as
0,1, or2.
For general item settings such as update interval, logging, units, and limits, see Create and edit items.
Understand raw-data storage
The effective sample frequency is calculated by dividing 100000 by Divide sample rate time. For example, a divisor of 10 produces a sample frequency of 10000 Hz.
Store samples in the item value
When External storage is set to None, the item value contains a JSON object with:
- The original and effective sample rates
- The sample-rate divisor
- The sensor type
- The requested sample count
- The sample array
Large sample counts produce large item values and can take longer to collect, process, and store.
Write samples to external storage
When an external storage device is selected on the instance, each Raw data reading is written to a CSV file on that device. The filename contains the instance name, sensor number, and collection time. The file contains timing information, the sensor type, the effective sample frequency, and the scaled samples.
The Raw data item's stored value is 0 when the samples are written to the CSV file. This value indicates that the reading was handled separately and does not contain the samples.
Selecting external storage affects every Raw data item in the instance.
Verify the configuration
- Enable the IFM VSE instance.
- Confirm that the instance does not show Connection failed.
- Open the item list and wait for the configured update interval.
- Confirm that object, alarm, and sensor-state items receive values.
- For a Raw data item, confirm that the JSON value is collected or that a CSV file is created on the selected external storage device.
Troubleshoot the IFM VSE Connector
| Message or symptom | Cause and action |
|---|---|
| Connection failed | SIA Connect could not initialize communication with the VSE unit. Confirm the IP address, port, routing, firewall rules, and power state. The normal connection timeout is five seconds. |
| Discovery finds an open port but reports that the IFM handshake failed | The service on that port did not complete the IFM handshake, or the VSE unit is already connected to an enabled SIA Connect instance. Confirm the target and disable the existing instance before scanning again. |
| Connected to the unit, but the IFM version could not be read | The TCP connection opened but identification did not complete. Disable other software or instances that are communicating with the unit, then retry. |
| No IPv4 hosts were available for discovery | No suitable connected IPv4 network or valid target subnet was available. Confirm the SIA Connect interface configuration or enter a specific IP address or CIDR range in Subnets. |
| The scan budget was reached | The scan duration ended before all targets were checked. Increase Scan duration or narrow the Subnets and Ports values. |
| The subnet or target list was capped | The scan limits a subnet to 1,024 hosts and the full scan to 4,096 host-and-port combinations. Enter a smaller subnet or a specific device address. |
| Discover items cannot connect and asks you to disable the device | The enabled instance may hold the VSE connection. Disable the instance, run Discover items again, import the items, and then re-enable the instance. |
| No browsable objects or sensors are returned | The VSE unit did not return a usable configuration. Confirm that its sensors and measurement objects are configured, then retry discovery. |
| IFM does not contain an object at a selected number | The manually configured Object number does not exist in the VSE configuration. Discover items or select an object that is configured in the unit. |
| Error during self-test | The Connector could not read the selected sensor's connection state. Confirm the sensor configuration and connection, then check the instance connection. |
| Error code followed by a number | The VSE unit returned an error while the Connector was reading an RPM object. Confirm that the selected RPM object exists and is available in the VSE configuration. |
| Raw data timeout (180s) | The requested sample count was not collected within 180 seconds. Confirm the sensor and network connection. Reduce Raw data samples or increase Divide sample rate time before retrying. |
| Error activating raw data | The VSE unit did not start or return the raw-data stream. Confirm the selected sensor and ensure that another application is not using the unit's measurement stream. |
| Mounting external HDD failed | The selected storage device could not be mounted or its mount location was not writable. Reconnect the drive, confirm it appears in External storage, and retry. |
| Raw item value is 0 | This is expected when External storage is selected. The samples are written to a CSV file instead of being stored in the item value. |
If a problem continues, review the Connector, instance, and item errors and the system logs. See Troubleshoot Connector, instance, item, and mapping errors.