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__(self: BFModule.CXPReg.clsDevice) None

Methods

CXPReadReg(*args, **kwargs)

Overloaded function.

CXPWriteReg(*args, **kwargs)

Overloaded function.

Close(self)

Close the current board, if any.

Open(self, BoardNumber)

Opens a board for access with the given Options.

__init__(self)

getBoardNumber(self)

Query the board number of the opened CXP register device.

isBrdOpen(self)

Query whether or not a board has been successfully opened.

isCXP(self)

Query whether or not the opened BitFlow board is a CoaXPress device.

CXPReadReg(*args, **kwargs)

Overloaded function.

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

    Read the value of a single CoaXPress register.

    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.

    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.

CXPWriteReg(*args, **kwargs)

Overloaded function.

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

    Write the value of a single CoaXPress register.

    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.

    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, BoardNumber: int) None

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

Parameters

BoardNumber (int) – The index of the board to be opened.

Raises
getBoardNumber(self: BFModule.CXPReg.clsDevice) int

Query the board number of the opened CXP register device.

Return type

int

Returns

The opened board number.

isBrdOpen(self: BFModule.CXPReg.clsDevice) int

Query whether or not a board has been successfully opened.

Return type

bool

Returns

TRUE - board is open, FALSE - board not open.

isCXP(self: BFModule.CXPReg.clsDevice) int

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.