class InstEtcTests(unittest.TestCase):
"""
Tests for instrument etc. ioc
"""
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(
ioc_name=DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix="PARS")
@parameterized.expand([("I", 12), ("R", 12.34), ("S", "123abc")])
def test_GIVEN_loaded_WHEN_set_and_read_user_integer_THEN_integer_is_set(
self, test_type, value):
for var_index in range(NUM_USER_VARS + 1):
self.ca.assert_setting_setpoint_sets_readback(
value, readback_pv="USER:{}{}".format(test_type, var_index))
self.ca.assert_that_pv_does_not_exist("USER:I{}".format(NUM_USER_VARS +
1))
def test_GIVEN_loaded_WHEN_get_max_user_record_THEN_max_is_returned(self):
self.ca.assert_that_pv_is("USER:MAX", NUM_USER_VARS)
def test_GIVEN_loaded_WHEN_get_max_user_buttons_THEN_max_is_returned(self):
self.ca.assert_that_pv_is("USER:BUTTONS:MAX", NUM_USER_BUTTONS)
def test_GIVEN_loaded_WHEN_set_and_read_button_THEN_running_set(self):
for var_index in range(NUM_USER_BUTTONS + 1):
self.ca.assert_setting_setpoint_sets_readback(
"Running",
readback_pv="USER:BUTTON{}:SP".format(var_index),
set_point_pv="USER:BUTTON{}:SP".format(var_index))
self.ca.assert_that_pv_does_not_exist(
"USER:BUTTON{}".format(NUM_USER_VARS + 1))
class MezfliprTests(unittest.TestCase):
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(
EMULATOR_NAME, DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX)
def test_WHEN_ioc_is_started_THEN_ioc_is_not_disabled(self):
self.ca.assert_that_pv_is("DISABLE", "COMMS ENABLED")
@skip_if_recsim("Disconnection simulation not implemented in recsim")
def test_GIVEN_device_is_connected_THEN_can_read_id(self):
self.ca.assert_that_pv_is("ID", "Flipper Control")
self.ca.assert_that_pv_alarm_is("ID", self.ca.Alarms.NONE)
@parameterized.expand(["ANALYSER", "POLARISER"])
def test_GIVEN_amplitude_is_set_THEN_amplitude_can_be_read_back(
self, flipper):
for val in [0., 0.12, 2.99]: # Amplitude should be limited to 3A
self.ca.assert_setting_setpoint_sets_readback(
val, readback_pv="{}:AMPLITUDE".format(flipper))
@parameterized.expand(["ANALYSER", "POLARISER"])
def test_GIVEN_compensation_is_set_THEN_compensation_can_be_read_back(
self, flipper):
for val in [0., 0.12, 5000.5]:
self.ca.assert_setting_setpoint_sets_readback(
val, readback_pv="{}:COMPENSATION".format(flipper))
@parameterized.expand(["ANALYSER", "POLARISER"])
def test_GIVEN_dt_is_set_THEN_dt_can_be_read_back(self, flipper):
for val in [0., -0.12, -5000.5]: # DT only accepts negative values.
self.ca.assert_setting_setpoint_sets_readback(
val, readback_pv="{}:DT".format(flipper))
@parameterized.expand(["ANALYSER", "POLARISER"])
def test_GIVEN_constant_is_set_THEN_constant_can_be_read_back(
self, flipper):
for val in [0., 0.12, 5000.5]:
self.ca.assert_setting_setpoint_sets_readback(
val, readback_pv="{}:CONSTANT".format(flipper))
@parameterized.expand(["ANALYSER", "POLARISER"])
def test_GIVEN_constant_is_set_THEN_constant_can_be_read_back(
self, flipper):
for filename in [r"C:\a.txt", r"C:\b.txt"]:
self.ca.assert_setting_setpoint_sets_readback(
filename, readback_pv="{}:FILENAME".format(flipper))
@parameterized.expand([
"Analyser Off Pol. Off",
"Analyser Off Pol. On",
"Analyser On Pol. Off",
"Analyser On Pol. On",
])
def test_GIVEN_toggle_state_is_set_THEN_toggle_state_can_be_read_back(
self, toggle_state):
self.ca.set_pv_value("TOGGLE:SP", toggle_state)
self.ca.assert_that_pv_is("TOGGLE", toggle_state)
self.ca.assert_that_pv_alarm_is("TOGGLE", self.ca.Alarms.NONE)
class OerconeTests(unittest.TestCase):
"""
Tests for the Oercone IOC.
"""
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(IOCS[0]["emulator"], DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX)
def test_WHEN_device_is_started_THEN_it_is_not_disabled(self):
self.ca.assert_that_pv_is("DISABLE", "COMMS ENABLED")
@parameterized.expand(parameterized_list(TEST_PRESSURE_VALUES))
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_WHEN_pressure_is_set_via_backdoor_THEN_readback_updates(self, _, pressure):
self._lewis.backdoor_set_on_device("pressure", pressure)
self.ca.assert_that_pv_is_number("PRESSURE", pressure)
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_WHEN_measurement_units_is_set_via_backdoor_THEN_readback_updates(self):
for units in Units:
self._lewis.backdoor_run_function_on_device("backdoor_set_units", [units.value])
expected_units = units.name
self.ca.assert_that_pv_is("PRESSURE.EGU", expected_units)
@parameterized.expand(parameterized_list(Units))
def test_WHEN_units_setpoint_set_THEN_read_back_is_correct(self, _, units):
self.ca.assert_setting_setpoint_sets_readback(units.name, "UNITS")
class SamposTests(unittest.TestCase):
"""
Tests for the sampos IOC.
"""
test_values = [0, 10]
axes = ['X', 'Y', 'Z', 'W', 'S']
def setUp(self):
self._ioc = IOCRegister.get_running("SAMPOS")
self.ca = ChannelAccess(20, device_prefix=DEVICE_PREFIX)
self.ca.assert_that_pv_exists("DISABLE", timeout=30)
def test_WHEN_ioc_is_started_THEN_ioc_is_not_disabled(self):
self.ca.assert_that_pv_is("DISABLE", "COMMS ENABLED")
def test_WHEN_values_are_set_THEN_readbacks_update(self):
for axis in self.axes:
for value in self.test_values:
self.ca.assert_setting_setpoint_sets_readback(
value,
readback_pv="{}".format(axis),
set_point_pv="{}:SP".format(axis))
def test_WHEN_values_are_set_THEN_setpoint_readbacks_update(self):
for axis in self.axes:
for value in self.test_values:
self.ca.assert_setting_setpoint_sets_readback(
value,
readback_pv="{}:SP:RBV".format(axis),
set_point_pv="{}:SP".format(axis))
def setUp(self):
self._ioc = IOCRegister.get_running("GALIL_01")
ca_mot = ChannelAccess()
ca_mot.assert_that_pv_exists("MOT:MTR0103", timeout=30)
ca_mot.assert_setting_setpoint_sets_readback(DEFAULT_MOTOR_RESOLUTION,
set_point_pv="MOT:MTR0103.MRES", readback_pv="MOT:MTR0103.MRES", )
self.ca = ChannelAccess(device_prefix=PREFIX)
self.ca.assert_that_pv_exists("VEL:SP", timeout=30)
class Hameg8123Tests(unittest.TestCase):
"""
Tests for the Hameg8123 IOC.
"""
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(None, DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX)
def test_GIVEN_desired_impedence_WHEN_set_impedence_THEN_readback_and_measured_impedence_are_set_to_desired_impedence(self):
expected_impedance = "50"
self.ca.assert_setting_setpoint_sets_readback(expected_impedance, "CHAN_A:IMPEDANCE:SP:RBV", "CHAN_A:IMPEDANCE:SP")
self.ca.assert_that_pv_is("CHAN_A:IMPEDANCE", expected_impedance)
class Mk2ChoprTests(unittest.TestCase):
"""
Tests for the Mk2Chopr IOC.
"""
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(
"Mk2Chopr", DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX)
def test_GIVEN_frequency_set_WHEN_read_THEN_frequency_readback_is_as_expected(
self):
test_value = 10
self.ca.set_pv_value("FREQ:SP", test_value)
self.ca.assert_setting_setpoint_sets_readback(test_value, "FREQ",
"FREQ:SP", test_value)
class SpinflipperTests(unittest.TestCase):
"""
Tests for the Spinflipper IOC.
"""
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(
"Spinflipper", DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX)
def test_GIVEN_max_guide_temp_set_WHEN_read_THEN_max_temp_is_as_expected(
self):
test_value = 150
self.ca.assert_setting_setpoint_sets_readback(test_value, "MAXTCOIL",
"MAXTCOIL:SP",
test_value)
class VerticalJawsTests(unittest.TestCase):
def set_motor_speeds(self):
self.ca.set_pv_value(UNDERLYING_MTR_NORTH + ".VMAX", 20)
self.ca.set_pv_value(UNDERLYING_MTR_NORTH + ".VELO", 20)
self.ca.set_pv_value(UNDERLYING_MTR_SOUTH + ".VMAX", 20)
self.ca.set_pv_value(UNDERLYING_MTR_SOUTH + ".VELO", 20)
"""
Tests for vertical jaws
"""
def setUp(self):
self._ioc = IOCRegister.get_running("vertical_jaws")
self.ca = ChannelAccess(default_timeout=30)
self.set_motor_speeds()
[self.ca.assert_that_pv_exists(mot) for mot in all_motors]
@parameterized.expand(parameterized_list(TEST_POSITIONS))
def test_WHEN_south_jaw_setpoint_changed_THEN_south_jaw_moves(
self, _, value):
self.ca.assert_setting_setpoint_sets_readback(value, MOTOR_S,
MOTOR_S_SP)
@parameterized.expand(parameterized_list(TEST_POSITIONS))
def test_WHEN_north_jaw_setpoint_changed_THEN_north_jaw_moves(
self, _, value):
self.ca.assert_setting_setpoint_sets_readback(value, MOTOR_N,
MOTOR_N_SP)
def test_GIVEN_jaws_closed_at_centre_WHEN_gap_opened_THEN_north_and_south_jaws_move(
self):
# GIVEN
self.ca.assert_that_pv_is("MOT:JAWS1:VGAP", 0)
self.ca.assert_that_pv_is("MOT:JAWS1:VCENT", 0)
# WHEN
self.ca.set_pv_value("MOT:JAWS1:VGAP:SP", 10)
# THEN
self.ca.assert_that_pv_is(MOTOR_S, -5)
self.ca.assert_that_pv_is(MOTOR_N, 5)
def test_GIVEN_jaws_open_WHEN_jaws_closed_THEN_jaws_close(self):
# GIVEN
self.ca.set_pv_value("MOT:JAWS1:VGAP:SP", 10)
# WHEN
self.ca.set_pv_value("MOT:JAWS1:VGAP:SP", 0)
# THEN
self.ca.assert_that_pv_is("MOT:JAWS1:VGAP", 0)
class WbvalveTests(unittest.TestCase):
"""
Tests for the Wbvalve IOC.
"""
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(
emulator_name, DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX)
self._lewis.backdoor_run_function_on_device('reset')
@parameterized.expand(['J1', 'J2'])
@skip_if_recsim("Recsim behaviour not defined")
def test_GIVEN_an_ioc_WHEN_set_valve_to_wb1on_THEN_status_is_wb1on(
self, expected_value):
self.ca.assert_setting_setpoint_sets_readback(expected_value, 'POS')
@skip_if_recsim("Can not test disconnection in rec sim")
def test_GIVEN_device_not_connected_WHEN_get_status_THEN_alarm(self):
self._lewis.backdoor_set_on_device('connected', False)
self.ca.assert_that_pv_alarm_is('POS', ChannelAccess.Alarms.INVALID)
class NeoceraTests(unittest.TestCase):
"""
Tests for the Neocera.
"""
def setUp(self):
self._ioc = IOCRegister.get_running(DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX)
def test_WHEN_ioc_is_started_THEN_ioc_is_not_disabled(self):
self.ca.assert_that_pv_is("DISABLE", "COMMS ENABLED")
def test_WHEN_units_mode_is_set_THEN_units_mode_readback_is_the_value_just_set(
self):
for mode in ["Monitor", "Control"]:
self.ca.assert_setting_setpoint_sets_readback(mode, "MODE")
def test_WHEN_temperatue_setpoint_is_set_THEN_readback_updates_to_the_value_just_set(
self):
for sensor, value in itertools.product(SENSORS, TEST_VALUES):
self.ca.assert_setting_setpoint_sets_readback(
value,
set_point_pv="{}:TEMP:SP".format(sensor),
readback_pv="{}:TEMP:SP:RBV".format(sensor))
def test_WHEN_pid_settings_are_set_THEN_readbacks_update_to_the_values_just_set(
self):
for sensor, value, control in itertools.product(
SENSORS, TEST_VALUES, ["P", "I", "D"]):
self.ca.assert_setting_setpoint_sets_readback(
value, "{}:{}".format(sensor, control))
class EgxcolimTests(unittest.TestCase):
"""
Tests for the egxcolim IOC.
"""
directions = ["NORTH", "SOUTH"]
axes = ["X"]
def setUp(self):
self._ioc = IOCRegister.get_running(DEVICE_PREFIX)
self.ca = ChannelAccess(20, device_prefix=DEVICE_PREFIX)
self.ca.assert_that_pv_exists("DISABLE", timeout=30)
def test_WHEN_ioc_is_started_THEN_ioc_is_not_disabled(self):
self.ca.assert_that_pv_is("DISABLE", "COMMS ENABLED")
def test_WHEN_setpoint_is_set_THEN_readback_updates(self):
for direction in self.directions:
for axis in self.axes:
self.ca.assert_setting_setpoint_sets_readback(
123, "{direction}:{axis}".format(direction=direction,
axis=axis))
class Wm323Tests(unittest.TestCase):
"""
Tests for the wm323 IOC.
"""
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(
"wm323", DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX,
default_timeout=20)
self.ca.assert_that_pv_exists("DISABLE")
def test_WHEN_ioc_is_started_THEN_it_is_not_disabled(self):
self.ca.assert_that_pv_is("DISABLE", "COMMS ENABLED")
@skip_if_recsim("Requires emulator logic so not supported in RECSIM")
def test_WHEN_ioc_is_started_THEN_pump_type_pv_correct(self):
self.ca.assert_that_pv_is("TYPE", "323Du")
@parameterized.expand([('On low limit', SPEED_LOW_LIMIT),
('Intermediate value', 42),
('On high limit', SPEED_HIGH_LIMIT)])
def test_WHEN_speed_setpoint_is_sent_THEN_readback_updates(self, _, value):
self.ca.assert_setting_setpoint_sets_readback(value, 'SPEED')
@parameterized.expand([('Low limit', SPEED_LOW_LIMIT, SPEED_LOW_LIMIT - 1),
('High limit', SPEED_HIGH_LIMIT,
SPEED_HIGH_LIMIT + 1)])
def test_WHEN_speed_setpoint_is_set_outside_max_limits_THEN_setpoint_within(
self, _, limit, value):
self.ca.set_pv_value("SPEED:SP", value)
self.ca.assert_that_pv_is("SPEED:SP", limit)
def test_WHEN_direction_setpoint_is_sent_THEN_readback_updates(self):
for mode in ["Clockwise", "Anti-Clockwise"]:
self.ca.assert_setting_setpoint_sets_readback(mode, "DIRECTION")
def test_WHEN_status_setpoint_is_sent_THEN_readback_updates(self):
for mode in ["Running", "Stopped"]:
self.ca.assert_setting_setpoint_sets_readback(mode, "STATUS")
@skip_if_recsim("Requires emulator logic so not supported in RECSIM")
def test_GIVEN_pump_off_WHEN_set_pump_on_THEN_pump_turned_on(self):
self.ca.set_pv_value("RUN:SP", "Run")
self.ca.assert_that_pv_is("STATUS", "Running")
@skip_if_recsim("Requires emulator logic so not supported in RECSIM")
def test_GIVEN_pump_on_WHEN_set_pump_off_THEN_pump_paused(self):
self.ca.set_pv_value("RUN:SP", "Run")
self.ca.assert_that_pv_is("STATUS", "Running")
self.ca.set_pv_value("STOP:SP", "Stop")
self.ca.assert_that_pv_is("STATUS", "Stopped")
class Ilm200Tests(unittest.TestCase):
"""
Tests for the Ilm200 IOC.
"""
DEFAULT_SCAN_RATE = 1
SLOW = "Slow"
FAST = "Fast"
LEVEL_TOLERANCE = 0.1
FULL = 100.0
LOW = 10.0
FILL = 5.0
RATE = "RATE"
LEVEL = "LEVEL"
TYPE = "TYPE"
CURRENT = "CURR"
@staticmethod
def channel_range():
number_of_channels = 3
starting_index = 1
return range(starting_index, starting_index + number_of_channels)
def helium_channels(self):
for i in self.channel_range():
if self.ca.get_pv_value(self.ch_pv(i, self.TYPE)) != "Nitrogen":
yield i
@staticmethod
def ch_pv(channel, pv):
return "CH{}:{}".format(channel, pv)
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc("ilm200", DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX, default_wait_time=0.0)
self.ca.assert_that_pv_exists("VERSION", timeout=30)
self._lewis.backdoor_set_on_device("cycle", False)
self._lewis.backdoor_run_function_on_device("set_cryo_type", (1, Ilm200ChannelTypes.NITROGEN))
self._lewis.backdoor_run_function_on_device("set_cryo_type", (2, Ilm200ChannelTypes.HELIUM))
self._lewis.backdoor_run_function_on_device("set_cryo_type", (3, Ilm200ChannelTypes.HELIUM_CONT))
def set_level_via_backdoor(self, channel, level):
self._lewis.backdoor_command(["device", "set_level", str(channel), str(level)])
def set_helium_current_via_backdoor(self, channel, is_on):
self._lewis.backdoor_command(["device", "set_helium_current", str(channel), str(is_on)])
def check_state(self, channel, level, is_filling, is_low):
self.ca.assert_that_pv_is_number(self.ch_pv(channel, self.LEVEL), level, self.LEVEL_TOLERANCE)
self.ca.assert_that_pv_is(self.ch_pv(channel, "FILLING"), "Filling" if is_filling else "Not filling")
self.ca.assert_that_pv_is(self.ch_pv(channel, "LOW"), "Low" if is_low else "Not low")
def test_GIVEN_ilm200_THEN_has_version(self):
self.ca.assert_that_pv_is_not("VERSION", "")
self.ca.assert_that_pv_alarm_is("VERSION", self.ca.Alarms.NONE)
def test_GIVEN_ilm200_THEN_each_channel_has_type(self):
for i in self.channel_range():
self.ca.assert_that_pv_is_not(self.ch_pv(i, self.TYPE), "Not in use")
self.ca.assert_that_pv_alarm_is(self.ch_pv(i, self.TYPE), self.ca.Alarms.NONE)
def set_and_check_level(self):
for i in self.channel_range():
level = ALARM_THRESHOLDS[i] + 10
self.set_level_via_backdoor(i, level)
self.ca.assert_that_pv_is_number(self.ch_pv(i, self.LEVEL), level, tolerance=0.1)
self.ca.assert_that_pv_alarm_is(self.ch_pv(i, self.LEVEL), self.ca.Alarms.NONE)
@skip_if_recsim("no backdoor in recsim")
def test_GIVEN_ilm_200_THEN_can_read_level(self):
self.set_and_check_level()
@skip_if_recsim("no backdoor in recsim")
def test_GIVEN_ilm_200_non_isobus_THEN_can_read_level(self):
with self._ioc.start_with_macros({"USE_ISOBUS": "NO"}, pv_to_wait_for="VERSION"):
self.set_and_check_level()
@skip_if_recsim("Cannot do back door of dynamic behaviour in recsim")
def test_GIVEN_ilm_200_WHEN_level_set_on_device_THEN_reported_level_matches_set_level(self):
for i in self.channel_range():
expected_level = i*12.3
self.set_level_via_backdoor(i, expected_level)
self.ca.assert_that_pv_is_number(self.ch_pv(i, self.LEVEL), expected_level, self.LEVEL_TOLERANCE)
@skip_if_recsim("No dynamic behaviour recsim")
def test_GIVEN_ilm_200_WHEN_is_cycling_THEN_channel_levels_change_over_time(self):
self._lewis.backdoor_set_on_device("cycle", True)
for i in self.channel_range():
def not_equal(a, b):
tolerance = self.LEVEL_TOLERANCE
return abs(a-b)/(a+b+tolerance) > tolerance
self.ca.assert_that_pv_value_over_time_satisfies_comparator(self.ch_pv(i, self.LEVEL), 2 * Ilm200Tests.DEFAULT_SCAN_RATE, not_equal)
def test_GIVEN_ilm200_channel_WHEN_rate_change_requested_THEN_rate_changed(self):
for i in self.channel_range():
initial_rate = self.ca.get_pv_value(self.ch_pv(i, self.RATE))
alternate_rate = self.SLOW if initial_rate == self.FAST else self.SLOW
self.ca.assert_setting_setpoint_sets_readback(alternate_rate, self.ch_pv(i, self.RATE))
self.ca.assert_setting_setpoint_sets_readback(initial_rate, self.ch_pv(i, self.RATE))
def test_GIVEN_ilm200_channel_WHEN_rate_set_to_current_value_THEN_rate_unchanged(self):
for i in self.channel_range():
self.ca.assert_setting_setpoint_sets_readback(self.ca.get_pv_value(self.ch_pv(i, self.RATE)),
self.ch_pv(i, self.RATE))
@skip_if_recsim("Cannot do back door of dynamic behaviour in recsim")
def test_GIVEN_ilm200_WHEN_channel_full_THEN_not_filling_and_not_low(self):
for i in self.channel_range():
level = self.FULL
self.set_level_via_backdoor(i, level)
self.check_state(i, level, False, False)
@skip_if_recsim("Cannot do back door of dynamic behaviour in recsim")
def test_GIVEN_ilm200_WHEN_channel_low_but_auto_fill_not_triggered_THEN_not_filling_and_low(self):
for i in self.channel_range():
level = self.LOW - (self.LOW - self.FILL)/2 # Somewhere between fill and low
self.set_level_via_backdoor(i, level)
self.check_state(i, level, False, True)
@skip_if_recsim("Cannot do back door of dynamic behaviour in recsim")
def test_GIVEN_ilm200_WHEN_channel_low_but_and_auto_fill_triggered_THEN_filling_and_low(self):
for i in self.channel_range():
level = self.FILL/2
self.set_level_via_backdoor(i, level)
self.check_state(i, level, True, True)
@skip_if_recsim("Cannot do back door of dynamic behaviour in recsim")
def test_GIVEN_ilm200_WHEN_channel_low_THEN_alarm(self):
for i in self.channel_range():
level = self.FILL/2
self.set_level_via_backdoor(i, level)
self.ca.assert_that_pv_alarm_is(self.ch_pv(i, "LOW"), self.ca.Alarms.MINOR)
@skip_if_recsim("Cannot do back door in recsim")
def test_GIVEN_helium_channel_WHEN_helium_current_set_on_THEN_ioc_reports_current(self):
for i in self.helium_channels():
self.set_helium_current_via_backdoor(i, True)
self.ca.assert_that_pv_is(self.ch_pv(i, self.CURRENT), "On")
@skip_if_recsim("Cannot do back door in recsim")
def test_GIVEN_helium_channel_WHEN_helium_current_set_off_THEN_ioc_reports_no_current(self):
for i in self.helium_channels():
self.set_helium_current_via_backdoor(i, False)
self.ca.assert_that_pv_is(self.ch_pv(i, self.CURRENT), "Off")
@skip_if_recsim("cannot do back door in recsim")
def test_GIVEN_not_in_use_channel_THEN_being_in_neither_fast_nor_slow_mode_does_not_cause_alarm(self):
self._lewis.backdoor_run_function_on_device("set_cryo_type", (1, Ilm200ChannelTypes.NOT_IN_USE))
# Assert in neither fast nor slow mode
self.ca.assert_that_pv_is(self.ch_pv(1, "STAT:RAW.B1"), "0")
self.ca.assert_that_pv_is(self.ch_pv(1, "STAT:RAW.B2"), "0")
# Assert that this does not cause an alarm
self.ca.assert_that_pv_alarm_is(self.ch_pv(1, "RATE:ASSERT"), self.ca.Alarms.NONE)
@skip_if_recsim("no backdoor in recsim")
def test_GIVEN_level_reading_is_below_threshold_THEN_goes_into_alarm(self):
for channel in self.channel_range():
self.set_level_via_backdoor(channel, ALARM_THRESHOLDS[channel] + 0.1)
self.ca.assert_that_pv_alarm_is(self.ch_pv(channel, "LEVEL"), self.ca.Alarms.NONE)
self.set_level_via_backdoor(channel, ALARM_THRESHOLDS[channel] - 0.1)
self.ca.assert_that_pv_alarm_is(self.ch_pv(channel, "LEVEL"), self.ca.Alarms.MAJOR)
class ZeroFieldTests(unittest.TestCase):
"""
Tests for the muon zero field controller IOC.
"""
def _set_simulated_measured_fields(self,
fields,
overload=False,
wait_for_update=True):
"""
Args:
fields (dict[AnyStr, float]): A dictionary with the same keys as FIELD_AXES and values corresponding to the
required fields
overload (bool): whether to simulate the magnetometer being overloaded
wait_for_update (bool): whether to wait for the statemachine to pick up the new readings
"""
for axis in FIELD_AXES:
self.magnetometer_ca.set_pv_value("SIM:DAQ:{}".format(axis),
fields[axis],
sleep_after_set=0)
# Just overwrite the calculation to return a constant as we are not interested in testing the
# overload logic in the magnetometer in these tests (that logic is tested separately).
self.magnetometer_ca.set_pv_value("OVERLOAD:_CALC.CALC",
"1" if overload else "0",
sleep_after_set=0)
if wait_for_update:
for axis in FIELD_AXES:
self.zfcntrl_ca.assert_that_pv_is("FIELD:{}".format(axis),
fields[axis])
self.zfcntrl_ca.assert_that_pv_is("FIELD:{}:MEAS".format(axis),
fields[axis])
def _set_user_setpoints(self, fields):
"""
Args:
fields (dict[AnyStr, float]): A dictionary with the same keys as FIELD_AXES and values corresponding to the
required fields
"""
for axis in FIELD_AXES:
self.zfcntrl_ca.set_pv_value("FIELD:{}:SP".format(axis),
fields[axis],
sleep_after_set=0)
def _set_simulated_power_supply_currents(self,
currents,
wait_for_update=True):
"""
Args:
currents (dict[AnyStr, float]): A dictionary with the same keys as FIELD_AXES and values corresponding to
the required currents
wait_for_update (bool): whether to wait for the readback and setpoint readbacks to update
"""
for axis in FIELD_AXES:
self.zfcntrl_ca.set_pv_value("OUTPUT:{}:CURR:SP".format(axis),
currents[axis],
sleep_after_set=0)
if wait_for_update:
for axis in FIELD_AXES:
self.zfcntrl_ca.assert_that_pv_is(
"OUTPUT:{}:CURR".format(axis), currents[axis])
self.zfcntrl_ca.assert_that_pv_is(
"OUTPUT:{}:CURR:SP:RBV".format(axis), currents[axis])
def _set_simulated_power_supply_voltages(self,
voltages,
wait_for_update=True):
"""
Args:
voltages (dict[AnyStr, float]): A dictionary with the same keys as FIELD_AXES and values corresponding to
the required voltages
wait_for_update (bool): whether to wait for the readback and setpoint readbacks to update
"""
for axis in FIELD_AXES:
self.zfcntrl_ca.set_pv_value("OUTPUT:{}:VOLT:SP".format(axis),
voltages[axis],
sleep_after_set=0)
if wait_for_update:
for axis in FIELD_AXES:
self.zfcntrl_ca.assert_that_pv_is(
"OUTPUT:{}:VOLT".format(axis), voltages[axis])
self.zfcntrl_ca.assert_that_pv_is(
"OUTPUT:{}:VOLT:SP:RBV".format(axis), voltages[axis])
def _assert_at_setpoint(self, status):
"""
Args:
status (string): value of AT_SETPOINT PV (either Yes, No or N/A)
"""
self.zfcntrl_ca.assert_that_pv_is("AT_SETPOINT", status)
def _assert_status(self, status):
"""
Args:
status (Tuple[str, str]): the controller status and error to assert.
"""
name, expected_alarm = status
# Special case - this alarm should be suppressed in manual mode. This is because, in manual mode, the
# scientists will intentionally apply large fields (which overload the magnetometer), but they do not want
# alarms for this case as it is a "normal" mode of operation.
if name == Statuses.MAGNETOMETER_OVERLOAD[
0] and self.zfcntrl_ca.get_pv_value(
"AUTOFEEDBACK") == "Manual":
expected_alarm = self.zfcntrl_ca.Alarms.NONE
self.zfcntrl_ca.assert_that_pv_is("STATUS", name)
self.zfcntrl_ca.assert_that_pv_alarm_is("STATUS", expected_alarm)
def _set_autofeedback(self, autofeedback):
self.zfcntrl_ca.set_pv_value(
"AUTOFEEDBACK", "Auto-feedback" if autofeedback else "Manual")
def _set_scaling_factors(self, px, py, pz, fiddle):
"""
Args:
px (float): Amps per mG for the X axis.
py (float): Amps per mG for the Y axis.
pz (float): Amps per mG for the Z axis.
fiddle (float): The feedback (sometimes called "fiddle") factor.
"""
self.zfcntrl_ca.set_pv_value("P:X", px, sleep_after_set=0)
self.zfcntrl_ca.set_pv_value("P:Y", py, sleep_after_set=0)
self.zfcntrl_ca.set_pv_value("P:Z", pz, sleep_after_set=0)
self.zfcntrl_ca.set_pv_value("P:FEEDBACK", fiddle, sleep_after_set=0)
def _set_output_limits(self, lower_limits, upper_limits):
"""
Args:
lower_limits (dict[AnyStr, float]): A dictionary with the same keys as FIELD_AXES and values corresponding to
the required output lower limits
upper_limits (dict[AnyStr, float]): A dictionary with the same keys as FIELD_AXES and values corresponding to
the required output upper limits
"""
for axis in FIELD_AXES:
self.zfcntrl_ca.set_pv_value("OUTPUT:{}:CURR:SP.DRVL".format(axis),
lower_limits[axis],
sleep_after_set=0)
self.zfcntrl_ca.set_pv_value("OUTPUT:{}:CURR:SP.LOLO".format(axis),
lower_limits[axis],
sleep_after_set=0)
self.zfcntrl_ca.set_pv_value("OUTPUT:{}:CURR:SP.DRVH".format(axis),
upper_limits[axis],
sleep_after_set=0)
self.zfcntrl_ca.set_pv_value("OUTPUT:{}:CURR:SP.HIHI".format(axis),
upper_limits[axis],
sleep_after_set=0)
self.zfcntrl_ca.set_pv_value("OUTPUT:{}:CURR.LOLO".format(axis),
lower_limits[axis],
sleep_after_set=0)
self.zfcntrl_ca.set_pv_value("OUTPUT:{}:CURR.HIHI".format(axis),
upper_limits[axis],
sleep_after_set=0)
self.zfcntrl_ca.set_pv_value(
"OUTPUT:{}:CURR:SP:RBV.LOLO".format(axis),
lower_limits[axis],
sleep_after_set=0)
self.zfcntrl_ca.set_pv_value(
"OUTPUT:{}:CURR:SP:RBV.HIHI".format(axis),
upper_limits[axis],
sleep_after_set=0)
@contextlib.contextmanager
def _simulate_disconnected_magnetometer(self):
"""
While this context manager is active, the magnetometer IOC will fail to take any new readings or process any PVs
"""
self.magnetometer_ca.set_pv_value("DISABLE", 1, sleep_after_set=0)
try:
yield
finally:
self.magnetometer_ca.set_pv_value("DISABLE", 0, sleep_after_set=0)
@contextlib.contextmanager
def _simulate_invalid_magnetometer_readings(self):
"""
While this context manager is active, any new readings from the magnetometer will be marked as INVALID
"""
for axis in FIELD_AXES:
self.magnetometer_ca.set_pv_value(
"DAQ:{}:_RAW.SIMS".format(axis),
self.magnetometer_ca.Alarms.INVALID,
sleep_after_set=0)
# Wait for RAW PVs to process
for axis in FIELD_AXES:
self.magnetometer_ca.assert_that_pv_alarm_is(
"DAQ:{}:_RAW.SEVR".format(axis),
self.magnetometer_ca.Alarms.INVALID)
try:
yield
finally:
for axis in FIELD_AXES:
self.magnetometer_ca.set_pv_value(
"DAQ:{}:_RAW.SIMS".format(axis),
self.magnetometer_ca.Alarms.NONE,
sleep_after_set=0)
# Wait for RAW PVs to process
for axis in FIELD_AXES:
self.magnetometer_ca.assert_that_pv_alarm_is(
"DAQ:{}:_RAW.SEVR".format(axis),
self.magnetometer_ca.Alarms.NONE)
@contextlib.contextmanager
def _simulate_invalid_power_supply(self):
"""
While this context manager is active, the readback values from all power supplies will be marked as INVALID
(this simulates the device not being plugged in, for example)
"""
pvs_to_make_invalid = ("CURRENT", "_CURRENT:SP:RBV", "OUTPUTMODE",
"OUTPUTSTATUS", "VOLTAGE", "VOLTAGE:SP:RBV")
for ca, pv in itertools.product(
(self.x_psu_ca, self.y_psu_ca, self.z_psu_ca),
pvs_to_make_invalid):
# 3 is the Enum value for an invalid alarm
ca.set_pv_value("{}.SIMS".format(pv), 3, sleep_after_set=0)
# Use a separate loop to avoid needing to wait for a 1-second scan 6 times.
for ca, pv in itertools.product(
(self.x_psu_ca, self.y_psu_ca, self.z_psu_ca),
pvs_to_make_invalid):
ca.assert_that_pv_alarm_is(pv, ca.Alarms.INVALID)
try:
yield
finally:
for ca, pv in itertools.product(
(self.x_psu_ca, self.y_psu_ca, self.z_psu_ca),
pvs_to_make_invalid):
ca.set_pv_value("{}.SIMS".format(pv), 0, sleep_after_set=0)
# Use a separate loop to avoid needing to wait for a 1-second scan 6 times.
for ca, pv in itertools.product(
(self.x_psu_ca, self.y_psu_ca, self.z_psu_ca),
pvs_to_make_invalid):
ca.assert_that_pv_alarm_is(pv, ca.Alarms.NONE)
@contextlib.contextmanager
def _simulate_failing_power_supply_writes(self):
"""
While this context manager is active, any writes to the power supply PVs will be ignored. This simulates the
device being in local mode, for example. Note that this does not mark readbacks as invalid (for that, use
_simulate_invalid_power_supply instead).
"""
pvs = [
"CURRENT:SP.DISP", "VOLTAGE:SP.DISP", "OUTPUTMODE:SP.DISP",
"OUTPUTSTATUS:SP.DISP"
]
for ca, pv in itertools.product(
(self.x_psu_ca, self.y_psu_ca, self.z_psu_ca), pvs):
ca.set_pv_value(pv, 1, sleep_after_set=0)
try:
yield
finally:
for ca, pv in itertools.product(
(self.x_psu_ca, self.y_psu_ca, self.z_psu_ca), pvs):
ca.set_pv_value(pv, 0, sleep_after_set=0)
@contextlib.contextmanager
def _simulate_measured_fields_changing_with_outputs(
self, psu_amps_at_measured_zero):
"""
Calculates and sets somewhat realistic simulated measured fields based on the current values of power supplies.
Args:
psu_amps_at_measured_zero: Dictionary containing the Amps of the power supplies when the measured field
corresponds to zero. i.e. if the system is told to go to zero field, these are the power supply readings
it will require to get there.
"""
# Always start at zero current
self._set_simulated_power_supply_currents({"X": 0, "Y": 0, "Z": 0})
thread = multiprocessing.Process(target=_update_fields_continuously,
args=(psu_amps_at_measured_zero, ))
thread.start()
try:
yield
finally:
thread.terminate()
def _wait_for_all_iocs_up(self):
"""
Waits for the "primary" pv(s) from each ioc to be available
"""
for ca in (self.x_psu_ca, self.y_psu_ca, self.z_psu_ca):
ca.assert_that_pv_exists("CURRENT")
ca.assert_that_pv_exists("CURRENT:SP")
ca.assert_that_pv_exists("CURRENT:SP:RBV")
for axis in FIELD_AXES:
self.zfcntrl_ca.assert_that_pv_exists("FIELD:{}".format(axis))
self.magnetometer_ca.assert_that_pv_exists(
"CORRECTEDFIELD:{}".format(axis))
def setUp(self):
_, self._ioc = get_running_lewis_and_ioc(None, ZF_DEVICE_PREFIX)
timeout = 20
self.zfcntrl_ca = ChannelAccess(device_prefix=ZF_DEVICE_PREFIX,
default_timeout=timeout)
self.magnetometer_ca = ChannelAccess(
device_prefix=MAGNETOMETER_DEVICE_PREFIX, default_timeout=timeout)
self.x_psu_ca = ChannelAccess(default_timeout=timeout,
device_prefix=X_KEPCO_DEVICE_PREFIX)
self.y_psu_ca = ChannelAccess(default_timeout=timeout,
device_prefix=Y_KEPCO_DEVICE_PREFIX)
self.z_psu_ca = ChannelAccess(default_timeout=timeout,
device_prefix=Z_KEPCO_DEVICE_PREFIX)
self._wait_for_all_iocs_up()
self.zfcntrl_ca.set_pv_value("TOLERANCE",
STABILITY_TOLERANCE,
sleep_after_set=0)
self.zfcntrl_ca.set_pv_value("STATEMACHINE:LOOP_DELAY",
LOOP_DELAY_MS,
sleep_after_set=0)
self._set_autofeedback(False)
# Set the magnetometer calibration to the 3x3 identity matrix
for x, y in itertools.product(range(1, 3 + 1), range(1, 3 + 1)):
self.magnetometer_ca.set_pv_value("SENSORMATRIX:{}{}".format(x, y),
1 if x == y else 0,
sleep_after_set=0)
self._set_simulated_measured_fields(ZERO_FIELD, overload=False)
self._set_user_setpoints(ZERO_FIELD)
self._set_simulated_power_supply_currents(ZERO_FIELD,
wait_for_update=True)
self._set_scaling_factors(1, 1, 1, 1)
self._set_output_limits(
lower_limits={
"X": DEFAULT_LOW_OUTPUT_LIMIT,
"Y": DEFAULT_LOW_OUTPUT_LIMIT,
"Z": DEFAULT_LOW_OUTPUT_LIMIT
},
upper_limits={
"X": DEFAULT_HIGH_OUTPUT_LIMIT,
"Y": DEFAULT_HIGH_OUTPUT_LIMIT,
"Z": DEFAULT_HIGH_OUTPUT_LIMIT
},
)
self._assert_at_setpoint(AtSetpointStatuses.NA)
self._assert_status(Statuses.NO_ERROR)
def test_WHEN_ioc_is_started_THEN_it_is_not_disabled(self):
self.zfcntrl_ca.assert_that_pv_is("DISABLE", "COMMS ENABLED")
@parameterized.expand(parameterized_list(FIELD_AXES))
def test_WHEN_manual_mode_and_any_readback_value_is_not_equal_to_setpoint_THEN_at_setpoint_field_is_na(
self, _, axis_to_vary):
fields = {"X": 10, "Y": 20, "Z": 30}
self._set_simulated_measured_fields(fields, overload=False)
self._set_user_setpoints(fields)
# Set one of the parameters to a completely different value
self.zfcntrl_ca.set_pv_value("FIELD:{}:SP".format(axis_to_vary),
100,
sleep_after_set=0)
self._assert_at_setpoint(AtSetpointStatuses.NA)
self._assert_status(Statuses.NO_ERROR)
def test_GIVEN_manual_mode_and_magnetometer_not_overloaded_WHEN_readback_values_are_equal_to_setpoints_THEN_at_setpoint_field_is_na(
self):
fields = {"X": 55, "Y": 66, "Z": 77}
self._set_simulated_measured_fields(fields, overload=False)
self._set_user_setpoints(fields)
self._assert_at_setpoint(AtSetpointStatuses.NA)
self._assert_status(Statuses.NO_ERROR)
def test_GIVEN_manual_mode_and_within_tolerance_WHEN_magnetometer_is_overloaded_THEN_status_overloaded_and_setpoint_field_is_na(
self):
fields = {"X": 55, "Y": 66, "Z": 77}
self._set_simulated_measured_fields(fields, overload=True)
self._set_user_setpoints(fields)
self._assert_at_setpoint(AtSetpointStatuses.NA)
self._assert_status(Statuses.MAGNETOMETER_OVERLOAD)
def test_GIVEN_manual_mode_and_just_outside_tolerance_WHEN_magnetometer_is_overloaded_THEN_status_overloaded_and_setpoint_field_is_na(
self):
fields = {"X": 55, "Y": 66, "Z": 77}
self._set_simulated_measured_fields(fields, overload=True)
self._set_user_setpoints({
k: v + 1.01 * STABILITY_TOLERANCE
for k, v in six.iteritems(fields)
})
self._assert_at_setpoint(AtSetpointStatuses.NA)
self._assert_status(Statuses.MAGNETOMETER_OVERLOAD)
def test_GIVEN_manual_mode_and_just_within_tolerance_WHEN_magnetometer_is_overloaded_THEN_status_overloaded_and_setpoint_field_is_na(
self):
fields = {"X": 55, "Y": 66, "Z": 77}
self._set_simulated_measured_fields(fields, overload=True)
self._set_user_setpoints({
k: v + 0.99 * STABILITY_TOLERANCE
for k, v in six.iteritems(fields)
})
self._assert_at_setpoint(AtSetpointStatuses.NA)
self._assert_status(Statuses.MAGNETOMETER_OVERLOAD)
def test_WHEN_magnetometer_ioc_does_not_respond_THEN_status_is_magnetometer_read_error(
self):
fields = {"X": 1, "Y": 2, "Z": 3}
self._set_simulated_measured_fields(fields, overload=False)
self._set_user_setpoints(fields)
with self._simulate_disconnected_magnetometer():
self._assert_status(Statuses.MAGNETOMETER_READ_ERROR)
for axis in FIELD_AXES:
self.zfcntrl_ca.assert_that_pv_alarm_is(
"FIELD:{}".format(axis), self.zfcntrl_ca.Alarms.INVALID)
self.zfcntrl_ca.assert_that_pv_alarm_is(
"FIELD:{}:MEAS".format(axis),
self.zfcntrl_ca.Alarms.INVALID)
# Now simulate recovery and assert error gets cleared correctly
self._assert_status(Statuses.NO_ERROR)
for axis in FIELD_AXES:
self.zfcntrl_ca.assert_that_pv_alarm_is(
"FIELD:{}".format(axis), self.zfcntrl_ca.Alarms.NONE)
self.zfcntrl_ca.assert_that_pv_alarm_is(
"FIELD:{}:MEAS".format(axis), self.zfcntrl_ca.Alarms.NONE)
def test_WHEN_magnetometer_ioc_readings_are_invalid_THEN_status_is_magnetometer_invalid(
self):
fields = {"X": 1, "Y": 2, "Z": 3}
self._set_simulated_measured_fields(fields, overload=False)
self._set_user_setpoints(fields)
with self._simulate_invalid_magnetometer_readings():
self._assert_status(Statuses.MAGNETOMETER_DATA_INVALID)
for axis in FIELD_AXES:
self.zfcntrl_ca.assert_that_pv_alarm_is(
"FIELD:{}".format(axis), self.zfcntrl_ca.Alarms.INVALID)
self.zfcntrl_ca.assert_that_pv_alarm_is(
"FIELD:{}:MEAS".format(axis),
self.zfcntrl_ca.Alarms.INVALID)
# Now simulate recovery and assert error gets cleared correctly
self._assert_status(Statuses.NO_ERROR)
for axis in FIELD_AXES:
self.zfcntrl_ca.assert_that_pv_alarm_is(
"FIELD:{}".format(axis), self.zfcntrl_ca.Alarms.NONE)
self.zfcntrl_ca.assert_that_pv_alarm_is(
"FIELD:{}:MEAS".format(axis), self.zfcntrl_ca.Alarms.NONE)
def test_WHEN_power_supplies_are_invalid_THEN_status_is_power_supplies_invalid(
self):
fields = {"X": 1, "Y": 2, "Z": 3}
self._set_simulated_measured_fields(fields, overload=False)
self._set_user_setpoints(fields)
self._set_autofeedback(True)
with self._simulate_invalid_power_supply():
self._assert_at_setpoint(
AtSetpointStatuses.TRUE
) # Invalid power supplies do not mark the field as "not at setpoint"
self._assert_status(Statuses.PSU_INVALID)
# Now simulate recovery and assert error gets cleared correctly
self._assert_at_setpoint(AtSetpointStatuses.TRUE)
self._assert_status(Statuses.NO_ERROR)
def test_WHEN_power_supplies_writes_fail_THEN_status_is_power_supply_writes_failed(
self):
fields = {"X": 1, "Y": 2, "Z": 3}
self._set_simulated_measured_fields(fields, overload=False)
# For this test we need changing fields so that we can detect that the writes failed
self._set_user_setpoints({
k: v + 10 * STABILITY_TOLERANCE
for k, v in six.iteritems(fields)
})
# ... and we also need large limits so that we see that the writes failed as opposed to a limits error
self._set_output_limits(lower_limits={k: -999999
for k in FIELD_AXES},
upper_limits={k: 999999
for k in FIELD_AXES})
self._set_autofeedback(True)
with self._simulate_failing_power_supply_writes():
self._assert_status(Statuses.PSU_WRITE_FAILED)
# Now simulate recovery and assert error gets cleared correctly
self._assert_status(Statuses.NO_ERROR)
def test_GIVEN_measured_field_and_setpoints_are_identical_THEN_setpoints_remain_unchanged(
self):
fields = {"X": 5, "Y": 10, "Z": -5}
outputs = {"X": -1, "Y": -2, "Z": -3}
self._set_simulated_measured_fields(fields, overload=False)
self._set_user_setpoints(fields)
self._set_simulated_power_supply_currents(outputs,
wait_for_update=True)
self._set_autofeedback(True)
for axis in FIELD_AXES:
self.zfcntrl_ca.assert_that_pv_is_number(
"OUTPUT:{}:CURR".format(axis), outputs[axis], tolerance=0.0001)
self.zfcntrl_ca.assert_that_pv_value_is_unchanged(
"OUTPUT:{}:CURR".format(axis), wait=5)
@parameterized.expand(
parameterized_list([
# If measured field is smaller than the setpoint, we want to adjust the output upwards to compensate
(operator.sub, operator.gt, 1),
# If measured field is larger than the setpoint, we want to adjust the output downwards to compensate
(operator.add, operator.lt, 1),
# If measured field is smaller than the setpoint, and A/mg is negative, we want to adjust the output downwards
# to compensate
(operator.sub, operator.lt, -1),
# If measured field is larger than the setpoint, and A/mg is negative, we want to adjust the output upwards
# to compensate
(operator.add, operator.gt, -1),
# If measured field is smaller than the setpoint, and A/mg is zero, then power supply output should remain
# unchanged
(operator.sub, operator.eq, 0),
# If measured field is larger than the setpoint, and A/mg is zero, then power supply output should remain
# unchanged
(operator.add, operator.eq, 0),
]))
def test_GIVEN_autofeedback_WHEN_measured_field_different_from_setpoints_THEN_power_supply_outputs_move_in_correct_direction(
self, _, measured_field_modifier, output_comparator,
scaling_factor):
fields = {"X": 5, "Y": 0, "Z": -5}
adjustment_amount = 10 * STABILITY_TOLERANCE # To ensure that it is not considered stable to start with
measured_fields = {
k: measured_field_modifier(v, adjustment_amount)
for k, v in six.iteritems(fields)
}
self._set_scaling_factors(scaling_factor,
scaling_factor,
scaling_factor,
fiddle=1)
self._set_simulated_measured_fields(measured_fields, overload=False)
self._set_user_setpoints(fields)
self._set_simulated_power_supply_currents({
"X": 0,
"Y": 0,
"Z": 0
},
wait_for_update=True)
self._set_output_limits(lower_limits={k: -999999
for k in FIELD_AXES},
upper_limits={k: 999999
for k in FIELD_AXES})
self._assert_status(Statuses.NO_ERROR)
self._set_autofeedback(True)
self._assert_at_setpoint(AtSetpointStatuses.FALSE)
for axis in FIELD_AXES:
self.zfcntrl_ca.assert_that_pv_value_over_time_satisfies_comparator(
"OUTPUT:{}:CURR".format(axis),
wait=5,
comparator=output_comparator)
# In this happy-path case, we shouldn't be hitting any long timeouts, so loop times should remain fairly quick
self.zfcntrl_ca.assert_that_pv_is_within_range(
"STATEMACHINE:LOOP_TIME", min_value=0, max_value=2 * LOOP_DELAY_MS)
def test_GIVEN_output_limits_too_small_for_required_field_THEN_status_error_and_alarm(
self):
self._set_output_limits(
lower_limits={
"X": -0.1,
"Y": -0.1,
"Z": -0.1
},
upper_limits={
"X": 0.1,
"Y": 0.1,
"Z": 0.1
},
)
# The measured field is smaller than the setpoint, i.e. the output needs to go up to the limits
self._set_simulated_measured_fields({"X": -1, "Y": -1, "Z": -1})
self._set_user_setpoints(ZERO_FIELD)
self._set_simulated_power_supply_currents(ZERO_FIELD)
self._set_autofeedback(True)
self._assert_status(Statuses.PSU_ON_LIMITS)
for axis in FIELD_AXES:
# Value should be on one of the limits
self.zfcntrl_ca.assert_that_pv_is_one_of(
"OUTPUT:{}:CURR:SP".format(axis), [-0.1, 0.1])
# ...and in alarm
self.zfcntrl_ca.assert_that_pv_alarm_is(
"OUTPUT:{}:CURR:SP".format(axis), self.zfcntrl_ca.Alarms.MAJOR)
def test_GIVEN_limits_wrong_way_around_THEN_appropriate_error_raised(self):
# Set upper limits < lower limits
self._set_output_limits(
lower_limits={
"X": 0.1,
"Y": 0.1,
"Z": 0.1
},
upper_limits={
"X": -0.1,
"Y": -0.1,
"Z": -0.1
},
)
self._set_autofeedback(True)
self._assert_status(Statuses.INVALID_PSU_LIMITS)
@parameterized.expand(
parameterized_list([
{
"X": 45.678,
"Y": 0.123,
"Z": 12.345
},
{
"X": 0,
"Y": 0,
"Z": 0
},
{
"X": -45.678,
"Y": -0.123,
"Z": -12.345
},
]))
def test_GIVEN_measured_values_updating_realistically_WHEN_in_auto_mode_THEN_converges_to_correct_answer(
self, _, psu_amps_at_zero_field):
self._set_output_limits(lower_limits={k: -100
for k in FIELD_AXES},
upper_limits={k: 100
for k in FIELD_AXES})
self._set_user_setpoints({"X": 0, "Y": 0, "Z": 0})
self._set_simulated_power_supply_currents({"X": 0, "Y": 0, "Z": 0})
# Set fiddle small to get a relatively slow response, which should theoretically be stable
self._set_scaling_factors(0.001, 0.001, 0.001, fiddle=0.05)
with self._simulate_measured_fields_changing_with_outputs(
psu_amps_at_measured_zero=psu_amps_at_zero_field):
self._set_autofeedback(True)
for axis in FIELD_AXES:
self.zfcntrl_ca.assert_that_pv_is_number(
"OUTPUT:{}:CURR:SP:RBV".format(axis),
psu_amps_at_zero_field[axis],
tolerance=STABILITY_TOLERANCE * 0.001,
timeout=60)
self.zfcntrl_ca.assert_that_pv_is_number(
"FIELD:{}".format(axis),
0.0,
tolerance=STABILITY_TOLERANCE)
self._assert_at_setpoint(AtSetpointStatuses.TRUE)
self.zfcntrl_ca.assert_that_pv_value_is_unchanged("AT_SETPOINT",
wait=20)
self._assert_status(Statuses.NO_ERROR)
@parameterized.expand(parameterized_list(FIELD_AXES))
def test_GIVEN_output_is_off_WHEN_autofeedback_switched_on_THEN_psu_is_switched_back_on(
self, _, axis):
self.zfcntrl_ca.assert_setting_setpoint_sets_readback(
"Off", "OUTPUT:{}:STATUS".format(axis))
self._set_autofeedback(True)
self.zfcntrl_ca.assert_that_pv_is("OUTPUT:{}:STATUS".format(axis),
"On")
@parameterized.expand(parameterized_list(FIELD_AXES))
def test_GIVEN_output_mode_is_voltage_WHEN_autofeedback_switched_on_THEN_psu_is_switched_to_current_mode(
self, _, axis):
self.zfcntrl_ca.assert_setting_setpoint_sets_readback(
"Voltage",
"OUTPUT:{}:MODE".format(axis),
expected_alarm=self.zfcntrl_ca.Alarms.MAJOR)
self._set_autofeedback(True)
self.zfcntrl_ca.assert_that_pv_is("OUTPUT:{}:MODE".format(axis),
"Current")
@parameterized.expand(parameterized_list(FIELD_AXES))
def test_GIVEN_output_is_off_and_cannot_write_to_psu_WHEN_autofeedback_switched_on_THEN_get_psu_write_error(
self, _, axis):
self.zfcntrl_ca.assert_setting_setpoint_sets_readback(
"Off", "OUTPUT:{}:STATUS".format(axis))
with self._simulate_failing_power_supply_writes():
self._set_autofeedback(True)
self._assert_status(Statuses.PSU_WRITE_FAILED)
# Check it can recover when writes work again
self._assert_status(Statuses.NO_ERROR)
self.zfcntrl_ca.assert_that_pv_is("OUTPUT:{}:STATUS".format(axis),
"On")
@parameterized.expand(parameterized_list(FIELD_AXES))
def test_GIVEN_output_mode_is_voltage_and_cannot_write_to_psu_WHEN_autofeedback_switched_on_THEN_get_psu_write_error(
self, _, axis):
self.zfcntrl_ca.assert_setting_setpoint_sets_readback(
"Voltage",
"OUTPUT:{}:MODE".format(axis),
expected_alarm=self.zfcntrl_ca.Alarms.MAJOR)
with self._simulate_failing_power_supply_writes():
self._set_autofeedback(True)
self._assert_status(Statuses.PSU_WRITE_FAILED)
# Check it can recover when writes work again
self._assert_status(Statuses.NO_ERROR)
self.zfcntrl_ca.assert_that_pv_is("OUTPUT:{}:MODE".format(axis),
"Current")
@parameterized.expand(
parameterized_list([
(True, True),
(False, True),
(True, False),
(False, False),
]))
def test_GIVEN_magnetometer_overloaded_THEN_error_suppressed_if_in_manual_mode(
self, _, autofeedback, overloaded):
self._set_autofeedback(autofeedback)
self._set_simulated_measured_fields(ZERO_FIELD,
overload=overloaded,
wait_for_update=True)
self._assert_status(Statuses.MAGNETOMETER_OVERLOAD
if overloaded else Statuses.NO_ERROR)
self.zfcntrl_ca.assert_that_pv_alarm_is(
"STATUS", self.zfcntrl_ca.Alarms.MAJOR
if overloaded and autofeedback else self.zfcntrl_ca.Alarms.NONE)
def test_GIVEN_power_supply_voltage_limit_is_set_incorrectly_WHEN_going_into_auto_mode_THEN_correct_limits_applied(
self):
self._set_simulated_power_supply_voltages({"X": 0, "Y": 0, "Z": 0})
self._set_autofeedback(True)
self.zfcntrl_ca.assert_that_pv_is("OUTPUT:X:VOLT:SP:RBV",
X_KEPCO_VOLTAGE_LIMIT)
self.zfcntrl_ca.assert_that_pv_is("OUTPUT:Y:VOLT:SP:RBV",
Y_KEPCO_VOLTAGE_LIMIT)
self.zfcntrl_ca.assert_that_pv_is("OUTPUT:Z:VOLT:SP:RBV",
Z_KEPCO_VOLTAGE_LIMIT)
class JulaboTests(unittest.TestCase):
"""
Tests for the Julabo IOC.
"""
TEMP_TOLERANCE = 0.005
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(
"julabo", "JULABO_01")
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX)
self.ca.assert_that_pv_exists("TEMP", timeout=30)
# Turn off circulate
self.ca.set_pv_value("MODE:SP", 0)
def test_set_new_temperature_sets_setpoint_readback_correctly(self):
# Get current temp
start_t = self.ca.get_pv_value("TEMP")
# Set new temp via SP
self.ca.set_pv_value("TEMP:SP", start_t + 5)
# Check SP RBV matches new temp
self.ca.assert_that_pv_is_number("TEMP:SP:RBV", start_t + 5)
@skip_if_recsim("In rec sim this test fails")
def test_setting_temperature_above_high_limit_does_not_set_value(self):
# Get current temp sp rbv
start_t = self.ca.get_pv_value("TEMP:SP:RBV")
# Get high limit
high_t = self.ca.get_pv_value("HIGHLIMIT")
# Set new temp to above high limit
self.ca.set_pv_value("TEMP:SP", high_t + 5)
# Check SP RBV hasn't changed
self.ca.assert_that_pv_is_number("TEMP:SP:RBV", start_t)
@skip_if_recsim("In rec sim this test fails")
def test_setting_temperature_below_low_limit_does_not_set_value(self):
# Get current temp sp rbv
start_t = self.ca.get_pv_value("TEMP:SP:RBV")
# Get low limit
low_t = self.ca.get_pv_value("LOWLIMIT")
# Set new temp to above high limit
self.ca.set_pv_value("TEMP:SP", low_t - 5)
# Check SP RBV hasn't changed
self.ca.assert_that_pv_is_number("TEMP:SP:RBV", start_t)
@skip_if_recsim("In rec sim this test fails")
def test_set_new_temperature_with_circulate_off_means_temperature_remains_unchanged(
self):
# Get current temp
start_t = self.ca.get_pv_value("TEMP")
# Set new temp via SP
self.ca.set_pv_value("TEMP:SP", start_t + 5)
# Check temp hasn't changed
self.ca.assert_that_pv_is_number("TEMP",
start_t,
tolerance=self.TEMP_TOLERANCE)
def test_set_new_temperature_with_circulate_on_changes_temperature(self):
# Get current temp plus a bit
start_t = self.ca.get_pv_value("TEMP") + 1
# Set new temp via SP
self.ca.set_pv_value("TEMP:SP", start_t)
# Turn on circulate
self.ca.set_pv_value("MODE:SP", 1)
# Check temp has changed
self.ca.assert_that_pv_is_number("TEMP", start_t)
def test_setting_external_PID_sets_values_correctly(self):
# Get initial values and add to them
p = self.ca.get_pv_value("EXTP") + 1
i = self.ca.get_pv_value("EXTI") + 1
d = self.ca.get_pv_value("EXTD") + 1
# Set new values
self.ca.set_pv_value("EXTP:SP", p)
self.ca.set_pv_value("EXTI:SP", i)
self.ca.set_pv_value("EXTD:SP", d)
# Check values have changed
self.ca.assert_that_pv_is_number("EXTP", p)
self.ca.assert_that_pv_is_number("EXTI", i)
self.ca.assert_that_pv_is_number("EXTD", d)
def test_setting_internal_PID_sets_values_correctly(self):
# Get initial values and add to them
p = self.ca.get_pv_value("INTP") + 1
i = self.ca.get_pv_value("INTI") + 1
d = self.ca.get_pv_value("INTD") + 1
# Set new values
self.ca.set_pv_value("INTP:SP", p)
self.ca.set_pv_value("INTI:SP", i)
self.ca.set_pv_value("INTD:SP", d)
# Check values have changed
self.ca.assert_that_pv_is_number("INTP", p)
self.ca.assert_that_pv_is_number("INTI", i)
self.ca.assert_that_pv_is_number("INTD", d)
@skip_if_recsim("In rec sim this test fails")
def test_setting_internal_PID_above_limit_does_nothing(self):
# Get initial values
start_p = self.ca.get_pv_value("INTP")
start_i = self.ca.get_pv_value("INTI")
start_d = self.ca.get_pv_value("INTD")
# Set outside of range
self.ca.set_pv_value("INTP:SP", TOO_HIGH_PID_VALUE)
self.ca.set_pv_value("INTI:SP", TOO_HIGH_PID_VALUE)
self.ca.set_pv_value("INTD:SP", TOO_HIGH_PID_VALUE)
# Check values have not changed
self.ca.assert_that_pv_is_number("INTP", start_p)
self.ca.assert_that_pv_is_number("INTI", start_i)
self.ca.assert_that_pv_is_number("INTD", start_d)
@skip_if_recsim("In rec sim this test fails")
def test_setting_internal_PID_below_limit_does_nothing(self):
# Get initial values
start_p = self.ca.get_pv_value("INTP")
start_i = self.ca.get_pv_value("INTI")
start_d = self.ca.get_pv_value("INTD")
# Set outside of range
self.ca.set_pv_value("INTP:SP", TOO_LOW_PID_VALUE)
self.ca.set_pv_value("INTI:SP", TOO_LOW_PID_VALUE)
self.ca.set_pv_value("INTD:SP", TOO_LOW_PID_VALUE)
# Check values have not changed
self.ca.assert_that_pv_is_number("INTP", start_p)
self.ca.assert_that_pv_is_number("INTI", start_i)
self.ca.assert_that_pv_is_number("INTD", start_d)
@skip_if_recsim("In rec sim this test fails")
def test_setting_external_PID_above_limit_does_nothing(self):
# Get initial values
start_p = self.ca.get_pv_value("EXTP")
start_i = self.ca.get_pv_value("EXTI")
start_d = self.ca.get_pv_value("EXTD")
# Set outside of range
self.ca.set_pv_value("EXTP:SP", TOO_HIGH_PID_VALUE)
self.ca.set_pv_value("EXTI:SP", TOO_HIGH_PID_VALUE)
self.ca.set_pv_value("EXTD:SP", TOO_HIGH_PID_VALUE)
# Check values have not changed
self.ca.assert_that_pv_is_number("EXTP", start_p)
self.ca.assert_that_pv_is_number("EXTI", start_i)
self.ca.assert_that_pv_is_number("EXTD", start_d)
@skip_if_recsim("In rec sim this test fails")
def test_setting_external_PID_below_limit_does_nothing(self):
# Get initial values
start_p = self.ca.get_pv_value("EXTP")
start_i = self.ca.get_pv_value("EXTI")
start_d = self.ca.get_pv_value("EXTD")
# Set outside of range
self.ca.set_pv_value("EXTP:SP", TOO_LOW_PID_VALUE)
self.ca.set_pv_value("EXTI:SP", TOO_LOW_PID_VALUE)
self.ca.set_pv_value("EXTD:SP", TOO_LOW_PID_VALUE)
# Check values have not changed
self.ca.assert_that_pv_is_number("EXTP", start_p)
self.ca.assert_that_pv_is_number("EXTI", start_i)
self.ca.assert_that_pv_is_number("EXTD", start_d)
def test_setting_control_mode_on_device_changes_control_mode_readback(
self):
for control_mode in ["Internal", "External",
"Internal"]: # Check both transitions
self.ca.assert_setting_setpoint_sets_readback(
control_mode, "CONTROLMODE")
class Sans2dVacuumSystemTests(unittest.TestCase):
"""
Tests for the SANS2D vacuum system, based on a FINS PLC.
"""
def setUp(self):
self._ioc = IOCRegister.get_running("FINS_01")
self.ca = ChannelAccess(device_prefix=ioc_prefix)
def test_WHEN_ioc_is_run_THEN_heartbeat_record_exists(self):
self.ca.assert_setting_setpoint_sets_readback(1, "HEARTBEAT",
"SIM:HEARTBEAT")
@parameterized.expand([(1, "IN", ChannelAccess.Alarms.NONE),
(2, "OUT", ChannelAccess.Alarms.NONE),
(3, "UNKNOWN", ChannelAccess.Alarms.MAJOR),
(4, "ERROR", ChannelAccess.Alarms.MAJOR),
(5, "ERROR(IN)", ChannelAccess.Alarms.MAJOR),
(6, "ERROR(OUT)", ChannelAccess.Alarms.MAJOR)])
def test_WHEN_data_changes_THEN_monitor_status_correct(
self, raw_value, enum_string, alarm):
self.ca.set_pv_value("SIM:ADDR:1001", raw_value)
self.ca.assert_that_pv_is("MONITOR3:STATUS", enum_string)
self.ca.assert_that_pv_alarm_is("MONITOR3:STATUS", alarm)
@parameterized.expand([(7, "CLOSED", ChannelAccess.Alarms.NONE),
(8, "OPEN", ChannelAccess.Alarms.NONE),
(16, "ERROR", ChannelAccess.Alarms.MAJOR),
(24, "ERROR(OPEN)", ChannelAccess.Alarms.MAJOR)])
def test_WHEN_data_changes_THEN_shutter_status_correct(
self, raw_value, enum_string, alarm):
self.ca.set_pv_value("SIM:ADDR:1001", raw_value)
self.ca.assert_that_pv_is("SHUTTER:STATUS", enum_string)
self.ca.assert_that_pv_alarm_is("SHUTTER:STATUS", alarm)
@parameterized.expand([(127, "CLOSED", ChannelAccess.Alarms.NONE),
(128, "OPEN", ChannelAccess.Alarms.NONE),
(256, "ERROR", ChannelAccess.Alarms.MAJOR),
(384, "ERROR(OPEN)", ChannelAccess.Alarms.MAJOR)])
def test_WHEN_data_changes_THEN_v8_status_correct(self, raw_value,
enum_string, alarm):
self.ca.set_pv_value("SIM:ADDR:1001", raw_value)
self.ca.assert_that_pv_is("V8:STATUS", enum_string)
self.ca.assert_that_pv_alarm_is("V8:STATUS", alarm)
def test_WHEN_common_alarm_low_THEN_common_alarm_bad_high_and_alarm(self):
self.ca.set_pv_value("SIM:ADDR:1001", 0)
self.ca.assert_that_pv_is("COMMON_ALARM:BAD", 1)
self.ca.assert_that_pv_alarm_is("COMMON_ALARM:BAD",
ChannelAccess.Alarms.MAJOR)
def test_WHEN_common_alarm_high_THEN_common_alarm_bad_low_and_no_alarm(
self):
self.ca.set_pv_value("SIM:ADDR:1001", 32768)
self.ca.assert_that_pv_is("COMMON_ALARM:BAD", 0)
self.ca.assert_that_pv_alarm_is("COMMON_ALARM:BAD",
ChannelAccess.Alarms.NONE)
@parameterized.expand([(1, "DEFLATED", ChannelAccess.Alarms.NONE),
(2, "INFLATING", ChannelAccess.Alarms.NONE),
(4, "INFLATED", ChannelAccess.Alarms.NONE),
(8, "DEFLATING", ChannelAccess.Alarms.NONE)])
def test_WHEN_data_changes_THEN_seal_status_correct(
self, raw_value, enum_string, alarm):
self.ca.set_pv_value("SIM:ADDR:1004", raw_value)
self.ca.assert_that_pv_is("SEAL:STATUS", enum_string)
self.ca.assert_that_pv_alarm_is("SEAL:STATUS", alarm)
@parameterized.expand([(0, 0), (4000, 10000), (2000, 5000)])
def test_WHEN_seal_supply_pressure_changes_THEN_correctly_converted(
self, raw_value, expected_converted_val):
self.ca.set_pv_value("SIM:SEAL:SUPPLY:PRESS:RAW", raw_value)
self.ca.assert_that_pv_is("SEAL:SUPPLY:PRESS", expected_converted_val)
def _set_sp_and_assert(self,
set_pv,
state,
expected_state=None,
int_state=None):
if int_state is None:
int_state = state
if expected_state is None:
expected_state = state
self.ca.set_pv_value("{}:STATUS:SP".format(set_pv), int_state)
self.ca.assert_that_pv_monitor_gets_values(
"{}:{}:SP".format(set_pv, expected_state), [expected_state, "..."])
def test_WHEN_opening_and_closing_shutter_THEN_propogates(self):
self._set_sp_and_assert("SHUTTER", "OPEN")
self._set_sp_and_assert("SHUTTER", "CLOSE")
self._set_sp_and_assert("SHUTTER", "OPEN")
def test_WHEN_opening_and_closing_shutter_with_numbers_THEN_propogates(
self):
self._set_sp_and_assert("SHUTTER", "OPEN", 1)
self._set_sp_and_assert("SHUTTER", "CLOSE", 0)
self._set_sp_and_assert("SHUTTER", "OPEN", 1)
def test_WHEN_insert_and_extract_monitor_THEN_propogates(self):
self._set_sp_and_assert("MONITOR3", "IN", "INSERT")
self._set_sp_and_assert("MONITOR3", "OUT", "EXTRACT")
self._set_sp_and_assert("MONITOR3", "IN", "INSERT")
def test_WHEN_insert_and_extract_monitor_with_numbers_THEN_propogates(
self):
self._set_sp_and_assert("MONITOR3", "IN", "INSERT", 1)
self._set_sp_and_assert("MONITOR3", "OUT", "EXTRACT", 0)
self._set_sp_and_assert("MONITOR3", "IN", "INSERT", 1)
def test_WHEN_start_and_stop_guide_THEN_propogates(self):
self._set_sp_and_assert("GUIDE", "START")
self._set_sp_and_assert("GUIDE", "STOP")
self._set_sp_and_assert("GUIDE", "START")
def test_WHEN_start_and_stop_guide_with_numbers_THEN_propogates(self):
self._set_sp_and_assert("GUIDE", "START", 1)
self._set_sp_and_assert("GUIDE", "STOP", 0)
self._set_sp_and_assert("GUIDE", "START", 1)
def test_WHEN_begin_run_in_auto_shutter_mode_THEN_shutter_opened(self):
self.ca.set_pv_value("SHUTTER:STATUS:SP", "CLOSE", wait=True)
self.ca.set_pv_value("SHUTTER:AUTO", 1, wait=True)
self.ca.process_pv("SHUTTER:OPEN_IF_AUTO")
self.ca.assert_that_pv_is("SHUTTER:STATUS:SP", "OPEN")
def test_WHEN_begin_run_in_manual_shutter_mode_THEN_shutter_opened(self):
self.ca.set_pv_value("SHUTTER:STATUS:SP", "CLOSE", wait=True)
self.ca.set_pv_value("SHUTTER:AUTO", 0, wait=True)
self.ca.process_pv("SHUTTER:OPEN_IF_AUTO")
self.ca.assert_that_pv_is_not("SHUTTER:STATUS:SP", "OPEN", timeout=5)
def test_WHEN_end_run_in_auto_shutter_mode_THEN_shutter_opened(self):
self.ca.set_pv_value("SHUTTER:STATUS:SP", "OPEN", wait=True)
self.ca.set_pv_value("SHUTTER:AUTO", 1, wait=True)
self.ca.process_pv("SHUTTER:CLOSE_IF_AUTO")
self.ca.assert_that_pv_is("SHUTTER:STATUS:SP", "CLOSE")
def test_WHEN_end_run_in_manual_shutter_mode_THEN_shutter_opened(self):
self.ca.set_pv_value("SHUTTER:STATUS:SP", "OPEN", wait=True)
self.ca.set_pv_value("SHUTTER:AUTO", 0, wait=True)
self.ca.process_pv("SHUTTER:CLOSE_IF_AUTO")
self.ca.assert_that_pv_is_not("SHUTTER:STATUS:SP", "CLOSE", timeout=5)
class ReflTests(unittest.TestCase):
"""
Tests for reflectometry server
"""
def setUp(self):
self._ioc = IOCRegister.get_running("refl")
self.ca = ChannelAccess(default_timeout=30,
device_prefix=DEVICE_PREFIX)
self.ca_galil = ChannelAccess(default_timeout=30, device_prefix="MOT")
self.ca_cs = ChannelAccess(default_timeout=30, device_prefix="CS")
self.ca_no_prefix = ChannelAccess()
self.ca_cs.set_pv_value("MOT:STOP:ALL", 1)
self.ca_cs.assert_that_pv_is("MOT:MOVING", 0, timeout=60)
self.ca.set_pv_value("BL:MODE:SP", "NR")
self.ca.set_pv_value("PARAM:S1:SP", 0)
self.ca.set_pv_value("PARAM:S3:SP", 0)
self.ca.set_pv_value("PARAM:SMANGLE:SP", 0)
self.ca.set_pv_value("PARAM:SMOFFSET:SP", 0)
self.ca.set_pv_value("PARAM:SMINBEAM:SP", "OUT")
self.ca.set_pv_value("PARAM:THETA:SP", 0)
self.ca.set_pv_value("PARAM:DET_POS:SP", 0)
self.ca.set_pv_value("PARAM:DET_ANG:SP", 0)
self.ca.set_pv_value("PARAM:DET_LONG:SP", 0)
self.ca.set_pv_value("PARAM:S3INBEAM:SP", "IN")
self.ca.set_pv_value("PARAM:CHOICE:SP", "MTR0205")
self.ca_galil.set_pv_value("MTR0207", 0)
self.ca.set_pv_value("PARAM:NOTINMODE:SP", 0)
self.ca.set_pv_value("BL:MODE:SP", "NR")
self.ca.set_pv_value("BL:MOVE", 1)
self.ca_galil.assert_that_pv_is("MTR0105", 0.0)
self.ca_cs.assert_that_pv_is("MOT:MOVING", 0, timeout=60)
def set_up_velocity_tests(self, velocity):
self.ca_galil.set_pv_value("MTR0102.VELO", velocity)
self.ca_galil.set_pv_value("MTR0104.VELO", velocity)
self.ca_galil.set_pv_value(
"MTR0105.VELO",
FAST_VELOCITY) # Remove angle as a speed limiting factor
def _check_param_pvs(self, param_name, expected_value):
self.ca.assert_that_pv_is_number("PARAM:%s" % param_name,
expected_value, 0.01)
self.ca.assert_that_pv_is_number("PARAM:%s:SP" % param_name,
expected_value, 0.01)
self.ca.assert_that_pv_is_number("PARAM:%s:SP:RBV" % param_name,
expected_value, 0.01)
@contextmanager
def _assert_pv_monitors(self, param_name, expected_value):
with self.ca.assert_that_pv_monitor_is_number("PARAM:%s" % param_name, expected_value, 0.01), \
self.ca.assert_that_pv_monitor_is_number("PARAM:%s:SP" % param_name, expected_value, 0.01), \
self.ca.assert_that_pv_monitor_is_number("PARAM:%s:SP:RBV" % param_name, expected_value, 0.01):
yield
def test_GIVEN_loaded_WHEN_read_status_THEN_status_ok(self):
self.ca.assert_that_pv_is("STAT", "OKAY")
def test_GIVEN_slit_with_beam_along_z_axis_WHEN_set_value_THEN_read_back_MTR_and_setpoints_moves_to_given_value(
self):
expected_value = 3.0
self.ca.set_pv_value("PARAM:S1:SP_NO_ACTION", expected_value)
self.ca.assert_that_pv_is("PARAM:S1:SP_NO_ACTION", expected_value)
self.ca.set_pv_value("BL:MOVE", 1)
self.ca.assert_that_pv_is("PARAM:S1:SP:RBV", expected_value)
self.ca_galil.assert_that_pv_is("MTR0101", expected_value)
self.ca_galil.assert_that_pv_is("MTR0101.RBV", expected_value)
self.ca.assert_that_pv_is("PARAM:S1", expected_value)
def test_GIVEN_slit_with_beam_along_z_axis_WHEN_set_value_THEN_monitors_updated(
self):
expected_value = 3.0
self.ca.set_pv_value("PARAM:S1:SP_NO_ACTION", expected_value)
self.ca.set_pv_value("BL:MOVE", 1)
self.ca.assert_that_pv_monitor_is("PARAM:S1", expected_value)
def test_GIVEN_theta_with_detector_and_slits3_WHEN_set_theta_THEN_values_are_all_correct_rbvs_updated_via_monitors_and_are_available_via_gets(
self):
theta_angle = 2
self.ca.set_pv_value("PARAM:THETA:SP", theta_angle)
expected_s3_value = SPACING * tan(radians(theta_angle * 2.0))
with self._assert_pv_monitors("S1", 0.0), \
self._assert_pv_monitors("S3", 0.0), \
self._assert_pv_monitors("THETA", theta_angle), \
self._assert_pv_monitors("DET_POS", 0.0), \
self._assert_pv_monitors("DET_ANG", 0.0):
self.ca.set_pv_value("BL:MOVE", 1)
# s1 not moved
self._check_param_pvs("S1", 0.0)
self.ca_galil.assert_that_pv_is_number("MTR0101", 0.0, 0.01)
# s3 moved in line
self._check_param_pvs("S3", 0.0)
self.ca_galil.assert_that_pv_is_number("MTR0102", expected_s3_value,
0.01)
# theta set
self._check_param_pvs("THETA", theta_angle)
# detector moved in line
self._check_param_pvs("DET_POS", 0.0)
expected_det_value = 2 * SPACING * tan(radians(theta_angle * 2.0))
self.ca_galil.assert_that_pv_is_number("MTR0104", expected_det_value,
0.01)
# detector angle faces beam
self._check_param_pvs("DET_ANG", 0.0)
expected_det_angle = 2.0 * theta_angle
self.ca_galil.assert_that_pv_is_number("MTR0105", expected_det_angle,
0.01)
def test_GIVEN_s3_in_beam_WHEN_disable_THEN_monitor_updates_and_motor_moves_to_out_of_beam_position(
self):
expected_value = "OUT"
with self.ca.assert_that_pv_monitor_is("PARAM:S3INBEAM",
expected_value):
self.ca.set_pv_value("PARAM:S3INBEAM:SP_NO_ACTION", expected_value)
self.ca.set_pv_value("BL:MOVE", 1)
self.ca_galil.assert_that_pv_is("MTR0102", OUT_POSITION_HIGH)
def test_GIVEN_mode_is_NR_WHEN_change_mode_THEN_monitor_updates_to_new_mode(
self):
expected_value = "POLARISED"
with self.ca.assert_that_pv_monitor_is("BL:MODE", expected_value), \
self.ca.assert_that_pv_monitor_is("BL:MODE.VAL", expected_value):
self.ca.set_pv_value("BL:MODE:SP", expected_value)
@unstable_test()
def test_GIVEN_new_parameter_setpoint_WHEN_triggering_move_THEN_SP_is_only_set_on_motor_when_difference_above_motor_resolution(
self):
target_mres = 0.001
pos_above_res = 0.01
pos_below_res = pos_above_res + 0.0001
self.ca_galil.set_pv_value("MTR0101.MRES", target_mres)
with self.ca_galil.assert_that_pv_monitor_is_number("MTR0101.VAL", pos_above_res), \
self.ca_galil.assert_that_pv_monitor_is_number("MTR0101.RBV", pos_above_res):
self.ca.set_pv_value("PARAM:S1:SP", pos_above_res)
with self.ca_galil.assert_that_pv_monitor_is_number("MTR0101.VAL", pos_above_res), \
self.ca_galil.assert_that_pv_monitor_is_number("MTR0101.RBV", pos_above_res):
self.ca.set_pv_value("PARAM:S1:SP", pos_below_res)
def test_GIVEN_motor_velocity_altered_by_move_WHEN_move_completed_THEN_velocity_reverted_to_original_value(
self):
expected = INITIAL_VELOCITY
self.set_up_velocity_tests(expected)
self.ca.set_pv_value("PARAM:THETA:SP", 5)
self.ca_galil.assert_that_pv_is("MTR0102.DMOV", 1, timeout=10)
self.ca_galil.assert_that_pv_is("MTR0102.VELO", expected)
self.ca_galil.assert_that_pv_is("MTR0104.DMOV", 1, timeout=10)
self.ca_galil.assert_that_pv_is("MTR0104.VELO", expected)
def test_GIVEN_motor_velocity_altered_by_move_WHEN_moving_THEN_velocity_altered(
self):
# Given a known initial velocity, confirm that on a move the velocity has changed for the axes
self.set_up_velocity_tests(INITIAL_VELOCITY)
self.ca.set_pv_value("PARAM:THETA:SP", 15)
self.ca_galil.assert_that_pv_is("MTR0102.DMOV", 0, timeout=10)
self.ca_galil.assert_that_pv_is_not("MTR0102.VELO", INITIAL_VELOCITY)
self.ca_galil.assert_that_pv_is("MTR0104.DMOV", 0, timeout=10)
self.ca_galil.assert_that_pv_is_not("MTR0104.VELO", INITIAL_VELOCITY)
def test_GIVEN_motor_velocity_altered_by_move_WHEN_move_interrupted_THEN_velocity_reverted_to_original_value(
self):
expected = INITIAL_VELOCITY
final_position = SPACING
self.set_up_velocity_tests(expected)
# move and wait for completion
self.ca.set_pv_value("PARAM:THETA:SP", 22.5)
self.ca_galil.set_pv_value("MTR0102.STOP", 1)
self.ca_galil.set_pv_value("MTR0104.STOP", 1)
self.ca_galil.set_pv_value("MTR0105.STOP", 1)
self.ca_galil.assert_that_pv_is("MTR0102.DMOV", 1, timeout=2)
self.ca_galil.assert_that_pv_is_not_number("MTR0102.RBV",
final_position,
tolerance=0.1)
self.ca_galil.assert_that_pv_is("MTR0102.VELO", expected)
self.ca_galil.assert_that_pv_is("MTR0104.DMOV", 1, timeout=2)
self.ca_galil.assert_that_pv_is_not_number("MTR0104.RBV",
2 * final_position,
tolerance=0.1)
self.ca_galil.assert_that_pv_is("MTR0104.VELO", expected)
def test_GIVEN_move_was_issued_while_different_move_already_in_progress_WHEN_move_completed_THEN_velocity_reverted_to_value_before_first_move(
self):
expected = INITIAL_VELOCITY
self.set_up_velocity_tests(expected)
self.ca_galil.set_pv_value("MTR0102", -4)
self.ca_galil.assert_that_pv_is("MTR0102.DMOV", 0, timeout=1)
self.ca.set_pv_value("PARAM:THETA:SP", 22.5)
self.ca_galil.assert_that_pv_is("MTR0102.DMOV", 1, timeout=30)
self.ca_galil.assert_that_pv_is("MTR0102.VELO", expected)
def test_GIVEN_move_in_progress_WHEN_modifying_motor_velocity_THEN_velocity_reverted_to_value_before_modified_velocity(
self):
# The by-design behaviour (but maybe not expected by the user) is that if a velocity is sent during a move
# then we ignore this and restore the cached value we had for the currently issued move.
initial = INITIAL_VELOCITY
altered = INITIAL_VELOCITY + 5
expected = INITIAL_VELOCITY
self.set_up_velocity_tests(initial)
self.ca.set_pv_value("PARAM:THETA:SP", 22.5)
self.ca_galil.assert_that_pv_is("MTR0102.DMOV", 0, timeout=1)
self.ca_galil.set_pv_value("MTR0102.VELO", altered)
self.ca_galil.assert_that_pv_is("MTR0102.DMOV", 1, timeout=30)
self.ca_galil.assert_that_pv_is("MTR0102.VELO", expected)
def test_GIVEN_mode_is_NR_WHEN_change_mode_THEN_monitor_updates_to_new_mode_and_PVs_inmode_are_labeled_as_such(
self):
expected_mode_value = "TESTING"
PARAM_PREFIX = "PARAM:"
IN_MODE_SUFFIX = ":IN_MODE"
expected_in_mode_value = "YES"
expected_out_of_mode_value = "NO"
with self.ca.assert_that_pv_monitor_is("BL:MODE", expected_mode_value), \
self.ca.assert_that_pv_monitor_is("BL:MODE.VAL", expected_mode_value):
self.ca.set_pv_value("BL:MODE:SP", expected_mode_value)
test_in_mode_param_names = ["S1", "S3", "THETA", "DET_POS", "S3INBEAM"]
test_out_of_mode_params = ["DET_ANG", "THETA_AUTO"]
for param in test_in_mode_param_names:
self.ca.assert_that_pv_monitor_is(
"{}{}{}".format(PARAM_PREFIX, param, IN_MODE_SUFFIX),
expected_in_mode_value)
for param in test_out_of_mode_params:
self.ca.assert_that_pv_monitor_is(
"{}{}{}".format(PARAM_PREFIX, param, IN_MODE_SUFFIX),
expected_out_of_mode_value)
def test_GIVEN_jaws_set_to_value_WHEN_change_sp_at_low_level_THEN_jaws_sp_rbv_does_not_change(
self):
expected_gap_in_refl = 0.2
expected_change_to_gap = 1.0
self.ca.set_pv_value("PARAM:S1HG:SP", expected_gap_in_refl)
self.ca.assert_that_pv_is_number("PARAM:S1HG",
expected_gap_in_refl,
timeout=15,
tolerance=MOTOR_TOLERANCE)
self.ca_galil.set_pv_value("JAWS1:HGAP:SP", expected_change_to_gap)
self.ca_galil.assert_that_pv_is_number("JAWS1:HGAP",
expected_change_to_gap,
timeout=15,
tolerance=MOTOR_TOLERANCE)
self.ca.assert_that_pv_is("PARAM:S1HG", expected_change_to_gap)
self.ca.assert_that_pv_is("PARAM:S1HG:SP:RBV", expected_gap_in_refl)
@parameterized.expand([("slits", "S1", 30.00),
("multi_component", "THETA", 20.00),
("angle", "DET_ANG", -80.0),
("displacement", "DET_POS", 20.0),
("binary", "S3INBEAM", 0)])
def test_GIVEN_new_parameter_sp_WHEN_parameter_rbv_changing_THEN_parameter_changing_pv_correct(
self, _, param, value):
expected_value = "YES"
value = value
self.ca.set_pv_value("PARAM:{}:SP".format(param), value)
self.ca.assert_that_pv_is("PARAM:{}:CHANGING".format(param),
expected_value)
@parameterized.expand([("slits", "S1", 500.00),
("multi_component", "THETA", -500.00),
("angle", "DET_ANG", -800.0),
("displacement", "DET_POS", 500.0),
("binary", "S3INBEAM", 0)])
def test_GIVEN_new_parameter_sp_WHEN_parameter_rbv_not_changing_THEN_parameter_changing_pv_correct(
self, _, param, value):
expected_value = "NO"
value = value
self.ca.set_pv_value("PARAM:{}:SP".format(param), value)
self.ca_cs.set_pv_value("MOT:STOP:ALL", 1)
self.ca.assert_that_pv_is("PARAM:{}:CHANGING".format(param),
expected_value)
@parameterized.expand([("slits", "S1", 500.00),
("multi_component", "THETA", 500.00),
("angle", "DET_ANG", -800.0),
("displacement", "DET_POS", 500.0),
("binary", "S3INBEAM", "OUT")])
def test_GIVEN_new_parameter_sp_WHEN_parameter_rbv_outside_of_sp_target_tolerance_THEN_parameter_at_rbv_pv_correct(
self, _, param, value):
expected_value = "NO"
value = value
self.ca.set_pv_value("PARAM:{}:SP".format(param), value)
self.ca_cs.set_pv_value("MOT:STOP:ALL", 1)
self.ca.assert_that_pv_is("PARAM:{}:RBV:AT_SP".format(param),
expected_value)
@parameterized.expand([("slits", "S1", 0.00),
("multi_component", "THETA", 0.00),
("angle", "DET_ANG", 0.0),
("displacement", "DET_POS", 0.0),
("binary", "S3INBEAM", 1)])
def test_GIVEN_new_parameter_sp_WHEN_parameter_rbv_within_sp_target_tolerance_THEN_parameter_at_rbv_pv_correct(
self, _, param, value):
expected_value = "YES"
value = value
self.ca.set_pv_value("PARAM:{}:SP".format(param), value)
self.ca_cs.set_pv_value("MOT:STOP:ALL", 1)
self.ca.assert_that_pv_is("PARAM:{}:RBV:AT_SP".format(param),
expected_value)
def test_GIVEN_a_low_level_beamline_change_WHEN_values_changed_THEN_high_level_parameters_updated(
self):
self.ca_galil.set_pv_value("MTR0102", -400)
self.ca.assert_that_pv_value_is_changing("PARAM:S3", wait=2)
self.ca.assert_that_pv_is("PARAM:S3:RBV:AT_SP", "NO")
def test_GIVEN_engineering_correction_WHEN_move_THEN_move_includes_engineering_correction(
self):
theta = 2
self.ca.set_pv_value("PARAM:THETA:SP", theta)
self.ca.set_pv_value("PARAM:S5:SP", 0)
self.ca.assert_that_pv_is(
"COR:MOT:MTR0206:DESC",
"Interpolated from file s4_correction.dat on MOT:MTR0206 for s5")
self.ca.assert_that_pv_is("COR:MOT:MTR0206", theta /
10.0) # s4 correction is a 1/10 of theta
# soon after movement starts and before movement stops the velocity should be the same
distance_from_sample_to_s4 = (3.5 - 2.0) * 2
expected_position = distance_from_sample_to_s4 * tan(radians(
theta * 2)) + theta / 10.0
self.ca_galil.assert_that_pv_is_number("MTR0206.RBV",
expected_position,
tolerance=MOTOR_TOLERANCE,
timeout=30)
self.ca.assert_that_pv_is_number("PARAM:S5",
0,
tolerance=MOTOR_TOLERANCE,
timeout=10)
def test_GIVEN_param_not_in_mode_and_sp_changed_WHEN_performing_beamline_move_THEN_sp_is_applied(
self):
expected = 1.0
self.ca.set_pv_value("PARAM:NOTINMODE:SP_NO_ACTION", expected)
self.ca.set_pv_value("BL:MOVE", 1, wait=True)
self.ca_galil.assert_that_pv_is("MTR0205.DMOV", 1, timeout=10)
self.ca.assert_that_pv_is_number("PARAM:NOTINMODE:SP:RBV", expected)
self.ca.assert_that_pv_is_number("PARAM:NOTINMODE", expected)
def test_GIVEN_param_not_in_mode_and_sp_changed_WHEN_performing_individual_move_THEN_sp_is_applied(
self):
expected = 1.0
self.ca.set_pv_value("PARAM:NOTINMODE:SP_NO_ACTION", expected)
self.ca.set_pv_value("PARAM:NOTINMODE:ACTION", 1, wait=True)
self.ca_galil.assert_that_pv_is("MTR0205.DMOV", 1, timeout=10)
self.ca.assert_that_pv_is_number("PARAM:NOTINMODE:SP:RBV", expected)
self.ca.assert_that_pv_is_number("PARAM:NOTINMODE", expected)
def test_GIVEN_param_not_in_mode_and_sp_changed_WHEN_performing_individual_move_on_other_param_THEN_no_value_applied(
self):
param_sp = 0.0
motor_pos = 1.0
self.ca.set_pv_value("PARAM:NOTINMODE:SP", param_sp)
self.ca_galil.set_pv_value("MTR0205", motor_pos, wait=True)
self.ca_galil.assert_that_pv_is("MTR0205.DMOV", 1, timeout=10)
self.ca.assert_that_pv_is_number("PARAM:NOTINMODE", motor_pos)
self.ca.set_pv_value("PARAM:THETA:SP", 0.2, wait=True)
self.ca_galil.assert_that_pv_is("MTR0205.DMOV", 1, timeout=10)
self.ca.assert_that_pv_is_number("PARAM:NOTINMODE:SP", param_sp)
self.ca.assert_that_pv_is_number("PARAM:NOTINMODE:SP:RBV", param_sp)
self.ca_galil.assert_that_pv_is_number("MTR0205", motor_pos)
def test_GIVEN_param_not_in_mode_and_sp_unchanged_WHEN_performing_beamline_move_THEN_no_value_applied(
self):
param_sp = 0.0
motor_pos = 1.0
self.ca_galil.set_pv_value("MTR0205", motor_pos, wait=True)
self.ca_galil.assert_that_pv_is("MTR0205.DMOV", 1, timeout=10)
self.ca.assert_that_pv_is_number("PARAM:NOTINMODE", motor_pos)
self.ca.set_pv_value("BL:MOVE", 1, wait=True)
self.ca_galil.assert_that_pv_is("MTR0205.DMOV", 1, timeout=10)
self.ca.assert_that_pv_is_number("PARAM:NOTINMODE:SP", param_sp)
self.ca.assert_that_pv_is_number("PARAM:NOTINMODE:SP:RBV", param_sp)
self.ca_galil.assert_that_pv_is_number("MTR0205", motor_pos)
def test_GIVEN_param_not_in_mode_and_sp_unchanged_WHEN_performing_individual_move_THEN_sp_is_applied(
self):
param_sp = 0.0
motor_pos = 1.0
self.ca_galil.set_pv_value("MTR0205", motor_pos, wait=True)
self.ca_galil.assert_that_pv_is("MTR0205.DMOV", 1, timeout=10)
self.ca.assert_that_pv_is_number("PARAM:NOTINMODE", motor_pos)
self.ca.set_pv_value("PARAM:NOTINMODE:ACTION", 1, wait=True)
self.ca_galil.assert_that_pv_is("MTR0205.DMOV", 1, timeout=10)
self.ca.assert_that_pv_is_number("PARAM:NOTINMODE:SP", param_sp)
self.ca.assert_that_pv_is_number("PARAM:NOTINMODE:SP:RBV", param_sp)
self.ca.assert_that_pv_is_number("PARAM:NOTINMODE", param_sp)
def test_GIVEN_param_not_in_mode_and_sp_unchanged_WHEN_performing_individual_move_on_other_param_THEN_no_value_applied(
self):
param_sp = 0.0
motor_pos = 1.0
self.ca_galil.set_pv_value("MTR0205", motor_pos, wait=True)
self.ca_galil.assert_that_pv_is("MTR0205.DMOV", 1, timeout=10)
self.ca.assert_that_pv_is_number("PARAM:NOTINMODE", motor_pos)
self.ca.set_pv_value("PARAM:THETA:SP", 0.2, wait=True)
self.ca_galil.assert_that_pv_is("MTR0205.DMOV", 1, timeout=10)
self.ca.assert_that_pv_is_number("PARAM:NOTINMODE:SP", param_sp)
self.ca.assert_that_pv_is_number("PARAM:NOTINMODE:SP:RBV", param_sp)
self.ca_galil.assert_that_pv_is_number("MTR0205", motor_pos)
def test_GIVEN_non_synchronised_axis_WHEN_move_which_should_change_velocity_THEN_velocity_not_changed(
self):
self.ca_galil.set_pv_value("MTR0103.VELO", MEDIUM_VELOCITY)
self.ca.set_pv_value("PARAM:THETA:SP", 22.5)
# soon after movement starts and before movement stops the velocity should be the same
self.ca_galil.assert_that_pv_is("MTR0103.DMOV", 0, timeout=10)
self.ca_galil.assert_that_pv_is("MTR0103.VELO",
MEDIUM_VELOCITY,
timeout=0.5)
self.ca_galil.assert_that_pv_is("MTR0103.DMOV", 0, timeout=10)
# when the movement finishes it should still be the same
self.ca_galil.assert_that_pv_is("MTR0103.DMOV", 1, timeout=10)
self.ca_galil.assert_that_pv_is("MTR0103.VELO", MEDIUM_VELOCITY)
def test_GIVEN_motor_axis_is_angle_WHEN_motor_alarm_status_is_updated_THEN_alarms_propagate_to_correct_parameters_on_component(
self):
expected_severity_code = "MINOR"
expected_status_code = "HIGH"
no_alarm_code = "NO_ALARM"
# Setting High Limit = Low limit produces alarm on 0105 (detector angle)
self.ca_galil.set_pv_value("MTR0105.HLM", SOFT_LIMIT_LO)
# detector angle should be in alarm
self.ca.assert_that_pv_is("PARAM:DET_ANG.STAT", expected_status_code)
self.ca.assert_that_pv_is("PARAM:DET_ANG.SEVR", expected_severity_code)
# detector offset is independent and should not be in alarm
self.ca.assert_that_pv_is("PARAM:DET_POS.STAT", no_alarm_code)
self.ca.assert_that_pv_is("PARAM:DET_POS.SEVR", no_alarm_code)
# Setting High Limit back clears alarm
self.ca_galil.set_pv_value("MTR0105.HLM", SOFT_LIMIT_HI)
self.ca.assert_that_pv_is("PARAM:DET_ANG.STAT", no_alarm_code)
self.ca.assert_that_pv_is("PARAM:DET_ANG.SEVR", no_alarm_code)
def test_GIVEN_motor_axis_is_displacement_WHEN_motor_alarm_status_is_updated_THEN_alarms_propagate_to_correct_parameters_on_component(
self):
expected_severity_code = "MINOR"
expected_status_code = "HIGH"
no_alarm_code = "NO_ALARM"
# Setting High Limit = Low limit produces alarm on 0104 (detector height)
self.ca_galil.set_pv_value("MTR0104.HLM", SOFT_LIMIT_LO)
# detector offset should be in alarm
self.ca.assert_that_pv_is("PARAM:DET_POS.STAT", expected_status_code)
self.ca.assert_that_pv_is("PARAM:DET_POS.SEVR", expected_severity_code)
# theta is derived from detector offset and should be in alarm
self.ca.assert_that_pv_is("PARAM:THETA.STAT", expected_status_code)
self.ca.assert_that_pv_is("PARAM:THETA.SEVR", expected_severity_code)
# detector angle is independent and should not be in alarm
self.ca.assert_that_pv_is("PARAM:DET_ANG.STAT", no_alarm_code)
self.ca.assert_that_pv_is("PARAM:DET_ANG.SEVR", no_alarm_code)
# Setting High Limit back clears alarm
self.ca_galil.set_pv_value("MTR0104.HLM", SOFT_LIMIT_HI)
self.ca.assert_that_pv_is("PARAM:DET_POS.STAT", no_alarm_code)
self.ca.assert_that_pv_is("PARAM:DET_POS.SEVR", no_alarm_code)
self.ca.assert_that_pv_is("PARAM:THETA.STAT", no_alarm_code)
self.ca.assert_that_pv_is("PARAM:THETA.SEVR", no_alarm_code)
@parameterized.expand([("Variable", "DET_POS", "MTR0104"),
("Frozen", "DET_POS", "MTR0104"),
("Frozen", "DET_ANG", "MTR0105")])
def test_GIVEN_motors_not_at_zero_WHEN_define_motor_position_to_THEN_motor_position_is_changed_without_move(
self, initial_foff, param_name, motor_name):
offset = 10
new_position = 2
self.ca.set_pv_value("PARAM:{}:SP".format(param_name), offset)
self.ca_galil.set_pv_value("MTR0104.FOFF", initial_foff)
self.ca_galil.set_pv_value("MTR0104.OFF", 0)
self.ca.assert_that_pv_is_number("PARAM:{}".format(param_name),
offset,
tolerance=MOTOR_TOLERANCE,
timeout=30)
self.ca_galil.assert_that_pv_is("MTR0104.DMOV", 1, timeout=30)
with ManagerMode(self.ca_no_prefix):
self.ca.set_pv_value(
"PARAM:{}:DEFINE_POSITION_AS".format(param_name), new_position)
# soon after change there should be no movement, ie a move is triggered but the motor itself does not move so it
# is very quick
self.ca_galil.assert_that_pv_is("{}.DMOV".format(motor_name),
1,
timeout=1)
self.ca_galil.assert_that_pv_is("{}.RBV".format(motor_name),
new_position)
self.ca_galil.assert_that_pv_is("{}.VAL".format(motor_name),
new_position)
self.ca_galil.assert_that_pv_is("{}.SET".format(motor_name), "Use")
self.ca_galil.assert_that_pv_is("{}.FOFF".format(motor_name),
initial_foff)
self.ca_galil.assert_that_pv_is_number("{}.OFF".format(motor_name),
0.0,
tolerance=MOTOR_TOLERANCE)
self.ca.assert_that_pv_is("PARAM:{}".format(param_name), new_position)
self.ca.assert_that_pv_is("PARAM:{}:SP".format(param_name),
new_position)
self.ca.assert_that_pv_is("PARAM:{}:SP_NO_ACTION".format(param_name),
new_position)
self.ca.assert_that_pv_is("PARAM:{}:CHANGED".format(param_name), "NO")
self.ca.assert_that_pv_is("PARAM:THETA", 0)
self.ca.assert_that_pv_is("PARAM:THETA:SP", 0)
self.ca.assert_that_pv_is("PARAM:THETA:SP:RBV", 0)
def test_GIVEN_jaws_not_at_zero_WHEN_define_motor_position_for_jaw_gaps_THEN_jaws_position_are_changed_without_move(
self):
param_name = "S1VG"
jaw_motors = ["MTR0201", "MTR0202"]
initial_gap = 1.0
initial_centre = 2.0
new_gap = 4.0
expected_pos = {
"MTR0201": new_gap / 2.0 - initial_centre,
"MTR0202": new_gap / 2.0 + initial_centre
}
self.ca.assert_setting_setpoint_sets_readback(initial_gap,
"PARAM:S1VG",
expected_alarm=None,
timeout=30)
self.ca.assert_setting_setpoint_sets_readback(initial_centre,
"PARAM:S1VC",
expected_alarm=None,
timeout=30)
for motor_name in jaw_motors:
self.ca_galil.set_pv_value("{}.FOFF".format(motor_name), "Frozen")
self.ca_galil.set_pv_value("{}.OFF".format(motor_name), 0)
for motor_name in jaw_motors:
self.ca_galil.assert_that_pv_is("{}.DMOV".format(motor_name),
1,
timeout=30)
with ManagerMode(self.ca_no_prefix):
self.ca.set_pv_value(
"PARAM:{}:DEFINE_POSITION_AS".format(param_name), new_gap)
# soon after change there should be no movement, ie a move is triggered but the motor itself does not move so it
# is very quick
for motor_name in jaw_motors:
self.ca_galil.assert_that_pv_is("{}.DMOV".format(motor_name),
1,
timeout=1)
for motor_name in jaw_motors:
# jaws are open to half the gap
self.ca_galil.assert_that_pv_is("{}.RBV".format(motor_name),
expected_pos[motor_name])
self.ca_galil.assert_that_pv_is("{}.VAL".format(motor_name),
expected_pos[motor_name])
self.ca_galil.assert_that_pv_is("{}.SET".format(motor_name), "Use")
self.ca_galil.assert_that_pv_is("{}.FOFF".format(motor_name),
"Frozen")
self.ca_galil.assert_that_pv_is_number("{}.OFF".format(motor_name),
0.0,
tolerance=MOTOR_TOLERANCE)
self.ca.assert_that_pv_is("PARAM:{}".format(param_name), new_gap)
self.ca.assert_that_pv_is("PARAM:{}:SP".format(param_name), new_gap)
self.ca.assert_that_pv_is("PARAM:{}:SP_NO_ACTION".format(param_name),
new_gap)
self.ca.assert_that_pv_is("PARAM:{}:CHANGED".format(param_name), "NO")
def test_GIVEN_jaws_not_at_zero_WHEN_define_motor_position_for_jaw_centres_THEN_jaws_position_are_changed_without_move(
self):
param_name = "S1HC"
jaw_motors = ["MTR0203", "MTR0204"]
initial_gap = 1.0
initial_centre = 2.0
new_centre = 4.0
expected_pos = {
"MTR0203": initial_gap / 2.0 + new_centre,
"MTR0204": initial_gap / 2.0 - new_centre
}
self.ca.assert_setting_setpoint_sets_readback(initial_gap,
"PARAM:S1HG",
expected_alarm=None,
timeout=30)
self.ca.assert_setting_setpoint_sets_readback(initial_centre,
"PARAM:S1HC",
expected_alarm=None,
timeout=30)
for motor_name in jaw_motors:
self.ca_galil.set_pv_value("{}.FOFF".format(motor_name), "Frozen")
self.ca_galil.set_pv_value("{}.OFF".format(motor_name), 0)
for motor_name in jaw_motors:
self.ca_galil.assert_that_pv_is("{}.DMOV".format(motor_name),
1,
timeout=30)
with ManagerMode(self.ca_no_prefix):
self.ca.set_pv_value(
"PARAM:{}:DEFINE_POSITION_AS".format(param_name), new_centre)
# soon after change there should be no movement, ie a move is triggered but the motor itself does not move so it
# is very quick
for motor_name in jaw_motors:
self.ca_galil.assert_that_pv_is("{}.DMOV".format(motor_name),
1,
timeout=1)
for motor_name in jaw_motors:
# jaws are open to half the gap
self.ca_galil.assert_that_pv_is("{}.RBV".format(motor_name),
expected_pos[motor_name])
self.ca_galil.assert_that_pv_is("{}.VAL".format(motor_name),
expected_pos[motor_name])
self.ca_galil.assert_that_pv_is("{}.SET".format(motor_name), "Use")
self.ca_galil.assert_that_pv_is("{}.FOFF".format(motor_name),
"Frozen")
self.ca_galil.assert_that_pv_is_number("{}.OFF".format(motor_name),
0.0,
tolerance=MOTOR_TOLERANCE)
self.ca.assert_that_pv_is("PARAM:{}".format(param_name), new_centre)
self.ca.assert_that_pv_is("PARAM:{}:SP".format(param_name), new_centre)
self.ca.assert_that_pv_is("PARAM:{}:SP_NO_ACTION".format(param_name),
new_centre)
self.ca.assert_that_pv_is("PARAM:{}:CHANGED".format(param_name), "NO")
def test_GIVEN_theta_THEN_define_position_as_does_not_exist(self):
param_name = "THETA"
self.ca.assert_that_pv_exists("PARAM:{}".format(param_name))
self.ca.assert_that_pv_does_not_exist(
"PARAM:{}:DEFINE_POSITION_AS".format(param_name))
def test_GIVEN_motors_at_zero_WHEN_define_motor_position_to_and_back_multiple_times_THEN_motor_position_is_changed_without_move(
self):
param_name = "DET_POS"
motor_name = "MTR0104"
initial_foff = "Frozen"
self.ca.set_pv_value("PARAM:{}:SP".format(param_name), 0)
self.ca_galil.set_pv_value("MTR0104.FOFF", initial_foff)
self.ca_galil.set_pv_value("MTR0104.OFF", 0)
self.ca.assert_that_pv_is_number("PARAM:{}".format(param_name),
0,
tolerance=MOTOR_TOLERANCE,
timeout=30)
self.ca_galil.assert_that_pv_is("MTR0104.DMOV", 1, timeout=30)
for i in range(20):
new_position = i - 5
with ManagerMode(self.ca_no_prefix):
self.ca.set_pv_value(
"PARAM:{}:DEFINE_POSITION_AS".format(param_name),
new_position)
# soon after change there should be no movement, ie a move is triggered but the motor itself does not move so it
# is very quick
self.ca_galil.assert_that_pv_is("{}.DMOV".format(motor_name),
1,
timeout=1)
self.ca_galil.assert_that_pv_is("{}.RBV".format(motor_name),
new_position)
self.ca_galil.assert_that_pv_is("{}.VAL".format(motor_name),
new_position)
self.ca_galil.assert_that_pv_is("{}.SET".format(motor_name), "Use")
self.ca_galil.assert_that_pv_is("{}.FOFF".format(motor_name),
initial_foff)
self.ca_galil.assert_that_pv_is_number("{}.OFF".format(motor_name),
0.0,
tolerance=MOTOR_TOLERANCE)
self.ca.assert_that_pv_is("PARAM:{}".format(param_name),
new_position)
self.ca.assert_that_pv_is("PARAM:{}:SP".format(param_name),
new_position)
self.ca.assert_that_pv_is(
"PARAM:{}:SP_NO_ACTION".format(param_name), new_position)
self.ca.assert_that_pv_is("PARAM:{}:CHANGED".format(param_name),
"NO")
def test_GIVEN_parameter_not_in_manager_mode_WHEN_define_position_THEN_position_is_not_defined(
self):
new_position = 10
param_pv = "PARAM:{}:DEFINE_POSITION_AS".format("DET_POS")
self.assertRaises(IOError, self.ca.set_pv_value, param_pv,
new_position)
self.ca.assert_that_pv_is_not(param_pv, new_position)
def test_GIVEN_value_parameter_WHEN_read_THEN_value_returned(self):
param_pv = "CONST:TEN"
self.ca.assert_that_pv_is(param_pv, 10)
self.ca.assert_that_pv_is("{}.DESC".format(param_pv), "The value 10")
def test_GIVEN_bool_parameter_WHEN_read_THEN_value_returned(self):
param_pv = "CONST:YES"
self.ca.assert_that_pv_is(param_pv, "YES")
def test_GIVEN_string_constant_parameter_WHEN_read_THEN_value_returned(
self):
param_pv = "CONST:STRING"
self.ca.assert_that_pv_is(param_pv, "Test String")
def test_GIVEN_PNR_mode_with_SM_angle_WHEN_move_in_disable_mode_and_into_PNR_THEN_beamline_is_updated_on_mode_change_and_value_of_pd_offsets_correct(
self):
self.ca.set_pv_value("BL:MODE:SP", "POLARISED")
self.ca.set_pv_value("PARAM:SMANGLE:SP_NO_ACTION", 0.2)
self.ca.set_pv_value("BL:MOVE", 1)
self.ca.assert_that_pv_is_number("PARAM:SMANGLE", 0.2, tolerance=1e-2)
self.ca.set_pv_value("BL:MODE:SP", "DISABLED")
self.ca.set_pv_value("PARAM:SMANGLE:SP", 0)
self.ca.assert_that_pv_is_number("PARAM:SMANGLE", 0.0, tolerance=1e-2)
self.ca.assert_that_pv_is_number("PARAM:S3", 0.0, tolerance=1e-2)
self.ca.assert_that_pv_is_number("PARAM:DET_POS", 0.0, tolerance=1e-2)
self.ca.set_pv_value("BL:MODE:SP", "POLARISED")
# In polarised mode the sm angle will now make everything appear to be in the wrong place.
# This test will also check that on changing modes the beamline is updated
self.ca.assert_that_pv_is_not_number("PARAM:S3", 0.0, tolerance=1e-2)
self.ca.assert_that_pv_is_not_number("PARAM:DET_POS",
0.0,
tolerance=1e-2)
@parameterized.expand([(0, OUT_POSITION_HIGH), (22.5, OUT_POSITION_LOW)])
def test_GIVEN_component_with_multiple_parked_positions_WHEN_moving_out_of_beam_THEN_driver_moves_to_correct_out_of_beam_position_based_on_beam_interception(
self, theta_sp, expected_out_of_beam_position):
self.ca.assert_that_pv_is("PARAM:S3INBEAM", "IN")
self.ca.set_pv_value("PARAM:THETA:SP_NO_ACTION", theta_sp, wait=True)
self.ca.set_pv_value("PARAM:S3INBEAM:SP_NO_ACTION", "OUT", wait=True)
self.ca.set_pv_value("BL:MOVE", 1, wait=True)
self.ca_galil.assert_that_pv_is_number("MTR0102.VAL",
expected_out_of_beam_position,
timeout=5)
def test_GIVEN_component_with_multiple_out_of_beam_positions_is_out_of_beam_WHEN_beam_intercept_moves_above_threshold_THEN_driver_moves_to_correct_out_of_beam_position(
self):
self.ca.assert_that_pv_is("PARAM:S3INBEAM", "IN")
self.ca.set_pv_value("PARAM:S3INBEAM:SP", "OUT", wait=True)
self.ca.assert_that_pv_is("PARAM:S3INBEAM:CHANGING", "NO", timeout=30)
self.ca_galil.assert_that_pv_is_number("MTR0102.RBV",
OUT_POSITION_HIGH,
timeout=20)
self.ca.set_pv_value("PARAM:THETA:SP", 22.5, wait=True)
self.ca_galil.assert_that_pv_is_number("MTR0102.VAL",
OUT_POSITION_LOW,
timeout=5)
@parameterized.expand([(0, OUT_POSITION_HIGH, "OUT"),
(0, OUT_POSITION_LOW, "IN"),
(22.5, OUT_POSITION_HIGH, "IN"),
(22.5, OUT_POSITION_LOW, "OUT")])
def test_GIVEN_component_with_multiple_parked_positions_WHEN_moving_axis_to_sp_THEN_inbeam_param_reports_correct_rbv(
self, theta_sp, axis_sp, expected_inbeam_status):
self.ca.assert_that_pv_is("PARAM:S3INBEAM", "IN")
self.ca.set_pv_value("PARAM:THETA:SP", theta_sp, wait=True)
self.ca.assert_that_pv_is("PARAM:THETA:CHANGING", "NO", timeout=30)
self.ca_galil.set_pv_value("MTR0102.VAL", axis_sp, wait=True)
self.ca.assert_that_pv_is("PARAM:S3INBEAM:CHANGING", "NO", timeout=30)
self.ca.assert_that_pv_is("PARAM:S3INBEAM", expected_inbeam_status)
def test_GIVEN_driver_with_param_value_dependent_axis_WHEN_set_value_THEN_correct_axis_drives_to_position_and_read_back_is_correct(
self):
expected_offset1 = 0.3
expected_offset2 = 0.2
for expected_offset, choice, mot0205, mot0207 in [
(expected_offset1, "MTR0207", 0, expected_offset1),
(expected_offset2, "MTR0205", expected_offset2, expected_offset1)
]:
self.ca.assert_setting_setpoint_sets_readback(
choice, "PARAM:CHOICE")
self.ca.set_pv_value("PARAM:NOTINMODE:SP", expected_offset)
self.ca.assert_that_pv_is("PARAM:NOTINMODE",
expected_offset,
timeout=20)
self.ca_galil.assert_that_pv_is_number("MTR0205.RBV",
mot0205,
timeout=20)
self.ca_galil.assert_that_pv_is_number("MTR0207.RBV",
mot0207,
timeout=20)
def test_GIVEN_theta_WHEN_detector_long_axis_changes_THEN_detector_tracks(
self):
theta_angle = 2
long_axis_addition = 1
self.ca.set_pv_value("PARAM:THETA:SP", theta_angle)
self.ca.set_pv_value("BL:MOVE", 1)
# theta set
self._check_param_pvs("THETA", theta_angle)
self.ca.set_pv_value("PARAM:DET_LONG:SP", long_axis_addition)
self.ca.set_pv_value("BL:MOVE", 1)
expected_det_value = (2 * SPACING + long_axis_addition) * tan(
radians(theta_angle * 2.0))
self._check_param_pvs("DET_LONG", long_axis_addition)
self._check_param_pvs("DET_POS", 0.0)
self.ca_galil.assert_that_pv_is_number("MTR0104", expected_det_value,
0.01)
class Itc503Tests(unittest.TestCase):
"""
Tests for the Itc503 IOC.
"""
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(
"itc503", DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX,
default_timeout=20)
self.ca.assert_that_pv_exists("DISABLE")
self._make_device_scan_faster()
def _make_device_scan_faster(self):
"""
Purely so that the tests run faster, the real IOC scans excruciatingly slowly.
"""
# Skip setting the PVs if the scan rate is already fast
self.ca.assert_that_pv_exists("FAN1")
self.ca.assert_that_pv_exists("FAN2")
if self.ca.get_pv_value("FAN1.SCAN") != ".1 second":
for i in range(1, 8 + 1):
# Ensure all DLY links are 0 in both FAN records
self.ca.set_pv_value("FAN1.DLY{}".format(i), 0)
self.ca.set_pv_value("FAN2.DLY{}".format(i), 0)
# Set the scan rate to .1 second (setting string does not work, have to use numeric value)
self.ca.set_pv_value("FAN1.SCAN", 9)
def test_WHEN_ioc_is_started_THEN_it_is_not_disabled(self):
self.ca.assert_that_pv_is("DISABLE", "COMMS ENABLED")
@parameterized.expand(
(pv, val)
for pv, val in itertools.product(["P", "I", "D"], TEST_VALUES))
def test_WHEN_setting_pid_settings_THEN_can_be_read_back(self, pv, val):
self.ca.set_pv_value("{}:SP".format(pv), val)
self.ca.assert_that_pv_is_number(
pv, val, tolerance=0.1) # Only comes back to 1dp
@parameterized.expand(val for val in parameterized_list(TEST_VALUES))
def test_WHEN_setting_flows_THEN_can_be_read_back(self, _, val):
self.ca.set_pv_value("GASFLOW:SP", val)
self.ca.assert_that_pv_is_number(
"GASFLOW", val, tolerance=0.1) # Only comes back to 1dp
@parameterized.expand(mode for mode in parameterized_list(MODES))
def test_WHEN_setting_gas_flow_control_mode_THEN_can_be_read_back(
self, _, mode):
self.ca.assert_setting_setpoint_sets_readback(mode, "MODE:GAS")
@parameterized.expand(mode for mode in parameterized_list(MODES))
def test_WHEN_setting_heater_flow_control_mode_THEN_can_be_read_back(
self, _, mode):
self.ca.assert_setting_setpoint_sets_readback(mode, "MODE:HTR")
@parameterized.expand(val for val in parameterized_list(TEST_VALUES))
def test_WHEN_temperature_is_set_THEN_temperature_and_setpoint_readbacks_update_to_new_value(
self, _, val):
self.ca.set_pv_value("TEMP:SP", val)
self.ca.assert_that_pv_is_number("TEMP:SP:RBV", val, tolerance=0.1)
self.ca.assert_that_pv_is_number("TEMP:1", val, tolerance=0.1)
self.ca.assert_that_pv_is_number("TEMP:2", val, tolerance=0.1)
self.ca.assert_that_pv_is_number("TEMP:3", val, tolerance=0.1)
@parameterized.expand(chan for chan in parameterized_list(CHANNELS))
@skip_if_recsim(
"Comes back via record redirection which recsim can't handle easily")
def test_WHEN_control_channel_is_set_THEN_control_channel_can_be_read_back(
self, _, chan):
self.ca.assert_setting_setpoint_sets_readback(chan, "CTRLCHANNEL")
@parameterized.expand(mode for mode in CTRL_MODE_ALARMS)
@skip_if_recsim(
"Comes back via record redirection which recsim can't handle easily")
def test_WHEN_setting_control_mode_THEN_can_be_read_back(self, mode):
self.ca.assert_setting_setpoint_sets_readback(
mode, "CTRL", expected_alarm=CTRL_MODE_ALARMS[mode])
@skip_if_recsim("Backdoor does not exist in recsim")
def test_WHEN_sweeping_mode_is_set_via_backdoor_THEN_it_updates_in_the_ioc(
self):
self._lewis.backdoor_set_on_device("sweeping", False)
self.ca.assert_that_pv_is("SWEEPING", "Not Sweeping")
self._lewis.backdoor_set_on_device("sweeping", True)
self.ca.assert_that_pv_is("SWEEPING", "Sweeping")
@parameterized.expand(state for state in ("ON", "OFF"))
@skip_if_recsim(
"Comes back via record redirection which recsim can't handle easily")
def test_WHEN_setting_autopid_THEN_readback_reflects_setting_just_sent(
self, state):
self.ca.assert_setting_setpoint_sets_readback(state, "AUTOPID")
@parameterized.expand(val for val in parameterized_list(TEST_VALUES))
@skip_if_recsim("Backdoor does not exist in recsim")
def test_WHEN_heater_voltage_is_set_THEN_heater_voltage_updates(
self, _, val):
self.ca.set_pv_value("HEATERP:SP", val)
self.ca.assert_that_pv_is_number("HEATERP", val, tolerance=0.1)
# Emulator responds with heater p == heater v. Test that heater p is also reading.
self.ca.assert_that_pv_is_number("HEATERV", val, tolerance=0.1)
@parameterized.expand(
control_command
for control_command in parameterized_list(ALL_CONTROL_COMMANDS))
@skip_if_recsim(
"Comes back via record redirection which recsim can't handle easily")
def test_WHEN_control_command_sent_THEN_remote_unlocked_set(
self, _, control_pv, set_value):
self.ca.set_pv_value("CTRL", "Locked")
self.ca.set_pv_value("{}:SP".format(control_pv), set_value)
self.ca.assert_that_pv_is("CTRL", "Local and remote")
self.ca.set_pv_value("CTRL", "Locked")
@skip_if_recsim(
"Comes back via record redirection which recsim can't handle easily")
def test_WHEN_sweeping_reported_by_hardware_THEN_correct_sweep_state_reported(
self):
"""
The hardware can report the control channel with and without a leading zero (depending on the hardware).
Ensure we catch all cases.
"""
for report_sweep_state_with_leading_zero in [True, False]:
for sweeping in [True, False]:
self._lewis.backdoor_set_on_device(
"report_sweep_state_with_leading_zero",
report_sweep_state_with_leading_zero)
self._lewis.backdoor_set_on_device("sweeping", sweeping)
self.ca.assert_that_pv_is(
"SWEEPING", "Sweeping" if sweeping else "Not Sweeping")
class Jsco4180Tests(unittest.TestCase):
"""
Tests for the Jsco4180 IOC.
"""
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(DEVICE_NAME, DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX, default_timeout=30)
for pv in required_pvs:
self.ca.assert_that_pv_exists(pv, timeout=30)
self._lewis.backdoor_run_function_on_device("reset")
@skip_if_recsim("Unable to use lewis backdoor in RECSIM")
def test_GIVEN_wrong_component_on_device_WHEN_running_THEN_retry_run_and_updates_component(self):
expected_value_A = 30
expected_value_B = 15
expected_value_C = 55
self.ca.set_pv_value("COMP:A:SP", expected_value_A)
self.ca.set_pv_value("COMP:B:SP", expected_value_B)
self.ca.set_pv_value("COMP:C:SP", expected_value_C)
self.ca.set_pv_value("START:SP", 1)
sleep(10)
# Setting an incorrect component on the device will result in the state machine attempting
# to rerun the pump and reset components.
self._lewis.backdoor_set_on_device("component_A", 25)
self._lewis.backdoor_set_on_device("component_B", 10)
self._lewis.backdoor_set_on_device("component_C", 14)
self.ca.assert_that_pv_is("COMP:A", expected_value_A, timeout=30)
self.ca.assert_that_pv_is("COMP:B", expected_value_B, timeout=30)
self.ca.assert_that_pv_is("COMP:C", expected_value_C, timeout=30)
# there was a previous problem where if setpoint and readback differed a sleep and resend was started,
# but the old state machine did not look to see if a new sp was issued while it was asleep and so then
# resent the old out of date SP
@unstable_test(max_retries=2, wait_between_runs=60)
@skip_if_recsim("Unable to use lewis backdoor in RECSIM")
def test_GIVEN_wrong_component_on_device_WHEN_send_new_sp_THEN_state_machine_aborts_resend(self):
value = 50
self.ca.set_pv_value("COMP:A:SP", value)
self.ca.set_pv_value("COMP:B:SP", value)
self.ca.set_pv_value("START:SP", 1)
self.ca.assert_that_pv_is("STATUS", "Pumping", timeout=5)
self.ca.assert_that_pv_is("COMP:A", value, timeout=30)
self.ca.assert_that_pv_is("COMP:B", value, timeout=30)
# Setting an incorrect component on the device will result in the state machine attempting
# to rerun the pump and reset components after a delay
initial_delay = self.ca.get_pv_value("ERROR:DELAY") # delay before state machine reset
delay = 30 # Increase delay to avoid race conditions
self.ca.set_pv_value("ERROR:DELAY", delay)
try:
with self.ca.assert_pv_not_processed("RESET:SP"):
self._lewis.backdoor_set_on_device("component_A", value - 5)
self.ca.assert_that_pv_is("COMP:A", value - 5, timeout=5)
sleep(delay / 2.0)
# however if we change setpoint, the loop should start again
self._lewis.backdoor_set_on_device("component_A", value - 5)
self.ca.set_pv_value("COMP:A:SP", value - 10)
self.ca.set_pv_value("COMP:B:SP", value + 10)
# reset should not have happened yet
self.ca.assert_that_pv_is("COMP:A", value - 5, timeout=delay / 2.0)
self.ca.assert_that_pv_value_is_unchanged("COMP:A", wait=delay / 2.0)
# Reset should now happen within a further timeout/2 seconds (but give it longer to avoid races)
with self.ca.assert_pv_processed("RESET:SP"):
self.ca.assert_that_pv_is("COMP:A", value - 10, timeout=delay * 2)
finally:
# Put error delay back to it's initial value
self.ca.set_pv_value("ERROR:DELAY", initial_delay)
@skip_if_recsim("Unable to use lewis backdoor in RECSIM")
def test_GIVEN_wrong_component_on_device_WHEN_running_continuous_THEN_retry_run_and_updates_component_in_correct_mode(
self):
value = 50
expected_value = "Pumping"
self.ca.set_pv_value("COMP:A:SP", value)
self.ca.set_pv_value("COMP:B:SP", value)
self.ca.set_pv_value("START:SP", 1)
# Give the device some time running in a good state
sleep(10)
# Sabotage! - Setting an incorrect component on the device will result in the state machine attempting
# to rerun the pump and reset components.
self._lewis.backdoor_set_on_device("component_A", 33)
self.ca.assert_that_pv_is("STATUS", expected_value, timeout=30)
@skip_if_recsim("Unable to use lewis backdoor in RECSIM")
def test_GIVEN_wrong_component_on_device_WHEN_running_timed_THEN_retry_run_and_updates_component_in_correct_mode(
self):
value = 50
expected_value = "Pumping"
self.ca.set_pv_value("COMP:A:SP", value)
self.ca.set_pv_value("COMP:B:SP", value)
self.ca.set_pv_value("TIME:RUN:SP", 100)
self.ca.set_pv_value("PUMP_FOR_TIME:SP", 1)
# Give the device some time running in a good state
sleep(10)
# Sabotage! - Setting an incorrect component on the device will result in the state machine attempting
# to rerun the pump and reset components.
self._lewis.backdoor_set_on_device("component_A", 33)
self.ca.assert_that_pv_is("STATUS", expected_value, timeout=30)
@skip_if_recsim("Flowrate device logic not supported in RECSIM")
def test_GIVEN_an_ioc_WHEN_set_flowrate_THEN_flowrate_setpoint_is_correct(self):
error_delay = float(self.ca.get_pv_value("ERROR:DELAY"))
sleep(2 * error_delay) # To make sure we're not in the middle of the error-checking state machine
expected_value = 1.000
self.ca.set_pv_value("FLOWRATE:SP", expected_value)
self.ca.assert_that_pv_is("FLOWRATE:SP:RBV", expected_value)
self.ca.set_pv_value("TIME:RUN:SP", 100)
self.ca.set_pv_value("START:SP", "Start")
self.ca.assert_that_pv_is("FLOWRATE", expected_value)
@skip_if_recsim("LeWIS backdoor not supported in RECSIM")
def test_GIVEN_an_ioc_WHEN_set_flowrate_and_pump_volume_THEN_ioc_uses_rbv_for_calculation_of_remaining_time(self):
expected_sp_value = 1.000
expected_rbv_value = 2.000
pump_for_volume = 2
expected_time_value = (pump_for_volume / expected_rbv_value) * 60
error_delay = float(self.ca.get_pv_value("ERROR:DELAY"))
sleep(2 * error_delay) # To make sure we're not in the middle of the error-checking state machine
# 1. set invalid flowrate setpoint (FLOWRATE:SP)
self.ca.set_pv_value("FLOWRATE:SP", expected_sp_value)
self.ca.assert_that_pv_is("FLOWRATE:SP:RBV", expected_sp_value)
# 2. set valid hardware flowrate (FLOWRATE:SP:RBV) via backdoor command
self._lewis.backdoor_set_on_device("flowrate_rbv", expected_rbv_value)
self.ca.assert_that_pv_is("FLOWRATE:SP:RBV", expected_rbv_value)
# 3. set volume setpoint and start pump
self.ca.set_pv_value("TIME:VOL:SP", pump_for_volume)
self.ca.set_pv_value("START:SP", "Start")
# 4. check calculated time is based on flowrate setpoint readback (:SP:RBV rather than :SP)
self.ca.assert_that_pv_is("TIME:VOL:CALCRUN", expected_time_value)
@skip_if_recsim("LeWIS backdoor not supported in RECSIM")
def test_GIVEN_an_ioc_WHEN_set_flowrate_and_pump_time_THEN_ioc_uses_rbv_for_calculation_of_remaining_volume(self):
expected_sp_value = 1.000
expected_rbv_value = 2.000
pump_for_time = 120
expected_volume_value = (pump_for_time * expected_rbv_value) / 60
error_delay = float(self.ca.get_pv_value("ERROR:DELAY"))
sleep(2 * error_delay) # To make sure we're not in the middle of the error-checking state machine
# 1. set invalid flowrate setpoint (FLOWRATE:SP)
self.ca.set_pv_value("FLOWRATE:SP", expected_sp_value)
self.ca.assert_that_pv_is("FLOWRATE:SP:RBV", expected_sp_value)
# 2. set valid hardware flowrate (FLOWRATE:SP:RBV) via backdoor command
self._lewis.backdoor_set_on_device("flowrate_rbv", expected_rbv_value)
self.ca.assert_that_pv_is("FLOWRATE:SP:RBV", expected_rbv_value)
# 3. set time setpoint and start pump
self.ca.set_pv_value("TIME:RUN:SP", pump_for_time)
self.ca.set_pv_value("START:SP", "Start")
# 4. check calculated volume is based on flowrate setpoint readback (:SP:RBV rather than :SP)
self.ca.assert_that_pv_is("TIME:RUN:CALCVOL", expected_volume_value)
# test to check that the IOC updates the flowrate RBV quickly enough
# for the remaining volume calculation to be valid. simulates operation of a script.
def test_GIVEN_an_ioc_WHEN_set_flowrate_and_immediately_set_pump_to_start_THEN_ioc_updates_rbv_for_calculation_of_remaining_volume(
self):
expected_sp_value = 2.000
script_sp_value = 3.000
pump_for_time = 120
# 1. initialize flowrate
self.ca.set_pv_value("FLOWRATE:SP", expected_sp_value)
self.ca.assert_that_pv_is("FLOWRATE:SP:RBV", expected_sp_value, timeout=5)
# 2. set new flowrate and immediately set pump to run, to simulate script
self.ca.set_pv_value("FLOWRATE:SP", script_sp_value)
self.ca.set_pv_value("TIME:RUN:SP", pump_for_time)
self.ca.set_pv_value("START:SP", "Start")
# 3. calculate remaining volume
expected_volume_value = (pump_for_time * self.ca.get_pv_value("FLOWRATE:SP:RBV")) / 60
# 4. check ioc calculation is as expected
self.ca.assert_that_pv_is("TIME:RUN:CALCVOL", expected_volume_value)
@skip_if_recsim("Lewis device logic not supported in RECSIM")
def test_GIVEN_an_ioc_WHEN_set_maximum_pressure_limit_THEN_maximum_pressure_limit_is_correct(self):
expected_value = 200
self.ca.assert_setting_setpoint_sets_readback(expected_value, "PRESSURE:MAX")
@skip_if_recsim("Lewis device logic not supported in RECSIM")
def test_GIVEN_an_ioc_WHEN_set_minimum_pressure_limit_THEN_minimum_pressure_limit_is_correct(self):
expected_value = 100
self.ca.set_pv_value("PRESSURE:MIN:SP", expected_value)
self.ca.assert_setting_setpoint_sets_readback(expected_value, "PRESSURE:MIN")
@skip_if_recsim("Lewis device logic not supported in RECSIM")
def test_GIVEN_an_ioc_WHEN_continuous_pump_set_THEN_pump_on(self):
self.ca.set_pv_value("START:SP", 1)
self.ca.assert_that_pv_is("STATUS", "Pumping")
@skip_if_recsim("Lewis device logic not supported in RECSIM")
def test_GIVEN_an_ioc_WHEN_timed_pump_set_THEN_timed_pump_on(self):
# Set a run time for a timed run
self.ca.set_pv_value("TIME:RUN:SP", 10000)
self.ca.set_pv_value("PUMP_FOR_TIME:SP", 1)
self.ca.assert_that_pv_is("STATUS", "Pumping")
@skip_if_recsim("Unable to use lewis backdoor in RECSIM")
def test_GIVEN_an_ioc_WHEN_get_current_pressure_THEN_current_pressure_returned(self):
expected_value = 300
self._lewis.backdoor_set_on_device("pressure", expected_value)
self.ca.assert_that_pv_is("PRESSURE", expected_value)
@parameterized.expand([
("component_{}".format(suffix), suffix) for suffix in ["A", "B", "C", "D"]
])
@skip_if_recsim("Reliant on setUP lewis backdoor call")
def test_GIVEN_an_ioc_WHEN_get_component_THEN_correct_component_returned(self, component, suffix):
expected_value = 10.0
self._lewis.backdoor_set_on_device(component, expected_value)
self.ca.assert_that_pv_is("COMP:{}".format(suffix), expected_value)
@parameterized.expand([
("COMP:{}".format(suffix), suffix) for suffix in ["A", "B", "C"]
])
@skip_if_recsim("Reliant on setUP lewis backdoor call")
def test_GIVEN_an_ioc_WHEN_set_component_THEN_correct_component_set(self, component, suffix):
expected_value = 100.0
self.ca.set_pv_value("COMP:{}:SP".format(suffix), expected_value)
if component == "COMP:A":
self.ca.set_pv_value("COMP:B:SP", 0)
self.ca.set_pv_value("COMP:C:SP", 0)
elif component == "COMP:B":
self.ca.set_pv_value("COMP:A:SP", 0)
self.ca.set_pv_value("COMP:C:SP", 0)
elif component == "COMP:C":
self.ca.set_pv_value("COMP:A:SP", 0)
self.ca.set_pv_value("COMP:B:SP", 0)
self.ca.set_pv_value("PUMP_FOR_TIME:SP", "Start")
self.ca.assert_that_pv_is(component, expected_value)
def test_GIVEN_ioc_initial_state_WHEN_get_error_THEN_error_returned(self):
expected_value = "No error"
self.ca.assert_that_pv_is("ERROR", expected_value)
@skip_if_recsim("Unable to use lewis backdoor in RECSIM")
def test_GIVEN_ioc_in_hardware_error_state_WHEN_get_error_THEN_hardware_error_returned(self):
expected_value = "Hardware error"
self._lewis.backdoor_set_on_device("error", ERROR_STATE_HARDWARE_FAULT)
self.ca.assert_that_pv_is("ERROR", expected_value)
@skip_if_recsim("Unable to use lewis backdoor in RECSIM")
def test_GIVEN_ioc_in_error_state_WHEN_reset_error_THEN_error_reset(self):
expected_value = "No error"
self._lewis.backdoor_set_on_device("error", ERROR_STATE_NO_ERROR)
self.ca.set_pv_value("ERROR:SP", "Reset")
self.ca.assert_that_pv_is("ERROR", expected_value)
@skip_if_recsim("Unable to use lewis backdoor in RECSIM")
def test_GIVEN_ioc_in_error_state_WHEN_reset_error_THEN_error_reset(self):
expected_value = "No error"
self._lewis.backdoor_set_on_device("error", ERROR_STATE_HARDWARE_FAULT)
self.ca.assert_that_pv_is("ERROR", expected_value)
@skip_if_recsim("Unable to use lewis backdoor in RECSIM")
def test_GIVEN_device_not_connected_WHEN_get_error_THEN_alarm(self):
self._lewis.backdoor_set_on_device('connected', False)
self.ca.assert_that_pv_alarm_is('ERROR:SP', ChannelAccess.Alarms.INVALID)
@skip_if_recsim("Reliant on setUP lewis backdoor call")
def test_GIVEN_timed_pump_WHEN_get_program_runtime_THEN_program_runtime_increments(self):
self.ca.set_pv_value("TIME:RUN:SP", 10000)
self.ca.set_pv_value("PUMP_FOR_TIME:SP", 1)
self.ca.assert_that_pv_value_is_increasing("TIME", wait=2)
@skip_if_recsim("Lewis device logic not supported in RECSIM")
def test_GIVEN_timed_pump_WHEN_set_constant_pump_THEN_state_updated_to_constant_pump(self):
# Set a run time for a timed run
self.ca.set_pv_value("TIME:RUN:SP", 10000)
self.ca.process_pv("PUMP_FOR_TIME:SP")
expected_value = "Pumping"
self.ca.assert_that_pv_is("STATUS", expected_value)
self.ca.process_pv("START:SP")
expected_value = "Pumping"
self.ca.assert_that_pv_is("STATUS", expected_value)
@skip_if_recsim("Lewis device logic not supported in RECSIM")
def test_GIVEN_constant_pump_WHEN_set_timed_pump_THEN_state_updated_to_timed_pump(self):
expected_value = "Pumping"
self.ca.process_pv("START:SP")
self.ca.assert_that_pv_is("STATUS", expected_value)
# Set a run time for a timed run
self.ca.set_pv_value("TIME:RUN:SP", 10000)
self.ca.process_pv("PUMP_FOR_TIME:SP")
self.ca.assert_that_pv_is("STATUS", expected_value)
@skip_if_recsim("Lewis device logic not supported in RECSIM")
def test_GIVEN_input_incorrect_WHEN_set_flowrate_THEN_trouble_message_returned(self):
self._lewis.backdoor_set_on_device("input_correct", False)
self.ca.set_pv_value("FLOWRATE:SP", 0.010)
self.ca.assert_that_pv_is("ERROR:STR", "[Error:stack underflow]")
@skip_if_recsim("Lewis device logic not supported in RECSIM")
def test_GIVEN_command_seq_that_would_crash_pump_WHEN_command_seq_called_THEN_pump_crashes(self):
self.ca.set_pv_value("_TEST_CRASH.PROC", 1)
self.ca.assert_that_pv_alarm_is("COMP:A", ChannelAccess.Alarms.INVALID, timeout=30)
@skip_if_recsim("Lewis device logic not supported in RECSIM")
def test_GIVEN_pump_running_WHEN_set_file_number_command_called_THEN_program_is_busy_error(self):
expected_value = "[Program is Busy]"
self.ca.set_pv_value("START:SP", 1)
self.ca.set_pv_value("FILE:SP", 0)
self.ca.assert_that_pv_is("ERROR:STR", expected_value)
@parameterized.expand([("low_set_time", 100, 1, 1),
("high_set_time", 1000, 10, 1),
("non_standard_set_time", 456, 5, 1)])
@unstable_test(max_retries=5)
@skip_if_recsim("Lewis device logic not supported in RECSIM")
def test_GIVEN_pump_for_volume_WHEN_pumping_THEN_device_is_pumping_set_volume(self, _, time, volume, flowrate):
# Set a target pump time a target pump volume. When we start a pump set volume run, then the remaining
# time should be related to the target volume, and not the target time (that would be used for a pump for time).
set_time = time
set_volume = volume
set_flowrate = flowrate
expected_time = set_volume * set_flowrate * 60 # flow rate units = mL/min, so convert to seconds
self.ca.set_pv_value("TIME:RUN:SP", set_time)
self.ca.set_pv_value("TIME:VOL:SP", set_volume)
self.ca.set_pv_value("FLOWRATE:SP", set_flowrate)
self.ca.process_pv("PUMP_SET_VOLUME:SP")
self.ca.assert_that_pv_is_within_range("TIME:REMAINING", min_value=expected_time - 20,
max_value=expected_time + 20)
class Lakeshore372Tests(unittest.TestCase):
"""
Tests for the lakeshore 372 IOC.
"""
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(
_EMULATOR_NAME, DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX,
default_timeout=15)
def test_WHEN_device_is_started_THEN_it_is_not_disabled(self):
self.ca.assert_that_pv_is("DISABLE", "COMMS ENABLED")
def _assert_readback_alarm_states(self, alarm):
for readback_pv in [
"TEMP", "TEMP:SP:RBV", "P", "I", "D", "HEATER:POWER",
"RESISTANCE", "HEATER:RANGE"
]:
self.ca.assert_that_pv_alarm_is(readback_pv, alarm)
@contextlib.contextmanager
def _simulate_disconnected_device(self):
self._lewis.backdoor_set_on_device("connected", False)
try:
yield
finally:
self._lewis.backdoor_set_on_device("connected", True)
@parameterized.expand(parameterized_list(TEST_TEMPERATURES))
def test_WHEN_temp_setpoint_is_set_THEN_actual_temperature_updates(
self, _, temperature):
self.ca.assert_setting_setpoint_sets_readback(temperature,
set_point_pv="TEMP:SP",
readback_pv="TEMP")
@parameterized.expand(parameterized_list(TEST_TEMPERATURES))
def test_WHEN_temp_setpoint_is_set_THEN_setpoint_readback_updates(
self, _, temperature):
self.ca.assert_setting_setpoint_sets_readback(
temperature, set_point_pv="TEMP:SP", readback_pv="TEMP:SP:RBV")
@parameterized.expand(parameterized_list(HEATER_RANGES))
def test_WHEN_heater_range_is_set_THEN_heater_range_readback_updates(
self, _, rng):
self.ca.assert_setting_setpoint_sets_readback(
rng, set_point_pv="HEATER:RANGE:SP", readback_pv="HEATER:RANGE")
@parameterized.expand(parameterized_list(TEST_HEATER_POWER_PERCENTAGES))
@skip_if_recsim("Uses lewis backdoor")
def test_WHEN_heater_power_is_set_via_backdoor_THEN_heater_power_pv_updates(
self, _, pwr):
self._lewis.backdoor_set_on_device("heater_power", pwr)
self.ca.assert_that_pv_is_number("HEATER:POWER", pwr, tolerance=0.001)
@parameterized.expand(parameterized_list(TEST_SENSOR_RESISTANCES))
@skip_if_recsim("Uses lewis backdoor")
def test_WHEN_sensor_resistance_is_set_via_backdoor_THEN_resistance_pv_updates(
self, _, res):
self._lewis.backdoor_set_on_device("sensor_resistance", res)
self.ca.assert_that_pv_is_number("RESISTANCE", res, tolerance=0.000001)
@parameterized.expand(parameterized_list(TEST_PID_PARAMS))
def test_WHEN_pid_parameters_are_set_THEN_readbacks_update(
self, _, p, i, d):
# Simulate a script by writing PIDs all in one go without waiting for update first.
self.ca.set_pv_value("P:SP", p)
self.ca.set_pv_value("I:SP", i)
self.ca.set_pv_value("D:SP", d)
self.ca.assert_that_pv_is("P", p)
self.ca.assert_that_pv_is("I", i)
self.ca.assert_that_pv_is("D", d)
@skip_if_recsim("Recsim does not support simulated disconnection")
def test_WHEN_device_does_not_respond_THEN_pvs_go_into_invalid_alarm(self):
self._assert_readback_alarm_states(self.ca.Alarms.NONE)
with self._simulate_disconnected_device():
self._assert_readback_alarm_states(self.ca.Alarms.INVALID)
# Assert alarms clear on reconnection
self._assert_readback_alarm_states(self.ca.Alarms.NONE)
@skip_if_recsim("Complex logic not testable in recsim")
def test_WHEN_temperature_setpoint_is_sent_THEN_control_mode_changed_to_5(
self):
# 5 is the control mode for closed loop PID control, which should always be sent along with a temperature set.
self._lewis.backdoor_set_on_device("control_mode", 0)
self._lewis.assert_that_emulator_value_is("control_mode", 0, cast=int)
self.ca.set_pv_value("TEMP:SP", 0)
self._lewis.assert_that_emulator_value_is("control_mode", 5, cast=int)
class IceFridgeTests(unittest.TestCase):
"""
Tests for the IceFrdge IOC.
"""
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(IOCS[0]["emulator"], DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX, default_timeout=25)
if not IOCRegister.uses_rec_sim:
self._lewis.backdoor_run_function_on_device("reset")
self._lewis.backdoor_set_on_device("connected", True)
def test_WHEN_device_is_started_THEN_it_is_not_disabled(self):
self.ca.assert_that_pv_is("DISABLE", "COMMS ENABLED")
@parameterized.expand(parameterized_list(VTI_TEMP_SUFFIXES))
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_WHEN_VTI_temp_set_backdoor_THEN_ioc_read_correctly(self, _, temp_num):
self._lewis.backdoor_run_function_on_device("set_cryo_temp", (temp_num, 3.6))
self.ca.assert_that_pv_is_number("VTI:TEMP{}".format(temp_num), 3.6, 0.001)
@parameterized.expand(parameterized_list(itertools.product(VTI_LOOPS, VTI_LOOP_TEST_INPUTS)))
def test_WHEN_vti_loop_setpoint_THEN_readback_identical(self, _, loop_num, temp):
self.ca.assert_setting_setpoint_sets_readback(temp, "VTI:LOOP{}:TSET".format(loop_num),
"VTI:LOOP{}:TSET:SP".format(loop_num))
@parameterized.expand(parameterized_list(itertools.product(VTI_LOOPS, VTI_LOOP_TEST_INPUTS)))
def test_WHEN_vti_loop_proportional_THEN_readback_identical(self, _, loop_num, temp):
self.ca.assert_setting_setpoint_sets_readback(temp, "VTI:LOOP{}:P".format(loop_num),
"VTI:LOOP{}:P:SP".format(loop_num))
@parameterized.expand(parameterized_list(itertools.product(VTI_LOOPS, VTI_LOOP_TEST_INPUTS)))
def test_WHEN_vti_loop_integral_THEN_readback_identical(self, _, loop_num, temp):
self.ca.assert_setting_setpoint_sets_readback(temp, "VTI:LOOP{}:I".format(loop_num),
"VTI:LOOP{}:I:SP".format(loop_num))
@parameterized.expand(parameterized_list(itertools.product(VTI_LOOPS, VTI_LOOP_TEST_INPUTS)))
def test_WHEN_vti_loop_derivative_THEN_readback_identical(self, _, loop_num, temp):
self.ca.assert_setting_setpoint_sets_readback(temp, "VTI:LOOP{}:D".format(loop_num),
"VTI:LOOP{}:D:SP".format(loop_num))
@parameterized.expand(parameterized_list(itertools.product(VTI_LOOPS, VTI_LOOP_TEST_INPUTS)))
def test_WHEN_vti_loop_ramp_rate_THEN_readback_identical(self, _, loop_num, temp):
self.ca.assert_setting_setpoint_sets_readback(temp, "VTI:LOOP{}:RAMPRATE".format(loop_num),
"VTI:LOOP{}:RAMPRATE:SP".format(loop_num))
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_WHEN_Lakeshore_MC_Cernox_set_backdoor_THEN_ioc_read_correctly(self):
self._lewis.backdoor_set_on_device("lakeshore_mc_cernox", 0.5)
self.ca.assert_that_pv_is_number("LS:MC:CERNOX", 0.5, 0.001)
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_WHEN_Lakeshore_MC_RuO_set_backdoor_THEN_ioc_read_correctly(self):
self._lewis.backdoor_set_on_device("lakeshore_mc_ruo", 0.6)
self.ca.assert_that_pv_is_number("LS:MC:RUO", 0.6, 0.001)
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_WHEN_Lakeshore_still_temp_set_backdoor_THEN_ioc_read_correctly(self):
self._lewis.backdoor_set_on_device("lakeshore_still_temp", 0.7)
self.ca.assert_that_pv_is_number("LS:STILL:TEMP", 0.7, 0.001)
def test_WHEN_Lakeshore_MC_setpoint_THEN_readback_identical(self):
self.ca.assert_setting_setpoint_sets_readback(0.8, "LS:MC:TEMP", "LS:MC:TEMP:SP")
@skip_if_recsim("Lewis assertion not working in recsim")
def test_WHEN_Lakeshore_MC_setpoint_is_zero_THEN_scan_correct(self):
self.ca.set_pv_value("LS:MC:TEMP:SP", 0)
self._lewis.assert_that_emulator_value_is("lakeshore_scan", 1, 15)
self._lewis.assert_that_emulator_value_is("lakeshore_cmode", 4, 15)
@skip_if_recsim("Lewis assertion not working in recsim")
def test_WHEN_Lakeshore_MC_setpoint_is_larger_than_zero_THEN_scan_correct(self):
self.ca.set_pv_value("LS:MC:TEMP:SP", 4)
self._lewis.assert_that_emulator_value_is("lakeshore_scan", 0, 15)
self._lewis.assert_that_emulator_value_is("lakeshore_cmode", 1, 15)
def test_WHEN_Lakeshore_MC_setpoint_negative_THEN_readback_zero(self):
self.ca.set_pv_value("LS:MC:TEMP:SP", -1)
self.ca.assert_that_pv_is("LS:MC:TEMP", 0)
def test_WHEN_Lakeshore_MC_setpoint_over_limit_THEN_readback_at_limit(self):
self.ca.set_pv_value("LS:MC:TEMP:SP", 301)
self.ca.assert_that_pv_is("LS:MC:TEMP", 300)
def test_WHEN_Lakeshore_MC_proportional_THEN_readback_identical(self):
self.ca.assert_setting_setpoint_sets_readback(0.9, "LS:MC:P", "LS:MC:P:SP")
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_Lakeshore_MC_integral_THEN_readback_identical(self):
self.ca.assert_setting_setpoint_sets_readback(11, "LS:MC:I", "LS:MC:I:SP")
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_Lakeshore_MC_derivative_THEN_readback_identical(self):
self.ca.assert_setting_setpoint_sets_readback(12, "LS:MC:D", "LS:MC:D:SP")
@parameterized.expand(parameterized_list(LS_MC_HTR_RANGE_VALUES))
def test_WHEN_Lakeshore_MC_heater_range_THEN_readback_identical(self, _, heater_range):
self.ca.assert_setting_setpoint_sets_readback(heater_range, "LS:MC:HTR:RANGE", "LS:MC:HTR:RANGE:SP")
@parameterized.expand(parameterized_list(LS_MC_HTR_RANGE_INVALID_VALUES))
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_WHEN_lakeshore_MC_heater_range_invalid_setpoint_THEN_pv_in_alarm(self, _, invalid_range):
self.ca.assert_that_pv_alarm_is("LS:MC:HTR:RANGE", self.ca.Alarms.NONE, timeout=15)
self._lewis.backdoor_set_on_device("lakeshore_mc_heater_range", invalid_range)
self.ca.assert_that_pv_alarm_is("LS:MC:HTR:RANGE", self.ca.Alarms.INVALID, timeout=15)
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_WHEN_Lakeshore_MC_heater_percentage_set_backdoor_THEN_ioc_read_correctly(self):
self._lewis.backdoor_set_on_device("lakeshore_mc_heater_percentage", 50)
self.ca.assert_that_pv_is_number("LS:MC:HTR:PERCENT", 50, 0.001)
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_WHEN_Lakeshore_MC_still_output_set_backdoor_THEN_ioc_read_correctly(self):
self._lewis.backdoor_set_on_device("lakeshore_still_output", 1.3)
self.ca.assert_that_pv_is_number("LS:STILL", 1.3, 0.001)
@parameterized.expand(parameterized_list(itertools.product(LS_VOLTAGE_CHANNELS, LS_VOLTAGE_RANGE_VALUES)))
def test_WHEN_Lakeshore_voltage_range_THEN_readback_identical(self, _, voltage_channel, voltage_value):
self.ca.assert_setting_setpoint_sets_readback(voltage_value, "LS:VLTG:RANGE:CH{}".format(voltage_channel),
"LS:VLTG:RANGE:SP")
@parameterized.expand(parameterized_list(itertools.product(LS_VOLTAGE_CHANNELS, LS_VOLTAGE_RANGE_INVALID_VALUES)))
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_WHEN_Lakeshore_voltage_range_invalid_setpoint_THEN_pv_in_alarm(self, _, voltage_channel, invalid_range):
self.ca.assert_that_pv_alarm_is("LS:VLTG:RANGE:CH{}".format(voltage_channel), self.ca.Alarms.NONE,
timeout=15)
self._lewis.backdoor_set_on_device("lakeshore_exc_voltage_range_ch{}".format(voltage_channel), invalid_range)
self.ca.assert_that_pv_alarm_is("LS:VLTG:RANGE:CH{}".format(voltage_channel), self.ca.Alarms.INVALID,
timeout=15)
@parameterized.expand(parameterized_list(MIMIC_PRESSURE_SUFFIXES))
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_WHEN_pressure_set_backdoor_THEN_ioc_read_correctly(self, _, pressure_num):
self._lewis.backdoor_run_function_on_device("set_pressure", (pressure_num, 1.4))
self.ca.assert_that_pv_is_number("PRESSURE{}".format(pressure_num), 1.4, 0.001)
@parameterized.expand(parameterized_list(MIMIC_VALVE_NUMBERS))
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_valve_status_open_THEN_readback_identical(self, _, valve_num):
self.ca.assert_setting_setpoint_sets_readback("OPEN", "VALVE{}".format(valve_num),
"VALVE{}:SP".format(valve_num))
@parameterized.expand(parameterized_list(MIMIC_VALVE_NUMBERS))
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_valve_status_closed_THEN_readback_identical(self, _, valve_num):
self.ca.assert_setting_setpoint_sets_readback("OPEN", "VALVE{}".format(valve_num),
"VALVE{}:SP".format(valve_num))
self.ca.assert_setting_setpoint_sets_readback("CLOSED", "VALVE{}".format(valve_num),
"VALVE{}:SP".format(valve_num))
@parameterized.expand(parameterized_list(MIMIC_PROPORTIONAL_VALVES_NUMBERS))
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_proportional_valve_THEN_readback_identical(self, _, proportional_valve_num):
self.ca.assert_setting_setpoint_sets_readback(1.5, "PROPORTIONAL_VALVE{}".format(proportional_valve_num),
"PROPORTIONAL_VALVE{}:SP".format(proportional_valve_num))
@parameterized.expand(parameterized_list(itertools.product(MIMIC_PROPORTIONAL_VALVES_NUMBERS, [0.001, 2])))
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_proportional_valve_not_0_THEN_calc_is_one(self, _, proportional_valve_num, test_value):
self.ca.set_pv_value("PROPORTIONAL_VALVE{}:SP".format(proportional_valve_num), test_value)
self.ca.assert_that_pv_is("PROPORTIONAL_VALVE{}:_CALC".format(proportional_valve_num), 1)
@parameterized.expand(parameterized_list(MIMIC_PROPORTIONAL_VALVES_NUMBERS))
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_proportional_valve_0_THEN_calc_is_zero(self, _, proportional_valve_num):
self.ca.set_pv_value("PROPORTIONAL_VALVE{}:SP".format(proportional_valve_num), 1)
self.ca.assert_that_pv_is("PROPORTIONAL_VALVE{}:_CALC".format(proportional_valve_num), 1)
self.ca.set_pv_value("PROPORTIONAL_VALVE{}:SP".format(proportional_valve_num), 0)
self.ca.assert_that_pv_is("PROPORTIONAL_VALVE{}:_CALC".format(proportional_valve_num), 0)
@parameterized.expand(parameterized_list(MIMIC_PROPORTIONAL_VALVES_NUMBERS))
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_proportional_valve_sp_negative_THEN_readback_zero(self, _, proportional_valve_num):
self.ca.set_pv_value("PROPORTIONAL_VALVE{}:SP".format(proportional_valve_num), -1)
self.ca.assert_that_pv_is("PROPORTIONAL_VALVE{}".format(proportional_valve_num), 0)
@parameterized.expand(parameterized_list(MIMIC_PROPORTIONAL_VALVES_NUMBERS))
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_proportional_valve_sp_over_limit_THEN_readback_at_limit(self, _, proportional_valve_num):
self.ca.set_pv_value("PROPORTIONAL_VALVE{}:SP".format(proportional_valve_num), 101)
self.ca.assert_that_pv_is("PROPORTIONAL_VALVE{}".format(proportional_valve_num), 100)
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_needle_valve_THEN_readback_identical(self):
self.ca.assert_setting_setpoint_sets_readback(1.6, "NEEDLE_VALVE", "NEEDLE_VALVE:SP")
@parameterized.expand(parameterized_list([0.001, 2]))
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_needle_valve_not_0_THEN_calc_is_one(self, _, test_value):
self.ca.set_pv_value("NEEDLE_VALVE:SP", test_value)
self.ca.assert_that_pv_is("NEEDLE_VALVE:_CALC", 1)
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_needle_valve_0_THEN_calc_is_zero(self):
self.ca.set_pv_value("NEEDLE_VALVE:SP", 0)
self.ca.assert_that_pv_is("NEEDLE_VALVE:_CALC", 0)
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_needle_valve_sp_negative_THEN_readback_zero(self):
self.ca.set_pv_value("NEEDLE_VALVE:SP", -1)
self.ca.assert_that_pv_is("NEEDLE_VALVE", 0)
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_needle_valve_sp_over_limit_THEN_readback_at_limit(self):
self.ca.set_pv_value("NEEDLE_VALVE:SP", 101)
self.ca.assert_that_pv_is("NEEDLE_VALVE", 100)
@parameterized.expand(parameterized_list(MIMIC_SOLENOID_VALVES_NUMBERS))
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_solenoid_valve_open_THEN_readback_identical(self, _, solenoid_valve_num):
self.ca.assert_setting_setpoint_sets_readback("OPEN", "SOLENOID_VALVE{}".format(solenoid_valve_num),
"SOLENOID_VALVE{}:SP".format(solenoid_valve_num))
@parameterized.expand(parameterized_list(MIMIC_SOLENOID_VALVES_NUMBERS))
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_solenoid_valve_close_THEN_readback_identical(self, _, solenoid_valve_num):
self.ca.assert_setting_setpoint_sets_readback("OPEN", "SOLENOID_VALVE{}".format(solenoid_valve_num),
"SOLENOID_VALVE{}:SP".format(solenoid_valve_num))
self.ca.assert_setting_setpoint_sets_readback("CLOSED", "SOLENOID_VALVE{}".format(solenoid_valve_num),
"SOLENOID_VALVE{}:SP".format(solenoid_valve_num))
@skip_if_recsim("lewis backdoor not available in recsim")
def test_WHEN_1K_stage_temp_THEN_ioc_read_correctly(self):
self._lewis.backdoor_set_on_device("temp_1K_stage", 1.7)
self.ca.assert_that_pv_is_number("1K:TEMP", 1.7, 0.001)
@skip_if_recsim("lewis backdoor not available in recsim")
def test_WHEN_MC_temperature_THEN_ioc_read_correctly(self):
self._lewis.backdoor_set_on_device("mixing_chamber_temp", 1.8)
self.ca.assert_that_pv_is_number("MC:TEMP", 1.8, 0.001)
@skip_if_recsim("lewis backdoor not available in recsim")
def test_WHEN_MC_resistance_THEN_ioc_read_correctly(self):
self._lewis.backdoor_set_on_device("mixing_chamber_resistance", 1.9)
self.ca.assert_that_pv_is_number("MC:_RESISTANCE", 1.9, 0.001)
@skip_if_recsim("lewis backdoor not available in recsim")
def test_WHEN_MC_resistance_calc_THEN_calculation_correct(self):
self._lewis.backdoor_set_on_device("mixing_chamber_resistance", 1918)
self.ca.assert_that_pv_is_number("MC:RESISTANCE:CALC", 1.918, 0.001)
def test_WHEN_mimic_mode_manual_THEN_buttons_disabled(self):
self.ca.set_pv_value("MIMIC:MODE:SP", "MANUAL")
self.ca.assert_that_pv_is("MIMIC:START:SP.DISP", '1')
self.ca.assert_that_pv_is("MIMIC:SKIP:SP.DISP", '1')
self.ca.assert_that_pv_is("MIMIC:STOP:SP.DISP", '1')
def test_WHEN_mimic_mode_automatic_THEN_buttons_disabled(self):
self.ca.set_pv_value("MIMIC:MODE:SP", "AUTOMATIC")
self.ca.assert_that_pv_is("MIMIC:START:SP.DISP", '1')
self.ca.assert_that_pv_is("MIMIC:SKIP:SP.DISP", '1')
self.ca.assert_that_pv_is("MIMIC:STOP:SP.DISP", '1')
def test_WHEN_mimic_mode_semi_automatic_THEN_buttons_enabled(self):
self.ca.set_pv_value("MIMIC:MODE:SP", "SEMI AUTOMATIC")
self.ca.assert_that_pv_is("MIMIC:START:SP.DISP", '0')
self.ca.assert_that_pv_is("MIMIC:SKIP:SP.DISP", '0')
self.ca.assert_that_pv_is("MIMIC:STOP:SP.DISP", '0')
@skip_if_recsim("Lewis assertion not working in recsim")
def test_WHEN_mimic_skip_THEN_skipped(self):
self._lewis.assert_that_emulator_value_is("skipped", False, 15)
self.ca.set_pv_value("MIMIC:MODE:SP", "SEMI AUTOMATIC")
# does not matter what value the pv is set to, only that it processes
self.ca.set_pv_value("MIMIC:SKIP:SP", "SKIP")
self._lewis.assert_that_emulator_value_is("skipped", True, 15)
@skip_if_recsim("Lewis assertion not working in recsim")
def test_WHEN_mimic_stop_THEN_stopped(self):
self._lewis.assert_that_emulator_value_is("stopped", False, 15)
self.ca.set_pv_value("MIMIC:MODE:SP", "SEMI AUTOMATIC")
# does not matter what value the pv is set to, only that it processes
self.ca.set_pv_value("MIMIC:STOP:SP", "STOP")
self._lewis.assert_that_emulator_value_is("stopped", True, 15)
@skip_if_recsim("Lewis assertion not working in recsim")
def test_WHEN_mimic_sequence_condense_THEN_condense(self):
self._lewis.assert_that_emulator_value_is("condense", False, 15)
self.ca.set_pv_value("MIMIC:MODE:SP", "SEMI AUTOMATIC")
self.ca.set_pv_value("MIMIC:SEQUENCE:SP", "Condense")
# does not matter what value the pv is set to, only that it processes
self.ca.set_pv_value("MIMIC:START:SP", "START")
self._lewis.assert_that_emulator_value_is("condense", True, 15)
@skip_if_recsim("Lewis assertion not working in recsim")
def test_WHEN_mimic_sequence_circulate_THEN_circulate(self):
self._lewis.assert_that_emulator_value_is("circulate", False, 15)
self.ca.set_pv_value("MIMIC:MODE:SP", "SEMI AUTOMATIC")
self.ca.set_pv_value("MIMIC:SEQUENCE:SP", "Circulate")
# does not matter what value the pv is set to, only that it processes
self.ca.set_pv_value("MIMIC:START:SP", "START")
self._lewis.assert_that_emulator_value_is("circulate", True, 15)
@skip_if_recsim("Lewis assertion not working in recsim")
def test_WHEN_mimic_sequence_condense_and_circulate_THEN_condense_and_circulate(self):
self._lewis.assert_that_emulator_value_is("condense", False, 15)
self._lewis.assert_that_emulator_value_is("circulate", False, 15)
self.ca.set_pv_value("MIMIC:MODE:SP", "SEMI AUTOMATIC")
self.ca.set_pv_value("MIMIC:SEQUENCE:SP", "Condense & Circulate")
# does not matter what value the pv is set to, only that it processes
self.ca.set_pv_value("MIMIC:START:SP", "START")
self._lewis.assert_that_emulator_value_is("condense", True, 15)
self._lewis.assert_that_emulator_value_is("circulate", True, 15)
@skip_if_recsim("Lewis assertion not working in recsim")
def test_WHEN_mimic_sequence_temp_control_THEN_readback_identical(self):
self._lewis.assert_that_emulator_value_is("temp_control", 0, 15)
self.ca.set_pv_value("MIMIC:MODE:SP", "SEMI AUTOMATIC")
self.ca.set_pv_value("MIMIC:SEQUENCE:SP", "Temperature Control")
self.ca.set_pv_value("MIMIC:SEQUENCE:TEMP:SP", 2.3)
# does not matter what value the pv is set to, only that it processes
self.ca.set_pv_value("MIMIC:START:SP", "START")
self.ca.assert_that_pv_is("MIMIC:SEQUENCE:TEMP", 2.3)
@skip_if_recsim("Lewis assertion not working in recsim")
def test_WHEN_mimic_sequence_make_safe_THEN_make_safe(self):
self._lewis.assert_that_emulator_value_is("make_safe", False, 15)
self.ca.set_pv_value("MIMIC:MODE:SP", "SEMI AUTOMATIC")
self.ca.set_pv_value("MIMIC:SEQUENCE:SP", "Make Safe")
# does not matter what value the pv is set to, only that it processes
self.ca.set_pv_value("MIMIC:START:SP", "START")
self._lewis.assert_that_emulator_value_is("make_safe", True, 15)
@skip_if_recsim("Lewis assertion not working in recsim")
def test_WHEN_mimic_sequence_warm_up_THEN_warm_up(self):
self._lewis.assert_that_emulator_value_is("warm_up", False, 15)
self.ca.set_pv_value("MIMIC:MODE:SP", "SEMI AUTOMATIC")
self.ca.set_pv_value("MIMIC:SEQUENCE:SP", "Warm Up")
# does not matter what value the pv is set to, only that it processes
self.ca.set_pv_value("MIMIC:START:SP", "START")
self._lewis.assert_that_emulator_value_is("warm_up", True, 15)
@skip_if_recsim("Lewis backdoor not working in recsim")
def test_WHEN_mimic_info_THEN_ioc_read_correctly(self):
self._lewis.backdoor_set_on_device("mimic_info", "RBMK reactors do not explode!")
self.ca.assert_that_pv_is("MIMIC:INFO", "RBMK reactors do not explode!")
@skip_if_recsim("Lewis backdoor not working in recsim")
def test_WHEN_state_THEN_ioc_read_correctly(self):
self._lewis.backdoor_set_on_device("state", "It\\'s disgraceful, really!")
self.ca.assert_that_pv_is("STATE", "It's disgraceful, really!")
def test_WHEN_nv_mode_setpoint_manual_THEN_readback_identical(self):
self.ca.assert_setting_setpoint_sets_readback("MANUAL", "NVMODE", "NVMODE:SP")
def test_WHEN_nv_mode_setpoint_auto_THEN_readback_identical(self):
self.ca.assert_setting_setpoint_sets_readback("MANUAL", "NVMODE", "NVMODE:SP")
self.ca.assert_setting_setpoint_sets_readback("AUTO", "NVMODE", "NVMODE:SP")
def test_WHEN_1K_pump_off_THEN_readback_identical(self):
self.ca.assert_setting_setpoint_sets_readback("ON", "1K:PUMP", "1K:PUMP:SP")
self.ca.assert_setting_setpoint_sets_readback("OFF", "1K:PUMP", "1K:PUMP:SP")
def test_WHEN_1K_pump_on_THEN_readback_identical(self):
self.ca.assert_setting_setpoint_sets_readback("OFF", "1K:PUMP", "1K:PUMP:SP")
self.ca.assert_setting_setpoint_sets_readback("ON", "1K:PUMP", "1K:PUMP:SP")
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_He3_pump_off_THEN_readback_identical(self):
self.ca.assert_setting_setpoint_sets_readback("OFF", "HE3:PUMP", "HE3:PUMP:SP")
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_He3_pump_on_THEN_readback_identical(self):
self.ca.assert_setting_setpoint_sets_readback("OFF", "HE3:PUMP", "HE3:PUMP:SP")
self.ca.assert_setting_setpoint_sets_readback("ON", "HE3:PUMP", "HE3:PUMP:SP")
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_roots_pump_off_THEN_readback_identical(self):
self.ca.assert_setting_setpoint_sets_readback("OFF", "ROOTS", "ROOTS:SP")
@skip_if_recsim("pv updated when other pv processes, has no scan field")
def test_WHEN_roots_pump_on_THEN_readback_identical(self):
self.ca.assert_setting_setpoint_sets_readback("OFF", "ROOTS", "ROOTS:SP")
self.ca.assert_setting_setpoint_sets_readback("ON", "ROOTS", "ROOTS:SP")
@skip_if_recsim("testing lack of connection to device makes no sense in recsim")
def test_WHEN_ioc_disconnected_THEN_all_pvs_in_alarm(self):
for pv in TEST_ALARM_STATUS_PVS:
self.ca.assert_that_pv_alarm_is(pv, self.ca.Alarms.NONE)
self._lewis.backdoor_set_on_device("connected", False)
for pv in TEST_ALARM_STATUS_PVS:
self.ca.assert_that_pv_alarm_is(pv, self.ca.Alarms.INVALID)
class Keithley2400Tests(unittest.TestCase):
"""
Tests for the keithley 2400.
"""
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(
"keithley_2400", DEVICE_PREFIX)
self._lewis.backdoor_set_on_device("random_output", False)
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX)
def calculate_resistance_range(self, value):
"""
The resistance ranges of the device are 2.1*10^x, where x is between 0 and 8
"""
for r in [2.1 * 10**i for i in range(1, 8)]:
if value < r:
return r / 10
@skip_if_recsim("Recsim does not work with lewis backdoor tests")
def test_WHEN_current_value_is_set_THEN_readback_returns_value_just_set(
self):
self.ca.set_pv_value("OUTPUT:MODE:SP", "On")
for test_val in TEST_OUTPUTS:
self._lewis.backdoor_set_on_device("current", test_val)
self.ca.assert_that_pv_is_number("CURR",
test_val,
tolerance=0.05 * abs(test_val))
@skip_if_recsim("Recsim does not work with lewis backdoor tests")
def test_WHEN_voltage_value_is_set_THEN_readback_returns_value_just_set(
self):
self.ca.set_pv_value("OUTPUT:MODE:SP", "On")
for test_val in TEST_OUTPUTS:
self._lewis.backdoor_set_on_device("voltage", test_val)
self.ca.assert_that_pv_is_number("VOLT",
test_val,
tolerance=0.05 * abs(test_val))
@skip_if_recsim("Recsim does not work with lewis backdoor tests")
def test_WHEN_voltage_and_current_are_set_THEN_readback_returns_valid_resistance(
self):
self.ca.set_pv_value("OUTPUT:MODE:SP", "On")
for volts, amps in itertools.product([4.5, 6.7], [6.7, 4.5]):
self._lewis.backdoor_set_on_device("current", amps)
self._lewis.backdoor_set_on_device("voltage", volts)
resistance = volts / amps
self.ca.assert_that_pv_is_number("RES",
resistance,
tolerance=0.05 * resistance)
def test_WHEN_ioc_is_started_THEN_ioc_is_not_disabled(self):
self.ca.assert_that_pv_is("DISABLE", "COMMS ENABLED")
def test_WHEN_output_mode_is_set_THEN_readback_updates_with_the_value_just_set(
self):
for mode in ["On", "Off"]:
self.ca.assert_setting_setpoint_sets_readback(mode, "OUTPUT:MODE")
@skip_if_recsim("Recsim does not work with lewis backdoor tests")
def test_WHEN_output_mode_is_unset_THEN_current_readback_does_not_update(
self):
# Write to the RAW pv, test that the CURR pv does not update with the new value when output is off
self.ca.set_pv_value("CURR:RAW", 1.0)
self.ca.set_pv_value("OUTPUT:MODE:SP", "Off")
self._lewis.backdoor_set_on_device("current", 5.0)
self.ca.assert_that_pv_value_is_unchanged("CURR", 1.0)
@skip_if_recsim("Recsim does not work with lewis backdoor tests")
def test_WHEN_output_mode_is_unset_THEN_voltage_readback_does_not_update(
self):
# Write to the RAW value, test that the VOLT pv does not update with the new value when output is off
self.ca.set_pv_value("VOLT:RAW", 1.0)
self.ca.set_pv_value("OUTPUT:MODE:SP", "Off")
self._lewis.backdoor_set_on_device("voltage", 5.0)
self.ca.assert_that_pv_value_is_unchanged("VOLT", 1.0)
def test_WHEN_resistance_mode_is_set_THEN_readback_updates_with_the_value_just_set(
self):
for mode in ["Manual", "Auto"]:
self.ca.assert_setting_setpoint_sets_readback(mode, "RES:MODE")
def test_WHEN_remote_sensing_mode_is_set_THEN_readback_updates_with_the_value_just_set(
self):
for mode in ["On", "Off"]:
self.ca.assert_setting_setpoint_sets_readback(mode, "SENS:MODE")
def test_WHEN_automatic_range_is_set_THEN_readback_updates_with_the_value_just_set(
self):
for test_val in ["Manual", "Auto"]:
self.ca.assert_setting_setpoint_sets_readback(
test_val, "RES:RANGE:AUTO")
@skip_if_recsim("Banded record behaviour too complex for recsim")
def test_WHEN_range_is_set_THEN_readback_updates_with_appropriate_range_for_value_just_set(
self):
for test_val in TEST_OUTPUTS:
ideal_range = self.calculate_resistance_range(test_val)
self.ca.set_pv_value("RES:RANGE:SP", test_val)
self.ca.assert_that_pv_is_number("RES:RANGE",
ideal_range,
tolerance=0.05 * ideal_range)
def test_WHEN_source_mode_is_set_THEN_readback_updates_with_the_value_just_set(
self):
for test_val in ["Current", "Voltage"]:
self.ca.assert_setting_setpoint_sets_readback(
test_val, "SOURCE:MODE")
def test_WHEN_current_compliance_is_set_THEN_readback_updates_with_the_value_just_set(
self):
for test_val in TEST_OUTPUTS:
self.ca.assert_setting_setpoint_sets_readback(
test_val, "CURR:COMPLIANCE")
def test_WHEN_voltage_compliance_is_set_THEN_readback_updates_with_the_value_just_set(
self):
for test_val in TEST_OUTPUTS:
self.ca.assert_setting_setpoint_sets_readback(
test_val, "VOLT:COMPLIANCE")
def test_WHEN_source_voltage_is_set_THEN_readback_updates_with_the_value_just_set(
self):
for test_val in TEST_OUTPUTS:
self.ca.assert_setting_setpoint_sets_readback(
test_val, "VOLT:SOURCE")
def test_WHEN_source_current_is_set_THEN_readback_updates_with_the_value_just_set(
self):
for test_val in TEST_OUTPUTS:
self.ca.assert_setting_setpoint_sets_readback(
test_val, "CURR:SOURCE")
def test_WHEN_source_current_autoranging_is_set_THEN_readback_updates_with_the_value_just_set(
self):
for test_val in ["Off", "On"]:
self.ca.assert_setting_setpoint_sets_readback(
test_val, "CURR:SOURCE:AUTORANGE")
def test_WHEN_source_voltage_autoranging_is_set_THEN_readback_updates_with_the_value_just_set(
self):
for test_val in ["On", "Off"]:
self.ca.assert_setting_setpoint_sets_readback(
test_val, "VOLT:SOURCE:AUTORANGE")
def test_WHEN_measurement_current_autoranging_is_set_THEN_readback_updates_with_the_value_just_set(
self):
for test_val in ["On", "Off"]:
self.ca.assert_setting_setpoint_sets_readback(
test_val, "CURR:MEAS:AUTORANGE")
def test_WHEN_measurement_voltage_autoranging_is_set_THEN_readback_updates_with_the_value_just_set(
self):
for test_val in ["On", "Off"]:
self.ca.assert_setting_setpoint_sets_readback(
test_val, "VOLT:MEAS:AUTORANGE")
@skip_if_recsim("Banded record behaviour too complex for recsim")
def test_WHEN_source_current_range_is_set_THEN_readback_updates_with_the_appropriate_range_for_value_just_set(
self):
"""
Current ranges on the KHLY2400 are simply powers of ten, the whole range of which is covered here
"""
for test_val in RANGE_MAGNITUDES:
self.ca.set_pv_value("CURR:SOURCE:RANGE:SP", test_val)
self.ca.assert_that_pv_is_number("CURR:SOURCE:RANGE",
test_val,
tolerance=0.05 * test_val)
@skip_if_recsim("Banded record behaviour too complex for recsim")
def test_WHEN_source_voltage_range_is_set_THEN_readback_updates_with_the_appropriate_range_for_value_just_set(
self):
"""
Voltage ranges on the KHLY2400 are 2*multiples of ten, the whole range is covered here.
"""
for magnitude in RANGE_MAGNITUDES:
test_val = 2. * magnitude
self.ca.set_pv_value("VOLT:SOURCE:RANGE:SP", test_val)
self.ca.assert_that_pv_is_number("VOLT:SOURCE:RANGE",
test_val,
tolerance=0.05 * test_val)
@skip_if_recsim("Banded record behaviour too complex for recsim")
def test_WHEN_volts_measurement_range_is_set_THEN_readback_updates_with_appropriate_range_for_value_just_set(
self):
"""
Voltage ranges on the KHLY2400 are 2*multiples of ten, the whole range is covered here.
"""
for magnitude in RANGE_MAGNITUDES:
test_val = 2. * magnitude
self.ca.set_pv_value("VOLT:MEAS:RANGE:SP", test_val)
self.ca.assert_that_pv_is_number("VOLT:MEAS:RANGE",
test_val,
tolerance=0.05 * test_val)
@skip_if_recsim("Banded record behaviour too complex for recsim")
def test_WHEN_current_measurement_range_is_set_THEN_readback_updates_with_appropriate_range_for_value_just_set(
self):
"""
Current ranges on the KHLY2400 are simply powers of ten, the whole range of which is covered here
"""
for test_val in RANGE_MAGNITUDES:
self.ca.set_pv_value("CURR:MEAS:RANGE:SP", test_val)
self.ca.assert_that_pv_is_number("CURR:MEAS:RANGE",
test_val,
tolerance=0.05 * test_val)
class InstronStressRigTests(unittest.TestCase):
"""
Tests for the Instron IOC.
"""
def _change_channel(self, name):
# Setpoint is zero-indexed
self.ca.set_pv_value("CHANNEL:SP", CHANNELS[name] - 1)
self.ca.assert_that_pv_is("CHANNEL.RVAL", CHANNELS[name])
self.ca.assert_that_pv_alarm_is("CHANNEL", self.ca.Alarms.NONE)
self.ca.assert_that_pv_is("CHANNEL:GUI", name)
self.ca.assert_that_pv_alarm_is("CHANNEL:GUI", self.ca.Alarms.NONE)
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(
"instron_stress_rig", DEVICE_PREFIX)
self.ca = ChannelAccess(15, device_prefix=DEVICE_PREFIX)
self.ca.assert_that_pv_exists("CHANNEL", timeout=30)
# Can't use lewis backdoor commands in recsim
# All of the below commands apply to devsim only.
if not IOCRegister.uses_rec_sim:
# Reinitialize the emulator state
self._lewis.backdoor_command(["device", "reset"])
self._lewis.backdoor_set_on_device("status", 7680)
for index, chan_type2 in enumerate((3, 2, 4)):
self._lewis.backdoor_command([
"device", "set_channel_param",
str(index + 1), "channel_type",
str(chan_type2)
])
self.ca.assert_that_pv_is("CHANNEL:SP.ZRST", "Position")
self._change_channel("Position")
# Ensure the rig is stopped
self._lewis.backdoor_command(["device", "movement_type", "0"])
self.ca.assert_that_pv_is("GOING", "NO")
# Ensure stress area and strain length are sensible values (i.e. not zero)
self._lewis.backdoor_command(
["device", "set_channel_param", "2", "area", "10"])
self._lewis.backdoor_command(
["device", "set_channel_param", "3", "length", "10"])
self.ca.assert_that_pv_is_number("STRESS:AREA",
10,
tolerance=0.001)
self.ca.assert_that_pv_is_number("STRAIN:LENGTH",
10,
tolerance=0.001)
# Ensure that all the scales are sensible values (i.e. not zero)
for index, channel in enumerate(POS_STRESS_STRAIN, 1):
self._lewis.backdoor_command(
["device", "set_channel_param",
str(index), "scale", "10"])
self.ca.assert_that_pv_is_number(channel + ":SCALE",
10,
tolerance=0.001)
# Always set the waveform generator to run for lots of cycles so it only stops if we want it to
self.ca.set_pv_value(quart_prefixed("CYCLE:SP"), LOTS_OF_CYCLES)
@skip_if_recsim("In rec sim we can not set the code easily")
def test_WHEN_the_rig_has_no_error_THEN_the_status_is_ok(self):
self._lewis.backdoor_set_on_device("status", 7680)
self.ca.assert_that_pv_is("STAT:DISP", "System OK")
self.ca.assert_that_pv_alarm_is("STAT:DISP", ChannelAccess.Alarms.NONE)
@skip_if_recsim("In rec sim we can not set the code easily")
def test_WHEN_the_rig_has_other_no_error_THEN_the_status_is_ok(self):
self._lewis.backdoor_set_on_device("status", 0)
self.ca.assert_that_pv_is("STAT:DISP", "System OK")
self.ca.assert_that_pv_alarm_is("STAT:DISP", ChannelAccess.Alarms.NONE)
@skip_if_recsim("In rec sim we can not set the code easily")
def test_WHEN_the_rig_has_error_THEN_the_status_is_emergency_stop_pushed(
self):
code_and_errors = [([0, 1, 1, 0], "Emergency stop pushed"),
([0, 0, 0, 1], "Travel limit exceeded"),
([0, 0, 1, 0], "Power amplifier too hot"),
([0, 1, 1, 0], "Emergency stop pushed"),
([0, 1, 0, 1], "Invalid status from rig"),
([0, 1, 0, 0], "Invalid status from rig"),
([0, 1, 1, 0], "Emergency stop pushed"),
([0, 1, 1, 1], "Oil too hot"),
([1, 0, 0, 0], "Oil level too low"),
([1, 0, 0, 1], "Motor too hot"),
([1, 0, 1, 0], "Oil pressure too high"),
([1, 0, 1, 1], "Oil pressure too low"),
([1, 1, 0, 0], "Manifold/pump blocked"),
([1, 1, 0, 1], "Oil level going too low"),
([1, 1, 1, 0], "Manifold low pressure")]
for code, error in code_and_errors:
code_val = code[0] * 2**12
code_val += code[1] * 2**11
code_val += code[2] * 2**10
code_val += code[3] * 2**9
self._lewis.backdoor_set_on_device("status", code_val)
self.ca.assert_that_pv_is("STAT:DISP",
error,
msg="code set {0} = {code_val}".format(
code, code_val=code_val))
self.ca.assert_that_pv_alarm_is("STAT:DISP",
ChannelAccess.Alarms.MAJOR)
def test_WHEN_the_rig_is_initialized_THEN_it_is_not_going(self):
self.ca.assert_that_pv_is("GOING", "NO")
def test_WHEN_the_rig_is_initialized_THEN_it_is_not_panic_stopping(self):
self.ca.assert_that_pv_is("PANIC:SP", "READY")
def test_WHEN_the_rig_is_initialized_THEN_it_is_not_stopping(self):
self.ca.assert_that_pv_is("STOP:SP", "READY")
def test_that_the_rig_is_not_normally_in_control_mode(self):
self.ca.assert_that_pv_is("STOP:SP", "READY")
def test_WHEN_init_sequence_run_THEN_waveform_ramp_is_set_the_status_is_ok(
self):
for chan in POS_STRESS_STRAIN:
self.ca.set_pv_value("{0}:RAMP:WFTYP:SP".format(chan), 0)
self.ca.set_pv_value("INIT", 1)
for chan in POS_STRESS_STRAIN:
self.ca.assert_that_pv_is("{0}:RAMP:WFTYP".format(chan),
RAMP_WAVEFORM_TYPES[3])
def _switch_to_position_channel_and_change_setpoint(self):
# It has to be big or the set point will be reached before the test completes
_big_set_point = 999999999999
# Select position as control channel
self._change_channel("Position")
# Change the setpoint so that movement can be started
self.ca.set_pv_value("POS:SP", _big_set_point)
self.ca.assert_that_pv_is_number("POS:SP", _big_set_point, tolerance=1)
self.ca.assert_that_pv_is_number("POS:SP:RBV",
_big_set_point,
tolerance=1)
@skip_if_recsim("Dynamic behaviour not captured in RECSIM")
def test_WHEN_going_and_then_stopping_THEN_going_pv_reflects_the_expected_state(
self):
self.ca.assert_that_pv_is("GOING", "NO")
self._switch_to_position_channel_and_change_setpoint()
self.ca.set_pv_value("MOVE:GO:SP", 1)
self.ca.assert_that_pv_is("GOING", "YES")
self.ca.set_pv_value("STOP:SP", 1)
self.ca.assert_that_pv_is("GOING", "NO")
self.ca.set_pv_value("STOP:SP", 0)
@skip_if_recsim("Dynamic behaviour not captured in RECSIM")
def test_WHEN_going_and_then_panic_stopping_THEN_going_pv_reflects_the_expected_state(
self):
self.ca.assert_that_pv_is("GOING", "NO")
self._switch_to_position_channel_and_change_setpoint()
self.ca.set_pv_value("MOVE:GO:SP", 1)
self.ca.assert_that_pv_is("GOING", "YES")
self.ca.set_pv_value("PANIC:SP", 1)
self.ca.assert_that_pv_is("GOING", "NO")
self.ca.set_pv_value("PANIC:SP", 0)
@skip_if_recsim("In rec sim this test fails")
def test_WHEN_arbitrary_command_Q22_is_sent_THEN_the_response_is_a_status_code(
self):
self.ca.set_pv_value("ARBITRARY:SP", "Q22")
# Assert that the response to Q22 is a status code
self.ca.assert_that_pv_is_within_range("ARBITRARY",
min_value=0,
max_value=65535)
@skip_if_recsim("In rec sim this test fails")
def test_WHEN_arbitrary_command_Q300_is_sent_THEN_the_response_is_a_number_between_1_and_3(
self):
self.ca.set_pv_value("ARBITRARY:SP", "Q300")
# Assert that the response to Q300 is between 1 and 3
self.ca.assert_that_pv_is_within_range("ARBITRARY",
min_value=1,
max_value=3)
@skip_if_recsim("In rec sim this test fails")
def test_WHEN_arbitrary_command_C4_is_sent_THEN_Q4_gives_back_the_value_that_was_just_set(
self):
def _set_and_check(value):
# Put the record into a non-alarm state. This is needed so that we can wait until the record is in alarm
# later, when we do a command which (expectedly) puts the record into a timeout alarm.
self.ca.set_pv_value("ARBITRARY:SP", "Q4,1")
self.ca.assert_that_pv_alarm_is("ARBITRARY", self.ca.Alarms.NONE)
self.ca.set_pv_value("ARBITRARY:SP", "C4,1," + str(value))
self.ca.assert_that_pv_is("ARBITRARY:SP", "C4,1," + str(value))
# No response from arbitrary command causes record to be TIMEOUT INVALID - this is expected.
self.ca.assert_that_pv_alarm_is("ARBITRARY",
self.ca.Alarms.INVALID)
self.ca.set_pv_value("ARBITRARY:SP", "Q4,1")
self.ca.assert_that_pv_is_number("ARBITRARY",
value,
tolerance=0.001,
timeout=60)
for v in [0, 1, 0]:
_set_and_check(v)
def test_WHEN_control_channel_is_requested_THEN_an_allowed_value_is_returned(
self):
self.ca.assert_that_pv_is_one_of("CHANNEL", CHANNELS.keys())
@skip_if_recsim("In rec sim this test fails")
def test_WHEN_control_channel_setpoint_is_requested_THEN_it_is_one_of_the_allowed_values(
self):
self.ca.assert_that_pv_is_one_of("CHANNEL:SP", CHANNELS.keys())
@skip_if_recsim("In rec sim this test fails")
def test_WHEN_the_control_channel_is_set_THEN_the_readback_contains_the_value_that_was_just_set(
self):
for channel in CHANNELS.keys():
# change channel function contains the relevant assertions.
self._change_channel(channel)
def test_WHEN_the_step_time_for_various_channels_is_set_as_an_integer_THEN_the_readback_contains_the_value_that_was_just_set(
self):
for chan, val in [("POS", 123), ("STRESS", 456), ("STRAIN", 789)]:
pv_name = chan + ":STEP:TIME"
self.ca.assert_setting_setpoint_sets_readback(val, pv_name)
def test_WHEN_the_step_time_for_various_channels_is_set_as_a_float_THEN_the_readback_contains_the_value_that_was_just_set(
self):
for chan, val in [("POS", 111.111), ("STRESS", 222.222),
("STRAIN", 333.333)]:
pv_name = chan + ":STEP:TIME"
self.ca.assert_setting_setpoint_sets_readback(val, pv_name)
def test_WHEN_the_ramp_waveform_for_a_channel_is_set_THEN_the_readback_contains_the_value_that_was_just_set(
self):
pv_name = "{0}:RAMP:WFTYP"
for chan in POS_STRESS_STRAIN:
for set_value, return_value in enumerate(RAMP_WAVEFORM_TYPES):
self.ca.assert_setting_setpoint_sets_readback(
set_value,
pv_name.format(chan),
expected_value=return_value)
def test_WHEN_the_ramp_amplitude_for_a_channel_is_set_as_an_integer_THEN_the_readback_contains_the_value_that_was_just_set(
self):
for chan in POS_STRESS_STRAIN:
for val in [0, 10, 1000, 1000000]:
pv_name = chan + ":RAW:SP"
pv_name_rbv = pv_name + ":RBV"
self.ca.assert_setting_setpoint_sets_readback(
val, readback_pv=pv_name_rbv, set_point_pv=pv_name)
def test_WHEN_the_ramp_amplitude_for_a_channel_is_set_as_a_float_THEN_the_readback_contains_the_value_that_was_just_set(
self):
for chan in POS_STRESS_STRAIN:
for val in [1.0, 5.5, 1.000001, 9.999999, 10000.1]:
pv_name = chan + ":RAW:SP"
pv_name_rbv = pv_name + ":RBV"
self.ca.assert_setting_setpoint_sets_readback(
val, readback_pv=pv_name_rbv, set_point_pv=pv_name)
@skip_if_recsim("In rec sim this test fails")
def test_WHEN_the_setpoint_for_a_channel_is_set_THEN_the_readback_contains_the_value_that_was_just_set(
self):
def _set_and_check(chan, value):
self.ca.set_pv_value(chan + ":SP", value)
self.ca.assert_that_pv_is_number(chan + ":SP",
value,
tolerance=0.001)
self.ca.assert_that_pv_is_number(chan + ":SP:RBV",
value,
tolerance=0.05,
timeout=30)
for chan in POS_STRESS_STRAIN:
for i in [1.0, 123.456, 555.555, 1000]:
_set_and_check(chan, i)
def test_WHEN_channel_tolerance_is_set_THEN_it_changes_limits_on_SP_RBV(
self):
for chan in POS_STRESS_STRAIN:
sp_val = 1
self.ca.set_pv_value(chan + ":SP", sp_val)
for val in [0.1, 1.0, 2.5]:
pv_name = chan + ":TOLERANCE"
pv_name_high = chan + ":SP:RBV.HIGH"
pv_name_low = chan + ":SP:RBV.LOW"
self.ca.assert_setting_setpoint_sets_readback(
val,
readback_pv=pv_name_high,
set_point_pv=pv_name,
expected_value=val + sp_val,
expected_alarm=None)
self.ca.assert_setting_setpoint_sets_readback(
val,
readback_pv=pv_name_low,
set_point_pv=pv_name,
expected_value=sp_val - val,
expected_alarm=None)
@skip_if_recsim("Alarms not properly emulated in recsim")
def test_GIVEN_a_big_tolerance_WHEN_the_setpoint_is_set_THEN_the_setpoint_has_no_alarms(
self):
def _set_and_check(chan, value):
self.ca.set_pv_value(chan + ":SP", value)
self.ca.set_pv_value(chan + ":TOLERANCE", 9999)
self.ca.assert_that_pv_alarm_is(chan + ":SP:RBV",
ChannelAccess.Alarms.NONE)
for chan in POS_STRESS_STRAIN:
for i in [0.123, 567]:
_set_and_check(chan, i)
@skip_if_recsim("Alarms not properly emulated in recsim")
def test_GIVEN_a_tolerance_of_minus_one_WHEN_the_setpoint_is_set_THEN_the_setpoint_readback_has_alarms(
self):
def _set_and_check(chan, value):
self.ca.set_pv_value(chan + ":SP", value)
self.ca.set_pv_value(chan + ":TOLERANCE", -1)
self.ca.assert_that_pv_alarm_is(chan + ":SP:RBV",
ChannelAccess.Alarms.MINOR)
for chan in POS_STRESS_STRAIN:
for i in [0.234, 789]:
_set_and_check(chan, i)
@skip_if_recsim("In rec sim this test fails")
def test_WHEN_ioc_gets_a_raw_position_reading_from_the_device_THEN_it_is_converted_correctly(
self):
for chan_scale in [0.1, 10.0]:
self._lewis.backdoor_command(
["device", "set_channel_param", "1", "scale",
str(chan_scale)])
self.ca.assert_that_pv_is("POS:SCALE", chan_scale)
for raw_value in [0, 123]:
self._lewis.backdoor_command([
"device", "set_channel_param", "1", "value",
str(raw_value)
])
self.ca.assert_that_pv_is_number("POS:RAW",
raw_value,
tolerance=0.01)
self.ca.assert_that_pv_is_number("POS",
raw_value * chan_scale * 1000,
tolerance=(0.01 * chan_scale *
1000))
@skip_if_recsim("In rec sim this test fails")
def test_WHEN_ioc_gets_a_raw_stress_reading_from_the_device_THEN_it_is_converted_correctly(
self):
for chan_area in [0.1, 10.0]:
self._lewis.backdoor_command(
["device", "set_channel_param", "2", "area",
str(chan_area)])
self.ca.assert_that_pv_is("STRESS:AREA", chan_area)
for chan_scale in [0.1, 10.0]:
self._lewis.backdoor_command([
"device", "set_channel_param", "2", "scale",
str(chan_scale)
])
self.ca.assert_that_pv_is("STRESS:SCALE", chan_scale)
for raw_value in [0, 123]:
self._lewis.backdoor_command([
"device", "set_channel_param", "2", "value",
str(raw_value)
])
self.ca.assert_that_pv_is("STRESS:RAW", raw_value)
self.ca.assert_that_pv_is(
"STRESS", raw_value * chan_scale * (1.0 / chan_area))
@skip_if_recsim("In rec sim this test fails")
def test_WHEN_strain_length_updates_on_device_THEN_pv_updates(self):
for value in [1, 123]:
self._lewis.backdoor_command(
["device", "set_channel_param", "3", "length",
str(value)])
self.ca.assert_that_pv_is("STRAIN:LENGTH", value)
@skip_if_recsim("In rec sim this test fails")
def test_WHEN_ioc_gets_a_raw_strain_reading_from_the_device_THEN_it_is_converted_correctly(
self):
for chan_scale in [0.1, 10.0]:
self._lewis.backdoor_command(
["device", "set_channel_param", "3", "scale",
str(chan_scale)])
for chan_length in [0.1, 10.0]:
self._lewis.backdoor_command([
"device", "set_channel_param", "3", "length",
str(chan_length)
])
for raw_value in [0, 0.001]:
self._lewis.backdoor_command([
"device", "set_channel_param", "3", "value",
str(raw_value)
])
self.ca.assert_that_pv_is("STRAIN:SCALE", chan_scale)
self.ca.assert_that_pv_is("STRAIN:LENGTH", chan_length)
self.ca.assert_that_pv_is("STRAIN:RAW", raw_value)
self.ca.assert_that_pv_is(
"STRAIN",
(raw_value * chan_scale * 100000 * (1 / chan_length)))
def test_WHEN_the_area_setpoint_is_set_THEN_the_area_readback_updates(
self):
def _set_and_check(value):
self.ca.set_pv_value("STRESS:AREA:SP", value)
self.ca.assert_that_pv_is_number("STRESS:AREA",
value,
tolerance=0.01)
self.ca.assert_that_pv_alarm_is("STRESS:AREA",
ChannelAccess.Alarms.NONE)
for val in [0.234, 789]:
_set_and_check(val)
def test_WHEN_the_area_setpoint_is_set_THEN_the_diameter_readback_updates(
self):
def _set_and_check(value):
self.ca.set_pv_value("STRESS:AREA:SP", value)
self.ca.assert_that_pv_is_number("STRESS:DIAMETER",
(2 * math.sqrt(value / math.pi)),
tolerance=0.01)
self.ca.assert_that_pv_alarm_is("STRESS:DIAMETER",
ChannelAccess.Alarms.NONE)
for val in [0.234, 789]:
_set_and_check(val)
def test_WHEN_the_diameter_setpoint_is_set_THEN_the_diameter_readback_updates(
self):
def _set_and_check(value):
self.ca.set_pv_value("STRESS:DIAMETER:SP", value)
self.ca.assert_that_pv_is_number("STRESS:DIAMETER",
value,
tolerance=0.0005)
self.ca.assert_that_pv_alarm_is("STRESS:DIAMETER",
ChannelAccess.Alarms.NONE)
for val in [0.234, 789]:
_set_and_check(val)
def test_WHEN_the_diameter_setpoint_is_set_THEN_the_area_readback_updates(
self):
def _set_and_check(value):
self.ca.set_pv_value("STRESS:DIAMETER:SP", value)
self.ca.assert_that_pv_is_number("STRESS:AREA",
((value / 2.0)**2 * math.pi),
tolerance=0.0005)
self.ca.assert_that_pv_alarm_is("STRESS:AREA",
ChannelAccess.Alarms.NONE)
for val in [0.234, 789]:
_set_and_check(val)
@skip_if_recsim("In rec sim this test fails")
def test_WHEN_a_position_setpoint_is_set_THEN_it_is_converted_correctly(
self):
for scale in [2.34, 456.78]:
self._lewis.backdoor_command(
["device", "set_channel_param", "1", "scale",
str(scale)])
self.ca.assert_that_pv_is("POS:SCALE", scale)
for val in [1.23, 123.45]:
self.ca.set_pv_value("POS:SP", val)
self.ca.assert_that_pv_is_number("POS:RAW:SP",
val * (1.0 / 1000.0) *
(1 / scale),
tolerance=0.0000000001)
self.ca.assert_that_pv_alarm_is("POS:RAW:SP",
ChannelAccess.Alarms.NONE)
@skip_if_recsim("In rec sim this test fails")
def test_WHEN_a_stress_setpoint_is_set_THEN_it_is_converted_correctly(
self):
for area in [789, 543.21]:
self._lewis.backdoor_command(
["device", "set_channel_param", "2", "area",
str(area)])
self.ca.assert_that_pv_is("STRESS:AREA", area)
for chan_scale in [2.34, 456.78]:
self._lewis.backdoor_command([
"device", "set_channel_param", "2", "scale",
str(chan_scale)
])
self.ca.assert_that_pv_is("STRESS:SCALE", chan_scale)
for val in [1.23, 123.45]:
self.ca.set_pv_value("STRESS:SP", val)
self.ca.assert_that_pv_is_number("STRESS:RAW:SP",
val * (1 / chan_scale) *
area,
tolerance=0.0000000001)
self.ca.assert_that_pv_alarm_is("STRESS:RAW:SP",
ChannelAccess.Alarms.NONE)
@skip_if_recsim("In rec sim this test fails")
def test_WHEN_a_strain_setpoint_is_set_THEN_it_is_converted_correctly(
self):
for length in [789, 543.21]:
self._lewis.backdoor_command(
["device", "set_channel_param", "3", "length",
str(length)])
self.ca.assert_that_pv_is("STRAIN:LENGTH", length)
for chan_scale in [2.34, 456.78]:
self._lewis.backdoor_command([
"device", "set_channel_param", "3", "scale",
str(chan_scale)
])
self.ca.assert_that_pv_is("STRAIN:SCALE", chan_scale)
for val in [1.23, 123.45]:
self.ca.set_pv_value("STRAIN:SP", val)
self.ca.assert_that_pv_is_number("STRAIN:RAW:SP",
val * (1 / chan_scale) *
length * (1.0 / 100000.0),
tolerance=0.0000000001)
self.ca.assert_that_pv_alarm_is("STRAIN:RAW:SP",
ChannelAccess.Alarms.NONE)
@skip_if_recsim("In rec sim this test fails")
def test_WHEN_the_channel_type_updates_on_the_device_THEN_the_pv_updates(
self):
for chan_name, chan_num in [("POS", 1), ("STRESS", 2), ("STRAIN", 3)]:
for value_1, value_2, return_value_1, return_value_2 in [
(0, 1, "Standard transducer", "Unrecognized"),
(1, 10, "User transducer", "Ext. waveform generator")
]:
self._lewis.backdoor_command([
"device", "set_channel_param",
str(chan_num), "transducer_type",
str(value_1)
])
self._lewis.backdoor_command([
"device", "set_channel_param",
str(chan_num), "channel_type",
str(value_2)
])
self.ca.assert_that_pv_is("" + chan_name + ":TYPE:STANDARD",
return_value_1)
self.ca.assert_that_pv_is("" + chan_name + ":TYPE",
return_value_2)
def test_WHEN_waveform_type_abs_set_on_axes_THEN_all_axes_are_set(self):
def _set_and_check(set_value, return_value):
self.ca.set_pv_value("AXES:RAMP:WFTYP:SP", set_value)
for chan in POS_STRESS_STRAIN:
self.ca.assert_that_pv_is("{0}:RAMP:WFTYP".format(chan),
return_value)
self.ca.assert_that_pv_alarm_is("{0}:RAMP:WFTYP".format(chan),
ChannelAccess.Alarms.NONE)
for set_value, return_value in enumerate(RAMP_WAVEFORM_TYPES):
_set_and_check(set_value, return_value)
@skip_if_recsim("In rec sim this test fails")
def test_WHEN_channel_fails_check_THEN_channel_mbbi_record_is_invalid_and_has_tag_disabled(
self):
for index, (chan_name, type, index_as_name,
channel_as_name) in enumerate(
zip(POS_STRESS_STRAIN, (1, 1, 1), ("ZR", "ON", "TW"),
("Position", "Stress", "Strain"))):
self._lewis.backdoor_command([
"device", "set_channel_param",
str(index + 1), "channel_type",
str(type)
])
self.ca.assert_that_pv_is("" + chan_name + ":TYPE:CHECK", "FAIL")
self.ca.assert_that_pv_is("CHANNEL:SP.{}ST".format(index_as_name),
"{0} - disabled".format(channel_as_name))
self.ca.set_pv_value("CHANNEL:SP", index)
self.ca.assert_that_pv_alarm_is("CHANNEL:SP",
ChannelAccess.Alarms.INVALID)
@skip_if_recsim("In rec sim this test fails")
def test_WHEN_channel_succeeds_check_THEN_channel_mbbi_record_is_invalid_and_has_tag_disabled(
self):
self.ca.set_pv_value("CHANNEL:SP", 3)
for index, (chan_name, type, index_as_name,
channel_as_name) in enumerate(
zip(POS_STRESS_STRAIN, (3, 2, 4), ("ZR", "ON", "TW"),
("Position", "Stress", "Strain"))):
self._lewis.backdoor_command([
"device", "set_channel_param",
str(index + 1), "channel_type",
str(type)
])
self.ca.assert_that_pv_is("" + chan_name + ":TYPE:CHECK",
"PASS",
timeout=30)
self.ca.assert_that_pv_is("CHANNEL:SP.{}ST".format(index_as_name),
channel_as_name)
self.ca.assert_that_pv_is("CHANNEL:SP.{}SV".format(index_as_name),
ChannelAccess.Alarms.NONE)
self.ca.set_pv_value("CHANNEL:SP", index)
self.ca.assert_that_pv_alarm_is("CHANNEL:SP",
ChannelAccess.Alarms.NONE)
@skip_if_recsim("In rec sim we can not disconnect the device from the IOC")
def test_WHEN_the_rig_is_not_connected_THEN_the_status_has_alarm(self):
self._lewis.backdoor_set_on_device("status", None)
self.ca.assert_that_pv_alarm_is("STAT:DISP",
ChannelAccess.Alarms.INVALID)
# Waveform tests
def check_running_state(self, status, running, continuing, timeout=None):
self.ca.assert_that_pv_is(wave_prefixed("STATUS"), status, timeout)
self.ca.assert_that_pv_is(wave_prefixed("RUNNING"),
"Running" if running else "Not running",
timeout)
self.ca.assert_that_pv_is(
wave_prefixed("CONTINUING"),
"Continuing" if continuing else "Not continuing", timeout)
@skip_if_recsim("No backdoor in LewisNone")
def test_GIVEN_the_waveform_generator_is_stopped_WHEN_it_is_started_THEN_it_is_running(
self):
self.check_running_state(status="Stopped",
running=False,
continuing=False)
self.ca.set_pv_value(wave_prefixed("START"), 1)
self.check_running_state(status="Running",
running=True,
continuing=True)
@skip_if_recsim("No backdoor in LewisNone")
def test_GIVEN_the_waveform_generator_is_stopped_WHEN_it_is_aborted_THEN_it_is_stopped(
self):
self.check_running_state(status="Stopped",
running=False,
continuing=False)
self.ca.set_pv_value(wave_prefixed("ABORT"), 1)
self.check_running_state(status="Stopped",
running=False,
continuing=False)
@skip_if_recsim("No backdoor in LewisNone")
def test_GIVEN_the_waveform_generator_is_stopped_WHEN_it_is_stopped_THEN_it_is_stopped(
self):
self.check_running_state(status="Stopped",
running=False,
continuing=False)
self.ca.set_pv_value(wave_prefixed("STOP"), 1)
self.check_running_state(status="Stopped",
running=False,
continuing=False)
@skip_if_recsim("No backdoor in LewisNone")
def test_GIVEN_the_waveform_generator_is_running_WHEN_it_is_started_THEN_it_is_running(
self):
self._lewis.backdoor_command(
["device", "set_waveform_state", WAVEFORM_RUNNING])
self.check_running_state(status="Running",
running=True,
continuing=True)
self.ca.set_pv_value(wave_prefixed("START"), 1)
self.check_running_state(status="Running",
running=True,
continuing=True)
@skip_if_recsim("No backdoor in LewisNone")
def test_GIVEN_the_waveform_generator_is_running_WHEN_it_is_aborted_THEN_it_is_aborted(
self):
self._lewis.backdoor_command(
["device", "set_waveform_state", WAVEFORM_RUNNING])
self.check_running_state(status="Running",
running=True,
continuing=True)
self.ca.set_pv_value(wave_prefixed("ABORT"), 1)
self.check_running_state(status="Aborted",
running=False,
continuing=False)
@skip_if_recsim("No backdoor in LewisNone")
def test_GIVEN_the_waveform_generator_is_running_WHEN_it_is_stopped_THEN_it_is_finishing_and_then_stops_within_5_seconds(
self):
self._lewis.backdoor_command(
["device", "set_waveform_state", WAVEFORM_RUNNING])
self.check_running_state(status="Running",
running=True,
continuing=True)
self.ca.set_pv_value(wave_prefixed("STOP"), 1)
self.check_running_state(status="Finishing",
running=True,
continuing=False)
self.check_running_state(status="Stopped",
running=False,
continuing=False,
timeout=5)
@skip_if_recsim("No backdoor in LewisNone")
def test_GIVEN_the_waveform_generator_is_aborted_WHEN_it_is_started_THEN_it_is_running_and_keeps_running(
self):
self._lewis.backdoor_command(
["device", "set_waveform_state", WAVEFORM_ABORTED])
self.check_running_state(status="Aborted",
running=False,
continuing=False)
self.ca.set_pv_value(wave_prefixed("START"), 1)
self.check_running_state(status="Running",
running=True,
continuing=True)
# We need to make sure it can keep running for a few scans. The IOC could feasibly stop the generator shortly
# after it is started
time.sleep(5)
self.check_running_state(status="Running",
running=True,
continuing=True)
@skip_if_recsim("No backdoor in LewisNone")
def test_GIVEN_the_waveform_generator_is_aborted_WHEN_it_is_aborted_THEN_it_is_aborted(
self):
self._lewis.backdoor_command(
["device", "set_waveform_state", WAVEFORM_ABORTED])
self.check_running_state(status="Aborted",
running=False,
continuing=False)
self.ca.set_pv_value(wave_prefixed("ABORT"), 1)
self.check_running_state(status="Aborted",
running=False,
continuing=False)
@skip_if_recsim("No backdoor in LewisNone")
def test_GIVEN_the_waveform_generator_is_aborted_WHEN_it_is_stopped_THEN_it_is_aborted(
self):
self._lewis.backdoor_command(
["device", "set_waveform_state", WAVEFORM_ABORTED])
self.check_running_state(status="Aborted",
running=False,
continuing=False)
self.ca.set_pv_value(wave_prefixed("STOP"), 1)
self.check_running_state(status="Aborted",
running=False,
continuing=False)
def test_WHEN_waveform_type_is_set_THEN_the_device_reports_it_has_changed(
self):
for index, wave_type in enumerate([
"Sine", "Triangle", "Square", "Haversine", "Havetriangle",
"Haversquare", "Sensor", "Aux", "Sawtooth"
]):
self.ca.assert_setting_setpoint_sets_readback(
index, wave_prefixed("TYPE"), expected_value=wave_type)
@skip_if_recsim("Recsim record does not handle multiple channels ")
def test_GIVEN_multiple_channels_WHEN_waveform_frequency_is_set_THEN_the_device_is_updated_to_that_value(
self):
expected_values = [123.456, 789.012, 345.678]
assert len(expected_values) == NUMBER_OF_CHANNELS
# Do this as two separate loops so that we can verify that all 3 channel values are stored independently
for device_channel in range(NUMBER_OF_CHANNELS):
self.ca.set_pv_value("CHANNEL:SP.VAL", device_channel)
self.ca.set_pv_value(wave_prefixed("FREQ:SP"),
expected_values[device_channel])
for device_channel in range(NUMBER_OF_CHANNELS):
self.ca.set_pv_value("CHANNEL:SP.VAL", device_channel)
self.ca.assert_that_pv_is(wave_prefixed("FREQ"),
expected_values[device_channel])
@unstable_test()
@skip_if_recsim("Conversion factors initialized to 0")
def test_GIVEN_multiple_channels_WHEN_waveform_amplitude_is_set_THEN_the_device_is_updated_to_that_value_with_channel_conversion_factor_applied(
self):
input_values = [123.4, 567.8, 91.2]
conversion_factors = [
float(self.ca.get_pv_value("POS:SCALE")) * 1000,
float(self.ca.get_pv_value("STRESS:SCALE")) /
float(self.ca.get_pv_value("STRESS:AREA")),
float(self.ca.get_pv_value("STRAIN:SCALE")) * 100000 *
float(self.ca.get_pv_value("STRAIN:LENGTH"))
]
for i in range(len(conversion_factors)):
self.assertNotEqual(0, conversion_factors[i],
"Factor {} was zero".format(i))
expected_values = [
input_values[i] / conversion_factors[i]
for i in range(NUMBER_OF_CHANNELS)
]
assert len(expected_values) == len(conversion_factors) == len(
input_values) == NUMBER_OF_CHANNELS
# Do this as two separate loops so that we can verify that all 3 channel values are stored independently
for device_channel in range(NUMBER_OF_CHANNELS):
self.ca.set_pv_value("CHANNEL:SP.VAL", device_channel)
self.ca.set_pv_value(wave_prefixed("AMP:SP"),
input_values[device_channel])
self.ca.assert_that_pv_is(wave_prefixed("AMP"),
expected_values[device_channel])
self.ca.assert_that_pv_is(wave_prefixed("AMP:SP:RBV"),
input_values[device_channel])
for device_channel in range(NUMBER_OF_CHANNELS):
self.ca.set_pv_value("CHANNEL:SP.VAL", device_channel)
self.ca.assert_that_pv_is(wave_prefixed("AMP"),
expected_values[device_channel])
self.ca.assert_that_pv_is(wave_prefixed("AMP:SP:RBV"),
input_values[device_channel])
@skip_if_recsim("RECSIM does not capture dynamic behaviour")
def test_WHEN_the_quarter_counter_is_off_THEN_the_number_of_counts_is_and_remains_zero(
self):
self.ca.set_pv_value(quart_prefixed("OFF"), 1)
self.ca.assert_that_pv_is("QUART", 0)
self.ca.assert_that_pv_is("QUART", 0, timeout=5)
@skip_if_recsim("Status more complicated than RECSIM can handle")
def test_WHEN_the_quarter_counter_is_armed_THEN_the_status_is_armed(self):
self.ca.set_pv_value(quart_prefixed("ARM"), 1)
self.ca.assert_that_pv_is(quart_prefixed("STATUS"), "Armed")
@skip_if_recsim("Counting part of dynamic device behaviour")
def test_WHEN_the_waveform_generator_is_started_THEN_the_quarter_counter_starts_counting_and_keeps_increasing(
self):
self.ca.set_pv_value(wave_prefixed("START"), 1)
self.ca.assert_that_pv_value_is_increasing("QUART", 5)
@skip_if_recsim("Status more complicated than RECSIM can handle")
def test_WHEN_the_quarter_counter_is_armed_THEN_the_number_of_quarts_never_exceeds_the_requested_maximum(
self):
cycles = 5
self.ca.set_pv_value(quart_prefixed("CYCLE:SP"), cycles)
self.ca.assert_that_pv_is(quart_prefixed("SP"), cycles * 4)
self.ca.set_pv_value(wave_prefixed("START"), 1)
while self.ca.get_pv_value(quart_prefixed("STATUS")) == "Armed":
self.assertLessEqual(float(self.ca.get_pv_value("QUART") / 4.0),
cycles)
self.ca.assert_that_pv_is(quart_prefixed("STATUS"), "Tripped")
def test_GIVEN_the_waveform_generator_is_stopped_WHEN_instructed_to_hold_THEN_status_is_stopped(
self):
self.ca.assert_that_pv_is(wave_prefixed("STATUS"), "Stopped")
self.ca.set_pv_value(wave_prefixed("HOLD"), 1)
self.ca.assert_that_pv_is(wave_prefixed("STATUS"), "Stopped")
@skip_if_recsim("No backdoor in LewisNone")
def test_GIVEN_the_waveform_generator_is_running_WHEN_instructed_to_hold_THEN_status_is_holding(
self):
self._lewis.backdoor_command(
["device", "set_waveform_state", WAVEFORM_RUNNING])
self.ca.assert_that_pv_is(wave_prefixed("STATUS"), "Running")
self.ca.set_pv_value(wave_prefixed("HOLD"), 1)
self.ca.assert_that_pv_is(wave_prefixed("STATUS"), "Holding")
@skip_if_recsim("No backdoor in LewisNone")
def test_GIVEN_the_waveform_generator_is_holding_WHEN_instructed_to_hold_THEN_status_is_holding(
self):
self._lewis.backdoor_command(
["device", "set_waveform_state", WAVEFORM_HOLDING])
self.ca.assert_that_pv_is(wave_prefixed("STATUS"), "Holding")
self.ca.set_pv_value(wave_prefixed("HOLD"), 1)
self.ca.assert_that_pv_is(wave_prefixed("STATUS"), "Holding")
@skip_if_recsim("No backdoor in LewisNone")
def test_GIVEN_the_waveform_generator_is_finishing_WHEN_instructed_to_hold_THEN_status_is_finishing(
self):
self._lewis.backdoor_command(
["device", "set_waveform_state", WAVEFORM_FINISHING])
self.ca.assert_that_pv_is(wave_prefixed("STATUS"), "Finishing")
self.ca.set_pv_value(wave_prefixed("HOLD"), 1)
self.ca.assert_that_pv_is(wave_prefixed("STATUS"), "Finishing")
def verify_channel_abs(self, expected_value):
self.ca.assert_that_pv_is("POS:RAMP:WFTYP", expected_value)
self.ca.assert_that_pv_is("STRAIN:RAMP:WFTYP", expected_value)
self.ca.assert_that_pv_is("STRESS:RAMP:WFTYP", expected_value)
def test_WHEN_the_waveform_generator_is_started_THEN_every_axis_is_set_to_ramp(
self):
self.ca.set_pv_value(wave_prefixed("START"), 1)
self.verify_channel_abs(RAMP_WAVEFORM_TYPES[0])
def test_WHEN_the_waveform_generator_is_stopped_THEN_every_axis_is_set_to_absolute_ramp(
self):
self.ca.set_pv_value(wave_prefixed("STOP"), 1)
self.verify_channel_abs(RAMP_WAVEFORM_TYPES[3])
@skip_if_recsim("Different statuses don't interact in RECSIM")
def test_WHEN_the_waveform_generator_is_started_THEN_the_quarter_counter_is_armed(
self):
self.ca.set_pv_value(wave_prefixed("START"), 1)
self.ca.assert_that_pv_is(quart_prefixed("STATUS"), "Armed")
def test_WHEN_the_max_cyles_is_set_THEN_the_readback_matches_setpoint(
self):
value = 7
self.ca.assert_setting_setpoint_sets_readback(
value=value,
set_point_pv=quart_prefixed("CYCLE:SP"),
readback_pv=quart_prefixed("CYCLE:SP:RBV"))
class Lakeshore460Tests(unittest.TestCase):
"""
Tests for the Lakeshore460.
"""
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(
"lakeshore460", DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix="LKSH460_01",
default_timeout=30,
default_wait_time=0.0)
self.ca.assert_that_pv_exists("IDN")
@parameterized.expand([("tesla", UnitFlags.TESLA, UnitStrings.TESLA),
("gauss", UnitFlags.GAUSS, UnitStrings.GAUSS)])
def test_GIVEN_unit_set_to_value_WHEN_read_THEN_unit_is_value(
self, _, unit_flag, unit_string):
self.ca.set_pv_value("CHANNEL", "X")
self.ca.assert_setting_setpoint_sets_readback(
unit_flag, "UNIT", expected_value=unit_string)
@skip_if_recsim("In rec sim this test fails")
def test_GIVEN_magnetic_field_reading_set_WHEN_read_THEN_magnetic_field_reading_is_set_value(
self):
for chan in channels:
set_field_reading = 1.2356
self._lewis.backdoor_command([
"device", "set_channel_param", chan, "field_reading",
str(set_field_reading)
])
self.ca.assert_that_pv_is("{}:FIELD:RAW".format(chan),
set_field_reading)
@skip_if_recsim("In rec sim this test fails")
def test_GIVEN_prms_set_peak_WHEN_read_THEN_prms_is_peak(self):
for chan in channels:
set_prms = UnitFlags.PEAK
expected_prms = UnitStrings.PEAK
self.ca.assert_setting_setpoint_sets_readback(
set_prms,
"{}:PRMS".format(chan),
expected_value=expected_prms,
timeout=15)
def test_GIVEN_source_set_WHEN_read_THEN_source_is_set_value(self):
for key in vectors:
set_value = key
expected_value = vectors[key]
self.ca.assert_setting_setpoint_sets_readback(
set_value, "SOURCE", expected_value=expected_value)
@parameterized.expand([("DC", UnitFlags.DC, UnitStrings.DC),
("AC", UnitFlags.AC, UnitStrings.AC)])
@skip_if_recsim("In rec sim this test fails")
def test_GIVEN_output_mode_set_to_value_WHEN_read_THEN_output_mode_is_value(
self, _, unit_flag, unit_string):
for chan in channels:
self.ca.assert_setting_setpoint_sets_readback(
unit_flag, "{}:MODE".format(chan), expected_value=unit_string)
@skip_if_recsim("In rec sim this test fails")
def test_GIVEN_prms_set_rms_WHEN_read_THEN_prms_is_rms(self):
for chan in channels:
set_prms = UnitFlags.RMS
expected_prms = UnitStrings.RMS
self.ca.assert_setting_setpoint_sets_readback(
set_prms,
"{}:PRMS".format(chan),
expected_value=expected_prms,
timeout=15)
@parameterized.expand([("ON", UnitFlags.ON, UnitStrings.ON),
("OFF", UnitFlags.OFF, UnitStrings.OFF)])
@skip_if_recsim("In rec sim this test fails")
def test_GIVEN_display_filter_set_to_val_WHEN_read_THEN_display_filter_is_set_value(
self, _, unit_flag, unit_string):
for chan in channels:
self.ca.assert_setting_setpoint_sets_readback(
unit_flag,
"{}:FILTER".format(chan),
expected_value=unit_string)
@parameterized.expand([("ON", UnitFlags.ON, UnitStrings.ON),
("OFF", UnitFlags.OFF, UnitStrings.OFF)])
@skip_if_recsim("In rec sim this test fails")
def test_GIVEN_rel_mode_status_set_to_val_WHEN_read_THEN_rel_mode_status_is_set_value(
self, _, unit_flag, unit_string):
for chan in channels:
self.ca.assert_setting_setpoint_sets_readback(
unit_flag,
"{}:RELMODE".format(chan),
expected_value=unit_string)
@parameterized.expand(parameterized_list([10.4, 20, 3]))
@skip_if_recsim("In rec sim this test fails")
def test_GIVEN_rel_mode_setpoint_set_to_val_WHEN_read_THEN_rel_mode_setpoint_is_set_value(
self, _, value):
for chan in channels:
self.ca.assert_setting_setpoint_sets_readback(
value, "{}:RELMODESET".format(chan))
@parameterized.expand([("ON", UnitFlags.ON, UnitStrings.ON),
("OFF", UnitFlags.OFF, UnitStrings.OFF)])
@skip_if_recsim("In rec sim this test fails")
def test_GIVEN_auto_mode_status_set_to_value_WHEN_read_THEN_auto_mode_status_is_set_value(
self, _, unit_flag, unit_string):
for chan in channels:
self.ca.assert_setting_setpoint_sets_readback(
unit_flag, "{}:AUTO".format(chan), expected_value=unit_string)
@parameterized.expand([("ON", UnitFlags.ON, UnitStrings.ON),
("OFF", UnitFlags.OFF, UnitStrings.OFF)])
@skip_if_recsim("In rec sim this test fails")
def test_GIVEN_max_hold_status_set_to_value_WHEN_read_THEN_max_hold_status_is_set_value(
self, _, unit_flag, unit_string):
for chan in channels:
self.ca.assert_setting_setpoint_sets_readback(
unit_flag,
"{}:MAXHOLD".format(chan),
expected_value=unit_string)
@parameterized.expand([
("ON", UnitFlags.CHANNEL_ON, UnitStrings.CHANNEL_ON),
("OFF", UnitFlags.CHANNEL_OFF, UnitStrings.CHANNEL_OFF)
])
@skip_if_recsim("In rec sim this test fails")
def test_GIVEN_channel_status_set_on_WHEN_read_THEN_channel_status_is_set_value(
self, _, unit_flag, unit_string):
for chan in channels:
self.ca.assert_setting_setpoint_sets_readback(
unit_flag,
"{}:STATUS".format(chan),
expected_value=unit_string)
@parameterized.expand([("11_alarm_major", 11, "MAJOR"),
("4_no_alarm", 4, "NO_ALARM")])
@skip_if_recsim("In rec sim this test fails")
def test_GIVEN_filter_windows_set_WHEN_read_THEN_alarm_is_as_expected(
self, _, filter_windows, exp_alarm):
for chan in channels:
self.ca.assert_setting_setpoint_sets_readback(
filter_windows,
"{}:FWIN".format(chan),
expected_alarm=exp_alarm)
@parameterized.expand([("65_alarm_major", 65, "MAJOR"),
("10_no_alarm", 10, "NO_ALARM")])
@skip_if_recsim("In rec sim this test fails")
def test_GIVEN_filter_points_set_WHEN_read_THEN_alarm_is_major(
self, _, filter_points, exp_alarm):
for chan in channels:
self.ca.assert_setting_setpoint_sets_readback(
filter_points,
"{}:FNUM".format(chan),
expected_alarm=exp_alarm)
@skip_if_recsim("In rec sim this test fails")
def test_GIVEN_range_set_WHEN_read_THEN_range_is_set_value(self):
for chan in channels:
for key in ranges:
set_range = key
expected_range = ranges[key]
self.ca.assert_setting_setpoint_sets_readback(
set_range,
"{}:RANGE".format(chan),
expected_value=expected_range)
class CryoSMSTests(unittest.TestCase):
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(
EMULATOR_NAME, DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX,
default_timeout=10)
if IOCRegister.uses_rec_sim:
self.ca.assert_that_pv_exists("DISABLE", timeout=30)
else:
self.ca.assert_that_pv_is("INIT", "Startup complete", timeout=60)
self._lewis.backdoor_set_on_device("mid_target", 0)
self._lewis.backdoor_set_on_device("output", 0)
self.ca.set_pv_value("MID:SP", 0)
self.ca.set_pv_value("START:SP", 1)
self.ca.set_pv_value("PAUSE:SP", 1)
self._lewis.backdoor_set_on_device("output", 0)
self.ca.set_pv_value("ABORT:SP", 1)
self.ca.set_pv_value("PAUSE:SP", 0)
self.ca.assert_that_pv_is("RAMP:STAT", "HOLDING ON TARGET")
self.ca.assert_that_pv_is("OUTPUT:RAW", 0)
@skip_if_recsim("Cannot properly simulate device startup in recsim")
def test_GIVEN_certain_macros_WHEN_IOC_loads_THEN_correct_values_initialised(
self):
expectedValues = {
"OUTPUT:SP": 0,
"OUTPUT": 0,
"OUTPUT:COIL": 0,
"OUTPUT:PERSIST": 0,
"OUTPUT:VOLT": 0,
"RAMP:RATE": 1.12,
"READY": 1,
"RAMP:RAMPING": 0,
"TARGET:TIME": 0,
"STAT": "",
"HEATER:STAT": "OFF",
"START:SP.DISP": "0",
"PAUSE:SP.DISP": "0",
"ABORT:SP.DISP": "0",
"OUTPUT:SP.DISP": "0",
"MAGNET:MODE.DISP": "1",
"RAMP:LEADS.DISP": "1",
}
failedPVs = []
for PV in expectedValues:
try:
self.ca.assert_that_pv_is(PV, expectedValues[PV], timeout=5)
except Exception as e:
failedPVs.append(e.message)
if failedPVs:
self.fail("The following PVs generated errors:\n{}".format(
"\n".join(failedPVs)))
def test_GIVEN_outputmode_sp_correct_WHEN_outputmode_sp_written_to_THEN_outputmode_changes(
self):
# For all other tests, alongside normal operation, communication should be in amps
self.ca.assert_setting_setpoint_sets_readback("TESLA",
"OUTPUTMODE",
"OUTPUTMODE:SP",
timeout=10)
self.ca.assert_setting_setpoint_sets_readback("AMPS",
"OUTPUTMODE",
"OUTPUTMODE:SP",
timeout=10)
@parameterized.expand(parameterized_list(TEST_RAMPS))
@skip_if_recsim("C++ driver can not correctly initialise in recsim")
def test_GIVEN_psu_at_field_strength_A_WHEN_told_to_ramp_to_B_THEN_correct_rates_used(
self, _, ramp_data):
startPoint, endPoint = ramp_data[0]
ramp_rates = ramp_data[1]
# When setting output, convert from Gauss to Amps by dividing by 10000 and T_TO_A, also ensure sign handled
# correctly
sign = 1 if startPoint >= 0 else -1
self._lewis.backdoor_run_function_on_device("switch_direction", [sign])
self._lewis.backdoor_set_on_device("output",
abs(startPoint) / (0.037 * 10000))
self.ca.set_pv_value("MID:SP", endPoint)
self.ca.set_pv_value("START:SP", 1)
for rate in ramp_rates:
self.ca.assert_that_pv_is("RAMP:RATE", rate, timeout=20)
self.ca.assert_that_pv_is("RAMP:STAT", "HOLDING ON TARGET", timeout=25)
self.ca.assert_that_pv_is_within_range("OUTPUT", endPoint - 0.01,
endPoint + 0.01)
@skip_if_recsim("C++ driver can not correctly initialise in recsim")
def test_GIVEN_IOC_not_ramping_WHEN_ramp_started_THEN_simulated_ramp_performed(
self):
self.ca.set_pv_value("MID:SP", 10000)
self.ca.set_pv_value("START:SP", 1)
self.ca.assert_that_pv_is("RAMP:STAT",
"RAMPING",
msg="Ramping failed to start")
self.ca.assert_that_pv_is("RAMP:STAT", "HOLDING ON TARGET", timeout=10)
@skip_if_recsim("C++ driver can not correctly initialise in recsim")
def test_GIVEN_IOC_ramping_WHEN_paused_and_unpaused_THEN_ramp_is_paused_resumed_and_completes(
self):
# GIVEN ramping
self.ca.set_pv_value("MID:SP", 10000)
self.ca.set_pv_value("START:SP", 1)
self.ca.assert_that_pv_is("RAMP:STAT", "RAMPING")
# Pauses when pause set to true
self.ca.set_pv_value("PAUSE:SP", 1)
self.ca.assert_that_pv_is("RAMP:STAT",
"HOLDING ON PAUSE",
msg="Ramping failed to pause")
self.ca.assert_that_pv_is_not(
"RAMP:STAT",
"HOLDING ON TARGET",
timeout=5,
msg="Ramp completed even though it should have paused")
# Resumes when pause set to false, completes ramp
self.ca.set_pv_value("PAUSE:SP", 0)
self.ca.assert_that_pv_is("RAMP:STAT",
"RAMPING",
msg="Ramping failed to resume")
self.ca.assert_that_pv_is("RAMP:STAT",
"HOLDING ON TARGET",
timeout=10,
msg="Ramping failed to complete")
@skip_if_recsim("C++ driver can not correctly initialise in recsim")
def test_GIVEN_IOC_ramping_WHEN_aborted_THEN_ramp_aborted(self):
# Given Ramping
self.ca.set_pv_value("MID:SP", 10000)
self.ca.set_pv_value("START:SP", 1)
self.ca.assert_that_pv_is("RAMP:STAT", "RAMPING")
# Aborts when abort set to true, then hits ready again
self.ca.set_pv_value("ABORT:SP", 1)
self.ca.assert_that_pv_is("RAMP:STAT", "HOLDING ON TARGET", timeout=10)
@skip_if_recsim("C++ driver can not correctly initialise in recsim")
def test_GIVEN_IOC_paused_WHEN_aborted_THEN_ramp_aborted(self):
# GIVEN paused
self.ca.set_pv_value("MID:SP", 10000)
self.ca.set_pv_value("START:SP", 1)
self.ca.set_pv_value("PAUSE:SP", 1)
rampTarget = self.ca.get_pv_value("MID")
self.ca.assert_that_pv_is("RAMP:STAT",
"HOLDING ON PAUSE",
msg="Ramping failed to pause")
# Aborts when abort set to true, then hits ready again
self.ca.set_pv_value("ABORT:SP", 1)
self.ca.assert_that_pv_is("RAMP:STAT", "HOLDING ON TARGET", timeout=10)
self.ca.assert_that_pv_is_not("MID", rampTarget)
@skip_if_recsim(
"Test is to tell whether data from emulator is correctly received")
def test_GIVEN_output_nonzero_WHEN_units_changed_THEN_output_raw_adjusts(
self):
# Check that it is currently working correctly in Amps
self._lewis.backdoor_set_on_device("is_paused", True)
self._lewis.backdoor_set_on_device("output",
1 / 0.037) # 1T (0.037 = T_TO_A)
self.ca.assert_that_pv_is_number("OUTPUT:RAW", 1 / 0.037, 0.001)
self.ca.assert_that_pv_is_number("OUTPUT", 10000,
1) # OUTPUT should remain in Gauss
# Set outputmode to tesla
self.ca.set_pv_value("OUTPUTMODE:SP", "TESLA")
self.ca.assert_that_pv_is_number("OUTPUT:RAW", 1, 0.001)
self.ca.assert_that_pv_is_number("OUTPUT", 10000, 1)
# Confirm functionality returns to normal when going back to Amps
self.ca.set_pv_value("OUTPUTMODE:SP", "AMPS")
self.ca.assert_that_pv_is_number("OUTPUT:RAW", 1 / 0.037, 0.001)
self.ca.assert_that_pv_is_number("OUTPUT", 10000, 1)
class GemorcTests(unittest.TestCase):
"""
Tests for the Gemorc IOC.
"""
def reset_emulator(self):
self._lewis.backdoor_set_on_device("reset", True)
sleep(
1
) # Wait for reset to finish so we don't jump the gun. No external indicator from emulator
def reset_ioc(self):
self.ca.set_pv_value("RESET", 1)
# INIT:ONCE is a property held exclusively in the IOC
calc_pv = "INIT:ONCE:CALC.CALC"
original_calc = self.ca.get_pv_value(calc_pv)
self.ca.set_pv_value(calc_pv, "0")
self.ca.assert_that_pv_is("INIT:ONCE", "No")
self.ca.set_pv_value(calc_pv, original_calc)
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(
"gemorc", DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX,
default_timeout=DEFAULT_TIMEOUT)
self.ca.assert_that_pv_exists("ID", timeout=30)
self.reset_ioc()
if not IOCRegister.uses_rec_sim:
self.reset_emulator()
self.check_init_state(False, False, True, False)
self.ca.assert_that_pv_is_number("CYCLES", 0)
def check_init_state(self, initialising, initialised,
initialisation_required, oscillating):
def bi_to_bool(val):
return val == "Yes"
# Do all states at once.
match = False
total_time = 0.0
max_wait = DEFAULT_TIMEOUT
interval = 1.0
actual_initialising = None
actual_initialised = None
actual_initialisation_required = None
actual_oscillating = None
while not match and total_time < max_wait:
actual_initialising = bi_to_bool(
self.ca.get_pv_value("INIT:PROGRESS"))
actual_initialised = bi_to_bool(self.ca.get_pv_value("INIT:DONE"))
actual_initialisation_required = bi_to_bool(
self.ca.get_pv_value("INIT:REQUIRED"))
actual_oscillating = bi_to_bool(self.ca.get_pv_value("STAT:OSC"))
match = all([
initialising == actual_initialising,
initialised == actual_initialised,
initialisation_required == actual_initialisation_required,
oscillating == actual_oscillating
])
total_time += interval
sleep(interval)
try:
self.assertTrue(match)
except AssertionError:
message_format = "State did not match the required state (initialising, initialised, initialisation " \
"required, oscillating)\nExpected: ({}, {}, {}, {})\nActual: ({}, {}, {}, {})"
self.fail(
message_format.format(initialising, initialised,
initialisation_required, oscillating,
actual_initialising, actual_initialised,
actual_initialisation_required,
actual_oscillating))
def initialise(self):
self.ca.set_pv_value("INIT", 1)
self.ca.assert_that_pv_is("INIT:DONE", "Yes", timeout=10)
def start_oscillating(self):
self.initialise()
self.ca.set_pv_value("START", 1)
def wait_for_re_initialisation_required(self, interval=10):
self.ca.set_pv_value("INIT:OPT", interval)
self.start_oscillating()
while self.ca.get_pv_value("CYCLES") < interval:
sleep(1)
@staticmethod
def backlash(speed, acceleration):
return int(0.5 * speed**2 / float(acceleration))
@staticmethod
def utility(width, backlash):
return width / float(width + backlash) * 100.0
@staticmethod
def period(width, backlash, speed):
return 2.0 * (width + backlash) / float(speed)
@staticmethod
def frequency(width, backlash, speed):
return 1.0 / GemorcTests.period(width, backlash, speed)
def set_and_confirm_state(self,
width=None,
speed=None,
acceleration=None,
offset=None):
pv_value_pairs = [("WIDTH", width), ("SPEED", speed),
("ACC", acceleration), ("OFFSET", offset)]
filtered_pv_values = [(pv, value) for pv, value in pv_value_pairs
if value is not None]
for pv, value in filtered_pv_values:
self.ca.set_pv_value("{}:SP".format(pv), value)
# Do all sets then all confirms to reduce wait time
for pv, value in filtered_pv_values:
self.ca.assert_that_pv_is_number(pv, value)
def test_WHEN_width_setpoint_set_THEN_local_readback_matches(self):
self.ca.assert_setting_setpoint_sets_readback(DEFAULT_WIDTH + 1,
"WIDTH:SP:RBV",
"WIDTH:SP")
def test_WHEN_width_setpoint_set_THEN_remote_readback_matches(self):
self.ca.assert_setting_setpoint_sets_readback(DEFAULT_WIDTH + 1,
"WIDTH")
def test_WHEN_speed_setpoint_set_THEN_local_readback_matches(self):
self.ca.assert_setting_setpoint_sets_readback(DEFAULT_SPEED + 1,
"SPEED:SP:RBV",
"SPEED:SP")
def test_WHEN_speed_setpoint_set_THEN_remote_readback_matches(self):
self.ca.assert_setting_setpoint_sets_readback(DEFAULT_SPEED + 1,
"SPEED")
def test_WHEN_acceleration_setpoint_set_THEN_local_readback_matches(self):
self.ca.assert_setting_setpoint_sets_readback(DEFAULT_ACCELERATION + 1,
"ACC:SP:RBV", "ACC:SP")
def test_WHEN_acceleration_setpoint_set_THEN_remote_readback_matches(self):
self.ca.assert_setting_setpoint_sets_readback(DEFAULT_ACCELERATION + 1,
"ACC")
def test_WHEN_offset_setpoint_set_THEN_local_readback_matches(self):
self.ca.assert_setting_setpoint_sets_readback(DEFAULT_OFFSET + 1,
"OFFSET:SP:RBV",
"OFFSET:SP")
def test_WHEN_offset_setpoint_set_THEN_remote_readback_matches(self):
self.ca.assert_setting_setpoint_sets_readback(DEFAULT_OFFSET + 1,
"OFFSET")
def test_WHEN_offset_setpoint_set_to_negative_value_THEN_remote_readback_matches(
self):
self.ca.assert_setting_setpoint_sets_readback(-DEFAULT_OFFSET,
"OFFSET")
def test_WHEN_device_first_started_THEN_initialisation_required(self):
self.check_init_state(initialising=False,
initialised=False,
initialisation_required=True,
oscillating=False)
@skip_if_recsim("Device reset requires Lewis backdoor")
def test_GIVEN_starting_state_WHEN_initialisation_requested_THEN_initialising_becomes_true(
self):
self.ca.set_pv_value("INIT", 1)
self.check_init_state(initialising=True,
initialised=False,
initialisation_required=False,
oscillating=False)
@skip_if_recsim("Device reset requires Lewis backdoor")
def test_GIVEN_starting_state_WHEN_initialisation_requested_THEN_becomes_initialised_when_no_longer_in_progress(
self):
self.ca.set_pv_value("INIT", 1)
total_wait = 0
max_wait = DEFAULT_TIMEOUT
interval = 1
initialisation_complete = self.ca.get_pv_value("INIT:DONE")
while self.ca.get_pv_value(
"INIT:PROGRESS") == "Yes" and total_wait < max_wait:
# Always check value from before we confirmed initialisation was in progress to avoid race conditions
self.assertNotEqual(initialisation_complete, 1)
sleep(interval)
total_wait += interval
initialisation_complete = self.ca.get_pv_value("INIT:DONE")
self.check_init_state(initialising=False,
initialised=True,
initialisation_required=False,
oscillating=False)
@skip_if_recsim("Device reset requires Lewis backdoor")
def test_GIVEN_initialised_WHEN_oscillation_requested_THEN_reports_oscillating(
self):
self.start_oscillating()
self.ca.assert_that_pv_is("STAT:OSC", "Yes")
@skip_if_recsim("Device reset requires Lewis backdoor")
def test_GIVEN_initialised_WHEN_oscillation_requested_THEN_complete_cycles_increases(
self):
self.start_oscillating()
self.ca.assert_that_pv_value_is_increasing("CYCLES", DEFAULT_TIMEOUT)
@skip_if_recsim("Device reset requires Lewis backdoor")
def test_GIVEN_oscillating_WHEN_oscillation_stopped_THEN_reports_not_oscillating(
self):
self.start_oscillating()
self.ca.set_pv_value("STOP", 1)
self.ca.assert_that_pv_is("STAT:OSC", "No")
@skip_if_recsim("Device reset requires Lewis backdoor")
def test_GIVEN_initialised_WHEN_oscillation_requested_THEN_complete_cycles_does_not_change(
self):
self.start_oscillating()
self.ca.set_pv_value("STOP", 1)
self.ca.assert_that_pv_value_is_unchanged("CYCLES", DEFAULT_TIMEOUT)
@skip_if_recsim("Device reset requires Lewis backdoor")
def test_GIVEN_oscillating_WHEN_initialisation_requested_THEN_initialises(
self):
self.start_oscillating()
self.ca.set_pv_value("INIT", 1)
self.check_init_state(initialising=True,
initialised=False,
initialisation_required=False,
oscillating=False)
@skip_if_recsim("Device reset requires Lewis backdoor")
def test_GIVEN_oscillating_and_initialisation_requested_WHEN_initialisation_complete_THEN_resumes_oscillation(
self):
self.start_oscillating()
self.initialise()
self.check_init_state(initialising=False,
initialised=True,
initialisation_required=False,
oscillating=True)
def test_WHEN_settings_reset_requested_THEN_settings_return_to_default_values(
self):
settings = (
("WIDTH", DEFAULT_WIDTH),
("ACC", DEFAULT_ACCELERATION),
("SPEED", DEFAULT_SPEED),
("OFFSET", DEFAULT_OFFSET),
("INIT:AUTO", DEFAULT_AUTO_INITIALISE),
("INIT:OPT", DEFAULT_OPT_INITIALISE),
)
for pv, default in settings:
self.ca.set_pv_value("{}:SP".format(pv),
default + 1) # I prefer the two lines here
self.ca.assert_that_pv_is_not_number(pv, default)
self.ca.set_pv_value("RESET", 1)
for pv, default in settings:
self.ca.assert_that_pv_is_number(pv, default)
@skip_if_recsim("ID is emulator specific")
def test_WHEN_device_is_running_THEN_it_gets_PnP_identity_from_emulator(
self):
self.ca.assert_that_pv_is(
"ID",
"0002 0001 ISIS Gem Oscillating Rotary Collimator (IBEX EMULATOR)",
timeout=20) # On a very slow scan
def test_GIVEN_standard_test_cases_WHEN_backlash_calculated_locally_THEN_result_is_in_range_supported_by_device(
self):
for _, speed, acceleration in SETTINGS_TEST_CASES:
self.assertTrue(0 <= self.backlash(speed, acceleration) <= 999)
@skip_if_recsim("Depends on emulator value")
def test_WHEN_emulator_running_THEN_backlash_has_value_derived_from_speed_and_acceleration(
self):
for width, speed, acceleration in SETTINGS_TEST_CASES:
self.set_and_confirm_state(speed=speed, acceleration=acceleration)
self.ca.assert_that_pv_is_number(
"BACKLASH", self.backlash(speed, acceleration))
def test_GIVEN_non_zero_speed_WHEN_width_and_speed_set_THEN_utility_time_corresponds_to_formula_in_test(
self):
for width, speed, acceleration in SETTINGS_TEST_CASES:
self.set_and_confirm_state(width, speed, acceleration)
backlash = self.ca.get_pv_value("BACKLASH")
self.ca.assert_that_pv_is_number("UTILITY",
self.utility(width, backlash),
tolerance=DEFAULT_TOLERANCE)
def test_WHEN_emulator_running_THEN_period_has_value_as_derived_from_speed_width_and_backlash(
self):
for width, speed, acceleration in SETTINGS_TEST_CASES:
self.set_and_confirm_state(width, speed, acceleration)
backlash = self.ca.get_pv_value("BACKLASH")
self.ca.assert_that_pv_is_number("PERIOD",
self.period(
width, backlash, speed),
tolerance=DEFAULT_TOLERANCE)
def test_WHEN_emulator_running_THEN_frequency_has_value_as_derived_from_speed_width_and_backlash(
self):
for width, speed, acceleration in SETTINGS_TEST_CASES:
self.set_and_confirm_state(width, speed, acceleration)
backlash = self.ca.get_pv_value("BACKLASH")
self.ca.assert_that_pv_is_number("FREQ",
self.frequency(
width, backlash, speed),
tolerance=DEFAULT_TOLERANCE)
@skip_if_recsim("This behaviour not implemented in recsim")
def test_GIVEN_non_zero_offset_WHEN_re_zeroed_to_datum_THEN_offset_is_zero(
self):
self.ca.assert_setting_setpoint_sets_readback(DEFAULT_OFFSET + 1,
"OFFSET", "OFFSET:SP")
self.ca.assert_that_pv_is_not_number("OFFSET", 0)
self.ca.set_pv_value("ZERO", 1)
self.ca.assert_that_pv_is_number("OFFSET", 0)
def test_WHEN_auto_initialisation_interval_set_THEN_readback_matches_set_value(
self):
self.ca.assert_setting_setpoint_sets_readback(
DEFAULT_AUTO_INITIALISE + 1, "INIT:AUTO")
def test_WHEN_opt_initialisation_interval_set_THEN_readback_matches_set_value(
self):
self.ca.assert_setting_setpoint_sets_readback(
DEFAULT_OPT_INITIALISE + 1, "INIT:OPT")
@skip_if_recsim("Cycle counting not performed in Recsim")
def test_GIVEN_oscillating_WHEN_number_of_cycles_exceeds_optional_init_interval_THEN_initialisation_required(
self):
self.wait_for_re_initialisation_required()
self.check_init_state(False, True, True, True)
@skip_if_recsim("Cycle counting not performed in Recsim")
def test_GIVEN_initialisation_required_after_oscillating_WHEN_reinitialised_THEN_re_initialisation_not_required(
self):
self.wait_for_re_initialisation_required()
self.ca.set_pv_value("INIT:OPT", DEFAULT_OPT_INITIALISE)
self.initialise()
self.check_init_state(False, True, False, True)
@skip_if_recsim("Initialisation logic not performed in Recsim")
def test_WHEN_device_initialised_THEN_initialised_once(self):
self.initialise()
self.ca.assert_that_pv_is("INIT:ONCE", "Yes")
@skip_if_recsim("Initialisation logic not performed in Recsim")
def test_WHEN_oscillating_THEN_initialised_once(self):
self.start_oscillating()
self.ca.assert_that_pv_is("INIT:ONCE", "Yes")
@skip_if_recsim("Initialisation logic not performed in Recsim")
def test_WHEN_oscillating_and_initialisation_required_THEN_initialised_once(
self):
self.wait_for_re_initialisation_required()
self.ca.assert_that_pv_is("INIT:ONCE", "Yes")
@skip_if_recsim("Initialisation logic not performed in Recsim")
def test_WHEN_reinitialising_THEN_initialised_once(self):
self.wait_for_re_initialisation_required()
self.ca.set_pv_value("INIT", 1)
self.ca.assert_that_pv_is("INIT:ONCE", "Yes")
@skip_if_recsim("Initialisation logic not performed in Recsim")
def test_WHEN_reinitialised_THEN_initialised_once(self):
self.wait_for_re_initialisation_required()
self.initialise()
self.ca.assert_that_pv_is("INIT:ONCE", "Yes")
@skip_if_recsim("Initialisation logic not performed in Recsim")
def test_GIVEN_oscillating_WHEN_stopped_and_immediately_initialised_THEN_number_of_cycles_goes_to_zero(
self):
self.start_oscillating()
self.ca.set_pv_value("STOP", 1)
self.ca.set_pv_value("INIT", 1)
self.ca.assert_that_pv_is_number("CYCLES", 0)
@skip_if_recsim("Initialisation logic not performed in Recsim")
def test_WHEN_oscillating_THEN_auto_reinitialisation_triggers_after_counter_reaches_auto_trigger_value(
self):
initialisation_interval = 100
initial_status_string = "Sequence not run since IOC startup"
self.ca.set_pv_value("INIT:AUTO", initialisation_interval)
self.start_oscillating()
while self.ca.get_pv_value("CYCLES") < initialisation_interval:
self.ca.assert_that_pv_is("INIT:PROGRESS", "No")
self.ca.assert_that_pv_is("INIT:STAT", initial_status_string)
sleep(1)
self.ca.assert_that_pv_is_not("INIT:STAT", initial_status_string)
self.ca.assert_that_pv_is(
"STAT:OSC", "No",
timeout=10) # Initialisation seq has a 5s wait at the start
class IndfurnTests(unittest.TestCase):
"""
Tests for the Indfurn IOC.
"""
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(
EMULATOR_NAME, DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX,
default_timeout=30)
def test_that_disable_pv_exists(self):
self.ca.assert_that_pv_is("DISABLE", "COMMS ENABLED")
@skip_if_recsim("Recsim does not emulate version command")
def test_that_version_pv_exists(self):
self.ca.assert_that_pv_is("VERSION", "EMULATED FURNACE")
@parameterized.expand(parameterized_list(TEST_TEMPERATURES))
def test_GIVEN_a_setpoint_WHEN_ask_for_the_setpoint_readback_THEN_get_the_value_just_set(
self, _, temp, alarm):
self.ca.assert_setting_setpoint_sets_readback(
temp,
set_point_pv="TEMP:SP",
readback_pv="TEMP:SP:RBV",
expected_alarm=alarm)
@parameterized.expand(parameterized_list(TEST_TEMPERATURES))
def test_GIVEN_a_setpoint_WHEN_ask_for_the_current_temperature_THEN_get_the_value_just_set(
self, _, temp, alarm):
self.ca.assert_setting_setpoint_sets_readback(temp,
set_point_pv="TEMP:SP",
readback_pv="TEMP",
expected_alarm=alarm)
@parameterized.expand(parameterized_list(TEST_TEMPERATURES))
def test_GIVEN_a_setpoint_WHEN_ask_for_the_sample_temperature_THEN_get_the_value_just_set(
self, _, temp, alarm):
self.ca.assert_setting_setpoint_sets_readback(
temp,
set_point_pv="TEMP:SP",
readback_pv="SAMPLE:TEMP",
expected_alarm=alarm)
@parameterized.expand(parameterized_list(TEST_DIAGNOSTIC_TEMPERATURES))
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_GIVEN_pipe_temperature_set_via_backdoor_when_read_pipe_temperature_THEN_get_value_just_set(
self, _, temp, alarm):
self._lewis.backdoor_set_on_device("pipe_temperature", temp)
self.ca.assert_that_pv_is_number("PIPE:TEMP", temp, tolerance=0.1)
self.ca.assert_that_pv_alarm_is("PIPE:TEMP", alarm)
@parameterized.expand(parameterized_list(TEST_DIAGNOSTIC_TEMPERATURES))
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_GIVEN_capacitor_temperature_set_via_backdoor_when_read_capacitor_temperature_THEN_get_value_just_set(
self, _, temp, alarm):
self._lewis.backdoor_set_on_device("capacitor_bank_temperature", temp)
self.ca.assert_that_pv_is_number("CAPACITOR:TEMP", temp, tolerance=0.1)
self.ca.assert_that_pv_alarm_is("CAPACITOR:TEMP", alarm)
@parameterized.expand(parameterized_list(TEST_DIAGNOSTIC_TEMPERATURES))
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_GIVEN_fet_temperature_set_via_backdoor_when_read_fet_temperature_THEN_get_value_just_set(
self, _, temp, alarm):
self._lewis.backdoor_set_on_device("fet_temperature", temp)
self.ca.assert_that_pv_is_number("FET:TEMP", temp, tolerance=0.1)
self.ca.assert_that_pv_alarm_is("FET:TEMP", alarm)
@parameterized.expand(parameterized_list(TEST_PID_VALUES))
def test_GIVEN_p_parameter_changed_WHEN_read_p_THEN_value_can_be_read_back(
self, _, val):
self.ca.assert_setting_setpoint_sets_readback(val, "P")
@parameterized.expand(parameterized_list(TEST_PID_VALUES))
def test_GIVEN_i_parameter_changed_WHEN_read_i_THEN_value_can_be_read_back(
self, _, val):
self.ca.assert_setting_setpoint_sets_readback(val, "I")
@parameterized.expand(parameterized_list(TEST_PID_VALUES))
def test_GIVEN_d_parameter_changed_WHEN_read_d_THEN_value_can_be_read_back(
self, _, val):
self.ca.assert_setting_setpoint_sets_readback(val, "D")
@parameterized.expand(parameterized_list(TEST_SAMPLE_TIMES))
def test_GIVEN_sample_time_changed_WHEN_read_sample_time_THEN_value_can_be_read_back(
self, _, sample_time):
self.ca.assert_setting_setpoint_sets_readback(sample_time,
"SAMPLETIME")
def test_GIVEN_pid_direction_is_set_THEN_it_can_be_read_back(self):
for mode in ["Heating", "Cooling",
"Heating"]: # Check both transitions
self.ca.assert_setting_setpoint_sets_readback(
mode, "PID:DIRECTION")
def test_GIVEN_pid_run_status_is_set_THEN_it_can_be_read_back(self):
for mode in ["Stopped", "Running",
"Stopped"]: # Check both transitions
self.ca.assert_setting_setpoint_sets_readback(mode, "PID:RUNNING")
@parameterized.expand(parameterized_list(TEST_PID_LIMITS))
def test_GIVEN_pid_lower_limit_is_set_THEN_it_can_be_read_back(
self, _, pid_limit):
self.ca.assert_setting_setpoint_sets_readback(pid_limit,
"PID:LIMIT:LOWER")
@parameterized.expand(parameterized_list(TEST_PID_LIMITS))
def test_GIVEN_pid_upper_limit_is_set_THEN_it_can_be_read_back(
self, _, pid_limit):
self.ca.assert_setting_setpoint_sets_readback(pid_limit,
"PID:LIMIT:UPPER")
@parameterized.expand(parameterized_list(TEST_PSU_VOLTAGES))
def test_GIVEN_psu_voltage_is_set_THEN_it_can_be_read_back(
self, _, psu_volt):
self.ca.assert_setting_setpoint_sets_readback(psu_volt, "PSU:VOLT")
@parameterized.expand(parameterized_list(TEST_PSU_CURRENTS))
def test_GIVEN_psu_current_is_set_THEN_it_can_be_read_back(
self, _, psu_curr):
self.ca.assert_setting_setpoint_sets_readback(psu_curr, "PSU:CURR")
@parameterized.expand(parameterized_list(TEST_OUTPUTS))
def test_GIVEN_output_is_set_THEN_it_can_be_read_back(self, _, output):
self.ca.assert_setting_setpoint_sets_readback(output, "OUTPUT")
def test_GIVEN_pid_mode_is_set_THEN_it_can_be_read_back(self):
for mode in ["Automatic", "Manual",
"Automatic"]: # Check both transitions
self.ca.assert_setting_setpoint_sets_readback(mode, "PID:MODE")
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_GIVEN_power_supply_mode_is_set_to_either_local_or_remote_THEN_it_sets_successfully_in_emulator(
self):
for remote in [False, True, False]: # Check both transitions
self.ca.assert_setting_setpoint_sets_readback(
"Remote" if remote else "Local",
"PSU:CONTROLMODE",
expected_alarm=self.ca.Alarms.NONE
if remote else self.ca.Alarms.MAJOR)
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_GIVEN_power_supply_output_is_set_to_either_on_or_off_THEN_it_sets_successfully_in_emulator(
self):
for output in [False, True, False]: # Check both transitions
self.ca.assert_setting_setpoint_sets_readback(
"On" if output else "Off", "PSU:POWER")
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_GIVEN_sample_area_led_is_set_to_either_on_or_off_THEN_it_sets_successfully_in_emulator(
self):
for led_on in [False, True, False]: # Check both transitions
self.ca.assert_setting_setpoint_sets_readback(
"On" if led_on else "Off", "LED")
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_GIVEN_power_supply_hf_is_set_to_either_on_or_off_THEN_it_sets_successfully_in_emulator(
self):
for hf_on in [False, True, False]: # Check both transitions
self.ca.assert_setting_setpoint_sets_readback(
"On" if hf_on else "Off", "PSU:HF")
@skip_if_recsim("Can't use lewis backdoor in recsim")
def test_GIVEN_psu_goes_over_temperature_THEN_alarm_comes_on_AND_can_reset_via_pv(
self):
self._lewis.backdoor_set_on_device("psu_overtemp", True)
self.ca.assert_that_pv_is("ALARM:PSUTEMP", "ALARM")
self.ca.assert_that_pv_alarm_is("ALARM:PSUTEMP", self.ca.Alarms.MAJOR)
self.ca.set_pv_value("ALARM:CLEAR", 1)
self.ca.assert_that_pv_is("ALARM:PSUTEMP", "OK")
self.ca.assert_that_pv_alarm_is("ALARM:PSUTEMP", self.ca.Alarms.NONE)
@skip_if_recsim("Can't use lewis backdoor in recsim")
def test_GIVEN_psu_goes_over_voltage_THEN_alarm_comes_on_AND_can_reset_via_pv(
self):
self._lewis.backdoor_set_on_device("psu_overvolt", True)
self.ca.assert_that_pv_is("ALARM:PSUVOLT", "ALARM")
self.ca.assert_that_pv_alarm_is("ALARM:PSUVOLT", self.ca.Alarms.MAJOR)
self.ca.set_pv_value("ALARM:CLEAR", 1)
self.ca.assert_that_pv_is("ALARM:PSUVOLT", "OK")
self.ca.assert_that_pv_alarm_is("ALARM:PSUVOLT", self.ca.Alarms.NONE)
@skip_if_recsim("Can't use lewis backdoor in recsim")
def test_GIVEN_cooling_water_flow_turns_off_THEN_this_is_visible_from_ioc_and_causes_alarm(
self):
self._lewis.backdoor_set_on_device("cooling_water_flow", 0)
self.ca.assert_that_pv_is("COOLINGWATER:FLOW", 0)
self.ca.assert_that_pv_is("COOLINGWATER:STATUS", "ALARM")
self.ca.assert_that_pv_alarm_is("COOLINGWATER:STATUS",
self.ca.Alarms.MAJOR)
self._lewis.backdoor_set_on_device("cooling_water_flow", 500)
self.ca.assert_that_pv_is("COOLINGWATER:FLOW", 500)
self.ca.assert_that_pv_is("COOLINGWATER:STATUS", "OK")
self.ca.assert_that_pv_alarm_is("COOLINGWATER:STATUS",
self.ca.Alarms.NONE)
@skip_if_recsim("Recsim can't handle arbitrary commands")
def test_GIVEN_an_arbitrary_command_THEN_get_a_response(self):
self.ca.set_pv_value("ARBITRARY:SP", "?ver")
self.ca.assert_that_pv_is(
"ARBITRARY", "<EMULATED FURNACE\r\n<EMULATED FURNACE\r\n")
@parameterized.expand(parameterized_list(SAMPLE_HOLDER_MATERIALS))
def test_GIVEN_sample_holder_material_is_set_THEN_sample_holder_material_can_be_read_back(
self, _, material):
self.ca.assert_setting_setpoint_sets_readback(material, "SAMPLEHOLDER")
@skip_if_recsim("Can't use lewis backdoor in recsim")
def test_GIVEN_thermocouple_1_fault_on_device_THEN_read_successfully(self):
self._lewis.backdoor_set_on_device("thermocouple_1_fault", 0)
for fault_pv in FAULTS:
self.ca.assert_that_pv_is("TC1FAULTS:{}".format(fault_pv), "OK")
for fault_pv, fault_number in FAULTS.items():
self._lewis.backdoor_set_on_device("thermocouple_1_fault",
fault_number)
self.ca.assert_that_pv_is("TC1FAULTS:{}".format(fault_pv), "FAULT")
@skip_if_recsim("Can't use lewis backdoor in recsim")
def test_GIVEN_thermocouple_2_fault_on_device_THEN_read_successfully(self):
self._lewis.backdoor_set_on_device("thermocouple_2_fault", 0)
for fault_pv in FAULTS:
self.ca.assert_that_pv_is("TC2FAULTS:{}".format(fault_pv), "OK")
for fault_pv, fault_number in FAULTS.items():
self._lewis.backdoor_set_on_device("thermocouple_2_fault",
fault_number)
self.ca.assert_that_pv_is("TC2FAULTS:{}".format(fault_pv), "FAULT")
class Lakeshore340Tests(unittest.TestCase):
"""
Tests for the lakeshore 340 IOC.
"""
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(
_EMULATOR_NAME, DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX,
default_timeout=15)
def test_WHEN_device_is_started_THEN_it_is_not_disabled(self):
self.ca.assert_that_pv_is("DISABLE", "COMMS ENABLED")
@parameterized.expand(
parameterized_list(itertools.product(SENSORS, TEST_TEMPERATURES)))
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_WHEN_temperature_set_via_backdoor_THEN_it_can_be_read_back(
self, _, sensor, value):
self._lewis.backdoor_set_on_device("temp_{}".format(sensor.lower()),
value)
self.ca.assert_that_pv_is_number("{}:TEMP".format(sensor.upper()),
value)
@parameterized.expand(
parameterized_list(itertools.product(SENSORS, TEST_TEMPERATURES)))
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_WHEN_measurement_set_via_backdoor_THEN_it_can_be_read_back(
self, _, sensor, value):
self._lewis.backdoor_set_on_device(
"measurement_{}".format(sensor.lower()), value)
self.ca.assert_that_pv_is_number("{}:RDG".format(sensor.upper()),
value)
@parameterized.expand(parameterized_list(TEST_TEMPERATURES))
def test_WHEN_tset_is_changed_THEN_readback_updates(self, _, val):
self.ca.assert_setting_setpoint_sets_readback(
val, readback_pv="A:TEMP:SP:RBV", set_point_pv="A:TEMP:SP")
@parameterized.expand(
parameterized_list(itertools.product(PID_SETTINGS, PID_TEST_VALUES)))
def test_WHEN_pid_settings_changed_THEN_can_be_read_back(
self, _, setting, value):
if setting == "D":
value = int(
value) # Derivative is only allowed to take integer values.
self.ca.assert_setting_setpoint_sets_readback(value, setting)
@parameterized.expand(parameterized_list(PID_MODES))
def test_WHEN_pid_settings_changed_THEN_can_be_read_back(self, _, mode):
self.ca.assert_setting_setpoint_sets_readback(mode, "PIDMODE")
@parameterized.expand(parameterized_list(LOOP_STATES))
def test_WHEN_loop_turned_on_or_off_THEN_can_be_read_back(
self, _, loopstate):
self.ca.assert_setting_setpoint_sets_readback(loopstate, "LOOP")
@parameterized.expand(parameterized_list(TEST_TEMPERATURES))
def test_WHEN_max_temperature_set_THEN_can_be_read_back(self, _, temp):
self.ca.assert_setting_setpoint_sets_readback(temp, "TEMP:MAX")
@parameterized.expand(parameterized_list(HEATER_PERCENTAGES))
@skip_if_recsim("Lewis backdoor not available in recsim")
def test_WHEN_heater_power_set_via_backdoor_THEN_can_be_read_back(
self, _, output):
self._lewis.backdoor_set_on_device("heater_output", output)
self.ca.assert_that_pv_is_number("OUTPUT", output)
@parameterized.expand(parameterized_list(RANGES))
def test_WHEN_heater_range_set_THEN_can_be_read_back(self, _, range):
self.ca.assert_setting_setpoint_sets_readback(range, "RANGE")
@parameterized.expand(parameterized_list(EXCITATIONS))
def test_WHEN_excitation_a_set_THEN_can_be_read_back(self, _, excitation):
self.ca.assert_setting_setpoint_sets_readback(excitation,
"EXCITATIONA")
@parameterized.expand(parameterized_list(EXCITATIONS))
@skip_if_recsim
def test_WHEN_excitation_set_by_backdoor_THEN_can_be_read_back(
self, _, excitation):
self._lewis.backdoor_set_on_device("excitationa",
EXCITATIONS.index(excitation))
self.ca.assert_that_pv_is("EXCITATIONA", excitation)
def test_WHEN_use_valid_file_THEN_threshold_file_is_none(self):
self.ca.assert_that_pv_is_path(THRESHOLD_FILE_PV,
THRESHOLD_FILES_DIR + THRESHOLDS_FILE)
self.ca.assert_that_pv_is(THRESHOLDS_ERROR_PV, "No Error")
self.ca.assert_that_pv_is_path("THRESHOLDS:USE", "YES")
def test_WHEN_do_not_use_file_THEN_threshold_file_is_not_set(self):
with self._ioc.start_with_macros(
{"USE_EXCITATION_THRESHOLD_FILE": "NO"},
pv_to_wait_for=THRESHOLD_FILE_PV):
self.ca.assert_that_pv_is_path("THRESHOLDS:USE", "NO")
self.ca.assert_that_pv_is(THRESHOLDS_ERROR_PV, "No Error")
def test_WHEN_initialise_with_incorrect_macro_THEN_pv_is_in_alarm(self):
filename = "DoesNotExist.txt"
with self._ioc.start_with_macros(
{
"EXCITATION_THRESHOLD_FILE": filename,
"USE_EXCITATION_THRESHOLD_FILE": "YES"
},
pv_to_wait_for=THRESHOLD_FILE_PV):
self.ca.assert_that_pv_is(THRESHOLDS_ERROR_PV, "File Not Found")
self.ca.assert_that_pv_is_path("THRESHOLDS:USE", "YES")
def test_WHEN_initialise_with_invalid_file_THEN_pv_is_in_alarm(self):
filename = "InvalidLines.txt"
with self._ioc.start_with_macros(
{
"EXCITATION_THRESHOLD_FILE": filename,
"USE_EXCITATION_THRESHOLD_FILE": "YES"
},
pv_to_wait_for=THRESHOLD_FILE_PV):
self.ca.assert_that_pv_is(THRESHOLDS_ERROR_PV,
"Invalid Lines In File")
self.ca.assert_that_pv_is_path("THRESHOLDS:USE", "YES")
def reset_thresholds_values(self, thresholds_excitations, thresholds_temp,
excitationa, error, delay_change, temp):
self.ca.assert_setting_setpoint_sets_readback(excitationa,
EXCITATIONA_PV)
self.ca.set_pv_value(THRESHOLD_TEMP_PV, thresholds_temp)
self.ca.set_pv_value(THRESHOLD_EXCITATIONS_PV, thresholds_excitations)
self.ca.set_pv_value(THRESHOLDS_DELAY_CHANGE_PV, delay_change)
self.ca.set_pv_value(THRESHOLDS_ERROR_PV, error)
self._lewis.backdoor_set_on_device("temp_a", temp)
def assert_threshold_values(self, thresholds_excitations, thresholds_temp,
excitationa, error, error_severity,
delay_change):
self.ca.assert_that_pv_is(THRESHOLD_EXCITATIONS_PV,
thresholds_excitations)
self.ca.assert_that_pv_is(THRESHOLD_TEMP_PV, thresholds_temp)
self.ca.assert_that_pv_is(THRESHOLDS_DELAY_CHANGE_PV, delay_change)
self.ca.assert_that_pv_is(THRESHOLDS_ERROR_PV, error)
self.ca.assert_that_pv_alarm_is(THRESHOLDS_ERROR_PV, error_severity)
self.ca.assert_that_pv_is(EXCITATIONA_PV, excitationa)
@parameterized.expand(parameterized_list(TEMP_SP_EXCITATIONS))
@skip_if_recsim
def test_WHEN_set_temp_sp_THEN_thresholds_recalculated(
self, _, temp_sp_excitations_map):
new_temp_sp = temp_sp_excitations_map["TEMP:SP"]
expected_thresholds_temp = temp_sp_excitations_map["THRESHOLDS:TEMP"]
expected_thresholds_excitation = temp_sp_excitations_map[
"THRESHOLDS:EXCITATION"]
# Reset pv values to test
self.reset_thresholds_values("Off", 0, "Off", "No Error", "NO",
new_temp_sp - 10)
# Set setpoint
self.ca.assert_setting_setpoint_sets_readback(
new_temp_sp, readback_pv="A:TEMP:SP:RBV", set_point_pv="A:TEMP:SP")
# Confirm change is delayed but threshold temp is set
self.assert_threshold_values(expected_thresholds_excitation,
expected_thresholds_temp, "Off",
"No Error", "NO_ALARM", "YES")
# Make temperature equal setpoint
self._lewis.backdoor_set_on_device("temp_a", new_temp_sp)
# Confirm Excitations is set correctly
self.assert_threshold_values(expected_thresholds_excitation,
expected_thresholds_temp,
expected_thresholds_excitation,
"No Error", "NO_ALARM", "NO")
@parameterized.expand(
parameterized_list([("None.txt", "NO_ALARM", "No Error"),
("DoesNotExist.txt", "MINOR", "File Not Found"),
("InvalidLines.txt", "MINOR",
"Invalid Lines In File")]))
@skip_if_recsim
def test_GIVEN_not_using_excitations_OR_invalid_file_WHEN_set_temp_sp_THEN_thresholds_not_recalculated(
self, _, filename, expected_error_severity, expected_error):
with self._ioc.start_with_macros(
{"EXCITATION_THRESHOLD_FILE": filename},
pv_to_wait_for=THRESHOLD_FILE_PV):
for temp_sp, temp, excitation in [(5.2, 3.1, "30 nA"),
(16.4, 18.2, "100 nA"),
(20.9, 0, "Off"),
(400.2, 20.3, "1 mV")]:
# Reset pv values to test
self.reset_thresholds_values(excitation, temp, excitation,
"No Error", "NO", temp_sp - 10)
# Set temp
self.ca.assert_setting_setpoint_sets_readback(
temp_sp,
readback_pv="A:TEMP:SP:RBV",
set_point_pv="A:TEMP:SP")
self._lewis.backdoor_set_on_device("temp_a", temp_sp)
# Assert nothing has changed
self.assert_threshold_values(excitation, temp, excitation,
expected_error,
expected_error_severity, "NO")
class IegTests(unittest.TestCase):
"""
Tests for the IEG IOC.
"""
operation_modes = [
(1, "Pump, Purge & Fill"),
(2, "Pump"),
(3, "Gas Flow"),
(4, "Gas - Single Shot"),
]
error_codes = [(0, "No error"), (2, "Samp vol: leak detected"),
(3, "Samp vol: no vacuum"), (4, "Buff vol: did not fill"),
(5, "Samp vol: fill iterations"),
(6, "Samp vol: pump timeout"),
(7, "Samp vol: fill timeout"), (8, "Buff or samp vol leak"),
(9, "Shot didn't raise press."), (10, "Manual stop"),
(11, "Vacuum tank interlock"),
(12, "Samp vol: leak detected"),
(13, "Sensor broken/disconnect")]
test_device_ids = [0, 123, 255]
test_pressures = [0, 10, 1024]
@staticmethod
def _get_actual_from_raw(value):
return value * CALIBRATION_A + CALIBRATION_B
@staticmethod
def _get_raw_from_actual(value):
return int(round((value - CALIBRATION_B) / CALIBRATION_A))
def setUp(self):
self._lewis, self._ioc = get_running_lewis_and_ioc(
"ieg", DEVICE_PREFIX)
self.ca = ChannelAccess(device_prefix=DEVICE_PREFIX,
default_timeout=20)
self.ca.assert_that_pv_exists("DISABLE", timeout=30)
def test_WHEN_ioc_is_started_THEN_ioc_is_not_disabled(self):
self.ca.assert_that_pv_is("DISABLE", "COMMS ENABLED")
def test_WHEN_mode_setpoint_is_set_THEN_readback_updates(self):
for set_val, return_val in self.operation_modes:
self.ca.assert_setting_setpoint_sets_readback(
set_val,
set_point_pv="MODE:SP",
readback_pv="MODE",
expected_value=return_val)
@skip_if_recsim("Not implemented in recsim")
def test_GIVEN_device_not_in_dormant_state_WHEN_kill_command_is_sent_THEN_device_goes_to_dormant_state(
self):
set_val, return_val = self.operation_modes[0]
self.ca.assert_setting_setpoint_sets_readback(
set_val,
set_point_pv="MODE:SP",
readback_pv="MODE",
expected_value=return_val)
self.ca.set_pv_value("ABORT", 1)
self.ca.assert_that_pv_is("MODE", "Dormant")
@skip_if_recsim("Uses lewis backdoor command")
def test_WHEN_device_id_is_changed_on_device_THEN_device_id_pv_updates(
self):
for val in self.test_device_ids:
self._lewis.backdoor_set_on_device("unique_id", val)
self.ca.assert_that_pv_is("ID", val, timeout=30)
self.ca.assert_that_pv_alarm_is("ID", self.ca.Alarms.NONE)
@skip_if_recsim("Uses lewis backdoor command")
def test_WHEN_valve_states_are_changed_on_device_THEN_valve_state_pv_updates(
self):
for gas_valve_open in [True, False]:
self._lewis.backdoor_set_on_device("gas_valve_open",
gas_valve_open)
for buffer_valve_open in [True, False]:
self._lewis.backdoor_set_on_device("buffer_valve_open",
buffer_valve_open)
for pump_valve_open in [True, False]:
self._lewis.backdoor_set_on_device("pump_valve_open",
pump_valve_open)
self.ca.assert_that_pv_is_number(
"VALVESTATE.B0", 1 if pump_valve_open else 0)
self.ca.assert_that_pv_is_number(
"VALVESTATE.B1", 1 if buffer_valve_open else 0)
self.ca.assert_that_pv_is_number(
"VALVESTATE.B2", 1 if gas_valve_open else 0)
self.ca.assert_that_pv_alarm_is("VALVESTATE",
self.ca.Alarms.NONE)
@skip_if_recsim("Uses lewis backdoor command")
def test_WHEN_valve_states_are_changed_on_device_THEN_valve_state_pv_updates(
self):
for error_num, error in self.error_codes:
self._lewis.backdoor_set_on_device("error", error_num)
self.ca.assert_that_pv_is("ERROR", error)
self.ca.assert_that_pv_alarm_is(
"ERROR",
self.ca.Alarms.MAJOR if error_num else self.ca.Alarms.NONE)
@skip_if_recsim("Uses lewis backdoor command")
def test_WHEN_pressure_is_changed_on_device_THEN_raw_pressure_pv_updates(
self):
for pressure in self.test_pressures:
self._lewis.backdoor_set_on_device("sample_pressure", pressure)
self.ca.assert_that_pv_is("PRESSURE:RAW", pressure)
self.ca.assert_that_pv_alarm_is("PRESSURE:RAW",
self.ca.Alarms.NONE)
@skip_if_recsim("Uses lewis backdoor command")
def test_WHEN_pressure_and_upper_limit_are_changed_on_device_THEN_pressure_high_pv_updates(
self):
for pressure in self.test_pressures:
self._lewis.backdoor_set_on_device("sample_pressure", pressure)
for upper_limit in [pressure - 1, pressure + 1]:
self._lewis.backdoor_set_on_device(
"sample_pressure_high_limit", upper_limit)
self.ca.assert_that_pv_is(
"PRESSURE:HIGH",
"Out of range" if pressure > upper_limit else "In range")
self.ca.assert_that_pv_alarm_is(
"PRESSURE:HIGH", self.ca.Alarms.MINOR
if pressure > upper_limit else self.ca.Alarms.NONE)
@skip_if_recsim("Uses lewis backdoor command")
def test_WHEN_pressure_and_lower_limit_are_changed_on_device_THEN_pressure_low_pv_updates(
self):
for pressure in self.test_pressures:
self._lewis.backdoor_set_on_device("sample_pressure", pressure)
for lower_limit in [pressure - 1, pressure + 1]:
self._lewis.backdoor_set_on_device("sample_pressure_low_limit",
lower_limit)
self.ca.assert_that_pv_is(
"PRESSURE:LOW",
"Out of range" if pressure < lower_limit else "In range")
self.ca.assert_that_pv_alarm_is(
"PRESSURE:LOW", self.ca.Alarms.MINOR
if pressure < lower_limit else self.ca.Alarms.NONE)
@skip_if_recsim("Uses lewis backdoor command")
def test_WHEN_buffer_pressure_high_is_changed_on_device_THEN_buffer_pressure_high_pv_updates(
self):
for value in [True, False]:
self._lewis.backdoor_set_on_device("buffer_pressure_high", value)
# Intentionally this way round - the manual
# says that 0 means 'above high threshold' and 1 is 'below high threshold'
self.ca.assert_that_pv_is("PRESSURE:BUFFER:HIGH",
"Out of range" if value else "In range")
self.ca.assert_that_pv_alarm_is(
"PRESSURE:BUFFER:HIGH",
self.ca.Alarms.MINOR if value else self.ca.Alarms.NONE)
@skip_if_recsim("Uses lewis backdoor command")
def test_WHEN_pressure_is_over_350_THEN_displayed_as_greater_than_350_mBar(
self):
self._lewis.backdoor_set_on_device("sample_pressure",
self._get_raw_from_actual(400))
self.ca.assert_that_pv_is("PRESSURE:GUI.OSV", ">350 mbar")
self.ca.assert_that_pv_alarm_is("PRESSURE:GUI", self.ca.Alarms.MAJOR)
@skip_if_recsim("Uses lewis backdoor command")
def test_WHEN_pressure_is_less_than_0_THEN_displayed_as_less_than_0_mBar(
self):
self._lewis.backdoor_set_on_device("sample_pressure",
self._get_raw_from_actual(-10))
self.ca.assert_that_pv_is("PRESSURE:GUI.OSV", "<0 mbar")
self.ca.assert_that_pv_alarm_is("PRESSURE:GUI", self.ca.Alarms.MAJOR)
@skip_if_recsim("Uses lewis backdoor command")
def test_WHEN_pressure_is_set_THEN_it_is_converted_correctly_using_the_calibration(
self):
for raw_pressure in self.test_pressures:
actual_pressure = self._get_actual_from_raw(raw_pressure)
self._lewis.backdoor_set_on_device("sample_pressure", raw_pressure)
# PRESSURE is restricted to use [0-350]. PRESSURE:CALC is unrestricted
self.ca.assert_that_pv_is_number("PRESSURE:CALC",
actual_pressure,
tolerance=0.05)
self.ca.assert_that_pv_alarm_is(
"PRESSURE", self.ca.Alarms.NONE
if .0 < actual_pressure < 350 else self.ca.Alarms.MAJOR)
