mvIMPACT Acquire SDK C++
mvSerialInterfaceControl Class Reference

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

Inheritance diagram for mvSerialInterfaceControl:
ComponentCollection

Public Member Functions

HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
 mvSerialInterfaceControl (mvIMPACT::acquire::Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::GenICam::mvSerialInterfaceControl object. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

PropertyI64 mvLiquidLensErrorCount
 An integer property. This register increments whenever an error occurred while communicating with the Liquid Lens. More...
 
PropertyI64 mvLiquidLensFirmwareVersion
 An integer property. Returns the firmware version of the Liquid Lens. More...
 
PropertyI64 mvLiquidLensPowerMode
 An enumerated integer property. Selects the device power mode. More...
 
PropertyI64 mvLiquidLensReceiveStatus
 An integer property. Result of the serial receive error detection mechanism. More...
 
Method mvLiquidLensSaveFocusValue
 A method object. Saves the current Focus position into LiquidLens EEPROM. More...
 
PropertyI64 mvLiquidLensSetFocusValue
 An integer property. Focus position value for Liquid Lens. More...
 
PropertyI64 mvLiquidLensStatus
 An enumerated integer property. Returns the current status of the Liquid Lens. More...
 
PropertyS mvSerialInterfaceASCIIBuffer
 A string property. Buffer for exchanging ASCII data over the serial interface. This buffer uses the same memory as 'mvSerialInterfaceBinaryBuffer'. More...
 
PropertyI64 mvSerialInterfaceBaudRate
 An enumerated integer property. Serial interface clock frequency. More...
 
PropertyS mvSerialInterfaceBinaryBuffer
 A string property. Buffer for exchanging binary data over the serial interface. This buffer uses the same memory as 'mvSerialInterfaceASCIIBuffer'. More...
 
PropertyI64 mvSerialInterfaceBytesAvailableForRead
 An integer property. Number of serial data bytes available for read. More...
 
PropertyI64 mvSerialInterfaceBytesToRead
 An integer property. Number of serial bytes to read. More...
 
PropertyI64 mvSerialInterfaceBytesToWrite
 An integer property. Length of data to write. More...
 
PropertyI64 mvSerialInterfaceDataBits
 An enumerated integer property. Number of data bits. More...
 
PropertyIBoolean mvSerialInterfaceEnable
 A boolean property. Controls whether the serial interface is enabled or not. More...
 
PropertyI64 mvSerialInterfaceMode
 An enumerated integer property. States the interface mode of the serial interface. More...
 
PropertyI64 mvSerialInterfaceParity
 An enumerated integer property. Serial interface parity. More...
 
Method mvSerialInterfaceRead
 A method object. Command to read data from serial interface. More...
 
PropertyI64 mvSerialInterfaceReceiveStatus
 An integer property. Result of the serial receive error detection mechanism. More...
 
PropertyI64 mvSerialInterfaceStopBits
 An enumerated integer property. Number of stop bits. More...
 
Method mvSerialInterfaceWrite
 A method object. Command to write data to serial interface. More...
 
PropertyF mvStepperAcceleration
 A floating point property. Current acceleration of the selected stepper motor. More...
 
PropertyIBoolean mvStepperAutoSavePositionEnable
 A boolean property. Controls if the auto-save of motor positions is active. More...
 
PropertyI64 mvStepperCurrentPosition
 An integer property. Read current position from stepper. More...
 
PropertyI64 mvStepperDesiredPosition
 An integer property. The desired position of the selected stepper motor. More...
 
PropertyI64 mvStepperErrorCount
 An integer property. This register increments whenever an error occurred while communicating with the Opto Engineering Stepper. More...
 
PropertyI64 mvStepperFirmwareVersion
 An integer property. Returns the firmware version of the Opto Engineering Stepper. More...
 
PropertyI64 mvStepperMotorSelector
 An enumerated integer property. Selects the stepper motor to control. More...
 
Method mvStepperMoveToHomeAll
 A method object. Moves all stepper motors to their home position. More...
 
Method mvStepperPositionSetLoad
 A method object. Loads the stepper 'mvStepperDesiredPosition' specified by 'mvStepperPositionSetSelector' and makes it active for each motor. More...
 
Method mvStepperPositionSetSave
 A method object. Saves the stepper 'mvStepperDesiredPosition' specified by 'mvStepperPositionSetSelector' into the steppers non-volatile memory for each motor. More...
 
PropertyI64 mvStepperPositionSetSelector
 An integer property. Selects the stepper parameter set to load or save. More...
 
PropertyI64 mvStepperReceiveStatus
 An integer property. Result of the serial receive error detection mechanism. More...
 
PropertyF mvStepperSpeed
 A floating point property. Current speed of the selected stepper motor. More...
 
PropertyF mvStepperSpeedManual
 A floating point property. Manual speed of the selected stepper motor. More...
 
PropertyI64 mvStepperStatus
 An enumerated integer property. Returns the current status of the stepper. More...
 
Method mvStepperStopAll
 A method object. Stops all stepper motors. More...
 

Protected Attributes

HOBJ m_hRoot
 

Detailed Description

Contains features to control the serial interface.

Contains features to control the serial interface.

Constructor & Destructor Documentation

◆ mvSerialInterfaceControl()

mvSerialInterfaceControl ( mvIMPACT::acquire::Device pDev,
const std::string &  settingName = "Base" 
)
inlineexplicit

Constructs a new mvIMPACT::acquire::GenICam::mvSerialInterfaceControl object.

Parameters
[in]pDevA pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object.
[in]settingNameThe 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 hObj ( void  ) const
inlineinherited

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()

const ComponentCollection& restoreDefault ( void  ) const
inlineinherited

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.

Member Data Documentation

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

◆ mvLiquidLensErrorCount

PropertyI64 mvLiquidLensErrorCount

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

PropertyI64 mvLiquidLensFirmwareVersion

An integer property. Returns the firmware version of the Liquid Lens.

Returns the firmware version of the Liquid Lens.

◆ mvLiquidLensPowerMode

PropertyI64 mvLiquidLensPowerMode

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::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ mvLiquidLensReceiveStatus

PropertyI64 mvLiquidLensReceiveStatus

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

Method mvLiquidLensSaveFocusValue

A method object. Saves the current Focus position into LiquidLens EEPROM.

Saves the current Focus position into LiquidLens EEPROM.

◆ mvLiquidLensSetFocusValue

PropertyI64 mvLiquidLensSetFocusValue

An integer property. Focus position value for Liquid Lens.

Focus position value for Liquid Lens.

◆ mvLiquidLensStatus

PropertyI64 mvLiquidLensStatus

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::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ mvSerialInterfaceASCIIBuffer

PropertyS mvSerialInterfaceASCIIBuffer

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

PropertyI64 mvSerialInterfaceBaudRate

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::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ mvSerialInterfaceBinaryBuffer

PropertyS mvSerialInterfaceBinaryBuffer

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

PropertyI64 mvSerialInterfaceBytesAvailableForRead

An integer property. Number of serial data bytes available for read.

Number of serial data bytes available for read.

◆ mvSerialInterfaceBytesToRead

PropertyI64 mvSerialInterfaceBytesToRead

An integer property. Number of serial bytes to read.

Number of serial bytes to read.

◆ mvSerialInterfaceBytesToWrite

PropertyI64 mvSerialInterfaceBytesToWrite

An integer property. Length of data to write.

Length of data to write.

◆ mvSerialInterfaceDataBits

PropertyI64 mvSerialInterfaceDataBits

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::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ mvSerialInterfaceEnable

PropertyIBoolean mvSerialInterfaceEnable

A boolean property. Controls whether the serial interface is enabled or not.

Controls whether the serial interface is enabled or not.

◆ mvSerialInterfaceMode

PropertyI64 mvSerialInterfaceMode

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::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ mvSerialInterfaceParity

PropertyI64 mvSerialInterfaceParity

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::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ mvSerialInterfaceRead

Method mvSerialInterfaceRead

A method object. Command to read data from serial interface.

Command to read data from serial interface.

◆ mvSerialInterfaceReceiveStatus

PropertyI64 mvSerialInterfaceReceiveStatus

An integer property. Result of the serial receive error detection mechanism.

Result of the serial receive error detection mechanism.

◆ mvSerialInterfaceStopBits

PropertyI64 mvSerialInterfaceStopBits

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::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ mvSerialInterfaceWrite

Method mvSerialInterfaceWrite

A method object. Command to write data to serial interface.

Command to write data to serial interface

◆ mvStepperAcceleration

PropertyF mvStepperAcceleration

A floating point property. Current acceleration of the selected stepper motor.

Current acceleration of the selected stepper motor.

◆ mvStepperAutoSavePositionEnable

PropertyIBoolean mvStepperAutoSavePositionEnable

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

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

◆ mvStepperCurrentPosition

PropertyI64 mvStepperCurrentPosition

An integer property. Read current position from stepper.

Read current position from stepper.

◆ mvStepperDesiredPosition

PropertyI64 mvStepperDesiredPosition

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

PropertyI64 mvStepperErrorCount

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

PropertyI64 mvStepperFirmwareVersion

An integer property. Returns the firmware version of the Opto Engineering Stepper.

Returns the firmware version of the Opto Engineering Stepper.

◆ mvStepperMotorSelector

PropertyI64 mvStepperMotorSelector

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::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ mvStepperMoveToHomeAll

Method mvStepperMoveToHomeAll

A method object. Moves all stepper motors to their home position.

Moves all stepper motors to their home position.

◆ mvStepperPositionSetLoad

Method mvStepperPositionSetLoad

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

Method mvStepperPositionSetSave

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

PropertyI64 mvStepperPositionSetSelector

An integer property. Selects the stepper parameter set to load or save.

Selects the stepper parameter set to load or save.

◆ mvStepperReceiveStatus

PropertyI64 mvStepperReceiveStatus

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

PropertyF mvStepperSpeed

A floating point property. Current speed of the selected stepper motor.

Current speed of the selected stepper motor.

◆ mvStepperSpeedManual

PropertyF mvStepperSpeedManual

A floating point property. Manual speed of the selected stepper motor.

Manual speed of the selected stepper motor.

◆ mvStepperStatus

PropertyI64 mvStepperStatus

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::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ mvStepperStopAll

Method mvStepperStopAll

A method object. Stops all stepper motors.

Stops all stepper motors.


The documentation for this class was generated from the following file: