Create a new device class for tcavs #261
Conversation
…sing two pvs for fb state
…ther tcavs are different
phys-cgarnier
changed the title
There was a problem hiding this comment.
Hi Chris, looks consistent with our other device classes. I found a bunch of places where pydantic validation could replace your manual validation. This device is unique because its configuration depends on its mode_config, but I think that's handled well here. Once we figure out the validation stuff.
lcls_tools/common/devices/tcav.py
Outdated
| def set_mode_config_option(self): | ||
| mode_config_options = self.PVs.mode_configs.get_ctrlvars(timeout=1) | ||
| if mode_config_options: | ||
| [ |
There was a problem hiding this comment.
I think it's fewer lines to write this for loop as:
for i, option in enumerate(mode_config_options["enum_strs"]):
self._mode_config_options.update({option: i})
There was a problem hiding this comment.
Sure I can do that, I was trying to make this as close to a match to magnet.py as possible but I can clean it up.
lcls_tools/common/devices/tcav.py
Outdated
| super(TCAVControlInformation, self).__init__(*args, **kwargs) | ||
|
|
||
| def set_mode_config_option(self): | ||
| mode_config_options = self.PVs.mode_configs.get_ctrlvars(timeout=1) |
There was a problem hiding this comment.
Should this code error out if get_ctrlvars times out? What's the use case for a TCAV without mode_config_options?
There was a problem hiding this comment.
I believe (although am unable to confirm at this time), that you cannot or should not be setting other pvs in the tcav while TCAV:DIAG0:11:MODECFG is in the Disable state. The use case would then be just read only for the TCAV PVs
lcls_tools/common/devices/tcav.py
Outdated
| options = [options_to_check] | ||
| for option in options: | ||
| if option not in self.controls_information.mode_config_options: | ||
| print( |
There was a problem hiding this comment.
I think an error here would be more appropriate. As it stands, the check_options decorator doesn't do anything to communicate to the code that something went wrong.
lcls_tools/common/devices/tcav.py
Outdated
|
|
||
| def decorated(self, *args, **kwargs): | ||
| if self.mode_config == "Disable": | ||
| print("Unable to perform action, TCAV is in Disabled state") |
There was a problem hiding this comment.
Another place where an error might be better than a print statement.
|
|
||
| @amp_set.setter | ||
| @check_state | ||
| def amp_set(self, amplitude): |
There was a problem hiding this comment.
Pydantic lets you validate function arguments with function annotations like so:
def amp_set(self, amplitude: float):
The if statement shouldn't be necessary.
lcls_tools/common/devices/tcav.py
Outdated
| @amp_fbenb.setter | ||
| @check_state | ||
| def amp_fbenb(self, state: Union[str, int]): | ||
| if not isinstance(state, str) or not isinstance(state, int): |
There was a problem hiding this comment.
Pydantic should already be validating this.
There was a problem hiding this comment.
Sorry, the expected type is actually an enum_str, I couldn't get the validation to work how I thought I could.
Unless I made the properties pydantic objects
lcls_tools/common/devices/tcav.py
Outdated
| @phase_fbenb.setter | ||
| @check_state | ||
| def phase_fbenb(self, state: Union[str, int]): | ||
| if not isinstance(state, str) or not isinstance(state, int): |
There was a problem hiding this comment.
Another place where pydantic covers function validation.
lcls_tools/common/devices/tcav.py
Outdated
| @amp_fbst.setter | ||
| @check_state | ||
| def amp_fbst(self, state: Union[str, int]): | ||
| if not isinstance(state, str) or not isinstance(state, int): |
lcls_tools/common/devices/tcav.py
Outdated
| @phase_fbst.setter | ||
| @check_state | ||
| def phase_fbst(self, state: Union[str, int]): | ||
| if not isinstance(state, str) or not isinstance(state, int): |
|
|
||
| @l_eff.setter | ||
| def l_eff(self, length): | ||
| if not isinstance(length, float): |
There was a problem hiding this comment.
Pydantic validation could replace this.
lcls_tools/common/devices/tcav.py
Outdated
| controls_information: SerializeAsAny[TCAVControlInformation] | ||
| metadata: SerializeAsAny[TCAVMetadata] | ||
|
|
||
| def __init__(self, *args, **kwargs): |
There was a problem hiding this comment.
I don't think you need an __init__ function when using Pydantic
TCAV Device class:
Changed generator.py to include extract_tcav function. Also implemented advanced filtering in extract devices. You can pass an unpacked dictionary that is organized by {field_name: expected value}
For example :
additional_filter_constraints = {"Engineering Name": "TRANS_DEFL"}
Added relevant fields to metadata.py