msl.equipment.resources.thorlabs.kinesis.structs module

Structs defined in Thorlabs Kinesis v1.14.10

class msl.equipment.resources.thorlabs.kinesis.structs.TLI_DeviceInfo[source]

Bases: Structure

PID: Structure/Union member

description: Structure/Union member

isCustomType: Structure/Union member

isKnownType: Structure/Union member

isLaser: Structure/Union member

isPiezoDevice: Structure/Union member

isRack: Structure/Union member

maxChannels: Structure/Union member

motorType: Structure/Union member

serialNo: Structure/Union member

typeID: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.TLI_HardwareInformation[source]

Bases: Structure

deviceDependantData: Structure/Union member

firmwareVersion: Structure/Union member

hardwareVersion: Structure/Union member

modelNumber: Structure/Union member

modificationState: Structure/Union member

notes: Structure/Union member

numChannels: Structure/Union member

serialNumber: Structure/Union member

type: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.MOT_VelocityParameters[source]

Bases: Structure

acceleration: Structure/Union member

maxVelocity: Structure/Union member

minVelocity: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.MOT_JogParameters[source]

Bases: Structure

mode: Structure/Union member

stepSize: Structure/Union member

stopMode: Structure/Union member

velParams: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.MOT_HomingParameters[source]

Bases: Structure

direction: Structure/Union member

limitSwitch: Structure/Union member

offsetDistance: Structure/Union member

velocity: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.MOT_VelocityProfileParameters[source]

Bases: Structure

jerk: Structure/Union member

lastNotUsed: Structure/Union member

mode: Structure/Union member

notUsed: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.MOT_StageAxisParameters[source]

Bases: Structure

axisID: Structure/Union member

countsPerUnit: Structure/Union member

maxAcceleration: Structure/Union member

maxDecceleration: Structure/Union member

maxPosition: Structure/Union member

maxVelocity: Structure/Union member

minPosition: Structure/Union member

partNumber: Structure/Union member

reserved1: Structure/Union member

reserved2: Structure/Union member

reserved3: Structure/Union member

reserved4: Structure/Union member

reserved5: Structure/Union member

reserved6: Structure/Union member

reserved7: Structure/Union member

reserved8: Structure/Union member

serialNumber: Structure/Union member

stageID: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.MOT_JoystickParameters[source]

Bases: Structure

directionSense: Structure/Union member

highGearAcceleration: Structure/Union member

highGearMaxVelocity: Structure/Union member

lowGearAcceleration: Structure/Union member

lowGearMaxVelocity: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.MOT_BrushlessPositionLoopParameters[source]

Bases: Structure

accelerationFeedForward: Structure/Union member

derivativeRecalculationTime: Structure/Union member

differentialGain: Structure/Union member

factorForOutput: Structure/Union member

integralGain: Structure/Union member

integralLimit: Structure/Union member

lastNotUsed: Structure/Union member

notUsed: Structure/Union member

positionErrorLimit: Structure/Union member

proportionalGain: Structure/Union member

velocityFeedForward: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.MOT_BrushlessTrackSettleParameters[source]

Bases: Structure

lastNotUsed: Structure/Union member

maxTrackingError: Structure/Union member

notUsed: Structure/Union member

settledError: Structure/Union member

time: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.MOT_BrushlessCurrentLoopParameters[source]

Bases: Structure

deadErrorBand: Structure/Union member

feedForward: Structure/Union member

integralGain: Structure/Union member

integralLimit: Structure/Union member

lastNotUsed: Structure/Union member

notUsed: Structure/Union member

phase: Structure/Union member

proportionalGain: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.MOT_BrushlessElectricOutputParameters[source]

Bases: Structure

continuousCurrentLimit: Structure/Union member

excessEnergyLimit: Structure/Union member

lastNotUsed: Structure/Union member

motorSignalBias: Structure/Union member

motorSignalLimit: Structure/Union member

notUsed: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.MOT_LimitSwitchParameters[source]

Bases: Structure

anticlockwiseHardwareLimit: Structure/Union member

anticlockwisePosition: Structure/Union member

clockwiseHardwareLimit: Structure/Union member

clockwisePosition: Structure/Union member

softLimitMode: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.MOT_PowerParameters[source]

Bases: Structure

movePercentage: Structure/Union member

restPercentage: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.MOT_DC_PIDParameters[source]

Bases: Structure

differentialGain: Structure/Union member

integralGain: Structure/Union member

integralLimit: Structure/Union member

parameterFilter: Structure/Union member

proportionalGain: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.BNT_IO_Settings[source]

Bases: Structure

BNCtriggerOrLowVoltageOut: Structure/Union member

amplifierCurrentLimit: Structure/Union member

amplifierLowPassFilter: Structure/Union member

channel: Structure/Union member

feedbackSignal: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.NT_HVComponent[source]

Bases: Structure

horizontalComponent: Structure/Union member

verticalComponent: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.NT_CircleParameters[source]

Bases: Structure

algorithmAdjustment: Structure/Union member

diameter: Structure/Union member

maxDiameter: Structure/Union member

minDiameter: Structure/Union member

mode: Structure/Union member

samplesPerRevolution: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.NT_CircleDiameterLUT[source]

Bases: Structure

LUTdiameter: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.NT_TIARangeParameters[source]

Bases: Structure

changeToOddOrEven: Structure/Union member

downLimit: Structure/Union member

mode: Structure/Union member

newRange: Structure/Union member

settleSamples: Structure/Union member

upLimit: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.NT_LowPassFilterParameters[source]

Bases: Structure

param1: Structure/Union member

param2: Structure/Union member

param3: Structure/Union member

param4: Structure/Union member

param5: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.NT_TIAReading[source]

Bases: Structure

absoluteReading: Structure/Union member

relativeReading: Structure/Union member

selectedRange: Structure/Union member

underOrOverRead: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.NT_IOSettings[source]

Bases: Structure

lowVoltageOutRange: Structure/Union member

lowVoltageOutputRoute: Structure/Union member

notYetInUse: Structure/Union member

unused: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.NT_GainParameters[source]

Bases: Structure

controlMode: Structure/Union member

gain: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.PZ_FeedbackLoopConstants[source]

Bases: Structure

integralTerm: Structure/Union member

proportionalTerm: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.PZ_LUTWaveParameters[source]

Bases: Structure

LUTValueDelay: Structure/Union member

cycleLength: Structure/Union member

mode: Structure/Union member

numCycles: Structure/Union member

numOutTriggerRepeat: Structure/Union member

outTriggerDuration: Structure/Union member

outTriggerStart: Structure/Union member

postCycleDelay: Structure/Union member

preCycleDelay: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.PPC_PIDConsts[source]

Bases: Structure

PIDConstsD: Structure/Union member

PIDConstsDFc: Structure/Union member

PIDConstsI: Structure/Union member

PIDConstsP: Structure/Union member

PIDDerivFilterOn: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.PPC_NotchParams[source]

Bases: Structure

filter1Fc: Structure/Union member

filter1Q: Structure/Union member

filter2Fc: Structure/Union member

filter2Q: Structure/Union member

filterNo: Structure/Union member

notchFilter1On: Structure/Union member

notchFilter2On: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.PPC_IOSettings[source]

Bases: Structure

FPBrightness: Structure/Union member

controlSrc: Structure/Union member

feedbackSrc: Structure/Union member

monitorOPBandwidth: Structure/Union member

monitorOPSig: Structure/Union member

reserved1: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.MOT_PIDLoopEncoderParams[source]

Bases: Structure

PIDOutputLimit: Structure/Union member

PIDTolerance: Structure/Union member

differentialGain: Structure/Union member

integralGain: Structure/Union member

loopMode: Structure/Union member

proportionalGain: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.FF_IOSettings[source]

Bases: Structure

ADCspeedValue: Structure/Union member

digIO1OperMode: Structure/Union member

digIO1PulseWidth: Structure/Union member

digIO1SignalMode: Structure/Union member

digIO2OperMode: Structure/Union member

digIO2PulseWidth: Structure/Union member

digIO2SignalMode: Structure/Union member

reserved1: Structure/Union member

reserved2: Structure/Union member

transitTime: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.MOT_ButtonParameters[source]

Bases: Structure

buttonMode: Structure/Union member

leftButtonPosition: Structure/Union member

rightButtonPosition: Structure/Union member

timeout: Structure/Union member

unused: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.MOT_PotentiometerStep[source]

Bases: Structure

thresholdDeflection: Structure/Union member

velocity: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.MOT_PotentiometerSteps[source]

Bases: Structure

potentiometerStepParameters: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.KMOT_MMIParams[source]

Bases: Structure

DisplayDimIntensity: Structure/Union member

DisplayIntensity: Structure/Union member

DisplayTimeout: Structure/Union member

PresetPos1: Structure/Union member

PresetPos2: Structure/Union member

WheelAcceleration: Structure/Union member

