eBUS Python Enums List

class eBUS.PvAccessType(*args: Any, **kwargs: Any)

GigE Vision device access type.

The PvAccessType indicates whether (and to what degree) a second PC can connect to a GigE Vision device after the first one connects. The GigE Vision device stores the value in the GenICam GevCCP feature.

The value can be set at connection time using PvDevice.Connect (recommended) or altered using the GenICam GevCCP feature, programmatically or through a GenICam browser dialog.

Enum

PvAccessUnknown

Value not known; You can’t set the value with PvDevice.Connect.

PvAccessOpen

Open access; the GigE Vision device isn’t connected to any other PC. You can’t set this value with PvDevice.Connect.

PvAccessControl
Shared access; a main controller has read-write access to the device and any other PvDevice can have read-only access to the device.
See also
PvAccessReadOnly

PvAccessExclusive

Exclusive access. The controller has full read-write access and any other requests but discovery or resent packets are denied.

PvAccessReadOnly

Can be used with PvDevice.Connect when requesting read-only access to a device currently on PvAccessOpen or PvAccessControl.
class eBUS.PvActionAckStatusEnum(*args: Any, **kwargs: Any)

Action command status enum.

Enum

PvActionAckStatusOK

The action command was received and executed with success.

PvActionAckStatusLate

The schedule action command was received after it was supposed to be executed.

PvActionAckStatusOverflow

The action command was dropped as too many action commands were already queued on the device.

PvActionAckStatusNoRefTime

The scheduled action command could not be synchronized as a reference time was not available.
class eBUS.PvBayerFilterType(*args: Any, **kwargs: Any)

Filter settings for PvBufferConverter.SetBayerFilter.

Enum

PvBayerFilterSimple

2x2 nearest neighbor used when converting from Bayer

PvBayerFilter3X3

3x3 kernel considered when converting from Bayer.
class eBUS.PvBiColorFilterType(*args: Any, **kwargs: Any)

Filter settings for PvBufferConverter.SetBiColorFilter.

class eBUS.PvDataReceiverType(*args: Any, **kwargs: Any)

The eBUS SDK Data Receiver Type.

Enum

PvDataReceiverTypeUnknown

PvDataReceiverTypeEBusDriver

PvDataReceiverTypeUserMode

PvDataReceiverTypeTCP
class eBUS.PvDeviceClass(*args: Any, **kwargs: Any)

GigE Vision device class.

Enum

PvDeviceClassUnknown

Device class unknown; indeterminate.

PvDeviceClassTransmitter

This device is a transmitter. This implies all its streaming channels transmit data.

PvDeviceClassReceiver

This device is a receiver. This implies all its streaming channels receive data.

PvDeviceClassTransceiver

This device is a transceiver. This implies that one or more streaming channels transmit data and one or more streaming channels receive data.

PvDeviceClassPeripheral

This device is a peripheral. This implies that this device does not have any streaming channels.
class eBUS.PvDeviceInfoType(*args: Any, **kwargs: Any)

The type of device the object represents.

Enum

PvDeviceInfoTypeUnknown

An unknown device type.

PvDeviceInfoTypeGEV

A GigE Vision compliant device.

PvDeviceInfoTypePleoraProtocol

A device compliant with Pleora Protocol (before GigE Vision)

PvDeviceInfoTypeUSB

A USB device

PvDeviceInfoTypeU3V

A USB3 Vision device
class eBUS.PvDeviceType(*args: Any, **kwargs: Any)

The device type.

Enum

PvDeviceTypeUnknown

The device is of unknown type

PvDeviceTypeGEV

The device is GigE Vision compliant

PvDeviceTypeU3V

The device is USB3 Vision compliant
class eBUS.PvDeviceSerial(*args: Any, **kwargs: Any)

Device serial port enumeration.

Enum

PvDeviceSerial0

Serial port 0, or UART0

PvDeviceSerial1

Serial port 1, or UART1

PvDeviceSerialBulk0

Bulk interface 0, or BULK0. Can be UART, USRT or I2C depending on device configuration.

