Impact Acquire SDK Python
Loading...
Searching...
No Matches
mvPoDLDeviceControl Class Reference

Category for device information and control. More...

Inheritance diagram for mvPoDLDeviceControl:
[legend]

Public Member Functions

 __init__ (self, *args)
 Constructs a new mvIMPACT.acquire.mvPoDLDeviceControl 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

 mvPoDLDeviceFamilyName = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceFamilyName_get, doc=)
 A string property.
 mvPoDLDeviceFirmwareId = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceFirmwareId_get, doc=)
 A string property.
 mvPoDLDeviceFirmwareVersion = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceFirmwareVersion_get, doc=)
 A string property.
 mvPoDLDeviceManufacturerInfo = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceManufacturerInfo_get, doc=)
 A string property.
 mvPoDLDeviceModelName = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceModelName_get, doc=)
 A string property.
 mvPoDLDeviceRegistersEndianness = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceRegistersEndianness_get, doc=)
 An enumerated integer property.
 mvPoDLDeviceReset = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceReset_get, doc=)
 A method object.
 mvPoDLDeviceSerialNumber = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceSerialNumber_get, doc=)
 A string property.
 mvPoDLDeviceTemperature = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceTemperature_get, doc=)
 A floating point property.
 mvPoDLDeviceTemperatureSelector = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceTemperatureSelector_get, doc=)
 An enumerated integer property.
 mvPoDLDeviceUserID = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceUserID_get, doc=)
 A string property.
 mvPoDLDeviceVendorName = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceVendorName_get, doc=)
 A string property.
 mvPoDLDeviceVersion = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceVersion_get, doc=)
 A string property.
 mvPoDLFirmwareUpdateMode = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLFirmwareUpdateMode_get, doc=)
 A method object.
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Detailed Description

Category for device information and control.

Category for device information and control.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
* args )

Constructs a new mvIMPACT.acquire.mvPoDLDeviceControl object.

Parameters
pDev[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.
settingName[in] The name of the driver internal setting to access with this instance. A list of valid setting names can be obtained by a call to mvIMPACT.acquire.FunctionInterface.getAvailableSettings, new settings can be created with the function mvIMPACT.acquire.FunctionInterface.createSetting

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

◆ mvPoDLDeviceFamilyName

mvPoDLDeviceFamilyName = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceFamilyName_get, doc=)
static

A string property.

Identifier of the product family of the device.

Identifier of the product family of the device.

◆ mvPoDLDeviceFirmwareId

mvPoDLDeviceFirmwareId = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceFirmwareId_get, doc=)
static

A string property.

Identifier of the firmware in the device.

Identifier of the firmware in the device.

◆ mvPoDLDeviceFirmwareVersion

mvPoDLDeviceFirmwareVersion = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceFirmwareVersion_get, doc=)
static

A string property.

Version of the firmware in the device.

Version of the firmware in the device.

◆ mvPoDLDeviceManufacturerInfo

mvPoDLDeviceManufacturerInfo = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceManufacturerInfo_get, doc=)
static

A string property.

Manufacturer information about the device.

Manufacturer information about the device.

◆ mvPoDLDeviceModelName

mvPoDLDeviceModelName = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceModelName_get, doc=)
static

A string property.

Model of the device.

Model of the device.

◆ mvPoDLDeviceRegistersEndianness

mvPoDLDeviceRegistersEndianness = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceRegistersEndianness_get, doc=)
static

An enumerated integer property.

Endianness of the registers of the device.

Endianness of the registers of the device.

The following string values might be valid for this feature:

  • Big (Display string: 'Big'): Device's registers are big Endian.
  • Little (Display string: 'Little'): Device's registers are little Endian.
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT.acquire.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ mvPoDLDeviceReset

mvPoDLDeviceReset = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceReset_get, doc=)
static

A method object.

Resets the device to its power up state.

Resets the device to its power up state. After reset, the device must be rediscovered.

◆ mvPoDLDeviceSerialNumber

mvPoDLDeviceSerialNumber = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceSerialNumber_get, doc=)
static

A string property.

Device's serial number.

Device's serial number. This string is a unique identifier of the device.

◆ mvPoDLDeviceTemperature

mvPoDLDeviceTemperature = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceTemperature_get, doc=)
static

A floating point property.

Device temperature in degrees Celsius (C).

Device temperature in degrees Celsius (C). It is measured at the location selected by DeviceTemperatureSelector.

◆ mvPoDLDeviceTemperatureSelector

mvPoDLDeviceTemperatureSelector = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceTemperatureSelector_get, doc=)
static

An enumerated integer property.

Selects the location within the device, where the temperature will be measured.

Selects the location within the device, where the temperature will be measured.

The following string values might be valid for this feature:

  • Mainboard (Display string: 'Mainboard'): Temperature of the device's mainboard.
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT.acquire.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ mvPoDLDeviceUserID

mvPoDLDeviceUserID = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceUserID_get, doc=)
static

A string property.

User-programmable device identifier.

User-programmable device identifier.

◆ mvPoDLDeviceVendorName

mvPoDLDeviceVendorName = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceVendorName_get, doc=)
static

A string property.

Name of the manufacturer of the device.

Name of the manufacturer of the device.

◆ mvPoDLDeviceVersion

mvPoDLDeviceVersion = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLDeviceVersion_get, doc=)
static

A string property.

Version of the device.

Version of the device.

◆ mvPoDLFirmwareUpdateMode

mvPoDLFirmwareUpdateMode = property(lib_mvIMPACT_acquire.mvPoDLDeviceControl_mvPoDLFirmwareUpdateMode_get, doc=)
static

A method object.

Resets the camera to the firmware update mode

Resets the camera to the firmware update mode

◆ thisown

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