Impact Acquire SDK Python
InfoBlueFOX Class Reference

A more specific class to query information about a mvBlueFOX device and its driver(Device specific interface layout only). More...

Inheritance diagram for InfoBlueFOX:
[legend]

Public Member Functions

 __init__ (self, pDev)
 Constructs a new mvIMPACT.acquire.InfoBlueFOX object.
 hObj (self)
 Returns a unique identifier for the component collection referenced by this object.
 restoreDefault (self)
 Restores the default for every component of this collection.

Properties

 captureBufferAlignment = property(lib_mvIMPACT_acquire.Info_captureBufferAlignment_get, doc=)
 An integer property (read-only) containing the capture buffer alignment in bytes needed by this device driver.
 deviceDriverVersion = property(lib_mvIMPACT_acquire.Info_deviceDriverVersion_get, doc=)
 An integer property (read-only) containing the device driver version used by this device.
 deviceSensorRevision = property(lib_mvIMPACT_acquire.InfoBlueFOX_deviceSensorRevision_get, doc=)
 A 64 bit integer property (read-only) containing the current revision of the sensor head of this device.
 deviceTemperature = property(lib_mvIMPACT_acquire.InfoBlueFOX_deviceTemperature_get, doc=)
 A float property (read-only) containing the temperature of the selected temperature sensor on the device in degrees Celsius.
 driverDate = property(lib_mvIMPACT_acquire.Info_driverDate_get, doc=)
 A string property (read-only) containing the date the device driver has been compiled.
 driverVersion = property(lib_mvIMPACT_acquire.Info_driverVersion_get, doc=)
 A string property (read-only) containing the version number of the device driver.
 firmwareVersion = property(lib_mvIMPACT_acquire.InfoBlueFOX_firmwareVersion_get, doc=)
 An integer property (read-only) containing the firmware version of this device.
 loadedSettings = property(lib_mvIMPACT_acquire.Info_loadedSettings_get, doc=)
 A string property (read-only) containing the name of the setting currently loaded.
 logFile = property(lib_mvIMPACT_acquire.Info_logFile_get, doc=)
 A string property (read-only) containing the name and the full path of the current log-file for this device.
 recommendedListsForUIs = property(lib_mvIMPACT_acquire.Info_recommendedListsForUIs_get, doc=)
 A string property (read-only) containing an array of full search paths to lists which are recommended to be displayed in a user interface that is created dynamically.
 sensorCaps = property(lib_mvIMPACT_acquire.InfoBlueFOX_sensorCaps_get, doc=)
 An integer property (read-only) containing a bit mask containing information about the sensors capabilities(if known).
 sensorColorMode = property(lib_mvIMPACT_acquire.InfoBlueDevice_sensorColorMode_get, doc=)
 An enumerated integer property (read-only) containing the type of the sensor (color/mono/...)(if known).
 sensorFPGAVersion = property(lib_mvIMPACT_acquire.InfoBlueFOX_sensorFPGAVersion_get, doc=)
 An integer property (read-only) containing the FPGA version of the camera(if known).
 sensorType = property(lib_mvIMPACT_acquire.InfoBlueDevice_sensorType_get, doc=)
 An enumerated integer property (read-only) containing the type of sensor chip of the camera (if known).
 sensorXRes = property(lib_mvIMPACT_acquire.InfoBlueDevice_sensorXRes_get, doc=)
 An integer property (read-only) containing the horizontal resolution of the camera sensor.
 sensorYRes = property(lib_mvIMPACT_acquire.InfoBlueDevice_sensorYRes_get, doc=)
 An integer property (read-only) containing the vertical resolution of the camera sensor.
 state = property(lib_mvIMPACT_acquire.Info_state_get, doc=)
 An enumerated integer property (read-only) containing the current state of this device.
 systemLogicalProcessorCount = property(lib_mvIMPACT_acquire.Info_systemLogicalProcessorCount_get, doc=)
 An integer property (read-only) containing the number of logical processors detected in the current system.
 systemPhysicalProcessorCount = property(lib_mvIMPACT_acquire.Info_systemPhysicalProcessorCount_get, doc=)
 An integer property (read-only) containing the number of physical processors detected in the current system.
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 userEEPROMSize = property(lib_mvIMPACT_acquire.InfoBlueFOX_userEEPROMSize_get, doc=)
 An integer property (read-only) containing the size of the user EEPROM that can be accessed using the I2C access features of mvIMPACT.acquire.I2CControl.