PvDeviceSerialBulk1

Bulk interface 1, or BULK1. Can be UART, USRT or I2C depending on device configuration.

PvDeviceSerialBulk2

Bulk interface 2, or BULK2. Can be UART, USRT or I2C depending on device configuration.

PvDeviceSerialBulk3

Bulk interface 3, or BULK3. Can be UART, USRT or I2C depending on device configuration.

PvDeviceSerialBulk4

Bulk interface 4, or BULK4. Can be UART, USRT or I2C depending on device configuration.

PvDeviceSerialBulk5

Bulk interface 5, or BULK5. Can be UART, USRT or I2C depending on device configuration.

PvDeviceSerialBulk6

Bulk interface 6, or BULK6. Can be UART, USRT or I2C depending on device configuration.

PvDeviceSerialBulk7

Bulk interface 7, or BULK7. Can be UART, USRT or I2C depending on device configuration.
class eBUS.PvEncodingEnum(*args: Any, **kwargs: Any)

The encoding used by the PvCompressionFilter.

Enum

PvEncodingUnknown

Value not known, indeterminate. The value is currently not supported.

PvEncodingPTC1

Pleora Compression Version 1 encoding.
class eBUS.PvGenAccessMode(*args: Any, **kwargs: Any)

Access Mode of the register

Enum

PvGenAccessModeReadOnly

PvGenAccessModeReadWrite

PvGenAccessModeWriteOnly

PvGenAccessModeNotImplemented

PvGenAccessModeNotAvailable

PvGenAccessModeUndefined
class eBUS.PvGenCache(*args: Any, **kwargs: Any)

The cached value of the register behind the feature.

Enum

PvGenCacheWriteThrough

PvGenCacheWriteAround

PvGenCacheNone

PvGenCacheUndefined
class eBUS.PvGenEndianness(*args: Any, **kwargs: Any)

The Data Endianness for the register.

Enum

PvGenEndiannessInvalid

PvGenEndiannessLittle

PvGenEndiannessBig
class eBUS.PvGenNameSpace(*args: Any, **kwargs: Any)

PvGenNameSpace Enum

Enum

PvGenNameSpaceStandard

PvGenNameSpaceCustom

PvGenNameSpaceUndefined
class eBUS.PvGenRepresentation(*args: Any, **kwargs: Any)

PvGenRepresentation suggests how the UI should present a numerical feature (PvGenInteger or PvGenFloat).

To get a feature’s representation, use the following methods:

Enum

PvGenRepresentationLinear

Linear. Use a slider.

PvGenRepresentationLogarithmic

Logarithmic. Use a slider. The GenICam standard doesn’t specify if the feature’s value represents x or y in the formula x = n ^ y.

PvGenRepresentationBoolean

Boolean. The number might be presented as a check box or enable. Use a similar UI as for features from the PvGenBoolean class.

PvGenRepresentationPureNumber

Pure number. Use an edit box with a decimal display.

PvGenRepresentationHexNumber

Hex number. Use an edit box with a hexadecimal display.

PvGenRepresentationUndefined

Not defined; valid representation not provided.
class eBUS.PvGenRefresh(*args: Any, **kwargs: Any)

Refresh method for a GenApi browser.

GenApi browsers typically provides different methods for refresh the parameters it is displaying.

Enum

PvGenRefreshPolling

The polling time provided for parameters in the XML are used to control parameter refreshing.

PvGenRefreshAuto

A round-robbin refresh is performed on all visible features.

PvGenRefreshManual

Refresh is disabled. The browser may offer a manual Refresh button that can be used to control parameter refreshing.
class eBUS.PvGenSign(*args: Any, **kwargs: Any)

PvGenSign Enum.

Enum

PvGenSignUndefined

PvGenSignUnsigned

PvGenSignSigned
class eBUS.PvGenType(*args: Any, **kwargs: Any)

Feature data type (Boolean, integer, etc.)

Each feature has a type that defines the information it contains and how it can be used. The type also determines the eBUS SDK class used to represent it (and the methods that are available).