WheelDirectionSense: Structure/Union member

WheelMaxVelocity: Structure/Union member

WheelMode: Structure/Union member

reserved: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.KMOT_TriggerConfig[source]

Bases: Structure

Trigger1Mode: Structure/Union member

Trigger1Polarity: Structure/Union member

Trigger2Mode: Structure/Union member

Trigger2Polarity: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.KMOT_TriggerParams[source]

Bases: Structure

CycleCount: Structure/Union member

TriggerIntervalFwd: Structure/Union member

TriggerIntervalRev: Structure/Union member

TriggerPulseCountFwd: Structure/Union member

TriggerPulseCountRev: Structure/Union member

TriggerPulseWidth: Structure/Union member

TriggerStartPositionFwd: Structure/Union member

TriggerStartPositionRev: Structure/Union member

reserved: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.KIM_DriveOPParameters[source]: Bases: Structure

class msl.equipment.resources.thorlabs.kinesis.structs.KIM_JogParameters[source]: Bases: Structure

class msl.equipment.resources.thorlabs.kinesis.structs.KIM_LimitSwitchParameters[source]: Bases: Structure

class msl.equipment.resources.thorlabs.kinesis.structs.KIM_HomeParameters[source]: Bases: Structure

class msl.equipment.resources.thorlabs.kinesis.structs.KIM_MMIParameters[source]: Bases: Structure

class msl.equipment.resources.thorlabs.kinesis.structs.KIM_MMIChannelParameters[source]: Bases: Structure

class msl.equipment.resources.thorlabs.kinesis.structs.KIM_TrigIOConfig[source]: Bases: Structure

class msl.equipment.resources.thorlabs.kinesis.structs.KIM_TrigParamsParameters[source]: Bases: Structure

class msl.equipment.resources.thorlabs.kinesis.structs.KIM_FeedbackSigParams[source]: Bases: Structure

class msl.equipment.resources.thorlabs.kinesis.structs.KIM_Status[source]: Bases: Structure

class msl.equipment.resources.thorlabs.kinesis.structs.KLD_MMIParams[source]

Bases: Structure

displayIntensity: Structure/Union member

reserved: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.KLD_TrigIOParams[source]

Bases: Structure

mode1: Structure/Union member

mode2: Structure/Union member

polarity1: Structure/Union member

polarity2: Structure/Union member

reserved1: Structure/Union member

reserved2: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.KLS_MMIParams[source]

Bases: Structure

displayIntensity: Structure/Union member

reserved: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.KLS_TrigIOParams[source]

Bases: Structure

mode1: Structure/Union member

mode2: Structure/Union member

polarity1: Structure/Union member

polarity2: Structure/Union member

reserved1: Structure/Union member

reserved2: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.KNA_TIARangeParameters[source]

Bases: Structure

changeToOddOrEven: Structure/Union member

downLimit: Structure/Union member

mode: Structure/Union member

newRange: Structure/Union member

settleSamples: Structure/Union member

upLimit: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.KNA_TIAReading[source]

Bases: Structure

absoluteReading: Structure/Union member

relativeReading: Structure/Union member

selectedRange: Structure/Union member

underOrOverRead: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.KNA_IOSettings[source]

Bases: Structure

highVoltageOutRange: Structure/Union member

highVoltageOutputRoute: Structure/Union member

lowVoltageOutRange: Structure/Union member

lowVoltageOutputRoute: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.KNA_MMIParams[source]

Bases: Structure

DisplayIntensity: Structure/Union member

WheelAdjustRate: Structure/Union member

reserved: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.KNA_TriggerConfig[source]

Bases: Structure

Trigger1Mode: Structure/Union member

Trigger1Polarity: Structure/Union member

Trigger2Mode: Structure/Union member

Trigger2Polarity: Structure/Union member

reserved: Structure/Union member

unused1: Structure/Union member

unused2: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.KNA_FeedbackLoopConstants[source]

Bases: Structure

integralTerm: Structure/Union member

proportionalTerm: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.TPZ_IOSettings[source]: Bases: Structure

class msl.equipment.resources.thorlabs.kinesis.structs.KPZ_MMIParams[source]

Bases: Structure

DisplayDimIntensity: Structure/Union member

DisplayIntensity: Structure/Union member

DisplayTimeout: Structure/Union member

JoystickDirectionSense: Structure/Union member

JoystickMode: Structure/Union member

PresetPos1: Structure/Union member

PresetPos2: Structure/Union member

VoltageAdjustRate: Structure/Union member

