GigE Vision Device Communication Parameters
For the latest eBUS SDK documentation and support, visit https://supportcenter.pleora.com
Category: Root/Communication
| Parameter | Description | Additional Information | Visibility |
|---|---|---|---|
| PreferredTransport | Preferred transport protocol to use for GVCP. Only used if supported by the device. Provided as new experimental capability. TCP transport is for now only possible with matched-version eBUS PvSoftDeviceGEV-based GigE Vision devices having the prototype TCP transport option enabled. | Enumeration. Entries: UDP, TCP |
Expert |
| AnswerTimeout | Time the GigE Vision Device can take for responding to a command from the application. | Unsigned 64 bits integer Min: 1 Max: 4294967295 |
Beginner |
| CommandRetryCount | Number of times a command is attempted before it is considered as failed. | Unsigned 64 bits integer Min: 1 Max: 255 |
Beginner |
| DefaultMCTT | Value written to the message channel transmission timeout register (MCTT) at the time of connection. The MCTT is the amount of time (in milliseconds) the GigE Vision device must wait before either timing out or receiving acknowledgment for a message (interrupt). | Unbound unsigned 16 bits integer | Beginner |
| DefaultMCRC | Value written to the message channel retry count register (MCRC) at the time of connection. The MCRC is the number of retransmissions allowed when the GigE Vision device times out waiting for acknowledgement of a message (interrupt). | Unsigned 64 bits integer Max: 255 |
Beginner |
| ReadMemPacketSize | Maximum allowed bytes for a READMEM_CMD packet. | Unsigned 64 bits integer Min: 552 Inc: 4 |
Expert |
| WriteMemPacketSize | Maximum allowed bytes for a WRITEMEM_CMD packet. | Unsigned 64 bits integer Min: 552 Inc: 4 |
Expert |
Category: Root/Connection
| Parameter | Description | Additional Information | Visibility |
|---|---|---|---|
| IPAddress | Local IP address used for communication. | Unbound unsigned 64 bits integer | Beginner |
| CommandTransport | Transport protocol in use for the GVCP command link. | Enumeration. Entries: UDP, TCP |
Expert |
| CommandPort | Local UDP port used for the command link to the device. | Unbound unsigned 16 bits integer | Beginner |
| MessagingTransport | Transport protocol in use for the GVCP messaging channel. | Enumeration. Entries: UDP, TCP |
Expert |
| MessagingPort | Local UDP port used for messaging channel. | Unbound unsigned 16 bits integer | Beginner |
| ForcedCommandPortEnabled | Enables the use of ForcedCommandPort for CommandPort. If not enabled, a system-assigned port number is used. If enabled, uses ForcedCommandPort. | Boolean | Guru |
| ForcedCommandPort | Port to use for CommandPort when connecting to the device. Used by the command link UDP socket. This parameter is only considered when connecting to the device. | Unbound unsigned 16 bits integer | Guru |
| ForcedMessagingPortEnabled | Enables the use of ForcedMessagingPort for MessagingPort. If not enabled, a system-assigned port number is used. If enabled, uses ForcedMessagingPort. | Boolean | Guru |
| ForcedMessagingPort | Port to use for MessagingPort when connecting to the device. Used by the messaging channel UDP socket. This parameter is only considered when connecting to the device. | Unbound unsigned 16 bits integer | Guru |
Category: Root/Heartbeat
| Parameter | Description | Additional Information | Visibility |
|---|---|---|---|
| HeartbeatInterval | Time in milliseconds between each heartbeat sent to the GigE Vision device. | Unsigned 64 bits integer Min: 500 Max: 65535 |
Beginner |
| DefaultHeartbeatTimeout | Default heartbeat timeout value applied on connection, in milliseconds. Applied on device connection. To change this value once the device is already connected, refer to the GevHeartbeatTimeout feature of your GigE Vision device. | Unbound unsigned 32 bits integer | Beginner |
| DisconnectOnAnyTimeout | If set to true, any GVCP command timeout triggers a disconnect notification. When false only a heartbeat timeout can trigger a disconnect notification. | Boolean | Beginner |
Category: Root/Statistics
| Parameter | Description | Additional Information | Visibility |
|---|---|---|---|
| StatisticsReset | Resets the communication statistics. | Command | Expert |
| CommandPendingAcknowledges | Count of pending acknowledges since the device was connected or the statistics were reset. Pending acknowledges on the command link are sent by the device when performning longer command processing to avoid GVCP timeouts. | Unbound unsigned 64 bits integer | Guru |
| CommandRetries | Count of retries since the device was connected or the statistics were reset. Retries on the command link are initiated by the host if the command acknowledge is not received whithin AnswerTimeout. | Unbound unsigned 64 bits integer | Expert |
| CommandRetriesMax | Maximum retries sent to the device for a single command. | Unbound unsigned 64 bits integer | Expert |
| CommandSendFailures | Counts the number of transmission failures of the command link. As UDP does not garantee delivery, only failures by the network stack to put the packet on the wire are reported. | Unbound unsigned 64 bits integer | Guru |
| MessagingRetries | Count of messaging channel retries since the device was connected or the statistics were reset. Retries on the messaging channel are initiated by the device if the event acknowledge is not received whithin the period of time specified in the MCTT register. See DefaultMCTT and DefaultMCRC. | Unbound unsigned 64 bits integer | Expert |
| MessagingRetriesMax | Maximum retries requested by the device (and received by the host) for a single event. | Unbound unsigned 64 bits integer | Expert |
| MessagingAckSendFailures | Counts the number of transmission failures of event acknowledges on the messaging channel. As UDP does not garantee delivery, only failures by the network stack to put the packet on the wire are reported. | Unbound unsigned 64 bits integer | Guru |
Category: Root/StreamingPacketSize
| Parameter | Description | Additional Information | Visibility |
|---|---|---|---|
| AutoNegotiation | Application level parameter used by eBUS Player and Net Command. When true, automatic packet size negotiation is performed. Note that this does not affect the behaviour of PvDeviceGEV::Connect. From an API perspective, automatic packet size negotiation may be performed using PvDeviceGEV::NegotiatePacketSize. | Boolean | Beginner |
| DefaultPacketSize | Application level parameter used by eBUS Player. Packet size initially assigned to the device for streaming if packet size auto negotiation is disabled. If this value is refused by the device, a fallback value of 576 is used. Note that this does not affect the behaviour of PvDeviceGEV::Connect. From an API perspective, automatic packet size negotiation may be performed using PvDeviceGEV::NegotiatePacketSize. | Unsigned 64 bits integer Min: 576 Max: 65024 Inc: 4 |
Beginner |
Category: Root/DeviceGenICamXMLAccess
| Parameter | Description | Additional Information | Visibility |
|---|---|---|---|
| DeviceGenICamXMLLocation | Selects which GenICam configuration file the SDK will use for the next connect. "Default" goes through all manifest entries (if supported and enabled) and then URL1, URL2 until the device node map can be successfully built. "File" reads from the XML file in the location specified by DeviceGenICamXMLFile. | Enumeration. Entries: Default, URL1, URL2, File, ManifestEntry1, ManifestEntry2, ManifestEntry3, ManifestEntry4, ManifestEntry5, ManifestEntry6, ManifestEntry7, ManifestEntry8 |
Guru |
| DeviceGenICamXMLFile | The location on the hard drive (absolute path) where the local XML file is loaded from when DeviceXMLLocation is set to "File". | String | Guru |
| DeviceGenICamXMLFileValid | True if the path in DeviceGenICamXMLFile is valid. | Boolean | Guru |
| UseManifests | Enables the use of the manifest when retrieving the GenICam XML file from the device. | Boolean | Guru |
Category: Root/Recovery
| Parameter | Description | Additional Information | Visibility |
|---|---|---|---|
| LinkRecoveryEnabled | When enabled, SDK attempts to automatically reconnect to the same device when the connection is lost. SDK does not recover the stream. Application is responsible for stream recovery. | Boolean | Beginner |
| RecoveryStatus | Status of the connection and stream state machine. | Enumeration. Entries: StatusOK, StatusLinkLost |
Beginner |
eBUS SDK | Pleora Technologies Inc.
Copyright (c) 2002-2026 Pleora Technologies Inc.
Send comments on this topic to info@pleora.com