Merge pull request #1217 from ZLLentz/rel-v8.4.0

DOC/REL: v8.4.0

docs/source/api.rst

@@ -140,6 +140,7 @@ pcdsdevices.ccm
     pcdsdevices.ccm.CCMAlio
     pcdsdevices.ccm.CCMConstantsMixin
     pcdsdevices.ccm.CCMEnergy
+    pcdsdevices.ccm.CCMEnergyWithACRStatus
     pcdsdevices.ccm.CCMEnergyWithVernier
     pcdsdevices.ccm.CCMMotor
     pcdsdevices.ccm.CCMPico
@@ -274,6 +275,7 @@ pcdsdevices.epics_motor
     pcdsdevices.epics_motor.PCDSMotorBase
     pcdsdevices.epics_motor.PMC100
     pcdsdevices.epics_motor.SmarAct
+    pcdsdevices.epics_motor.SmarActEncodedTipTilt
     pcdsdevices.epics_motor.SmarActOpenLoop
     pcdsdevices.epics_motor.SmarActOpenLoopPositioner
     pcdsdevices.epics_motor.SmarActTipTilt
@@ -591,6 +593,14 @@ pcdsdevices.lic
     pcdsdevices.lic.LICMirror
     pcdsdevices.lic.LaserInCoupling
 
+pcdsdevices.lic_2d_tmo
+----------------------
+
+.. autosummary::
+    :toctree: generated
+
+    pcdsdevices.lic_2d_tmo.TMOLaserInCouplingTwoDimension
+
 pcdsdevices.light_control
 -------------------------
 
@@ -641,6 +651,7 @@ pcdsdevices.lxe
     pcdsdevices.lxe.LaserEnergyPositioner
     pcdsdevices.lxe.LaserTiming
     pcdsdevices.lxe.LaserTimingCompensation
+    pcdsdevices.lxe.Lcls2LaserTiming
     pcdsdevices.lxe.LxtTtcExample
     pcdsdevices.lxe.TimeToolDelay
     pcdsdevices.lxe._ReversedTimeToolDelay
@@ -1030,6 +1041,16 @@ pcdsdevices.slits
     pcdsdevices.slits.Slits
     pcdsdevices.slits.SlitsBase
 
+pcdsdevices.smarpod
+-------------------
+
+.. autosummary::
+    :toctree: generated
+
+    pcdsdevices.smarpod.SmarPod
+    pcdsdevices.smarpod.SmarPodPose
+    pcdsdevices.smarpod.SmarPodStatus
+
 pcdsdevices.spectrometer
 ------------------------
 
@@ -1165,6 +1186,7 @@ pcdsdevices.utils
     pcdsdevices.utils.maybe_make_method
     pcdsdevices.utils.move_subdevices_to_start
     pcdsdevices.utils.post_ophyds_to_elog
+    pcdsdevices.utils.re_arg
     pcdsdevices.utils.reorder_components
     pcdsdevices.utils.schedule_task
     pcdsdevices.utils.set_many

docs/source/releases.rst

@@ -1,6 +1,78 @@
 Release History
 ###############
 
+v8.4.0 (2024-04-16)
+===================
+
+Compatibility Notes
+-------------------
+- If your SmarAct release is < R1.0.20, then the EPICS signals will timeout on the new PVs.
+  Please make sure to update your children IOCs.
+
+Features
+--------
+- Adds `ioc_chan_num` and `ioc_card_num` to the `EnvironmentalMonitor` happi container.
+- Adds the "embedded" file for `BeckhoffAxisEPSCustom` that allows for typhos screens to open using the compact controls.
+- Adds a convenience `re_arg` decorator to redefine and deprecate a function's args in a backwards-compatible way in the `pcdsdevices.utils` submodule.
+
+Device Updates
+--------------
+- `TprTrigger`: Update numerous PVs to "config", add TCMPL PV as the `operation` signal.
+- Adds the following temperature monitoring signals to `SmarAct` and `SmarActOpenLoop`:
+
+  - `channel_temp`
+  - `module_temp`
+- Adds the following hidden config PVs to the (encoded) `SmarAct` device class:
+
+  - `log_scale_offset`
+  - `log_scale_inv`
+  - `def_range_min`
+  - `def_range_max`
+  - `dist_code_inv`
+- Adds the following missing epics signals to `MPODApalisModule`:
+
+  - `supply_status`
+  - `module_status`
+  - `fine_adjustment_status`
+  - `input_status`
+  - `live_insertion_status`
+  - `safety_loop_status`
+  - `kill`
+
+- Adds an `energy_with_acr_status` instance to CCM
+- Updates `BeamEnergyRequest` argument from "bunch" to "pv_index" to better reflect the broader use cases.
+  A backward compatible warning is now returned if the old bunch kwarg is used.
+- Updates "atol" in `BeamEnergyRequestNoWait` to 0.5 (was 5). This is needed for self-seeding.
+- `XOffsetMirrorStateCool` and `XOffsetMirrorNoBend` gets `variable_cool` for controlling 24V solenoid valve.
+
+New Devices
+-----------
+- Adds `li2k4` as `TMOLaserInCouplingTwoDimension`, with the x and y motors supported (no states yet).
+- Adds `Lcls2LaserTiming`: New class supporting control of laser timing for the OPCPA laser locker system.
+- Adds `SmarActEncodedTipTilt` to the `pcdsdevices.epics_motor` submodule.
+- Adds `SmarPod` and related devices in new `pcdsdevices.smarpod` submodule.
+- Adds a `CCMEnergyWithACRStatus` class to the `pcdsdevices.ccm` submodule, a new variant of `CCMEnergy` that waits for ACR status before marking moves as complete.
+
+Bugfixes
+--------
+- Previously, calculate_on_get/put functions used in `MultiDerivedSignal` s in `pcdsdevices.tpr` classes were not accessing their attrs correctly and would throw KeyErrors when called.
+  Specifically, the name of the attr was being used as the key for items dictionary instead of the actual signal object
+- Also added unit tests for these `MultiDerivedSignal` s in the `pcdsdevices.tpr` submodule.
+- Modify `sp1k4` Attenuator RTD class (`TMOSpectrometer`) to match prefix for `sp1k4` group device.
+
+Contributors
+------------
+- aberges-SLAC
+- baljamal
+- jozamudi
+- KaushikMalapati
+- nrwslac
+- patoppermann
+- sainyamn
+- slactjohnson
+- tongju12
+- vespos
+
 
 v8.3.0 (2024-02-21)
 ===================