To test for a feature’s type, use PvGenParameter.GetType.

Enum

PvGenTypeInteger
Type: Integer

PvGenTypeEnum
Type: Enumeration

PvGenTypeBoolean
Type: Boolean

PvGenTypeString
Type: String

PvGenTypeCommand
Type: Command

PvGenTypeFloat
Type: Float

PvGenTypeUndefined

Type: Not defined; valid type not provided.
class eBUS.PvGenVisibility(*args: Any, **kwargs: Any)

Feature (PvGenParameter object) visibility.

Every feature has a visibility setting that suggests how difficult the feature is to use and when it shouldn’t be made available (visible) to the end user. The current visibility might be a program-specific variable available, for example, in an options or configuration dialog. When opening the program for the first time, the visibility would typically be set to beginner.

You can test the feature-by-feature visibility using the following methods:

PvGenParameter PvGenParameter.IsVisible PvGenParameter PvGenParameter.GetVisibility PvGenEnumEntry PvGenEnumEntry.IsVisible (for enumeration entries) PvGenEnumEntry PvGenEnumEntry.GetVisibility (for enumeration entries)

The visibility levels, from lowest to highest:

Beginner (PvGenVisibilityBeginner) Expert (PvGenVisibilityExpert) Guru (PvGenVisibilityGuru) Invisible (PvGenVisibilityInvisible)

If a program’s current visibility were set to Expert, the user would expect to see Beginner and Expert-level features, but not Guru or Invisible-level features.

Enum

PvGenVisibilityBeginner

Always visible, to all users.

PvGenVisibilityExpert

Intended for advanced users.

PvGenVisibilityGuru

Intended for very advanced users.

PvGenVisibilityInvisible

Appears in the API, but not the GUI.

PvGenVisibilityUndefined

Not defined; valid visibility not provided.
class eBUS.PvInterfaceType(*args: Any, **kwargs: Any)

The type of interface the object represents.

Enum

PvInterfaceTypeUnknown

interface unknown

PvInterfaceTypeUSBHostController

A USB host controller. USB devices (PvDeviceInfoUSB or PvDeviceInfoU3V) are enumerated through this interface.

PvInterfaceTypeNetworkAdapter

A network interface. Ethernet devices (PvDeviceInfoGEV or PvDeviceInfoPleoraProtocol) are enumerated through this interface.
class eBUS.PvMultiPartDataType(*args: Any, **kwargs: Any)

Enumeration reprensenting the data type of a section of a multi-part container.

Enum

PvMultiPartInvalid

Invalid or uninitialized value.

PvMultiPart2DImage

2D image.

Color or monochrome (2D) image. This part carries all the pixel data of the given image (even if the image is represented by a single-plane pixel format).

PvMultiPart2DPlaneOfBiPlanar

2D plane of a two-plane image.

Single plane of a planar (2D) image. The data should be linked with the other planes to get the complete image. The complete image consists of 2 planes. The planes of a given planar image MUST be placed as consecutive parts within the payload.

PvMultiPart2DPlaneOfTriPlanar

2D plane of a three-plane image.

Single plane of a planar (2D) image. The data should be linked with the other planes to get the complete image. The complete image consists of 3 planes. The planes of a given planar image MUST be placed as consecutive parts within the payload.

PvMultiPart2DPlaneOfQuadPlanar

2D plane of a four-plane image.

Single plane of a planar (2D) image. The data should be linked with the other planes to get the complete image. The complete image consists of 4 planes. The planes of a given planar image MUST be placed as consecutive parts within the payload.

PvMultiPart3DImage

3D image.

3D image (pixel coordinates). This part carries all the pixel data of the given image (even if the image is represented by a single-plane pixel format, for example when transferring the depth map only).

PvMultiPart3DPlaneOfBiPlanar

3D plane of a two-plane image. Single plane of a planar 3D image. The data should be linked with the other coordinate planes to get the complete image. The complete image consists of 2 planes. The planes of a given planar image MUST be placed as consecutive parts within the payload.

PvMultiPart3DPlaneOfTriPlanar

