Impact Acquire SDK Python
mvSerialInterfaceControl Class Reference

Contains features to control the serial interface. More...

Inheritance diagram for mvSerialInterfaceControl:
[legend]

Public Member Functions

 __init__ (self, *args)
 Constructs a new mvIMPACT.acquire.mvSerialInterfaceControl object.
 

Properties

 mvLiquidLensErrorCount = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvLiquidLensErrorCount_get, doc=)
 An integer property.
 
 mvLiquidLensFirmwareVersion = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvLiquidLensFirmwareVersion_get, doc=)
 An integer property.
 
 mvLiquidLensPowerMode = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvLiquidLensPowerMode_get, doc=)
 An enumerated integer property.
 
 mvLiquidLensReceiveStatus = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvLiquidLensReceiveStatus_get, doc=)
 An integer property.
 
 mvLiquidLensSaveFocusValue = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvLiquidLensSaveFocusValue_get, doc=)
 A method object.
 
 mvLiquidLensSetFocusValue = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvLiquidLensSetFocusValue_get, doc=)
 An integer property.
 
 mvLiquidLensStatus = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvLiquidLensStatus_get, doc=)
 An enumerated integer property.
 
 mvSerialInterfaceASCIIBuffer = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceASCIIBuffer_get, doc=)
 A string property.
 
 mvSerialInterfaceBaudRate = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceBaudRate_get, doc=)
 An enumerated integer property.
 
 mvSerialInterfaceBinaryBuffer = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceBinaryBuffer_get, doc=)
 A string property.
 
 mvSerialInterfaceBytesAvailableForRead = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceBytesAvailableForRead_get, doc=)
 An integer property.
 
 mvSerialInterfaceBytesToRead = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceBytesToRead_get, doc=)
 An integer property.
 
 mvSerialInterfaceBytesToWrite = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceBytesToWrite_get, doc=)
 An integer property.
 
 mvSerialInterfaceDataBits = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceDataBits_get, doc=)
 An enumerated integer property.
 
 mvSerialInterfaceEnable = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceEnable_get, doc=)
 A boolean property.
 
 mvSerialInterfaceMode = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceMode_get, doc=)
 An enumerated integer property.
 
 mvSerialInterfaceParity = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceParity_get, doc=)
 An enumerated integer property.
 
 mvSerialInterfaceRead = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceRead_get, doc=)
 A method object.
 
 mvSerialInterfaceReceiveStatus = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceReceiveStatus_get, doc=)
 An integer property.
 
 mvSerialInterfaceStopBits = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceStopBits_get, doc=)
 An enumerated integer property.
 
 mvSerialInterfaceWrite = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceWrite_get, doc=)
 A method object.
 
 mvStepperAcceleration = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperAcceleration_get, doc=)
 A floating point property.
 
 mvStepperAutoSavePositionEnable = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperAutoSavePositionEnable_get, doc=)
 A boolean property.
 
 mvStepperCurrentPosition = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperCurrentPosition_get, doc=)
 An integer property.
 
 mvStepperDesiredPosition = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperDesiredPosition_get, doc=)
 An integer property.
 
 mvStepperErrorCount = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperErrorCount_get, doc=)
 An integer property.
 
 mvStepperFirmwareVersion = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperFirmwareVersion_get, doc=)
 An integer property.
 
 mvStepperMotorSelector = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperMotorSelector_get, doc=)
 An enumerated integer property.
 
 mvStepperMoveToHomeAll = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperMoveToHomeAll_get, doc=)
 A method object.
 
 mvStepperPositionSetLoad = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperPositionSetLoad_get, doc=)
 A method object.
 
 mvStepperPositionSetSave = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperPositionSetSave_get, doc=)
 A method object.
 
 mvStepperPositionSetSelector = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperPositionSetSelector_get, doc=)
 An integer property.
 
 mvStepperReceiveStatus = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperReceiveStatus_get, doc=)
 An integer property.
 
 mvStepperSpeed = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperSpeed_get, doc=)
 A floating point property.
 
 mvStepperSpeedManual = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperSpeedManual_get, doc=)
 A floating point property.
 
 mvStepperStatus = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperStatus_get, doc=)
 An enumerated integer property.
 
 mvStepperStopAll = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperStopAll_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

Contains features to control the serial interface.

Contains features to control the serial interface.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
* args )

Constructs a new mvIMPACT.acquire.mvSerialInterfaceControl 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

Reimplemented from ComponentCollection.

Property Documentation

◆ mvLiquidLensErrorCount

