BFModule.CXPReg.clsDevice

class BFModule.CXPReg.clsDevice

Bases: pybind11_object

Python wrapper class to access and modify registers on a CXP device via a BitFlow frame grabber.

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: BFModule.CXPReg.clsDevice) -> None

2. __init__(self: BFModule.CXPReg.clsDevice, arg0: BFModule.BufferAcquisition.clsBufferedAcquisition) -> None

Methods

CXPReadData(*args, **kwargs)	Overloaded function.
CXPReadReg(*args, **kwargs)	Overloaded function.
CXPWriteData(*args, **kwargs)	Overloaded function.
CXPWriteReg(*args, **kwargs)	Overloaded function.
Close(self)	Close the current board, if any.
Open(self)	Opens a board for access with the given Options.
__init__(*args, **kwargs)	Overloaded function.
isCXP(self)	Query whether or not the opened BitFlow board is a CoaXPress device.

CXPReadData(*args, **kwargs)

Overloaded function.

1. CXPReadData(self: BFModule.CXPReg.clsDevice, address: int, bytes: int) -> list[int]

   Read from CXP data space (buffer size should be multiple of 4) on the Master Link.

   param int address:

   The byte address of the first register to be read.

   param int bytes:

   The number of bytes to be read from the register space. Must be a multiple of 4.

   rtype:

   int

   return:

   value of the specified register.

   raises ValueError:

   if the board is not a CXP device.

   raises ValueError:

   if the bytes parameter is not a multiple of 4.

   raises RuntimeError:

   if timed out waiting for acknowledgement.

   raises RuntimeError:

   if error code in acknowledgement from camera.

2. CXPReadData(self: BFModule.CXPReg.clsDevice, link: int, address: int, bytes: int) -> list[int]

   Read from CXP data space (buffer size should be multiple of 4) on the specified Link.

   param int link:

   The cxp link to read data from.

   param int address:

   The byte address of the first register to be read.

   param int bytes:

   The number of bytes to be read from the register space. Must be a multiple of 4.

   rtype:

   int

   return:

   value of the specified register.

   raises ValueError:

   if the board is not a CXP device.

   raises ValueError:

   if the bytes parameter is not a multiple of 4.

   raises RuntimeError:

   if timed out waiting for acknowledgement.

   raises RuntimeError:

   if error code in acknowledgement from camera.

CXPReadReg(*args, **kwargs)

Overloaded function.

1. CXPReadReg(self: BFModule.CXPReg.clsDevice, address: int) -> int

   Read the value of a single CoaXPress register on the Master Link.

   param int address:

   The byte address of the register to be read.

   rtype:

   int

   return:

   value of the specified register.

   raises ValueError:

   if the board is not a CXP device.

   raises RuntimeError:

   if timed out waiting for acknowledgement.

   raises RuntimeError:

   if error code in acknowledgement from camera.

2. CXPReadReg(self: BFModule.CXPReg.clsDevice, link: int, address: int) -> int

   Read the value of a single CoaXPress register on the specified Link.

   param int address:

   The byte address of the register to be read.

   param int link:

   The camera link to read data from.

   rtype:

   int

   return:

   value of the specified register.

   raises ValueError:

   if the board is not a CXP device.

   raises RuntimeError:

   if timed out waiting for acknowledgement.

   raises RuntimeError:

   if error code in acknowledgement from camera.

CXPWriteData(*args, **kwargs)

Overloaded function.

1. CXPWriteData(self: BFModule.CXPReg.clsDevice, address: int, data: list[int]) -> None

   Write to CXP data space on the Master Link.

   param int address:

   The byte address of the first register to write to.

   param list data:

   The values to write. Size of the list must be in multiples of 4.

   rtype:

   void

   raises ValueError:

   if the board is not a CXP device.

   raises RuntimeError:

   if timed out waiting for acknowledgement.

   raises RuntimeError:

   if error code in acknowledgement from camera.

2. CXPWriteData(self: BFModule.CXPReg.clsDevice, link: int, address: int, data: list[int]) -> None

   Write to CXP data space on the specified Link.

   param int address:

   The byte address of the first register to write to.

   param int link:

   The camera link to write data to.

   param list data:

   The values to write. Size of the list must be in multiples of 4.

   rtype:

   void

   raises ValueError:

   if the board is not a CXP device.

   raises RuntimeError:

   if timed out waiting for acknowledgement.

   raises RuntimeError:

   if error code in acknowledgement from camera.

CXPWriteReg(*args, **kwargs)

Overloaded function.

1. CXPWriteReg(self: BFModule.CXPReg.clsDevice, address: int, value: int) -> None

   Write the value of a single CoaXPress register on the Master Link.

   param int address:

   The byte address of the register to be write to.

   param int value:

   The value to write to the specified register.

   rtype:

   void

   raises ValueError:

   if the board is not a CXP device.

   raises RuntimeError:

   if timed out waiting for acknowledgement.

   raises RuntimeError:

   if error code in acknowledgement from camera.

2. CXPWriteReg(self: BFModule.CXPReg.clsDevice, link: int, address: int, value: int) -> None

   Write the value of a single CoaXPress register on the specified Link.

   param int address:

   The byte address of the register to be write to.

   param int link:

   The camera link to write data to.

   param int value:

   The value to write to the specified register.

   rtype:

   void

   raises ValueError:

   if the board is not a CXP device.

   raises RuntimeError:

   if timed out waiting for acknowledgement.

   raises RuntimeError:

   if error code in acknowledgement from camera.

Close(self: BFModule.CXPReg.clsDevice) → None

Close the current board, if any. Do nothing, otherwise.

Open(self: BFModule.CXPReg.clsDevice) → None

Opens a board for access with the given Options. The board number refers to all model bitflow boards.

Raises:

• ValueError – if the board number is not valid.

• RuntimeError – if the board could not be opened.

isCXP(self: BFModule.CXPReg.clsDevice) → bool

Query whether or not the opened BitFlow board is a CoaXPress device. The CXP register methods are non-functional, if the Device isn’t CoaXPress.

Return type:

bool

Returns:

true - board is CoaXPress, false - board is not CoaXPress.