Qudi
Public Member Functions | Public Attributes | List of all members
CTC100_temperature.CTC100 Class Reference

This module implements communication with CTC100 temperature controllers or clones/licensed devices. More...

Inheritance diagram for CTC100_temperature.CTC100:
Inheritance graph
[legend]
Collaboration diagram for CTC100_temperature.CTC100:
Collaboration graph
[legend]

Public Member Functions

def on_activate (self)
 Activate modeule.
 
def on_deactivate (self)
 Deactivate modeule.
 
def connect (self, interface)
 Connect to Instrument. More...
 
def disconnect (self)
 Close the connection to the instrument.
 
def get_channel_names (self)
 Get a list of channel names. More...
 
def is_channel_selected (self, channel)
 Check if a channel is selectes. More...
 
def is_output_on (self)
 Check if device outputs are enabled. More...
 
def get_temp_by_name (self, name)
 Get temperature by name. More...
 
def get_all_outputs (self)
 Get a list of all output names. More...
 
def get_selected_channels (self)
 Get all selected channels. More...
 
def channel_off (self, channel)
 Turn off channel. More...
 
def enable_output (self)
 Turn on all outputs. More...
 
def disable_output (self)
 Turn off all outputs. More...
 
- Public Member Functions inherited from core.module.BaseMixin
def __init__ (self, manager, name, config=None, callbacks=None, kwargs)
 Initialise Base class object and set up its state machine. More...
 
def log (self)
 Returns a logger object.
 
def is_module_threaded (self)
 Returns whether the module shall be started in a thread.
 
def on_activate (self)
 Method called when module is activated. More...
 
def on_deactivate (self)
 Method called when module is deactivated. More...
 
def getStatusVariables (self)
 Return a dict of variable names and their content representing the module state for saving. More...
 
def setStatusVariables (self, variableDict)
 Give a module a dict of variable names and their content representing the module state. More...
 
def getConfiguration (self)
 Return the configration dictionary for this module. More...
 
def get_connector (self, connector_name)
 Return module connected to the given named connector. More...
 
- Public Member Functions inherited from core.module.ModuleMeta
def __new__ (cls, name, bases, attrs)
 Collect declared Connectors, ConfigOptions and StatusVars into dictionaries. More...
 

Public Attributes

 rm
 
 inst
 
- Public Attributes inherited from core.module.BaseMixin
 module_state
 
 connectors
 

Detailed Description

This module implements communication with CTC100 temperature controllers or clones/licensed devices.

ATTENTION This module is untested and very likely broken.

Example config for copy-paste:

tempcontroller_ctc100: module 'CTC100_temperature.CTC100' interface 'ASRL1::INSTR' fitlogic 'fitlogic' # name of the fitlogic module, see default config

Member Function Documentation

◆ channel_off()

def CTC100_temperature.CTC100.channel_off (   self,
  channel 
)

Turn off channel.

Parameters
channelstr: name of channel to turn off

◆ connect()

def CTC100_temperature.CTC100.connect (   self,
  interface 
)

Connect to Instrument.

Parameters
strinterface: visa interface identifier
Returns
bool: connection success

◆ disable_output()

def CTC100_temperature.CTC100.disable_output (   self)

Turn off all outputs.

Returns
bool: whether turning off was successful

◆ enable_output()

def CTC100_temperature.CTC100.enable_output (   self)

Turn on all outputs.

Returns
bool: whether turning on was successful

◆ get_all_outputs()

def CTC100_temperature.CTC100.get_all_outputs (   self)

Get a list of all output names.

Returns
list(str): output names

◆ get_channel_names()

def CTC100_temperature.CTC100.get_channel_names (   self)

Get a list of channel names.

Returns
list(str): list of channel names

◆ get_selected_channels()

def CTC100_temperature.CTC100.get_selected_channels (   self)

Get all selected channels.

Returns
dict: dict of channel_name: bool indicating selected channels

◆ get_temp_by_name()

def CTC100_temperature.CTC100.get_temp_by_name (   self,
  name 
)

Get temperature by name.

Returns
float: temperature value

◆ is_channel_selected()

def CTC100_temperature.CTC100.is_channel_selected (   self,
  channel 
)

Check if a channel is selectes.

Parameters
strchannel: channel name
Returns
bool: whether channel is selected

◆ is_output_on()

def CTC100_temperature.CTC100.is_output_on (   self)

Check if device outputs are enabled.

Returns
bool: wheter device outputs are enabled

The documentation for this class was generated from the following file: