diff --git a/docs/source/releases.rst b/docs/source/releases.rst index 8bd7b51ba06..c4e9659c1d4 100644 --- a/docs/source/releases.rst +++ b/docs/source/releases.rst @@ -1,6 +1,94 @@ Release History ############### + +v7.0.0 (2022-10-21) +=================== + +API Changes +----------- +- Now compatible with and expecting ``lightpath`` ``v1.0.0`` for ``lightpath`` support. +- Converted ``LightpathMixin`` to the new ``lightpath`` API, consolodating + reporting into a single ``LightpathState`` Dataclass. The ``lightpath`` + subscription system has also been simplified by using an ``AggregateSignal`` + to monitor all relevant components. +- Overwrote the default move method for the ``CCMEnergy`` class to kill the PID loop at the end of each move (default). + This should prevent the piezo motor from heating up and breaking vacuum or frying itself. + +Features +-------- +- Made ``LCLSItem`` fully ``lightpath``-compatible, to maintain backcompatibility + of happi db, as well as added happi containers that work with the new ``lightpath`` interface. + These containers allow ``input_branches`` and ``output_branches`` + to be optional kwargs. This lets these containers work with devices + that both do and do not implement the ``lightpath`` interface. + In a future release the extra containers may be removed and should + not be considered a permanent API. +- Added LightControl.ui screen for controlling fiber-lites. +- Added useful qmini embedded screen that's been active in dev for over a year. + +Device Updates +-------------- +- Updated ``LightpathMixin`` implementation to the new API for all + existing ``lightpath``-active devices. This includes but is not limited to: + + - Mirrors + - LODCMs + - Attenuators + +- Added an ``ns_delay_scan motor`` to the evr ``Trigger`` class that is + convenient for scanning the delay in nanoseconds. +- Added the missing ``valve_position`` signal to ``ValveBase``, + making it available for all valve classes. This contains the valve's state, + e.g. "OPEN", "CLOSED", "MOVING", "INVALID". +- Made devices that use ``PVStateSignal`` like ``GateValve`` + and ``PulsePicker`` report their enum states and write permissions + in subscriptions for applications like ``typhos`` and ``lightpath``. +- Updated ``pcdsdevices.laser.btps`` device classes following a PV rename. +- Updated ``pcdsdevices.laser.btps`` device classes to support the Laser Beam + Transport Motion System (BTMS). In addition, this includes a module + ``pcdsdevices.laser.btms_config`` which has utilities to represent the state + of the BTS in a control system independent way and allows for motion + verification and other sanity checks. +- Added two new thorlabs ZST213 into ``TMOSpectrometer``, ``lens_pitch`` and ``lens_yaw``. +- Renamed the valve signal named ``close_override`` to ``override_force_close`` + for consistency with ``override_force_open``, which is the corresponding "open" signal. + +New Devices +----------- +- Added ``RohdeSchwarzPowerSupply`` class for controlling the Rohde Schwarz NGP800 power supply series. +- Added ``pcdsdevices.laser.btps.BtpsVGC`` a variant of the VGC class that included + ``valve_position`` prior to this being added in ``ValveBase``. +- Added ``HPI6030`` in radiation.py, a device for reading out 6030 radiation data. +- Added ``Gen1VonHamos4Crystal`` and ``Gen1VonHamosCrystal`` to the ``spectrometer`` module to support the pre-ADS 4 crystal VonHamos. + +Bugfixes +-------- +- Fixed an issue where various types of motors could have inconsistent + limits metadata when the IOC or gateway doesn't behave as expected. +- Fixed an issue where the ``UpdateComponent`` was incompatible with + subscription decorators. +- Fixed PV typos in the ``BeckhoffSlits`` and ``PowerSlits`` typhos ui templates. + +Maintenance +----------- +- Made some of the test motor simulations slightly more accurate. +- Mark ``test_presets`` as xfail because it has a race condition that is + slowing down our development. + +Contributors +------------ +- christina-pino +- jortiz-slac +- klauer +- nrwslac +- tangkong +- tongju12 +- vespos +- wwright-slac +- zllentz + + v6.3.0 (2022-07-27) =================== diff --git a/docs/source/upcoming_release_notes/1022-add_RSpowersupply.rst b/docs/source/upcoming_release_notes/1022-add_RSpowersupply.rst deleted file mode 100644 index 03da210985c..00000000000 --- a/docs/source/upcoming_release_notes/1022-add_RSpowersupply.rst +++ /dev/null @@ -1,30 +0,0 @@ -1022 add RSpowersupply -################# - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- N/A - -New Devices ------------ -- Add RohdeSchwarzPowerSupply class for controlling the Rohde Schwarz NGP800 power supply series - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- tongju12 diff --git a/docs/source/upcoming_release_notes/1028-enh_lp_mixin.rst b/docs/source/upcoming_release_notes/1028-enh_lp_mixin.rst deleted file mode 100644 index d8ba3e4a58b..00000000000 --- a/docs/source/upcoming_release_notes/1028-enh_lp_mixin.rst +++ /dev/null @@ -1,42 +0,0 @@ -1028 enh_lp_mixin -################# - -API Changes ------------ -- Converts LightpathMixin to the new Lightpath API, consolodating - reporting into a single LightpathState Dataclass. The lightpath - subscription system has also been simplified by using an AggregateSignal - to monitor all relevant components. - -Features --------- -- N/A - -Device Updates --------------- -- Updates LightpathMixin implementation to the new API for all - existing lightpath-active devices. This includes but is not limited to: - - - Mirrors - - LODCMs - - Attenuators - - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- Adds happi containers that work with the new Lightpath interface. - Notably, these containers allow input_branches and output_branches - to be optional kwargs. This lets these containers work with devices - that both do and do not implement the Lightpath interface. - -Contributors ------------- -- tangkong diff --git a/docs/source/upcoming_release_notes/1034-Kill_ccm_PID_on_move.rst b/docs/source/upcoming_release_notes/1034-Kill_ccm_PID_on_move.rst deleted file mode 100644 index 0086c26a398..00000000000 --- a/docs/source/upcoming_release_notes/1034-Kill_ccm_PID_on_move.rst +++ /dev/null @@ -1,31 +0,0 @@ -1034 Kill ccm PID on move -################# - -API Changes ------------ -Overwrite default move method for the CCMEnergy class to kill the PID loop at the end of each move (default) -This should prevent the piezo motor from heating up and breaking vacuum or frying itself. - -Features --------- -- N/A - -Device Updates --------------- -- N/A - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -espov diff --git a/docs/source/upcoming_release_notes/1037-enh_evr_motor.rst b/docs/source/upcoming_release_notes/1037-enh_evr_motor.rst deleted file mode 100644 index f2e452a05fd..00000000000 --- a/docs/source/upcoming_release_notes/1037-enh_evr_motor.rst +++ /dev/null @@ -1,31 +0,0 @@ -1037 enh_evr_motor -################## - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- Added an ``ns_delay_scan motor`` to the evr ``Trigger`` class that is - convenient for scanning the delay in nanoseconds. - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- zllentz diff --git a/docs/source/upcoming_release_notes/1041-fix_valvebase.rst b/docs/source/upcoming_release_notes/1041-fix_valvebase.rst deleted file mode 100644 index 5bf4b70d265..00000000000 --- a/docs/source/upcoming_release_notes/1041-fix_valvebase.rst +++ /dev/null @@ -1,32 +0,0 @@ -1041 fix_valvebase -################## - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- Add the missing ``valve_position`` signal to ``ValveBase``, - making it available for all valve classes. This contains the valve's state, - e.g. "OPEN", "CLOSED", "MOVING", "INVALID" - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- klauer diff --git a/docs/source/upcoming_release_notes/1045-fix_limits.rst b/docs/source/upcoming_release_notes/1045-fix_limits.rst deleted file mode 100644 index 8bb225ecdef..00000000000 --- a/docs/source/upcoming_release_notes/1045-fix_limits.rst +++ /dev/null @@ -1,33 +0,0 @@ -1045 fix limits -############### - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- N/A - -New Devices ------------ -- N/A - -Bugfixes --------- -- Fix an issue where various types of motors could have inconsistent - limits metadata when the IOC or gateway doesn't behave as expected. -- Fix an issue where the ``UpdateComponent`` was incompatible with - subscription decorators. - -Maintenance ------------ -- Make some of the test motor simulations slightly more accurate. - -Contributors ------------- -- zllentz diff --git a/docs/source/upcoming_release_notes/1046-pvstate_metadata.rst b/docs/source/upcoming_release_notes/1046-pvstate_metadata.rst deleted file mode 100644 index 012b33647de..00000000000 --- a/docs/source/upcoming_release_notes/1046-pvstate_metadata.rst +++ /dev/null @@ -1,32 +0,0 @@ -1046 pvstate metadata -##################### - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- Make devices that use ``PVStateSignal`` like ``GateValve`` - and ``PulsePicker`` report their enum states and write permissions - in subscriptions for applications like typhos and lightpath. - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- zllentz diff --git a/docs/source/upcoming_release_notes/1047-Adding_LightControl.ui.rst b/docs/source/upcoming_release_notes/1047-Adding_LightControl.ui.rst deleted file mode 100644 index abd5278a848..00000000000 --- a/docs/source/upcoming_release_notes/1047-Adding_LightControl.ui.rst +++ /dev/null @@ -1,30 +0,0 @@ -1047 Adding LightControl.ui -################# - -API Changes ------------ -- N/A - -Features --------- -- New LightControl.ui screen for controlling fiber-lites - -Device Updates --------------- -- N/A - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- wwright-slac diff --git a/docs/source/upcoming_release_notes/1049-enh_btms.rst b/docs/source/upcoming_release_notes/1049-enh_btms.rst deleted file mode 100644 index 58435470ef3..00000000000 --- a/docs/source/upcoming_release_notes/1049-enh_btms.rst +++ /dev/null @@ -1,36 +0,0 @@ -1049 enh_btms -############# - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- Updated ``pcdsdevices.laser.btps`` device classes following a PV rename. -- Updated ``pcdsdevices.laser.btps`` device classes to support the Laser Beam - Transport Motion System (BTMS). In addition, this includes a module - ``pcdsdevices.laser.btms_config`` which has utilities to represent the state - of the BTS in a control system independent way and allows for motion - verification and other sanity checks. - -New Devices ------------ -- ``pcdsdevices.laser.btps.BtpsVGC`` a variant of the VGC class that includes - ``valve_position``. - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- klauer diff --git a/docs/source/upcoming_release_notes/1052-fix_slits_typos.rst b/docs/source/upcoming_release_notes/1052-fix_slits_typos.rst deleted file mode 100644 index acd4cd25b20..00000000000 --- a/docs/source/upcoming_release_notes/1052-fix_slits_typos.rst +++ /dev/null @@ -1,30 +0,0 @@ -1052 fix_slits_typos -#################### - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- N/A - -New Devices ------------ -- N/A - -Bugfixes --------- -- Fix PV typos in the BeckhoffSlits and PowerSlits typhos ui templates. - -Maintenance ------------ -- N/A - -Contributors ------------- -- zllentz diff --git a/docs/source/upcoming_release_notes/1054-radiation-sensor.rst b/docs/source/upcoming_release_notes/1054-radiation-sensor.rst deleted file mode 100644 index 2de2675f221..00000000000 --- a/docs/source/upcoming_release_notes/1054-radiation-sensor.rst +++ /dev/null @@ -1,30 +0,0 @@ -1054 radiation-sensor -################# - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- N/A - -New Devices ------------ -- Added HPI6030 in radiation.py, a device for reading out 6030 radiation data. - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- nrwslac diff --git a/docs/source/upcoming_release_notes/1055-tst_race_cond_bandaid.rst b/docs/source/upcoming_release_notes/1055-tst_race_cond_bandaid.rst deleted file mode 100644 index 8697873c0be..00000000000 --- a/docs/source/upcoming_release_notes/1055-tst_race_cond_bandaid.rst +++ /dev/null @@ -1,31 +0,0 @@ -1055 tst_race_cond_bandaid -########################## - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- N/A - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- Mark test_presets as xfail because it has a race condition that is - slowing down our development. - -Contributors ------------- -- zllentz diff --git a/docs/source/upcoming_release_notes/1056-Add_Gen1VonHamos4Crystal.rst b/docs/source/upcoming_release_notes/1056-Add_Gen1VonHamos4Crystal.rst deleted file mode 100644 index bb8389503bc..00000000000 --- a/docs/source/upcoming_release_notes/1056-Add_Gen1VonHamos4Crystal.rst +++ /dev/null @@ -1,30 +0,0 @@ -1056 Add Gen1VonHamos4Crystal -################# - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- Added Gen1VonHamos4Crystal and Gen1VonHamosCrystal to the spectrometer device to support the pre-ADS 4 crystal VonHamos - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- jortiz-slac diff --git a/docs/source/upcoming_release_notes/1057-Enabling_slider_on_LightControl.ui.rst b/docs/source/upcoming_release_notes/1057-Enabling_slider_on_LightControl.ui.rst deleted file mode 100644 index 18f891e5788..00000000000 --- a/docs/source/upcoming_release_notes/1057-Enabling_slider_on_LightControl.ui.rst +++ /dev/null @@ -1,30 +0,0 @@ -1057 Enabling slider on LightControl.ui -################# - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- N/A - -New Devices ------------ -- N/A - -Bugfixes --------- -- Enabling slider on LightControl.ui - -Maintenance ------------ -- N/A - -Contributors ------------- -- wwright-slac diff --git a/docs/source/upcoming_release_notes/1058-Add_new_motors_into_spectrometer.rst b/docs/source/upcoming_release_notes/1058-Add_new_motors_into_spectrometer.rst deleted file mode 100644 index 540011c6bbf..00000000000 --- a/docs/source/upcoming_release_notes/1058-Add_new_motors_into_spectrometer.rst +++ /dev/null @@ -1,30 +0,0 @@ -1058 Add new motors into spectrometer -################# - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- Add two new thorlabs ZST213 into TMOSpectrometer, lens_pitch and lens_yaw. - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- tongju12 diff --git a/docs/source/upcoming_release_notes/1060-Fixing_some_confusing_naming_regard_override_force_close.rst b/docs/source/upcoming_release_notes/1060-Fixing_some_confusing_naming_regard_override_force_close.rst deleted file mode 100644 index d20a92cfbec..00000000000 --- a/docs/source/upcoming_release_notes/1060-Fixing_some_confusing_naming_regard_override_force_close.rst +++ /dev/null @@ -1,30 +0,0 @@ -1060 Fixing some confusing naming regarding override force close -################# - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- N/A - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- The commands for force closing and force opening status' were different. Override force open was override_force_open, but override force close was close_override. This just makes things clearer. - -Contributors ------------- -- wwright-slac diff --git a/docs/source/upcoming_release_notes/1062-mnt_lp_branch_property.rst b/docs/source/upcoming_release_notes/1062-mnt_lp_branch_property.rst deleted file mode 100644 index a03ab20a6e9..00000000000 --- a/docs/source/upcoming_release_notes/1062-mnt_lp_branch_property.rst +++ /dev/null @@ -1,32 +0,0 @@ -1062 mnt_lp_branch_property -########################### - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- N/A - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- ``input_branches`` and ``output_branches`` keyword arguments are no longer required - for ``LightpathMixin``. ``LightpathMixin`` will attempt to grab - this information from the ``md`` namespace attached by happi. - -Contributors ------------- -- tangkong diff --git a/docs/source/upcoming_release_notes/1064-enh_qmini.rst b/docs/source/upcoming_release_notes/1064-enh_qmini.rst deleted file mode 100644 index a5ba97022e7..00000000000 --- a/docs/source/upcoming_release_notes/1064-enh_qmini.rst +++ /dev/null @@ -1,30 +0,0 @@ -1064 enh_qmini -############## - -API Changes ------------ -- N/A - -Features --------- -- Added useful qmini embedded screen that's been active in dev for over a year. - -Device Updates --------------- -- N/A - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- christina-pino diff --git a/docs/source/upcoming_release_notes/1065-mnt_backcompat_lightpathitem.rst b/docs/source/upcoming_release_notes/1065-mnt_backcompat_lightpathitem.rst deleted file mode 100644 index e68a7bd79a5..00000000000 --- a/docs/source/upcoming_release_notes/1065-mnt_backcompat_lightpathitem.rst +++ /dev/null @@ -1,31 +0,0 @@ -1065 mnt_backcompat_lightpathitem -################################# - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- N/A - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- makes LCLSItem fully lightpath-compatible, to maintain backcompatibility - of happi db - -Contributors ------------- -- tangkong