GetSystemConfig
These parameters are used in conjunction with the GetSystemConfig Evaluate Native Mode command to return system information.
- Active Cells Limit
- DHCP Timeout
- Internal Temperature
- Network Supported Link Modes
- Network Requested Link Mode
- OPC UA TimeSync
- Services Enabled
- Telnet Port
- Trigger Timestamp Mode
- Trigger Timestamp (Single and Multiple Triggers)
- Trigger Timestamp: Number of Inputs (Multiple Triggers)
- Trigger Timestamp: Maximum Queue Length (Multiple Triggers)
- Trigger Timestamp: Override Window (Multiple Triggers)
- Trigger Timestamp Error: Faults
- Trigger Timestamp Error: Queue Faults
- Trigger Timestamp Error: Ignored Updates
- Trigger Timestamp Error: Timestamps Overridden
Active Cells Limit
Returns the number of available spreadsheet cells settings configured in the Active Cells Limit dialog.
Inputs
Syntax: EV GetSystemConfig("ActiveCellLimit")
Parameter |
Description |
---|---|
"ActiveCellLimit" |
The active cell limit, in units of cells. (2048 to 10400) |
Outputs
Returns a status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes are:
Status Codes | Description |
---|---|
1 | The command was executed successfully. |
0 | Unrecognized command. |
-2 | The command could not be executed. |
-6 | User does not have Full
Access to execute the command. |
Example
To retrieve the active cell limit of the In-Sight vision system or vision system, issue the following command: EV GetSystemConfig("ActiveCellsLimit")
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (34). Finally, the current limit (6144), followed by the minimum (2048) and maximum (10400) range active cell limit ranges are returned.
DHCP Timeout
Returns DHCP Timeout information that is configured in the Network Settings dialog.
Inputs
Syntax: EV GetSystemConfig("DHCPTimeout")
Parameter |
Description |
---|---|
"DHCPTimeout" |
The time (5 to 180 seconds; default = 60) an In-Sight vision system will wait for a DHCP server to respond with an available IP address, when the vision system is configured for DHCP. If the vision system times out, network communication will be suspended. The vision system will not attempt to connect to the network again until power is cycled on the vision system. |
Outputs
Returns a status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes are:
Status Codes | Description |
---|---|
1 | The command was executed successfully. |
0 | Unrecognized command. |
-2 | The command could not be executed. |
-6 | User does not have Full
Access to execute the command. |
Example
To retrieve the DHCP Timeout information configured in the Network Settings dialog, issue the following command: EV GetSystemConfig("DHCPTimeout")The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (21). Finally, the DHCP Timeout information (30) is returned.
Internal Temperature
Returns the internal temperature of the vision system, in degrees Celsius. The internal temperature can then be used to determine the vision system case temperature, to ensure it does not exceed the case temperature specification.
After issuing the EV GetSystemConfig("Internal.Temperature") command and the internal temperature is returned, use the following formula to determine the vision system case temperature:
[Internal Temperature] - [Case Temperature Delta] = Case Temperature
Next, verify the current case temperature does not exceed the case temperature specification, based on the vision system model:
Vision System Model | Case Temperature Delta | Case Temperature Specification |
---|---|---|
In-Sight 7000 Gen2 series | ~3 to 5 degrees | 0°C to 50°C |
In-Sight 8100, 8200 and 8400 series | ±5 degrees | 0°C to 50°C |
In-Sight 8500 series | ~3 degrees | 0°C to 60°C |
In-Sight 9000 series | ~3 to 5 degrees | 0°C to 50°C |
Inputs
Syntax: EV GetSystemConfig("Internal.Temperature")
Parameter | Description |
---|---|
"Internal.Temperature" | The vision system's internal temperature, in degrees Celsius. |
Outputs
Returns a status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes are:
Status Codes | Description |
---|---|
1 | The command was executed successfully. |
0 | Unrecognized command. |
-2 | The command could not be executed. |
-6 | User does not have Full
Access to execute the command. |
Results
Returns the vision system's internal temperature, in degrees Celsius.
Example
To retrieve the vision system's current internal temperature, issue the following command: EV GetSystemConfig("Internal.Temperature")
- The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (23). Finally, the current temperature is returned: 52.5°C.
- For the 8402 vision system, the internal temperature is ±5 degrees above the case temperature. We can use these two numbers to determine the case temperature: 52.5°C - 5°C = 47.5°C
- The case temperature specification for the 8402 is 0°C to 50°C, so the current case temperature of 47.5°C does not exceed this range.
Network Supported Link Modes
Returns the Ethernet link speeds and duplex modes (half or full) supported by the vision system, as configured in the Network Settings dialog.
Inputs
Syntax: EV GetSystemConfig("Network.SupportedLinkModes")
Parameter | Description |
---|---|
"Network.SupportedLinkModes" | The Ethernet link speeds and duplex modes supported by the vision system. |
Outputs
Returns a status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes are:
Status Codes | Description |
---|---|
1 | The command was executed successfully. |
0 | Unrecognized command. |
-2 | The command could not be executed. |
-6 | User does not have Full
Access to execute the command. |
Results
Result | Description |
---|---|
0 | Auto-Negotiate |
100 | 10 Mbps Half Duplex |
101 | 10 Mbps Full Duplex |
102 | 100 Mbps Half Duplex |
103 | 100 Mbps Full Duplex |
104 | 1000 Mbps Full Duplex |
Example
To retrieve the supported link speeds and duplex modes for the vision system, issue the following command: EV GetSystemConfig("Network.SupportedLinkModes")The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (40). Finally, the supported Ethernet link speeds and duplex modes are returned.
Network Requested Link Mode
Returns the vision system's current Ethernet link speed and duplex mode (full or half), as configured in the Network Settings dialog.
Inputs
Syntax: EV GetSystemConfig("Network.RequestedLinkMode")
Parameter | Description |
---|---|
"Network.RequestedLinkMode" | The vision system's current Ethernet link speed and duplex mode. |
Outputs
Returns a status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes are:
Status Codes | Description |
---|---|
1 | The command was executed successfully. |
0 | Unrecognized command. |
-2 | The command could not be executed. |
-6 | User does not have Full
Access to execute the command. |
Results
Result | Description |
---|---|
0 | Auto-Negotiate* (default) |
100 | 10 Mbps Half Duplex |
101 | 10 Mbps Full Duplex |
102 | 100 Mbps Half Duplex |
103 | 100 Mbps Full Duplex |
104 | 1000 Mbps Full Duplex |
Example
To retrieve the current link speed for the vision system, issue the following command: EV GetSystemConfig("Network.RequestedLinkMode")
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (20). Finally, the current link speed is returned.
OPC UA TimeSync
Returns the time synchronization settings for OPC UA tag timestamps.
Inputs
Syntax: EV GetSystemConfig("OPCUA.TimeSync")
Parameter | Description |
---|---|
"OPCUA.TimeSync" | References the OPC UA time sync settings. |
Outputs
Returns a status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes are:
Status Codes | Description |
---|---|
1 | The command was executed successfully. |
0 | Unrecognized command. |
-2 | The command could not be executed. |
-6 | User does not have Full
Access to execute the command. |
Results
Result | Description |
---|---|
TimeSyncFrequency |
|
InitialTimeoutSec | The amount of time the OPC UA server will wait (in seconds) for the date/time change to take effect. |
TimeSyncFrequencySec | The time synchronization frequency when the TimeSyncFrequency parameter value is 1. |
Example
To retrieve the OPC UA Time Sync information, issue the following command: EV GetSystemConfig("OPCUA.TimeSync")
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (25). Finally, the OPC UA time sync settings are returned.
Services Enabled
Returns Protocol Services information that is configured in the Network Settings dialog.
Inputs
Syntax: EV GetSystemConfig("ServicesEnabled")
Parameter | Description |
---|---|
"ServicesEnabled" | Services currently enabled on the vision system. |
Outputs
Returns a status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes are:
Status Codes | Description |
---|---|
1 | The command was executed successfully. |
0 | Unrecognized command. |
-2 | The command could not be executed. |
-6 | User does not have Full
Access to execute the command. |
The results are: The value returned is a decimal value, converted from its binary equivalent.
Service | Binary | Decimal Equivalent |
---|---|---|
CC-Link IE Field Basic | 10000000 | 128 |
iQSS | 01000000 | 64 |
POWERLINK Note: Only supported on the In-Sight 70xx - 74xx series vision system running firmware version 4.x.x. | 00100000 | 32 |
SLMP Scanner | 00010000 | 16 |
Precision Time Protocol (IEEE 1588 PTP) | 00001000 | 8 |
ProfiNET | 00000100 | 4 |
EtherNet/IP | 00000010 | 2 |
Modbus Server | 00000001 | 1 |
None | 00000000 | 0 |
If more than one service is enabled, you can convert the returned decimal value to its binary equivalent to determine which services are enabled. Example
Example
To retrieve the Protocol Services information configured in the Network Settings dialog, issue the following command: EV GetSystemConfig("ServicesEnabled")
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (20). Finally, the enabled service(s) (2) is returned, indicating the EtherNet/IP service is enabled.
Telnet Port
Returns Telnet Port information that is configured in the Network Settings dialog.
Inputs
Syntax: EV GetSystemConfig("TelnetPort")
Parameter | Description |
---|---|
"TelnetPort" | The telnet port on which the active In-Sight vision system (a TCP/IP server waiting for communication) listens for incoming requests from a remote device (a TCP/IP client that initiates communication). A valid port assignment is any unused number between 1 and 65535, excluding 21, 68, 80, 502, 1069, 1070, 1212, 2222, 44818 and 50000 (reserved for In-Sight communications). |
Outputs
Returns a status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes are:
Status Codes | Description |
---|---|
1 | The command was executed successfully. |
0 | Unrecognized command. |
-2 | The command could not be executed. |
-6 | User does not have Full
Access to execute the command. |
Results
On-shot/continuous | |
InitialTimeoutSec | |
TimeSyncFreqSec | |
Example
To retrieve the Telnet Port information configured in the Network Settings dialog, issue the following command: EV GetSystemConfig("TelnetPort")
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (21). Finally, the Telnet Port information (23) is returned.
Trigger Timestamp Mode
Returns the trigger mode, either single triggering for vision systems running on In-Sight firmware version 4.x.x, or single and multiple triggering for visions systems running firmware version 5.6.1.
Inputs
Syntax: EV GetSystemConfig("TriggerTimestampLegacyMode")
Parameter | Description |
---|---|
"TriggerTimestampLegacyMode" | The timestamp triggering mode. |
Outputs
Returns a status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes are:
Status Codes | Description |
---|---|
1 | The command was executed successfully. |
0 | Unrecognized command. |
-2 | The command could not be executed. |
-6 | User does not have Full
Access to execute the command. |
Results
Result | Description |
---|---|
0 | Single and multiple timestamp triggering in In-Sight version 5.6.1. |
1 | Single timestamp triggering from firmware versions 4.x.x |
Trigger Timestamp (Single and Multiple Triggers)
Returns the offset into the EtherNet/IP input assembly that is used to trigger the vision system for single or multiple triggers.
Inputs
Syntax: EV GetSystemConfig("TriggerTimestampInputOffset")
Parameter | Description |
---|---|
"TriggerTimestampInputOffset" | The offset into the EtherNet/IP output assembly for a single timestamp trigger. |
Outputs
Returns a status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes are:
Status Codes | Description |
---|---|
1 | The command was executed successfully. |
0 | Unrecognized command. |
-2 | The command could not be executed. |
-6 | User does not have Full
Access to execute the command. |
Trigger Timestamp: Number of Inputs (Multiple Triggers)
Returns the number of timestamps that the vision system can process simultaneously from one PLC user data packet. The PLC can send a maximum of four timestamps.
Inputs
Syntax: EV GetSystemConfig("TriggerTimestampNumInputs")
Parameter | Description |
---|---|
"TriggerTimestampNumInputs" | The number of timestamps that the vision system can process simultaneously from one PLC user data packet. |
Outputs
Returns a status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes are:
Status Codes | Description |
---|---|
1 | The command was executed successfully. |
0 | Unrecognized command. |
-2 | The command could not be executed. |
-6 | User does not have Full
Access to execute the command. |
Results
The number of timestamps.
Trigger Timestamp: Maximum Queue Length (Multiple Triggers)
Returns the maximum number of pending time triggers that the vision system can store simultaneously.
Inputs
Syntax: EV GetSystemConfig("TriggerTimestampMaxQueueLength")
Parameter | Description |
---|---|
"TriggerTimestampMaxQueueLength" | Sets the maximum number of timestamps that the vision system can store simultaneously. |
Outputs
Returns a status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes are:
Status Codes | Description |
---|---|
1 | The command was executed successfully. |
0 | Unrecognized command. |
-2 | The command could not be executed. |
-6 | User does not have Full
Access to execute the command. |
Results
The maximum number of timestamps that the vision system can store simultaneously.
Trigger Timestamp: Override Window (Multiple Triggers)
Returns the number of microseconds that a queued PLC timestamp has to fall within before it can override an existing timestamp on the vision system.
Inputs
Syntax: EV GetSystemConfig("TriggerTimestampOverrideWindowUs")
Parameter | Description |
---|---|
"TriggerTimestampOverrideWindowUs" | The number of microseconds that a queued PLC timestamp has to fall within before it can override an existing timestamp on the vision system. |
Outputs
Returns a status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes are:
Status Codes | Description |
---|---|
1 | The command was executed successfully. |
0 | Unrecognized command. |
-2 | The command could not be executed. |
-6 | User does not have Full
Access to execute the command. |
Results
The number of microseconds that a queued PLC timestamp has to fall within before it can override an existing timestamp.
Trigger Timestamp Error: Faults
If the timestamp occurs either in the past or more than ten minutes in the future when the vision system receives it, the TimeTriggerFault is triggered and the EIP.Trigger.TimestampFaults count increments.
Inputs
Syntax: EV GetSystemConfig("Eip.TriggerTimestampFaults")
Parameter | Description |
---|---|
"TriggerTimestampFaults" | Timstamp occurs either in the past or more than ten minutes in the future when the vision system receives it. |
Outputs
Returns a status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes are:
Status Codes | Description |
---|---|
1 | The command was executed successfully. |
0 | Unrecognized command. |
-2 | The command could not be executed. |
-6 | User does not have Full
Access to execute the command. |
Results
Returns the number of times a timestamps that have faulted.
Trigger Timestamp Error: Queue Faults
The vision system receives more pending timestamps that are configured in the SetSystemConfig "Eip.TriggerTimestampMaxQueueLength" command. The "Eip.TriggerTimestampQueueFaults" increments.
Inputs
Syntax: EV GetSystemConfig("Eip.TriggerTimestampQueueFaults")
Parameter | Description |
---|---|
"TriggerTimestampQueueFaults" | The vision system receives more pending timestamps that are configured. |
Outputs
Returns a status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes are:
Status Codes | Description |
---|---|
1 | The command was executed successfully. |
0 | Unrecognized command. |
-2 | The command could not be executed. |
-6 | User does not have Full
Access to execute the command. |
Results
Returns the number of timestamps received when the timestamp queue was full.
Trigger Timestamp Error: Ignored Updates
If you try to update a timestamp within 10 milliseconds of another timestamp trigger, the vision system ignores that timestamp and the "Eip.TriggerTimestampIgnoredUpdates" increments.
Inputs
Syntax: EV GetSystemConfig("Eip.TriggerTimestampIgnoredUpdates"
Parameter | Description |
---|---|
"TriggerTimestampIgnoredUpdates" | The vision system ignores the timestamp. |
Outputs
Returns a status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes are:
Status Codes | Description |
---|---|
1 | The command was executed successfully. |
0 | Unrecognized command. |
-2 | The command could not be executed. |
-6 | User does not have Full
Access to execute the command. |
Results
Returns the number of ignored timestamps.
Trigger Timestamp Error: Timestamps Overridden
A timestamp sent from the PLC overrides a timestamp in the In-Sight queue. The "Eip.TriggerTimestampOverriden" increments.
Inputs
Syntax: EV GetSystemConfig("Eip.TriggerTimestampOverridden")
Parameter | Description |
---|---|
"TriggerTimestampOverridden" | The number of overridden timstamps. |
Outputs
Returns a status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes are:
Status Codes | Description |
---|---|
1 | The command was executed successfully. |
0 | Unrecognized command. |
-2 | The command could not be executed. |
-6 | User does not have Full
Access to execute the command. |
Results
Returns the number of timestamps overridden in the In-Sight queue.