mvLiquidLensErrorCount = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvLiquidLensErrorCount_get, doc=)
static

An integer property.

This register increments whenever an error occurred while communicating with the Liquid Lens.

This register increments whenever an error occurred while communicating with the Liquid Lens.

◆ mvLiquidLensFirmwareVersion

mvLiquidLensFirmwareVersion = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvLiquidLensFirmwareVersion_get, doc=)
static

An integer property.

Returns the firmware version of the Liquid Lens.

Returns the firmware version of the Liquid Lens.

◆ mvLiquidLensPowerMode

mvLiquidLensPowerMode = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvLiquidLensPowerMode_get, doc=)
static

An enumerated integer property.

Selects the device power mode.

Selects the device power mode.

The following string values might be valid for this feature:

  • mvLiquidLensActive (Display string: 'mv Liquid Lens Active'): Puts the device to power-active mode.
  • mvLiquidLensStandby (Display string: 'mv Liquid Lens Standby'): Puts the Liquid Lens in power-saving mode. In this mode the device will only consume up to 25 percent of its normal power consumption.
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.

◆ mvLiquidLensReceiveStatus

mvLiquidLensReceiveStatus = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvLiquidLensReceiveStatus_get, doc=)
static

An integer property.

Result of the serial receive error detection mechanism.

Result of the serial receive error detection mechanism. This is a bit field. The bits have the following meaning: 0x1: CRC Error, 0x2: NAK received, 0x4: No response, 0x8 Incorrect answer received.

◆ mvLiquidLensSaveFocusValue

mvLiquidLensSaveFocusValue = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvLiquidLensSaveFocusValue_get, doc=)
static

A method object.

Saves the current Focus position into LiquidLens EEPROM.

Saves the current Focus position into LiquidLens EEPROM.

◆ mvLiquidLensSetFocusValue

mvLiquidLensSetFocusValue = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvLiquidLensSetFocusValue_get, doc=)
static

An integer property.

Focus position value for Liquid Lens.

Focus position value for Liquid Lens.

◆ mvLiquidLensStatus

mvLiquidLensStatus = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvLiquidLensStatus_get, doc=)
static

An enumerated integer property.

Returns the current status of the Liquid Lens.

Returns the current status of the Liquid Lens.

The following string values might be valid for this feature:

  • NoError (Display string: 'No Error'): No Errors.
  • VhOverload (Display string: 'Vh Overload'): Vh below 70V because Liquid Lens is taking too much current.
  • ThermalOverload (Display string: 'Thermal Overload'): Driver shutdown because Liquid Lens is too hot.
  • VhAndThermalOverload (Display string: 'Vh And Thermal Overload'): Vh does not reach 70V and driver shutdown because Liquid Lens is too hot.
  • StatusReadErrorNoAnswer (Display string: 'Status Read Error No Answer'): No response from Liquid Lens.
  • StatusReadErrorCRC (Display string: 'Status Read Error CRC'): CRC error in response from Liquid Lens.
  • StatusReadErrorNakAnswer (Display string: 'Status Read Error Nak Answer'): NAK response from Liquid Lens.
  • StatusReadErrorInvalidAnswer (Display string: 'Status Read Error Invalid Answer'): Invalid Size or Command in response from Liquid Lens.
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.

◆ mvSerialInterfaceASCIIBuffer

mvSerialInterfaceASCIIBuffer = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceASCIIBuffer_get, doc=)
static

A string property.

Buffer for exchanging ASCII data over the serial interface. This buffer uses the same memory as 'mvSerialInterfaceBinaryBuffer'.

Buffer for exchanging ASCII data over the serial interface. This buffer uses the same memory as 'mvSerialInterfaceBinaryBuffer'.

◆ mvSerialInterfaceBaudRate

mvSerialInterfaceBaudRate = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceBaudRate_get, doc=)
static

An enumerated integer property.

Serial interface clock frequency.

Serial interface clock frequency.

The following string values might be valid for this feature:

  • Hz_115200 (Display string: '115200 Hz')
  • Hz_57600 (Display string: '57600 Hz')
  • Hz_38400 (Display string: '38400 Hz')
  • Hz_19200 (Display string: '19200 Hz')
  • Hz_9600 (Display string: '9600 Hz')
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.

◆ mvSerialInterfaceBinaryBuffer

mvSerialInterfaceBinaryBuffer = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceBinaryBuffer_get, doc=)
static

A string property.

Buffer for exchanging binary data over the serial interface. This buffer uses the same memory as 'mvSerialInterfaceASCIIBuffer'.