3D plane of a three-plane image.

Single plane of a planar 3D image. The data should be linked with the other coordinate planes to get the complete image. The complete image consists of 3 planes. The planes of a given planar image MUST be placed as consecutive parts within the payload.

PvMultiPart3DPlaneOfQuadPlanar

3D plane of a four-plane image.

Single plane of a planar 3D image. The data should be linked with the other coordinate planes to get the complete image. The complete image consists of 4 planes. The planes of a given planar image MUST be placed as consecutive parts within the payload.

PvMultiPartConfidenceMap

Confidence map.

Confidence of the individual pixel values. Expresses the level of validity of given pixel values.

Confidence map is always used together with one or more additional image-based parts matching 1:1 dimension-wise.

Each value in the confidence map expresses level of validity of the image pixel at matching position. The data format must be a Confidence PFNC format.

PvMultiPartChunkData

Chunk data section. Always last in a multi-part container.

Part carrying the chunk data in the Extended Chunk Data Mode. This MUST be always the last part in the payload. There MUST NOT be more than one chunk data part in the payload.

PvMultiPartJPEGImage

JPEG image.

JPEG compressed image following the guidelines defined for the GVSP JPEG payload type.

The data_type_specific field is used to carry information found in the JPEG data leader packet.

PvMultiPartJPEG2000Image

JEPG 2000 image.

JPEG 2000 compressed image following the guidelines defined for the GVSP JPEG 2000 payload type.

The data type specific field is used to carry information found in the JPEG 2000 data leader packet.
class eBUS.PvPayloadType(*args: Any, **kwargs: Any)

GVSP payload type.

Enum

PvPayloadTypeUndefined

Undefined or non initialized payload type

PvPayloadTypeNone

A proprietary type used for GigE Vision Validation Framework testing. Refer to IPvStreamingChannelSource.SetTestPayloadFormatMode for more details.

PvPayloadTypeImage

Image payload type. Access from PvBuffer using PvBuffer.GetImage.

PvPayloadTypeRawData

Raw data payload type. Access from PvBuffer using PvBuffer.GetRawData.

PvPayloadTypeFile

File payload type. Not currently supported.

PvPayloadTypeChunkData

Chunk data payload type. Not currently supported.

PvPayloadTypeExtendedChunkData

Extended chunk data payload type. Not currently supported.

PvPayloadTypeJPEG

JPEG compressed image payload type. Not currently supported.

PvPayloadTypeJPEG2000

JPEG 2000 compressed image payload type. Not currently supported.

PvPayloadTypeH264

H.264 compressed video stream payload type. Not currently supported.

PvPayloadTypeMultiZoneImage

Multi-zone image payload type. Not currently supported.

PvPayloadTypeMultiPart

Multi-part payload type.

PvPayloadTypeDeviceSpecificBase

Base value for device specific payload type. Not currently supported.

PvPayloadTypePleoraCompressed

Pleora compressed payload type.
class eBUS.PvPixelType(*args: Any, **kwargs: Any)

Pixel types use by image buffers.

** PvBufferConverter conversion currently supported to the following pixel types:**

  • PvPixelRGBa

  • PvPixelBGRa

  • PvPixelRGB

  • PvPixelBGR

  • PvPixelRGB565

  • PvPixelMono8

Pre GEV 2.0 pixel types:

  • PvPixelRGB8Packed

  • PvPixelBGR8Packed

  • PvPixelRGBA8Packed

  • PvPixelBGRA8Packed

  • PvPixelRGB10Packed

  • PvPixelBGR10Packed

  • PvPixelRGB12Packed

  • PvPixelBGR12Packed

  • PvPixelRGB16Packed

  • PvPixelBGR10V1Packed

  • PvPixelBGR10V2Packed

  • PvPixelYUV411Packed

  • PvPixelYUV422Packed

  • PvPixelYUV422YUYVPacked

  • PvPixelYUV444Packed

  • PvPixelRGB8Planar

  • PvPixelRGB10Planar

  • PvPixelRGB12Planar

  • PvPixelRGB16Planar

