diff --git a/doc/news/interface_changes/DM-46165.tunablelaser.rst b/doc/news/interface_changes/DM-46165.tunablelaser.rst new file mode 100644 index 000000000..4de668399 --- /dev/null +++ b/doc/news/interface_changes/DM-46165.tunablelaser.rst @@ -0,0 +1 @@ +Adding in Optical Configuration enum for TunableLaser diff --git a/python/lsst/ts/xml/data/sal_interfaces/TunableLaser/TunableLaser_Commands.xml b/python/lsst/ts/xml/data/sal_interfaces/TunableLaser/TunableLaser_Commands.xml index 5380d171a..41949236d 100644 --- a/python/lsst/ts/xml/data/sal_interfaces/TunableLaser/TunableLaser_Commands.xml +++ b/python/lsst/ts/xml/data/sal_interfaces/TunableLaser/TunableLaser_Commands.xml @@ -31,10 +31,10 @@ TunableLaser TunableLaser_command_setOpticalConfiguration - Set the optical configuration. + Set the optical configuration; an OpticalConfiguration enum. configuration - Optical alignment configuration to be set. + Optical alignment configuration to be set; an OpticalConfiguration enum. string 1 unitless diff --git a/python/lsst/ts/xml/data/sal_interfaces/TunableLaser/TunableLaser_Events.xml b/python/lsst/ts/xml/data/sal_interfaces/TunableLaser/TunableLaser_Events.xml index 835a1b4db..def73df2d 100644 --- a/python/lsst/ts/xml/data/sal_interfaces/TunableLaser/TunableLaser_Events.xml +++ b/python/lsst/ts/xml/data/sal_interfaces/TunableLaser/TunableLaser_Events.xml @@ -7,6 +7,14 @@ LaserErrorCode_ASCII_ERROR = 7301, LaserErrorCode_GENERAL_ERROR = 7302, LaserErrorCode_TIMEOUT_ERROR = 7303, LaserErrorCode_HW_CPU_ERROR = 7304 + + +OpticalConfiguration_SCU, +OpticalConfiguration_F1_SCU, +OpticalConfiguration_F2_SCU, +OpticalConfiguration_NO_SCU, +OpticalConfiguration_F1_NO_SCU, +OpticalConfiguration_F2_NO_SCU TunableLaser @@ -40,10 +48,10 @@ LaserErrorCode_HW_CPU_ERROR = 7304 TunableLaser TunableLaser_logevent_opticalConfiguration - The optical configuration. + The optical configuration; an OpticalConfiguration enum. configuration - The new optical alignment configuration. + The optical alignment configuration; a OpticalConfiguration enum. string 1 unitless diff --git a/python/lsst/ts/xml/enums/TunableLaser.py b/python/lsst/ts/xml/enums/TunableLaser.py index 1e843614c..a828b7d0e 100644 --- a/python/lsst/ts/xml/enums/TunableLaser.py +++ b/python/lsst/ts/xml/enums/TunableLaser.py @@ -1,4 +1,4 @@ -__all__ = ["LaserDetailedState", "LaserErrorCode"] +__all__ = ["LaserDetailedState", "OpticalConfiguration", "LaserErrorCode"] import enum @@ -29,6 +29,35 @@ class LaserDetailedState(enum.IntEnum): PROPAGATING_BURST_MODE = 4 +class OpticalConfiguration(enum.StrEnum): + """Configuration of the optical output + + Attributes + ---------- + + SCU: `str` + Pass the beam straight-through the SCU. + F1_SCU: `str` + Direct the beam through the F1 after passing through the SCU. + F2_SCU: `str` + Direct the beam through the F2 after passing through the SCU. + NO_SCU: `str` + Pass the beam straight-through. + F1_NO_SCU: `str` + Pass the beam to F1 output. + F2_NO_SCU: `str` + Pass the beam to F2 output. + + """ + + SCU = "SCU" + F1_SCU = "F1 SCU" + F2_SCU = "F2 SCU" + NO_SCU = "No SCU" + F1_NO_SCU = "F1 No SCU" + F2_NO_SCU = "F2 No SCU" + + class LaserErrorCode(enum.IntEnum): """Laser error codes"""