Buffer for exchanging binary data over the serial interface. This buffer uses the same memory as 'mvSerialInterfaceASCIIBuffer'.

◆ mvSerialInterfaceBytesAvailableForRead

mvSerialInterfaceBytesAvailableForRead = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceBytesAvailableForRead_get, doc=)
static

An integer property.

Number of serial data bytes available for read.

Number of serial data bytes available for read.

◆ mvSerialInterfaceBytesToRead

mvSerialInterfaceBytesToRead = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceBytesToRead_get, doc=)
static

An integer property.

Number of serial bytes to read.

Number of serial bytes to read.

◆ mvSerialInterfaceBytesToWrite

mvSerialInterfaceBytesToWrite = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceBytesToWrite_get, doc=)
static

An integer property.

Length of data to write.

Length of data to write.

◆ mvSerialInterfaceDataBits

mvSerialInterfaceDataBits = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceDataBits_get, doc=)
static

An enumerated integer property.

Number of data bits.

Number of data bits.

The following string values might be valid for this feature:

  • Seven (Display string: 'Seven')
  • Eight (Display string: 'Eight')
  • Nine (Display string: 'Nine')
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.

◆ mvSerialInterfaceEnable

mvSerialInterfaceEnable = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceEnable_get, doc=)
static

A boolean property.

Controls whether the serial interface is enabled or not.

Controls whether the serial interface is enabled or not.

◆ mvSerialInterfaceMode

mvSerialInterfaceMode = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceMode_get, doc=)
static

An enumerated integer property.

States the interface mode of the serial interface

States the interface mode of the serial interface

The following string values might be valid for this feature:

  • Plain (Display string: 'Plain')
  • InveniosLiquidLens (Display string: 'Invenios Liquid Lens')
  • OptoEngineeringStepper (Display string: 'Opto Engineering Stepper')
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.

◆ mvSerialInterfaceParity

mvSerialInterfaceParity = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceParity_get, doc=)
static

An enumerated integer property.

Serial interface parity.

Serial interface parity.

The following string values might be valid for this feature:

  • None (Display string: 'None')
  • Odd (Display string: 'Odd')
  • Even (Display string: 'Even')
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.

◆ mvSerialInterfaceRead

mvSerialInterfaceRead = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceRead_get, doc=)
static

A method object.

Command to read data from serial interface.

Command to read data from serial interface.

◆ mvSerialInterfaceReceiveStatus

mvSerialInterfaceReceiveStatus = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceReceiveStatus_get, doc=)
static

An integer property.

Result of the serial receive error detection mechanism.

Result of the serial receive error detection mechanism.

◆ mvSerialInterfaceStopBits

mvSerialInterfaceStopBits = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceStopBits_get, doc=)
static

An enumerated integer property.

Number of stop bits.

Number of stop bits.

The following string values might be valid for this feature:

  • One (Display string: 'One')
  • Two (Display string: 'Two')
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.

◆ mvSerialInterfaceWrite

mvSerialInterfaceWrite = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvSerialInterfaceWrite_get, doc=)
static

A method object.

Command to write data to serial interface

Command to write data to serial interface

◆ mvStepperAcceleration

mvStepperAcceleration = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperAcceleration_get, doc=)
static

A floating point property.

Current acceleration of the selected stepper motor.

Current acceleration of the selected stepper motor.

◆ mvStepperAutoSavePositionEnable

mvStepperAutoSavePositionEnable = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperAutoSavePositionEnable_get, doc=)
static

A boolean property.

Controls if the auto-save of motor positions is active.

Controls if the auto-save of motor positions is active.

◆ mvStepperCurrentPosition

mvStepperCurrentPosition = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperCurrentPosition_get, doc=)
static

An integer property.

Read current position from stepper.

Read current position from stepper.

◆ mvStepperDesiredPosition

mvStepperDesiredPosition = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperDesiredPosition_get, doc=)
static

An integer property.

The desired position of the selected stepper motor.

The desired position of the selected stepper motor. When the motor has not yet reached this position(is moving) this value may differ from 'mvStepperCurrentPosition'.

◆ mvStepperErrorCount

mvStepperErrorCount = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperErrorCount_get, doc=)
static

An integer property.

This register increments whenever an error occurred while communicating with the Opto Engineering Stepper.

This register increments whenever an error occurred while communicating with the Opto Engineering Stepper.

◆ mvStepperFirmwareVersion

mvStepperFirmwareVersion = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperFirmwareVersion_get, doc=)
static

An integer property.