class eBUS.PvResultCode(value)

PvResult Code information about the success or failure of the methods you use.

Most successful methods return PV_OK, however, there are exceptions:

Some methods return immediately, but the ultimate success of the method may not be know for some time after (several seconds or more). These methods return PV_PENDING. Pending operations are considered successful.

To use result codes (best coding practices):

  1. Call a method.

  2. Test the result for success. Use PvResult.IsSuccess, PvResult.IsOK, or test against specific PvResultCode values.

Enum

PV_OK

Success! (Immediate.)

PV_NOT_INITIALIZED

An error code hasn’t been set.

When initially created, the PvResult object has the value NOT_INITIALIZED.
The value only occurs when the object is first created; no method returns NOT_INITIALIZED.

PV_NOT_FOUND

The expected item wasn’t found.

Possible causes include:

  • Connecting to a GigE Vision device that doesn’t exist (or isn’t on the network).

  • Accessing a non-existent parameter.

PV_CANNOT_OPEN_FILE

The file doesn’t exist or can’t be opened.

PV_NO_MORE_ITEM

No more of what was requested is currently available.

PV_NOT_CONNECTED

The object (PvDevice or PvStream object) isn’t connected.

Refer to the documentation of the method being called or call PvResult.GetDescription for further information.

PV_STATE_ERROR

The method is (probably) legal, but the system’s current state doesn’t allow the action.

For example, you can’t queue buffers to a stream (using PvStream.QueueBuffer) before opening it (using PvStream.Open).

PV_THREAD_ERROR

An error occurred while attempting to perform an operation on a thread like starting,stopping or changing priority.

PV_INVALID_DATA_FORMAT

The data format is not supported for the requested operation.

PV_ABORTED

The operation was aborted

PV_NOT_ENOUGH_MEMORY

Not enough memory. An operation failed to complete as not enough memory was available.

PV_GENERIC_ERROR

An undefined error occurred.

Refer to the documentation of the method being called or call PvResult.GetDescription for further information.

PV_INVALID_PARAMETER

A parameter passed to the method is invalid.

Possible causes include:

  • A value is out-of-bounds.

  • An empty string, where a non-empty string is required.

  • A null pointer.

PV_CANCEL

The user closed a dialog and the operation was not performed. This can occur if the “Cancel” button is clicked.

PV_PENDING

Success! (Pending.)

Returned by PvStream.QueueBuffer to indicate that a buffer has been successfully queued but the operation is still pending (the data has not yet been received).

PV_TIMEOUT

The operation timed out.

The operation exceeded its specified maximum wait time without succeeding.

PV_NO_LICENSE

An eBUS SDK license is missing.

To receive data from a GigE Vision device that does not contain a Pleora video interface, a receiver license is required. A license is also required to transmit data using the eBUS SDK using PvTransmitterGEV. When working with images, a watermark is applied when no license is present. This is so that the SDK can be used for evaluation purposes.

PV_GENICAM_XML_ERROR

The GenICam XML file could not be loaded into GenApi.

The file could be corrupted or simply incorrectly structured. Some third-party vendors use XML files that don’t conform to the GenApi schema.

PV_CANT_READ_MANIFEST

The manifest table of the device could not be read

Device was discovered but the manifest table could not be read. It may have a corrupt firmware load or could be powered incorrectly.

PV_NOT_IMPLEMENTED

The requested feature or functionality is not implemented.

Can happen when a dynamically selected feature or capability is not implemented in the SDK.

PV_NOT_SUPPORTED

The requested feature or functionality is not supported.

PV_FILE_ERROR

A file operation error occured.

PV_ERR_OVERFLOW

Overflow occurred.

Can happen when a counter overflows or when an attempt was made to write past the upper boundary of a file or data structure.

PV_IMAGE_ERROR

Error with an image.

May be returned when a corrupt image arrives due to discontinuities in data between the camera and the hardware responsible for transmitting packets in the GigE Vision device. | This can include data overrun, partial and full lines missing.

PV_MISSING_PACKETS

Some packets are missing in the buffer.

