API Reference - icicle

This library provides lightweight classes and command line tools for instrument control/DCS.

The following devices are currently supported:

• Rhode&Schwarz/Hameg HMP4040 LV power supply: hmp4040.

• TTI MX100TP-class LV power supply: tti.

• Keithley 2000 multimeter: keithley2000.

• Keithley 24X0-class source-measure unit: keithley2410.

• ETHZ SLDO probe card controller board (arduino; a. la. Vasilije Perovic): relay_board

A super-device implementation for a standard module testing setup consisting of LV, HV, relay board, and multimeter (with interlock features) is provided: instrument_cluster.

adc_board	ADCBoard class for probe cards to measure voltage on RD53B quad-chip modules. Different versions of the probe card can be implemented by inheriting from adc_board and overwriting ``DEFAULT_PIN_MAP`, an example is given with eth_probecard.
adc_board_cli	ADCBoard CLI module.
binder_climate_chamber	Binder class for climate chamber.
binder_climate_chamber_cli	Binder CLI module.
cli_utils	Utility decorators and functions to used with Click library to generate instrument CLIs.
dummy	This instrument is essentially just a placeholder for a non-existing instrument.
eth_probecard	ETHProbecard class for probe cards to measure voltage on RD53B quad-chip modules.
eth_probecard_cli	ETHProbecard CLI module.
hmp4040	HMP4040 class for Rhode&Schwarz/Hameg HMP4040 4-output power supply.
hmp4040_cli	HMP4040 CLI module.
hp34401a	HP34401A class for HP34401A multimeter.
hp34401a_cli	HP34401A CLI module.
instrument	Instrument interface and associated decorator tools.
instrument_cluster	InstrumentCluster class wrapping HV, LV and AdcBoard for multiple modules.
instrument_cluster_cli	InstrumentCluster CLI module.
itkdcsinterlock	ITkDCSInterlock class for Rhode&Schwarz/Hameg HMP4040 4-output power supply.
keithley2000	Keithley2000 class for Keithley 2000 multimeter.
keithley2000_cli	Keithley2000 CLI module.
keithley6500	Keithley6500 class for Keithley 6500 multimeter running in emulation mode.
keithley6500_cli	Keithley6500 CLI module.
keithley2410	Keithley2410 class for Keithley 2410 source-measure unit.
keithley2410_cli	Keithley2410 CLI module.
keysighte3633a	Keysight class for Keysight E3633A low voltage power supplies.
keysighte3633a_cli	Keysight CLI module.
lauda	Lauda class for Lauda chillers.
lauda_cli	Lauda CLI module.
measurechannel_cli	MeasureChannel CLI module.
mp1	MP1 class for Gulmay MP1 xray controllers.
mp1_cli	Gulmay MP1 CLI module.
mqtt_client	MQTTClient class for publishing measurements to MQTT broker.
mqtt_instrument
pidcontroller	PIDController class for TRICICLE PIDcontroller-UI instance.
powerchannel_cli	PowerChannel CLI module.
psi_coldbox	PSIColdbox Class for the CMS Pixel 8-channel Coldbox developed at PSI
psi_coldbox_cli	PSIColdbox CLI module.
psi_probecard	PSIProbecard class for probe cards to measure voltage on RD53B quad-chip modules.
psi_probecard_cli	PSIProbecard CLI module.
relay_board	RelayBoard class for ETHZ Relayboard (Vasilije Perovic design).
relay_board_cli	Relay Board CLI module.
scpi_instrument	SCPI Instrument interface and associated decorator tools.
tpx4sc	TimePix4 socket control class for Spidr4 readout system.
tpx4sc_cli	TPX4SC CLI module.
tti	TTI class for TTI MX100TP-style low voltage power supplies.
tti_cli	TTI CLI module.
ttitsx	TTI class for TTI TSX1820P-style low voltage power supplies.
ttitsx_cli	TTITSX CLI module.
utils.parser_utils	Parser utilities.
visa_instrument	PyVISA Instrument interface and associated decorator tools.
icicle.utils.parser_utils	Parser utilities.