LakeShore218 Satellite

Name	LakeShore218
Description	Satellite controlling a LakeShore Model 218 temperature monitor
Language	Python

Description

This satellite uses the RS-232 serial port of LakeShore Model 218 temperature monitors to read the temperature of the connected temperature sensors.

Note

This satellite requires write access to the serial port or USB-to-serial converter the device is attached to. It is recommended to not run this satellite with root privileges but to allow the regular user access to the required port instead. On Unix, if the port is e.g. /dev/ttyUSB0, the group can be found via stat /dev/ttyUSB0 (the Gid entry). If the group is e.g. dialout, the permissions can be given with sudo usermod -a -G dialout $USER. A restart is required for the changes to be effective.

Note

Since the LakeShore Model 218 has a male RS-232 connector, most USB-to-serial converters require an adapter. This adapter has to be a null modem, where the TX and RX lines are switched.

Requirements

The Keithley satellite requires the [visa] component, which can be installed with:

PyPI

pip install "ConstellationDAQ[visa]"

Source

pip install --no-build-isolation -e ".[visa]"

Parameters

Parameter	Description	Type	Default Value
port	Serial port to connect to	String	-
channel_names	Names of the temperature channels used for the metrics	List of strings	see metrics
sampling_interval	Sampling interval in seconds	Float	5.0

Metrics

Metric	Description	Value Type	Metric Type	Interval
TEMP_1	Temperature 1	Float	LAST_VALUE	5s
TEMP_2	Temperature 2	Float	LAST_VALUE	5s
TEMP_3	Temperature 3	Float	LAST_VALUE	5s
TEMP_4	Temperature 4	Float	LAST_VALUE	5s
TEMP_5	Temperature 5	Float	LAST_VALUE	5s
TEMP_6	Temperature 6	Float	LAST_VALUE	5s
TEMP_7	Temperature 7	Float	LAST_VALUE	5s
TEMP_8	Temperature 8	Float	LAST_VALUE	5s

Custom Commands

Command	Description	Arguments	Return Value	Allowed States
get_temp	Temperature	Channel (Integer)	Float	any

Framework Parameters

This satellite inherits the following framework parameters from its base classes:

Parameters inherited from Satellite

Autonomous Operation

Parameter	Type	Description	Default Value
_role	Role name	Role this satellite should take in the Constellation. Accepted values are ESSENTIAL, DYNAMIC, TRANSIENT and NONE.	DYNAMIC

Transition Orchestration

Parameters to control autonomous transition orchestration of satellites:

Parameter	Type	Description	Default Value
_conditional_transition_timeout	Unsigned integer	Timeout in seconds to wait for all conditions to be satisfied for conditional transitioning	30
_require_initializing_after	List of strings	List of canonical names of remote satellites for conditional transitioning in initializing state	-
_require_launching_after	List of strings	List of canonical names of remote satellites for conditional transitioning in launching state	-
_require_landing_after	List of strings	List of canonical names of remote satellites for conditional transitioning in landing state	-
_require_starting_after	List of strings	List of canonical names of remote satellites for conditional transitioning in starting state	-
_require_stopping_after	List of strings	List of canonical names of remote satellites for conditional transitioning in stopping state	-

Framework Metrics

This satellite inherits the following framework metrics from its base classes:

Metrics inherited from Satellite

None