Happens when at least one packet of the buffer is missing when it was released back to the calling application.

PV_BUFFER_TOO_SMALL

The buffer was not large enough to hold the payload of the block being received.

Call PvBuffer.GetRequiredSize to use the information from the leader packet to determine the size of buffer that would have been required to receive the block.

Call PvBuffer.Alloc or PvBuffer.Attach to allocate or associate an a larger area of memory to receive the next block.

PV_TOO_MANY_RESENDS

Too many resend packets were requested, buffer acquisition failure.

PV_RESENDS_FAILURE

Failure to receive all missing packets for a buffer through resend packets.

PV_TOO_MANY_CONSECUTIVE_RESENDS

Buffer reception failed, consecutive missing buffers higher than allowed.

The data receiver may stop attempting to receive a block if a set of consecutive packets exceeding MaximumResendGroupSize.

PV_AUTO_ABORTED

Buffer reception failed.

The data receiver entered a state where so many packets and/or blocks were missing that all queued buffers were automatically aborted on an internal reset.

PV_BAD_VERSION

Some component versions are not compatible.

PV_NO_MORE_ENTRY

There are no more entries to retrieve/enumerate.

PV_NO_AVAILABLE_DATA

There is no available data to enumerate.

PV_NETWORK_ERROR

A network error occurred while performing the requested operation.

PV_RESYNC

Kick out of the driver because of a forced resynchronisation.

PV_BUSY

The resource requested is already in use.

PV_CORRUPTED_DATA

The data is corrupted.
class eBUS.PvScanType(*args: Any, **kwargs: Any)

The Image Source Scan Type. It could be Area scan or line scan in 3D or not.

Enum

PvScanTypeInvalid

PvScanTypeArea

PvScanTypeLine

PvScanTypeArea3D

PvScanTypeLine3D
class eBUS.PvStreamType(*args: Any, **kwargs: Any)

The Image Stream Type.

Enum

PvStreamTypeUnknown

PvStreamTypeGEV

PvStreamTypeU3V

PvStreamTypeRTP
class eBUS.PvUSBStatus(*args: Any, **kwargs: Any)

USB device status.

Enum

PvUSBStatusConnected

USB device successfully enumerated.

PvUSBStatusFailedEnumeration

Impossible to enumerate the device.

PvUSBStatusGeneralFailure

General failure of connection to the USB device.

PvUSBStatusCausedOvercurrent

The device caused an over current situation on the USB bus.

PvUSBStatusNotEnoughPower

The device lacks power and thus cannot even be enumerated.

PvUSBStatusNotEnoughBandwidth

Not enough bandwidth on the USB bus to enumerate the device.

PvUSBStatusHubNestedTooDeeply

The device is nested too deeply in the hub architecture to be properly enumerated.

PvUSBStatusInLegacyHub

The device cannot be enumerated as is connected in a legacy hub.

PvUSBStatusEnumerating

The device is currently being enumerated.

PvUSBStatusReset

The device is currently restarting.
class eBUS.PvUSBSpeed(*args: Any, **kwargs: Any)

The speed grade of the USB device or interface.

Enum

PvUSBSpeedUnsupported

An error indicated an unsupported or mismatched speed

PvUSBSpeedUnknown

The USB speed is not determined

PvUSBSpeedLow

The USB speed is low (USB 1.1 maximum 1.5Mbps)

PvUSBSpeedFull

The USB speed is full (USB 1.1 maximum 12Mbps)

PvUSBSpeedHigh

The USB speed is high (USB 2.0 maximum 480Mbps)

PvUSBSpeedSuper

The USB speed is super (USB 3.0 maximum 5Gbps)
class eBUS.PvUserSetState(*args: Any, **kwargs: Any)

UserSetState enumeration type.

Enum

PvUserSetStateSaveStart

The device is about to start a UserSetSave

PvUserSetStateSaveCompleted

The device has just completed a UserSetSave

PvUserSetStateLoadStart

The device is about to start a UserSetLoad

PvUserSetStateLoadCompleted

The device has just completed a UserSetLoad