msl.equipment.resources.thorlabs.kinesis.messages module

Device Message Queue defined in Thorlabs Kinesis v1.14.18

The device message queue allows the internal events raised by the device to be monitored by the DLLs owner.

The device raises many different events, usually associated with a change of state.

These messages are temporarily stored in the DLL and can be accessed using the appropriate message functions.

The message consists of 3 components, a messageType, a messageID and messageData:

WORD messageType
WORD messageID
WORD messageData
msl.equipment.resources.thorlabs.kinesis.messages.MessageTypes = {0: 'GenericDevice', 1: 'GenericPiezo', 2: 'GenericMotor', 3: 'GenericDCMotor', 4: 'GenericSimpleMotor', 5: 'RackDevice', 6: 'Laser', 7: 'TECCtlr', 8: 'Quad', 9: 'NanoTrak', 10: 'Specialized', 11: 'Solenoid'}

MessageTypes

msl.equipment.resources.thorlabs.kinesis.messages.GenericDevice = {0: 'settingsInitialized', 1: 'settingsUpdated', 2: 'settingsExtern', 3: 'error', 4: 'close', 5: 'settingsReset'}

GenericDevice

msl.equipment.resources.thorlabs.kinesis.messages.GenericMotor = {0: 'Homed', 1: 'Moved', 2: 'Stopped', 3: 'LimitUpdated'}

GenericMotor

msl.equipment.resources.thorlabs.kinesis.messages.GenericDCMotor = {0: 'error', 1: 'status'}

GenericDCMotor

msl.equipment.resources.thorlabs.kinesis.messages.GenericPiezo = {0: 'maxVoltageChanged', 1: 'controlModeChanged', 2: 'statusChanged', 3: 'maxTravelChanged', 4: 'TSG_Status', 5: 'TSG_DisplayModeChanged'}

GenericPiezo

msl.equipment.resources.thorlabs.kinesis.messages.RackDevice = {0: 'RackCountEstablished', 1: 'RackBayState'}

RackDevice

msl.equipment.resources.thorlabs.kinesis.messages.Quad = {0: 'statusChanged'}

Quad

msl.equipment.resources.thorlabs.kinesis.messages.TECCtlr = {0: 'statusChanged', 2: 'displaySettingsChanged', 3: 'feedbackParamsChanged'}

TECCtlr

msl.equipment.resources.thorlabs.kinesis.messages.Laser = {0: 'statusChanged', 1: 'controlSourceChanged', 2: 'displayModeChanged'}

Laser

msl.equipment.resources.thorlabs.kinesis.messages.Solenoid = {0: 'statusChanged'}

Solenoid

msl.equipment.resources.thorlabs.kinesis.messages.NanoTrak = {0: 'statusChanged'}

NanoTrak

msl.equipment.resources.thorlabs.kinesis.messages.Specialized = {}

Specialized

msl.equipment.resources.thorlabs.kinesis.messages.GenericSimpleMotor = {}

GenericSimpleMotor

msl.equipment.resources.thorlabs.kinesis.messages.MessageID = {'GenericDCMotor': {0: 'error', 1: 'status'}, 'GenericDevice': {0: 'settingsInitialized', 1: 'settingsUpdated', 2: 'settingsExtern', 3: 'error', 4: 'close', 5: 'settingsReset'}, 'GenericMotor': {0: 'Homed', 1: 'Moved', 2: 'Stopped', 3: 'LimitUpdated'}, 'GenericPiezo': {0: 'maxVoltageChanged', 1: 'controlModeChanged', 2: 'statusChanged', 3: 'maxTravelChanged', 4: 'TSG_Status', 5: 'TSG_DisplayModeChanged'}, 'GenericSimpleMotor': {}, 'Laser': {0: 'statusChanged', 1: 'controlSourceChanged', 2: 'displayModeChanged'}, 'NanoTrak': {0: 'statusChanged'}, 'Quad': {0: 'statusChanged'}, 'RackDevice': {0: 'RackCountEstablished', 1: 'RackBayState'}, 'Solenoid': {0: 'statusChanged'}, 'Specialized': {}, 'TECCtlr': {0: 'statusChanged', 2: 'displaySettingsChanged', 3: 'feedbackParamsChanged'}}

MessageID