Configure the MTConnect Connector
Connect SIA Connect to an MTConnect Agent, discover machines and data items, read current values, and resolve common errors.
The MTConnect Connector reads live data from CNC machines and other equipment through an MTConnect Agent. It uses the Agent's /probe endpoint to identify devices and data items, then reads current values from /current.
This guide explains how to discover or manually create an MTConnect instance, discover its items, verify the returned values, and resolve common connection and response errors.
Before you begin
Make sure that:
- The MTConnect Connector is installed and enabled.
- The MTConnect Agent is running and SIA Connect can reach it over the network.
- You know the Agent's hostname or IP address and HTTP port if you intend to create the instance manually.
- The Agent provides valid MTConnect XML through
/probeand/current.
The Connector reads MTConnect data only. It does not write commands or values to the machine.
Choose a setup method
| Method | Use it when |
|---|---|
| Discover instances | You want SIA Connect to scan selected IPv4 hosts, subnets, and ports for MTConnect Agents. |
| Create an instance manually | You already know the complete address of the Agent, or the Agent is outside the networks that should be scanned. |
Discover an MTConnect instance
- In the Edge Portal, open Workspace > Instances.
- Start instance discovery and select the MTConnect Connector.
- Complete the discovery parameters.
- Start the scan.
- Select the required Agent from the results.
- Import the selected instance.
The scan checks whether each selected TCP port is open. It then tries the Agent's /probe endpoint. If /probe cannot identify the Agent during discovery, the Connector also checks /current.
A discovered result can include the Agent address, device names, protocol version, and a generated UID. When an Agent exposes several devices, their names are combined in the result.
Instance discovery parameters
| Parameter | Default | Accepted values | Description |
|---|---|---|---|
| Scan duration (ms) | 30000 |
Positive whole number | Maximum duration of the complete scan in milliseconds. |
| Ports | 5000, 7878, 5717 |
Up to 32 comma-separated TCP ports from 1 to 65535
|
HTTP ports checked for MTConnect Agents. Add other ports such as 80 or 8082 when required. |
| Subnets | Empty | Comma-separated IPv4 addresses, hostnames, or CIDR ranges | Limits the scan to specific targets. For example, 192.168.1.0/24,10.0.0.10. When empty, the Connector scans suitable IPv4 networks connected to SIA Connect. |
Automatic discovery skips loopback and common virtual bridge interfaces. Networks broader than /22 are not scanned automatically. Enter a specific address or range under Subnets when you need to scan one of these networks.
A subnet scan is limited to 1,024 hosts. A complete discovery is limited to 4,096 host and port combinations. Use a narrow subnet and only the required ports when a scan reaches either limit.
Create an instance manually
- In the Edge Portal, open Workspace > Instances.
- Select Add instance.
- Select the MTConnect Connector.
- Enter a descriptive name.
- Enter the MTConnect Agent address.
- Set the connection timeout.
- Save the instance.
You can enter an address with or without the URL scheme. Examples:
192.168.1.50:5000http://machine-agent:5000https://machine-agent:443
If the scheme is omitted, the Connector uses HTTP. An address ending in port 443 uses HTTPS automatically. Include https:// when HTTPS is used on another port.
Instance parameters
| Parameter | Required | Default | Description |
|---|---|---|---|
| Address | Yes | None | Hostname or IP address and port of the MTConnect Agent. A URL scheme can be included. |
| Connection timeout | No |
10 seconds |
Maximum time allowed for each Agent request. Values of zero or less use the 10-second default. |
Discover items
- Open the MTConnect instance.
- Start item discovery.
- Wait while the Connector reads
/probeand/current. - Review the returned item names, descriptions, units, and sample values.
- Select the required items.
- Import the selected items.
The Connector builds each item name from the device and component path reported by the Agent. The description includes the MTConnect category, type, and subtype when available. All discovered items are read-only and use the TEXT data type.
If /probe succeeds but /current fails, the item list can still be returned without sample values. Review the warning, correct the current-value request problem, and test the imported items.
Create an item manually
Item discovery is the recommended method because it generates the required UID from the MTConnect device UUID and data item ID.
- Open the MTConnect instance and add an item.
- Enter a descriptive name.
- Set the UID to
<device UUID>_<data item ID>. - Set the item to read access.
- Choose a suitable read interval.
- Save the item.
The UID must identify a data item returned by the Agent's /probe response. Use discovery when possible to avoid transcription errors.
Understand the returned values
At each read, the Connector requests the Agent's /current document and matches each configured item with its MTConnect data item ID.
- Sample and event values are returned as text exactly as exposed by the Agent.
- For a Condition data item, the value is the condition state name, such as the XML condition element reported by the Agent.
- The engineering unit is taken from the data item definition returned by
/probe.
Automatic identity items
The Connector maintains the following read-only identity items for each instance:
| Item | Source |
|---|---|
| Vendor | Manufacturer of the first device reported by the Agent |
| Model | Name of the first device reported by the Agent |
| Serial | Serial number of the first device reported by the Agent |
| Firmware | MTConnect protocol version reported in the Agent header |
Verify the configuration
- Confirm that the instance and imported items are enabled.
- Open the instance and check that it does not show a current connection or XML error.
- Confirm that the imported items receive values from
/current. - Compare a known machine value with the value shown in the Edge Portal.
- Review the Vendor, Model, Serial, and Firmware identity items when the Agent supplies those values.
Troubleshoot the Connector
No Agent is found during discovery
Confirm that the Agent is running and listening on one of the configured ports. Check the SIA Connect network interface, subnet, routing, and firewall rules. Enter the Agent's exact IPv4 address under Subnets and limit Ports to the known port.
Scan budget reached before every host/port combination was probed
The scan duration ended before all targets were checked. Increase Scan duration (ms), reduce the number of ports, or narrow the subnet list.
No IPv4 hosts were available for MTConnect discovery
No suitable connected IPv4 network was found. Confirm the SIA Connect network configuration, or enter a reachable IPv4 address or CIDR range under Subnets.
Ignoring invalid MTConnect discovery port
A value under Ports is not a whole number from 1 to 65535. Correct or remove the invalid value and run discovery again.
Unable to resolve discovery host
The hostname entered under Subnets could not be resolved to an IPv4 address. Check DNS, correct the hostname, or enter the Agent's IPv4 address.
Invalid HTTP response code from agent
The Agent did not return HTTP status 200. Confirm the address, port, Agent service, and requested endpoint. Check whether a proxy, redirect, authentication page, or another web service is responding on that port.
Error parsing XML from agent
The response is not valid XML. Open the Agent's /probe and /current endpoints from a computer on the same network and confirm that both return complete MTConnect XML.
Root element MTConnectDevices not found or Devices element not found
The /probe response does not have the expected MTConnect device structure. Confirm that the address points to the root of an MTConnect Agent and that /probe is supported.
Root element MTConnectStreams not found or Streams element not found
The /current response does not have the expected MTConnect stream structure. Confirm that the Agent returns a valid MTConnectStreams document from /current.
MTConnect agent not probed yet.
The Connector could not complete the initial /probe request before reading current values. Correct the preceding connection or probe error, then retry the instance.
An imported item has no value
Confirm that the data item is present in /probe and has a current observation in /current. Check that its UID has not been changed. Run item discovery again if the Agent configuration or device UUID has changed.
The request times out
Confirm network connectivity and that the Agent responds promptly. Increase Connection timeout if the Agent needs more time, but investigate recurring delays at the Agent or network.