VoltageStep: Structure/Union member

reserved: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.KPZ_TriggerConfig[source]

Bases: Structure

Trigger1Mode: Structure/Union member

Trigger1Polarity: Structure/Union member

Trigger2Mode: Structure/Union member

Trigger2Polarity: Structure/Union member

reserved: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.QD_LoopParameters[source]

Bases: Structure

differentialGain: Structure/Union member

integralGain: Structure/Union member

lowPassFilterCutOffFreq: Structure/Union member

lowPassFilterEnabled: Structure/Union member

notchFilterCenterFrequency: Structure/Union member

notchFilterEnabled: Structure/Union member

notchFilterQ: Structure/Union member

proportionalGain: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.QD_PIDParameters[source]

Bases: Structure

differentialGain: Structure/Union member

integralGain: Structure/Union member

proportionalGain: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.QD_LowPassFilterParameters[source]

Bases: Structure

lowPassFilterCutOffFreq: Structure/Union member

lowPassFilterEnabled: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.QD_NotchFilterParameters[source]

Bases: Structure

notchFilterCenterFrequency: Structure/Union member

notchFilterEnabled: Structure/Union member

notchFilterQ: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.QD_PositionDemandParameters[source]

Bases: Structure

lowVoltageOutputRoute: Structure/Union member

maxXdemand: Structure/Union member

maxYdemand: Structure/Union member

minXdemand: Structure/Union member

minYdemand: Structure/Union member

openLoopOption: Structure/Union member

xFeedbackSignedGain: Structure/Union member

yFeedbackSignedGain: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.QD_Position[source]

Bases: Structure

x: Structure/Union member

y: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.QD_Readings[source]

Bases: Structure

demandedPos: Structure/Union member

posDifference: Structure/Union member

sum: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.QD_KPA_TrigIOConfig[source]

Bases: Structure

trig1DiffThreshold: Structure/Union member

trig1Mode: Structure/Union member

trig1Polarity: Structure/Union member

trig1SumMax: Structure/Union member

trig1SumMin: Structure/Union member

trig2DiffThreshold: Structure/Union member

trig2Mode: Structure/Union member

trig2Polarity: Structure/Union member

trig2SumMax: Structure/Union member

trig2SumMin: Structure/Union member

wReserved: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.QD_KPA_DigitalIO[source]

Bases: Structure

wDigOPs: Structure/Union member

wReserved: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.SC_CycleParameters[source]

Bases: Structure

closedTime: Structure/Union member

numCycles: Structure/Union member

openTime: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.KSC_MMIParams[source]

Bases: Structure

DisplayDimIntensity: Structure/Union member

DisplayIntensity: Structure/Union member

DisplayTimeout: Structure/Union member

reserved: Structure/Union member

unused: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.KSC_TriggerConfig[source]

Bases: Structure

Trigger1Mode: Structure/Union member

Trigger1Polarity: Structure/Union member

Trigger2Mode: Structure/Union member

Trigger2Polarity: Structure/Union member

reserved: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.TSG_IOSettings[source]

Bases: Structure

displayMode: Structure/Union member

forceCalibration: Structure/Union member

futureUse: Structure/Union member

hubAnalogOutput: Structure/Union member

notYetInUse: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.KSG_MMIParams[source]

Bases: Structure

DisplayDimIntensity: Structure/Union member

DisplayIntensity: Structure/Union member

DisplayTimeout: Structure/Union member

reserved: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.KSG_TriggerConfig[source]

Bases: Structure

LowerLimit: Structure/Union member

SmoothingSamples: Structure/Union member

Trigger1Mode: Structure/Union member

Trigger1Polarity: Structure/Union member

Trigger2Mode: Structure/Union member

Trigger2Polarity: Structure/Union member

UpperLimit: Structure/Union member

reserved: Structure/Union member

class msl.equipment.resources.thorlabs.kinesis.structs.TIM_DriveOPParameters[source]: Bases: Structure

class msl.equipment.resources.thorlabs.kinesis.structs.TIM_JogParameters[source]: Bases: Structure

class msl.equipment.resources.thorlabs.kinesis.structs.TIM_ButtonParameters[source]: Bases: Structure

class msl.equipment.resources.thorlabs.kinesis.structs.TIM_Status[source]: Bases: Structure

class msl.equipment.resources.thorlabs.kinesis.structs.TC_LoopParameters[source]

Bases: Structure

differentialGain: Structure/Union member

integralGain: Structure/Union member

proportionalGain: Structure/Union member