Returns the firmware version of the Opto Engineering Stepper.

Returns the firmware version of the Opto Engineering Stepper.

◆ mvStepperMotorSelector

mvStepperMotorSelector = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperMotorSelector_get, doc=)
static

An enumerated integer property.

Selects the stepper motor to control.

Selects the stepper motor to control(Zoom, Iris or Focus).

The following string values might be valid for this feature:

  • All (Display string: 'All'): All stepper motors are selected.
  • Zoom (Display string: 'Zoom'): Selects the stepper motor controlling the zoom.
  • Focus (Display string: 'Focus'): Selects the stepper motor controlling the focus.
  • Iris (Display string: 'Iris'): Selects the stepper motor controlling the iris.
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.

◆ mvStepperMoveToHomeAll

mvStepperMoveToHomeAll = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperMoveToHomeAll_get, doc=)
static

A method object.

Moves all stepper motors to their home position.

Moves all stepper motors to their home position.

◆ mvStepperPositionSetLoad

mvStepperPositionSetLoad = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperPositionSetLoad_get, doc=)
static

A method object.

Loads the stepper 'mvStepperDesiredPosition' specified by 'mvStepperPositionSetSelector' and makes it active for each motor.

Loads the stepper 'mvStepperDesiredPosition' specified by 'mvStepperPositionSetSelector' and makes it active for each motor.

◆ mvStepperPositionSetSave

mvStepperPositionSetSave = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperPositionSetSave_get, doc=)
static

A method object.

Saves the stepper 'mvStepperDesiredPosition' specified by 'mvStepperPositionSetSelector' into the steppers non-volatile memory for each motor.

Saves the stepper 'mvStepperDesiredPosition' specified by 'mvStepperPositionSetSelector' into the steppers non-volatile memory for each motor.

◆ mvStepperPositionSetSelector

mvStepperPositionSetSelector = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperPositionSetSelector_get, doc=)
static

An integer property.

Selects the stepper parameter set to load or save.

Selects the stepper parameter set to load or save.

◆ mvStepperReceiveStatus

mvStepperReceiveStatus = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperReceiveStatus_get, doc=)
static

An integer property.

Result of the serial receive error detection mechanism.

Result of the serial receive error detection mechanism. This is a bit field. The bits have the following meaning: 0x1: Reserved, 0x2: Mismatch in answer detected, 0x4: No response, 0x8 Incorrect answer received.

◆ mvStepperSpeed

mvStepperSpeed = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperSpeed_get, doc=)
static

A floating point property.

Current speed of the selected stepper motor.

Current speed of the selected stepper motor.

◆ mvStepperSpeedManual

mvStepperSpeedManual = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperSpeedManual_get, doc=)
static

A floating point property.

Manual speed of the selected stepper motor.

Manual speed of the selected stepper motor.

◆ mvStepperStatus

mvStepperStatus = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperStatus_get, doc=)
static

An enumerated integer property.

Returns the current status of the stepper.

Returns the current status of the stepper.

The following string values might be valid for this feature:

  • Unknown (Display string: 'Unknown'): The current status of the stepper is unknown.
  • Moving (Display string: 'Moving'): The selected stepper motor is currently moving.
  • StoppedAtLowerLimitWithTorque (Display string: 'Stopped At Lower Limit With Torque'): The selected stepper motor has stopped at its lower limit with torque(this should never happen and indicates a problem).
  • StoppedAtLowerLimit (Display string: 'Stopped At Lower Limit'): The selected stepper motor has stopped at its lower limit.
  • StoppedAtUpperLimitWithTorque (Display string: 'Stopped At Upper Limit With Torque'): The selected stepper motor has stopped at its upper limit with torque(this should never happen and indicates a problem).
  • StoppedAtUpperLimit (Display string: 'Stopped At Upper Limit'): The selected stepper motor has stopped at its upper limit.
  • StoppedWithTorque (Display string: 'Stopped With Torque'): The selected stepper motor has stopped with torque(this should never happen and indicates a problem).
  • Stopped (Display string: 'Stopped'): The selected stepper motor has stopped.
  • OvercurrentOrOvertemperatureError (Display string: 'Overcurrent Or Overtemperature Error'): The selected stepper motor either became too hot or is taking in too much current(this should never happen and indicates a problem).
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.

◆ mvStepperStopAll

mvStepperStopAll = property(lib_mvIMPACT_acquire.mvSerialInterfaceControl_mvStepperStopAll_get, doc=)
static

A method object.

Stops all stepper motors.

Stops all stepper motors.

◆ thisown

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