Detailed Description

A more specific class to query information about a mvBlueFOX device and its driver(Device specific interface layout only).

This class contains a collection of properties providing various information about a mvBlueFOX device and its driver.

Note
This class will only be available if mvIMPACT.acquire.Device.interfaceLayout is set to mvIMPACT.acquire.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
pDev )

Constructs a new mvIMPACT.acquire.InfoBlueFOX object.

Parameters
pDev[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.

Member Function Documentation

◆ hObj()

hObj ( self)
inherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mvIMPACT.acquire.ComponentList.

Returns
A unique identifier for the component referenced by this object.

◆ restoreDefault()

restoreDefault ( self)
inherited

Restores the default for every component of this collection.

Calling this function will restore the default value for every component belonging to this collection.

Note
The caller must have the right to modify the component. Otherwise an exception will be thrown.
Returns
A const reference to the component.

Property Documentation

◆ captureBufferAlignment

captureBufferAlignment = property(lib_mvIMPACT_acquire.Info_captureBufferAlignment_get, doc=)
staticinherited

An integer property (read-only) containing the capture buffer alignment in bytes needed by this device driver.

◆ deviceDriverVersion

deviceDriverVersion = property(lib_mvIMPACT_acquire.Info_deviceDriverVersion_get, doc=)
staticinherited

An integer property (read-only) containing the device driver version used by this device.

This is the version of the underlying hardware driver. For device drivers that don't have another user mode driver below the interface driver this property will contain the same version information as the property mvIMPACT.acquire.Info.driverVersion.

◆ deviceSensorRevision

deviceSensorRevision = property(lib_mvIMPACT_acquire.InfoBlueFOX_deviceSensorRevision_get, doc=)
static

A 64 bit integer property (read-only) containing the current revision of the sensor head of this device.

Note
This feature is currently not supported by all sensors. If a sensor can't provide this information, the value of this property will remain 0 at all time.
Since
1.12.65

◆ deviceTemperature

deviceTemperature = property(lib_mvIMPACT_acquire.InfoBlueFOX_deviceTemperature_get, doc=)
static

A float property (read-only) containing the temperature of the selected temperature sensor on the device in degrees Celsius.

Note
This property will not be available for every mvBlueFOX. Right now this feature is only implemented for 202d version of the mvBlueFOX.
Since
1.12.62

◆ driverDate

driverDate = property(lib_mvIMPACT_acquire.Info_driverDate_get, doc=)
staticinherited

A string property (read-only) containing the date the device driver has been compiled.

◆ driverVersion

driverVersion = property(lib_mvIMPACT_acquire.Info_driverVersion_get, doc=)
staticinherited

A string property (read-only) containing the version number of the device driver.

◆ firmwareVersion

firmwareVersion = property(lib_mvIMPACT_acquire.InfoBlueFOX_firmwareVersion_get, doc=)
static

An integer property (read-only) containing the firmware version of this device.

◆ loadedSettings

loadedSettings = property(lib_mvIMPACT_acquire.Info_loadedSettings_get, doc=)
staticinherited

A string property (read-only) containing the name of the setting currently loaded.

◆ logFile

logFile = property(lib_mvIMPACT_acquire.Info_logFile_get, doc=)
staticinherited

A string property (read-only) containing the name and the full path of the current log-file for this device.

◆ recommendedListsForUIs

recommendedListsForUIs = property(lib_mvIMPACT_acquire.Info_recommendedListsForUIs_get, doc=)
staticinherited

A string property (read-only) containing an array of full search paths to lists which are recommended to be displayed in a user interface that is created dynamically.

◆ sensorCaps

sensorCaps = property(lib_mvIMPACT_acquire.InfoBlueFOX_sensorCaps_get, doc=)
static

An integer property (read-only) containing a bit mask containing information about the sensors capabilities(if known).

Note
If nothing is known about this feature, this property will contain '-1'.

◆ sensorColorMode

sensorColorMode = property(lib_mvIMPACT_acquire.InfoBlueDevice_sensorColorMode_get, doc=)
staticinherited

An enumerated integer property (read-only) containing the type of the sensor (color/mono/...)(if known).

Valid values for this property may be: mvIMPACT.acquire.iscmUnknown, mvIMPACT.acquire.iscmMono, mvIMPACT.acquire.iscmBayer, mvIMPACT.acquire.iscmColor, mvIMPACT.acquire.iscmNIR.

Note
If nothing is known about this feature, this property will contain mvIMPACT.acquire.iscmUnknown.

If the device has more than one sensor head, and all these sensor heads can be accessed using the current interface, this property will contain as many values as the devices offers sensor heads.

◆ sensorFPGAVersion

sensorFPGAVersion = property(lib_mvIMPACT_acquire.InfoBlueFOX_sensorFPGAVersion_get, doc=)
static

An integer property (read-only) containing the FPGA version of the camera(if known).

Note
If nothing is known about this feature, this property will contain '-1'.

◆ sensorType

sensorType = property(lib_mvIMPACT_acquire.InfoBlueDevice_sensorType_get, doc=)
staticinherited

An enumerated integer property (read-only) containing the type of sensor chip of the camera (if known).

Valid values for this property may be: mvIMPACT.acquire.istUnknown, mvIMPACT.acquire.istCCD, mvIMPACT.acquire.istCMOS.

This usually will either be mvIMPACT.acquire.istCCD or mvIMPACT.acquire.istCMOS.

If the device has more than one sensor head, and all these sensor heads can be accessed using the current interface, this property will contain as many values as the devices offers sensor heads.

◆ sensorXRes

sensorXRes = property(lib_mvIMPACT_acquire.InfoBlueDevice_sensorXRes_get, doc=)
staticinherited

An integer property (read-only) containing the horizontal resolution of the camera sensor.

If the device has more than one sensor head, and all these sensor heads can be accessed using the current interface, this property will contain as many values as the devices offers sensor heads.

◆ sensorYRes

sensorYRes = property(lib_mvIMPACT_acquire.InfoBlueDevice_sensorYRes_get, doc=)
staticinherited

An integer property (read-only) containing the vertical resolution of the camera sensor.

If the device has more than one sensor head, and all these sensor heads can be accessed using the current interface, this property will contain as many values as the devices offers sensor heads.

◆ state

state = property(lib_mvIMPACT_acquire.Info_state_get, doc=)
staticinherited

An enumerated integer property (read-only) containing the current state of this device.

This property e.g. provides information about the current state of the device. For USB devices this can e.g. indicate whether a device is currently plugged into the system or not.

Valid values for this property may be: mvIMPACT.acquire.dsAbsent, mvIMPACT.acquire.dsPresent, mvIMPACT.acquire.dsInitializing, mvIMPACT.acquire.dsUnreachable, mvIMPACT.acquire.dsPowerDown.

GenICam/GenTL device specific: In order to reduce the amount of network traffic to a minimum, this property will only be updated automatically for network devices if the property mvIMPACT.acquire.Device.registerErrorEvent is set to mvIMPACT.acquire.bTrue (which is the default behaviour). If the IP addresses stay the same the connection is automatically re-established then once the device is detected by the driver again. However if the IP address of the device and/or the network adapter of the system it is used from changes mvIMPACT.acquire.DeviceManager.updateDeviceList() must be called regardless of the value of mvIMPACT.acquire.Device.registerErrorEvent before a device that was lost can re-establish a connection to the capture driver.

◆ systemLogicalProcessorCount

systemLogicalProcessorCount = property(lib_mvIMPACT_acquire.Info_systemLogicalProcessorCount_get, doc=)
staticinherited

An integer property (read-only) containing the number of logical processors detected in the current system.

Since
2.44.0

◆ systemPhysicalProcessorCount

systemPhysicalProcessorCount = property(lib_mvIMPACT_acquire.Info_systemPhysicalProcessorCount_get, doc=)
staticinherited

An integer property (read-only) containing the number of physical processors detected in the current system.

Since
2.44.0

◆ thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static

◆ userEEPROMSize

userEEPROMSize = property(lib_mvIMPACT_acquire.InfoBlueFOX_userEEPROMSize_get, doc=)
static

An integer property (read-only) containing the size of the user EEPROM that can be accessed using the I2C access features of mvIMPACT.acquire.I2CControl.

Note
The size may vary depending on the product. Even different products with the same sensor might report different values here.
The user EEPROM uses a virtual I2C address of 0x1A2 for write access and 0x1A3 for read access.