Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



USB3\ Vision\ Device\ Communication\ Parameters


Category: Root/Connection


Parameter Description Additional Information Visibility
DeviceGUID USB3 Vision GUID of the device the controller is connected to. String Beginner
ConnectionSpeed Effective connection speed to the device once connected. Enumeration.
Entries: LowSpeed,
FullSpeed,
HighSpeed,
SuperSpeed,
NotConnected
Beginner


Category: Root/Heartbeat


Parameter Description Additional Information Visibility
HeartbeatInterval Time in milliseconds between each heartbeat sent to the USB3 Vision device. Unsigned 64 bits integer
Min: 100
Max: 65535
Beginner


Category: Root/ControlInterface


Parameter Description Additional Information Visibility
CIPacketSize Packet size of the control channel end point in bytes. Unbound unsigned 64 bits integer Beginner
CISuccess Count of control commands success. Unbound unsigned 64 bits integer Expert
CIPendingAcknowledge Count of control pending acknowledge. Unbound unsigned 64 bits integer Expert
CICancelled Count of cancelled commands. Unbound unsigned 64 bits integer Guru
CITimeout Count of command timeouts. Unbound unsigned 64 bits integer Guru
CILinkError Count of link error. Unbound unsigned 64 bits integer Guru
CIFormattingRequestError Count of formatting request error. Unbound unsigned 64 bits integer Guru
CIMalformedAcknowledge Count of malformed acknowledge. Unbound unsigned 64 bits integer Guru
CIDiscardedLateAcknowledge Count of discarded late acknowledge. Unbound unsigned 64 bits integer Guru


Category: Root/EventInterface


Parameter Description Additional Information Visibility
EIPacketSize Packet size of the messaging channel end point in bytes. Unbound unsigned 64 bits integer Beginner


Category: Root/StreamInterface


Parameter Description Additional Information Visibility
SIChannel Stream channel selector for the parameters in the StreamInterface category. Unbound unsigned 64 bits integer Expert
SIPayloadSizeAlignment Limits streaming size registers to byte size alignment. Updated when streaming is enabled on the device. Unbound unsigned 64 bits integer Expert
SIRequiredPayloadSize Device reported minimum required payload size with current settings. Updated when streaming is enabled on the device. Unbound unsigned 64 bits integer Expert
SIRequiredLeaderSize Device reported minimum required leader size. Updated when streaming is enabled on the device. Unbound unsigned 64 bits integer Expert
SIRequiredTrailerSize Device reported minimum required trailer size. Updated when streaming is enabled on the device. Unbound unsigned 64 bits integer Expert
SIMaximumLeaderSize Maximum leader size configured on the device and driver. Updated when streaming is enabled on the device. Unbound unsigned 64 bits integer Expert
SIPayloadTransferSize Expected size of a single payload as configured on the device and driver. Updated when streaming is enabled on the device. Unbound unsigned 64 bits integer Expert
SIPayloadTransferCount Expected number of payload transfers as configured on the device and driver. Updated when streaming is enabled on the device. Unbound unsigned 64 bits integer Expert
SIPayloadFinalTransfer1Size Size of the first final payload transfer as configured on the device and driver. Updated when streaming is enabled on the device. Unbound unsigned 64 bits integer Expert
SIPayloadFinalTransfer2Size Size of the second final payload transfer as configured on the device and driver. Updated when streaming is enabled on the device. Unbound unsigned 64 bits integer Expert
SIMaximumTrailerSize Maximum trailer size as configured on the device and driver. Updated when streaming is enabled on the device. Unbound unsigned 64 bits integer Expert
SIMaximumPacketSize Maximum packet size that can be used on the streaming end point. Automatically set on connection. Used when computing the various stream interface sizes. Unbound unsigned 64 bits integer Expert
SICustomPayloadTransferSize Custom payload size to use when setting SIPayloadTransferSize.If 0, the payload transfer size is configured automatically by the device controller. The custom payload size is only used as a starting point and can be adjusted to meet other constraints like payload size alignment. Unbound unsigned 64 bits integer Guru


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) until the device node map can be successfully built. "File" reads from the XML file in the location specified by DeviceGenICamXMLFile. Enumeration.
Entries: Default,
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


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

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com