Skip to content

ClimeEventSimpac#

Controls Weiss Technik climate chambers with an S!MPAC controller from Python. Programs can be started and stopped, set points and measured values can be read and written. This class inherits from MeasmaticDevice.

property verbose_log#

Enables or disables verbose logging of the communication with the climate chamber.

Returns#

Type Description
bool True if verbose logging is enabled, otherwise False . The property can also be
assigned.

Example#

chamber = measmatic.get_device('device-climate-chamber')
chamber.verbose_log = True

method get_chamber_info(infoType: Any)#

Queries information about the climate chamber.

Parameters#

Name Description
infoType The info to query (.NET enum Atv.Framework.Devices.ClimateChamber.ClimeEventSimpac.InfoType ,

Returns#

Type Description
str The requested information.

Example#

from Atv.Framework.Devices.ClimateChamber import ClimeEventSimpac
chamber = measmatic.get_device('device-climate-chamber')
serial = chamber.get_chamber_info(ClimeEventSimpac.InfoType.SerialNumber)

method get_chamber_state()#

Queries the state of the climate chamber.

Returns#

Type Description
Any The chamber state (.NET flags enum
Atv.Framework.Devices.ClimateChamber.ClimeEventSimpac.ChamberState : test system running or
not running, warnings present, alarms present).

Example#

chamber = measmatic.get_device('device-climate-chamber')
state = chamber.get_chamber_state()

method get_control_value(valueIndex: int)#

Queries the current value of a control value.

Parameters#

Name Description
valueIndex The index of the control value.

Returns#

Type Description
float The current value, in the unit reported by get_control_value_unit .

Example#

chamber = measmatic.get_device('device-climate-chamber')
value = chamber.get_control_value(1)

method get_control_value_name(controlValueIndex: int)#

Queries the name of a control value.

Parameters#

Name Description
controlValueIndex The index of the control value whose name is to be queried.

Returns#

Type Description
str The name of the control value.

Example#

chamber = measmatic.get_device('device-climate-chamber')
name = chamber.get_control_value_name(1)

method get_control_values()#

Returns the names and units of the control values.

Returns#

Type Description
Any A list of (name, unit) tuples (.NET type IReadOnlyList<(string name, string unit)> ).

Example#

chamber = measmatic.get_device('device-climate-chamber')
for name, unit in chamber.get_control_values():
print(name, unit)

method get_control_value_unit(controlValueIndex: int)#

Queries the unit of a control value.

Parameters#

Name Description
controlValueIndex The index of the control value whose unit is to be queried.

Returns#

Type Description
str The unit of the control value.

Example#

chamber = measmatic.get_device('device-climate-chamber')
unit = chamber.get_control_value_unit(1)

method get_control_variable(valueIndex: int)#

Queries the current value of a control variable.

Parameters#

Name Description
valueIndex The index of the control variable.

Returns#

Type Description
float The current value, in the unit reported by get_control_variable_unit .

Example#

chamber = measmatic.get_device('device-climate-chamber')
value = chamber.get_control_variable(1)

method get_control_variable_actual_value(valueIndex: int)#

Queries the actual value of a control variable.

Parameters#

Name Description
valueIndex The index of the control variable.

Returns#

Type Description
float The actual value, in the unit reported by get_control_variable_unit .

Example#

chamber = measmatic.get_device('device-climate-chamber')
actual = chamber.get_control_variable_actual_value(1)

method get_control_variable_name(controlVariableIndex: int)#

Queries the name of a control variable.

Parameters#

Name Description
controlVariableIndex The index of the control variable whose name is to be queried.

Returns#

Type Description
str The name of the control variable.

Example#

chamber = measmatic.get_device('device-climate-chamber')
name = chamber.get_control_variable_name(1)

method get_control_variables()#

Returns the names and units of the control variables.

Returns#

Type Description
Any A list of (name, unit) tuples (.NET type IReadOnlyList<(string name, string unit)> ).

Example#

chamber = measmatic.get_device('device-climate-chamber')
for name, unit in chamber.get_control_variables():
print(name, unit)

method get_control_variable_unit(controlVariableIndex: int)#

Queries the unit of a control variable.

Parameters#

Name Description
controlVariableIndex The index of the control variable whose unit is to be queried.

Returns#

Type Description
str The unit of the control variable.

Example#

chamber = measmatic.get_device('device-climate-chamber')
unit = chamber.get_control_variable_unit(1)

method get_counter_name(counterIndex: int)#

Queries the name of a counter.

Parameters#

Name Description
counterIndex The index of the counter whose name is to be queried.

Returns#

Type Description
str The name of the counter.

Example#

chamber = measmatic.get_device('device-climate-chamber')
name = chamber.get_counter_name(1)

method get_counters()#

Returns the names and units of the counters.

Returns#

Type Description
Any A list of (name, unit) tuples (.NET type IReadOnlyList<(string name, string unit)> ).

Example#

chamber = measmatic.get_device('device-climate-chamber')
for name, unit in chamber.get_counters():
print(name, unit)

method get_counter_unit(counterIndex: int)#

Queries the unit of a counter.

Parameters#

Name Description
counterIndex The index of the counter whose unit is to be queried.

Returns#

Type Description
str The unit of the counter.

Example#

chamber = measmatic.get_device('device-climate-chamber')
unit = chamber.get_counter_unit(1)

method get_counter_value(counterIndex: int)#

Queries the current value of a counter.

Parameters#

Name Description
counterIndex The index of the counter.

Returns#

Type Description
int The current value of the counter.

Example#

chamber = measmatic.get_device('device-climate-chamber')
value = chamber.get_counter_value(1)

method get_current_program_name()#

Queries the name of the currently running program.

Returns#

Type Description
str The name of the program.

Example#

chamber = measmatic.get_device('device-climate-chamber')
name = chamber.get_current_program_name()

method get_current_program_number()#

Queries the number of the currently running program.

Returns#

Type Description
int The number of the program.

Example#

chamber = measmatic.get_device('device-climate-chamber')
number = chamber.get_current_program_number()

method get_measure_value(valueIndex: int)#

Queries the current value of a measure value, e.g. the measured temperature or humidity.

Parameters#

Name Description
valueIndex The index of the measure value. The assignment of the indices depends on the controller

Returns#

Type Description
float The current value, in the unit reported by get_measure_value_unit .

Example#

chamber = measmatic.get_device('device-climate-chamber')
temperature = chamber.get_measure_value(1)

method get_measure_value_name(measureValueIndex: int)#

Queries the name of a measure value.

Parameters#

Name Description
measureValueIndex The index of the measure value whose name is to be queried.

Returns#

Type Description
str The name of the measure value.

Example#

chamber = measmatic.get_device('device-climate-chamber')
name = chamber.get_measure_value_name(1)

method get_measure_values()#

Returns the names and units of the measure values.

Returns#

Type Description
Any A list of (name, unit) tuples (.NET type IReadOnlyList<(string name, string unit)> ).

Example#

chamber = measmatic.get_device('device-climate-chamber')
for name, unit in chamber.get_measure_values():
print(name, unit)

method get_measure_value_unit(measureValueIndex: int)#

Queries the unit of a measure value.

Parameters#

Name Description
measureValueIndex The index of the measure value whose unit is to be queried.

Returns#

Type Description
str The unit of the measure value.

Example#

chamber = measmatic.get_device('device-climate-chamber')
unit = chamber.get_measure_value_unit(1)

method get_message_category(messageNumber: int)#

Queries the category of a message of the climate chamber.

Parameters#

Name Description
messageNumber The number of the message.

Returns#

Type Description
str The message category.

Example#

chamber = measmatic.get_device('device-climate-chamber')
category = chamber.get_message_category(1)

method get_message_text(messageNumber: int)#

Queries the text of a message of the climate chamber.

Parameters#

Name Description
messageNumber The number of the message.

Returns#

Type Description
str The message text.

Example#

chamber = measmatic.get_device('device-climate-chamber')
text = chamber.get_message_text(1)

method get_message_type(messageNumber: int)#

Queries the type of a message of the climate chamber.

Parameters#

Name Description
messageNumber The number of the message.

Returns#

Type Description
str The message type.

Example#

chamber = measmatic.get_device('device-climate-chamber')
message_type = chamber.get_message_type(1)

method get_number_of_control_values()#

Queries the number of control values.

Returns#

Type Description
int The number of control values.

Example#

chamber = measmatic.get_device('device-climate-chamber')
count = chamber.get_number_of_control_values()

method get_number_of_control_variables()#

Queries the number of control variables.

Returns#

Type Description
int The number of control variables.

Example#

chamber = measmatic.get_device('device-climate-chamber')
count = chamber.get_number_of_control_variables()

method get_number_of_counters()#

Queries the number of counters.

Returns#

Type Description
int The number of counters.

Example#

chamber = measmatic.get_device('device-climate-chamber')
count = chamber.get_number_of_counters()

method get_number_of_measure_values()#

Queries the number of measure values.

Returns#

Type Description
int The number of measure values.

Example#

chamber = measmatic.get_device('device-climate-chamber')
count = chamber.get_number_of_measure_values()

method get_program_active_time()#

Returns the time the current program has been running for.

Returns#

Type Description
float The running time of the program in seconds.

Example#

chamber = measmatic.get_device('device-climate-chamber')
seconds = chamber.get_program_active_time()

method get_program_state()#

Queries the state of the currently running program.

Returns#

Type Description
Any The program state (.NET flags enum
Atv.Framework.Devices.ClimateChamber.ClimeEventSimpac.ProgramState , e.g. ProgramIsNotRunning , ProgramIsRunning , ProgramPauses ).

Example#

chamber = measmatic.get_device('device-climate-chamber')
state = chamber.get_program_state()

method has_message(messageNumber: int)#

Queries whether a message with the given number is present.

Parameters#

Name Description
messageNumber The number of the message.

Returns#

Type Description
bool True if the message is present, otherwise False .

Example#

chamber = measmatic.get_device('device-climate-chamber')
if chamber.has_message(1):
print(chamber.get_message_text(1))

method pause_program()#

Pauses the currently running program.

Example#

chamber = measmatic.get_device('device-climate-chamber')
chamber.pause_program()

method reset_all_errors()#

Clears all errors on the climate chamber.

Example#

chamber = measmatic.get_device('device-climate-chamber')
chamber.reset_all_errors()

method resume_program()#

Resumes the paused program.

Example#

chamber = measmatic.get_device('device-climate-chamber')
chamber.resume_program()

method set_control_value(valueIndex: int, value: float)#

Sets a control value.

Parameters#

Name Description
valueIndex The index of the control value.
value The new value, in the unit reported by get_control_value_unit .

Example#

chamber = measmatic.get_device('device-climate-chamber')
chamber.set_control_value(1, 25.0)

method set_control_variable(valueIndex: int, value: float)#

Sets a control variable, e.g. the temperature set point in manual mode.

Parameters#

Name Description
valueIndex The index of the control variable.
value The new value, in the unit reported by get_control_variable_unit .

Example#

chamber = measmatic.get_device('device-climate-chamber')
chamber.set_control_variable(1, 25.0)

method start_manual_mode()#

Starts the manual mode of the climate chamber.

Example#

chamber = measmatic.get_device('device-climate-chamber')
chamber.start_manual_mode()

method start_program(programNumber: int, runThroughCount: int = 1)#

Starts a program of the climate chamber.

Parameters#

Name Description
programNumber The number of the program to start.
runThroughCount The number of times the program is to be executed. Default: 1

Example#

chamber = measmatic.get_device('device-climate-chamber')
chamber.start_program(3, 2)

method stop_manual_mode()#

Stops the manual mode of the climate chamber.

Example#

chamber = measmatic.get_device('device-climate-chamber')
chamber.stop_manual_mode()

method stop_program()#

Stops the currently running program.

Example#

chamber = measmatic.get_device('device-climate-chamber')
chamber.stop_program()