Module azcam.tools.tempcon_console

Contains the base TempConConsole class.

Classes

class TempconConsole

Temperature controller tool for consoles. Usually implemented as the "tempcon" tool.

Args

name : str
name of this tool.

Ancestors

Instance variables

var verbosity

Inherited from: ConsoleTools.verbosity

verbosity for debug, > 0 is more verbose

Methods

def delete_keyword(self, keyword: str) ‑> Optional[str]

Inherited from: ConsoleTools.delete_keyword

Delete a keyword from a header …

def get_control_temperature(self, temperature_id: int = 0) ‑> Union[str, float]

Get the control temperature (set point).

Args

temperature_id
temperature sensor identifier

Returns

control_temperature
control temperature
def get_keyword(self, keyword: str) ‑> str

Inherited from: ConsoleTools.get_keyword

Return a keyword value, its comment string, and type. Comment always returned in double quotes, even if empty …

def get_keywords(self) ‑> list

Inherited from: ConsoleTools.get_keywords

Return a list of all keyword names …

def get_string(self) ‑> str

Inherited from: ConsoleTools.get_string

Returns the entire header as a formatted string …

def get_temperature(self, temperature_id: int = 0) ‑> float

Returns a system temperature.

Args

temperature_id
temperature sensor identifier

Returns

temperature
temperature read
def get_temperatures(self) ‑> List[float]

Return all system temperatures.

Returns

temperatures
list of temperatures read
def initialize(self) ‑> None

Inherited from: ConsoleTools.initialize

Initialize this tool.

def read_header(self)

Inherited from: ConsoleTools.read_header

Returns the current header …

def reset(self) ‑> None

Inherited from: ConsoleTools.reset

Reset this tool.

def set_control_temperature(self, control_temperature: float, temperature_id: int = 0) ‑> Optional[str]

Set the control temperature (set point).

Args

control_temperature
control temperature in Celsius.
temperature_id
temperature sensor identifier
def set_keyword(self, keyword: str, value: str, comment: str = 'none', typestring: str = 'none') ‑> Optional[str]

Inherited from: ConsoleTools.set_keyword

Set a keyword value, comment, and type.

Args

keyword
keyword
value
value of keyword
comment
comment string
typestring
one of …
def update_header(self)

Inherited from: ConsoleTools.update_header

Update the header of a tool. This command usually reads hardware to get the lastest keyword values.