OptoEngineering
MTDV - CommandGetPosition
Read position from MTDV device
IN
| Name | Type | Description |
|---|---|---|
| InClient | DynamicEnum | The MTDV client instance.Type : string |
| Channel | Int | The channel to be controlled.Type : int |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Value | Float | The read position. |
| Error | ErrorState | Gets the execution error message |
MTDV - CommandGoTo
Move MTDV device to given position
IN
| Name | Type | Description |
|---|---|---|
| MotionType | Enum < MotionTypes > | The motion type （Relative/Absolute）. |
| Position | Float | The position to set. |
| WaitForEnd | Bool | Sets if the operation must wait the movement to be completed. |
| DelayCheckMoving | Int | The repeated delay,in milliseconds, to check if the movement has been completed.This value is meaningful if WaitForEnd=true. |
| InClient | DynamicEnum | The MTDV client instance.Type : string |
| Channel | Int | The channel to be controlled.Type : int |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
MTDV - CommandHoming
Performs homing of MTDV device
IN
| Name | Type | Description |
|---|---|---|
| WaitForEnd | Bool | Bool |
| DelayCheckMoving | Int | Int |
| InClient | DynamicEnum | The MTDV client instance.Type : string |
| Channel | Int | The channel to be controlled.Type : int |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
MTDV - CommandStop
Stops MTDV device
IN
| Name | Type | Description |
|---|---|---|
| InClient | DynamicEnum | The MTDV client instance.Type : string |
| Channel | Int | The channel to be controlled.Type : int |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
MTDV - Connect
Connects a MTDV device
IN
| Name | Type | Description |
|---|---|---|
| InClient | DynamicEnum | The MTDV client instance.Type : string |
| Channel | Int | The channel to be controlled.Type : int |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
MTDV - Disconnect
Disconnects a MTDV device
IN
| Name | Type | Description |
|---|---|---|
| InClient | DynamicEnum | The MTDV client instance.Type : string |
| Channel | Int | The channel to be controlled.Type : int |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
MTDV - GetBoolean
Read bool value from MTDV device
IN
| Name | Type | Description |
|---|---|---|
| Parameter | Enum | The parameter to read. |
| InClient | DynamicEnum | The MTDV client instance.Type : string |
| Channel | Int | The channel to be controlled.Type : int |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Value | Bool | The read value. |
| Error | ErrorState | Gets the execution error message |
MTDV - GetFloat
Read float value from MTDV device
IN
| Name | Type | Description |
|---|---|---|
| Parameter | Enum < MTDV_Parameters_Float > | The parameter to read. |
| InClient | DynamicEnum | The MTDV client instance.Type : string |
| Channel | Int | The channel to be controlled.Type : int |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Value | Float | The read value. |
| Error | ErrorState | Gets the execution error message |
MTDV - GetInt
Read int value from MTDV device
IN
| Name | Type | Description |
|---|---|---|
| Parameter | Enum < MTDV_Parameters_Int > | The parameter to read. |
| InClient | DynamicEnum | The MTDV client instance.Type : string |
| Channel | Int | The channel to be controlled.Type : int |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Value | Int | The read value. |
| Error | ErrorState | Gets the execution error message |
MTDV - GetStatus
Read status values from MTDV device
IN
| Name | Type | Description |
|---|---|---|
| InClient | DynamicEnum | The MTDV client instance.Type : string |
| Channel | Int | The channel to be controlled.Type : int |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| InputOverVoltage | Bool | The input over voltage state. |
| InputUnderVoltage | Bool | The input under voltage state. |
| OverTemperature | Bool | The over temperature state. |
| ErrorMotorDriver1 | Bool | The driver 1 error state. |
| ErrorMotorDriver2 | Bool | The driver 2 error state. |
| ErrorMotorDriver3 | Bool | The driver 3 error state. |
| ErrorMotorDriver4 | Bool | The driver 4 error state. |
| ErrorEncoder1 | Bool | The encoder 1 error state. |
| ErrorEncoder2 | Bool | The encoder 2 error state. |
| ErrorEncoder3 | Bool | The encoder 3 error state. |
| ErrorEncoder4 | Bool | The encoder 4 error state. |
| IsInError | Bool | The generic error state. |
| IsMoving | Bool | Gets if at least one motor is moving. |
| Error | ErrorState | Gets the execution error message |
MTDV - GetUnsignedInt
Read unsigned int value from MTDV device
IN
| Name | Type | Description |
|---|---|---|
| Parameter | Enum < MTDV_Parameters_UnsignedInt > | The parameter to read. |
| InClient | DynamicEnum | The MTDV client instance.Type : string |
| Channel | Int | The channel to be controlled.Type : int |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Value | Int | The read value. |
| Error | ErrorState | Gets the execution error message |
MTDV - IsConnected
Checks the connection state of MTDV device
IN
| Name | Type | Description |
|---|---|---|
| InClient | DynamicEnum | The MTDV client instance.Type : string |
| Channel | Int | The channel to be controlled.Type : int |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutIsConnected | Bool | The connection state |
| Error | ErrorState | Gets the execution error message |
MTDV - SetBoolean
Set bool value to MTDV device
IN
| Name | Type | Description |
|---|---|---|
| Parameter | Enum < MTDV_Parameters_Boolean > | The parameter to write. |
| Value | Bool | The value to write. |
| InClient | DynamicEnum | The MTDV client instance.Type : string |
| Channel | Int | The channel to be controlled.Type : int |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
MTDV - SetFloat
Set float value to MTDV device
IN
| Name | Type | Description |
|---|---|---|
| Parameter | Enum < MTDV_Parameters_Float > | The parameter to write. |
| Value | Float | The value to write. |
| InClient | DynamicEnum | The MTDV client instance.Type : string |
| Channel | Int | The channel to be controlled.Type : int |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
MTDV - SetInt
Set int value to MTDV device
IN
| Name | Type | Description |
|---|---|---|
| Parameter | Enum < MTDV_Parameters_Int > | The parameter to write. |
| Value | Int | The value to write. |
| InClient | DynamicEnum | The MTDV client instance.Type : string |
| Channel | Int | The channel to be controlled.Type : int |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
MTDV - SetUnsignedInt
Set unsigned int value to MTDV device
IN
| Name | Type | Description |
|---|---|---|
| Parameter | Enum < MTDV_Parameters_UnsignedInt > | The parameter to write. |
| Value | Int | The value to write. |
| InClient | DynamicEnum | The MTDV client instance.Type : string |
| Channel | Int | The channel to be controlled.Type : int |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
MTDV - WaitEndMove
Waits MTDV device to complete movement
IN
| Name | Type | Description |
|---|---|---|
| DelayCheckMoving | Int | The repeated delay,in milliseconds, to check if the movement has been completed. |
| InClient | DynamicEnum | The MTDV client instance.Type : string |
| Channel | Int | The channel to be controlled.Type : int |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
LTDV - Connect
Connects a LTDV device
IN
| Name | Type | Description |
|---|---|---|
| InClient | DynamicEnum | DynamicEnum |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
LTDV - Disconnect
Disconnects a LTDV device
IN
| Name | Type | Description |
|---|---|---|
| InClient | DynamicEnum | DynamicEnum |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
LTDV - GetLightOutputParameters
Gets the light output parameters (source,current range,current value etc.) from LTDV device
IN
| Name | Type | Description |
|---|---|---|
| InLightOutput | Enum < LTDV_LightOutputs > | The output to get the state from （LD1-LD8）. |
| InClient | DynamicEnum | DynamicEnum |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSource | Enum < LTDV_OutputSources > | Select the activation source for the light output. |
| OutCurrentRange | Enum < LTDV_CurrentRange > | Select the current range for the light output. It can be chosen between Automatic range selection （default）, Low range （from zero up to 200 mA）, Mid range （from zero up to 4 A） and High range （from zero up to 20 A）. |
| OutTonCheck | Enum < LTDV_TCheck > | Enable protection against excessive turn-on time. |
| OutToffCheck | Enum < LTDV_TCheck > | Enable protection against insufficient turn-off time. |
| OutCurrentReductionDelay | Int | Current reduction delay. |
| OutCurrentValue | Float | Current value 〔A〕. |
| OutTonMax | Int | Time ON max value 〔ms〕. |
| OutToffMin | Int | Time OFF max value 〔ms〕. |
| OutFinalCurrentValue | Int | Int |
| Error | ErrorState | Gets the execution error message |
LTDV - GetLightOutputState
Gets the ligth output state (voltage/current) from LTDV device
IN
| Name | Type | Description |
|---|---|---|
| InLightOutput | Enum < LTDV_LightOutputs > | The output to get the state from （LD1-LD8）. |
| InClient | DynamicEnum | DynamicEnum |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutMeasuredCurrent | Float | Light output current value 〔A〕. |
| OutMeasuredVoltage | Float | Light output voltage value 〔V〕. |
| Error | ErrorState | Gets the execution error message |
LTDV - GetState
Get general state from LTDV device like temperature,voltage, current,
IN
| Name | Type | Description |
|---|---|---|
| InClient | DynamicEnum | DynamicEnum |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutConverterTemperature | Float | Converter's temperature. |
| OutDriverTemperature | Float | Driver's temperature. |
| OutRemoteTemperature1 | Float | Remote temperature of external source 1 |
| OutRemoteTemperature2 | Float | Remote temperature of external source 2 |
| OutSupplyVoltage | Float | Power supply voltage 〔V〕. |
| OutSupplyCurrent | Float | Power supply current 〔A〕. |
| OutConverterOutputVoltage | Float | Power converter voltage 〔V〕. |
| OutConverterOutputCurrent | Float | Power converter current 〔A〕. |
| OutDriverVoltage | Float | Driver voltage 〔V〕. |
| Error | ErrorState | Gets the execution error message |
LTDV - IsConnected
Checks the connection state of LTDV device
IN
| Name | Type | Description |
|---|---|---|
| InClient | DynamicEnum | DynamicEnum |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutIsConnected | Bool | The connection state |
| Error | ErrorState | Gets the execution error message |
LTDV - SetupConverterSettings
Set the voltage coverter
IN
| Name | Type | Description |
|---|---|---|
| InConverterMode | Enum < LTDV_ConverterModes > | The converter mode. |
| InConverterMaximumVoltage | Int | Maximum voltage converter value 〔V〕. |
| InClient | DynamicEnum | DynamicEnum |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutConverterPresetVoltage | Int | Preset voltage converter value 〔V〕. |
| Error | ErrorState | Gets the execution error message |
LTDV - SetupDriverMode
Set the driver mode for outputs
IN
| Name | Type | Description |
|---|---|---|
| InDriverMode | Enum < LTDV_DriverModes > | The driver mode. |
| InClient | DynamicEnum | DynamicEnum |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
LTDV - SetupLightOutput
Setup a light output according to given current and modulation parameters
IN
| Name | Type | Description |
|---|---|---|
| InLightOutput | Enum < LTDV_LightOutputs > | Select the light output to use. |
| InSource | Enum < LTDV_OutputSources > | Select the activation source for the light output. |
| InCurrentRange | Enum < LTDV_CurrentRange > | Select the current range for the light output. It can be chosen between Automatic range selection （default）, Low range （from zero up to 200 mA）, Mid range （from zero up to 4 A） and High range （from zero up to 20 A）. |
| InTonCheck | Enum < LTDV_TCheck > | Enable protection against excessive turn-on time. |
| InToffCheck | Enum < LTDV_TCheck > | Enable protection against insufficient turn-off time. |
| InCurrentReductionDelay | Int | Current reduction delay. |
| InCurrentValue | Float | Current value 〔A〕. |
| InTonMax | Int | Time ON max value 〔ms〕. |
| InToffMin | Int | Time OFF max value 〔ms〕. |
| InFinalCurrentValue | Int | Int |
| InClient | DynamicEnum | DynamicEnum |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
LTDV - SetupOscillatorPeriod
Set the oscillator period time
IN
| Name | Type | Description |
|---|---|---|
| InOscillatorPeriod | Int | The period time, from 10ms to 1000ms. |
| InClient | DynamicEnum | DynamicEnum |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
LTDV - SetupPulseGenerator
Setup the pulse generator
IN
| Name | Type | Description |
|---|---|---|
| InPulseGenerator | Enum < LTDV_PulseGenerators > | The pulse generator to set |
| InSource | Enum < LTDV_PulseGeneratorSources > | Source that triggers the pulse generator. |
| InEdge | Enum < LTDV_Edges > | Select the edge type for triggering the pulse generator |
| InPulseDelay | Int | Pulse delay 〔us〕. |
| InPulseWidth | Int | Pulse width 〔us〕. |
| InHoldoffTime | Int | Hold off time 〔us〕, used for LTDVE1CH_40F and LTDVE2CH_20F. |
| InClient | DynamicEnum | DynamicEnum |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
LTDV - SetupSynchInput
Setup synch input
IN
| Name | Type | Description |
|---|---|---|
| SynchInput | Enum < LTDV_SynchInputs > | The synch input to set. |
| DigitalFilter | Enum < LTDV_DigitalFilters > | Set digital filter for the input. |
| InClient | DynamicEnum | DynamicEnum |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
LTDV - SetupSynchOutput
Setup synch output
IN
| Name | Type | Description |
|---|---|---|
| SynchOutput | Enum < LTDV_SynchOutputs > | The synch output to set. |
| Source | Enum < LTDV_OutputSources > | The source for synch output. |
| InClient | DynamicEnum | DynamicEnum |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |