dls-dodal 1.56.0__py3-none-any.whl → 1.58.0__py3-none-any.whl

{dls_dodal-1.56.0.dist-info → dls_dodal-1.58.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dls-dodal
-Version: 1.56.0
+Version: 1.58.0
 Summary: Ophyd devices and other utils that could be used across DLS beamlines
 Author-email: Dominic Oram <dominic.oram@diamond.ac.uk>, Joseph Ware <joseph.ware@diamond.ac.uk>, Oliver Silvester <Oliver.Silvester@diamond.ac.uk>, Noemi Frisina <noemi.frisina@diamond.ac.uk>
 License:                                  Apache License
@@ -215,7 +215,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: click
 Requires-Dist: ophyd
-Requires-Dist: ophyd-async[ca,pva]>=0.13.0
+Requires-Dist: ophyd-async[ca,pva]>=0.13.2
 Requires-Dist: bluesky==1.14.2
 Requires-Dist: pyepics
 Requires-Dist: dataclasses-json

{dls_dodal-1.56.0.dist-info → dls_dodal-1.58.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
-dls_dodal-1.56.0.dist-info/licenses/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
+dls_dodal-1.58.0.dist-info/licenses/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
 dodal/__init__.py,sha256=Ksms_WJF8LTkbm38gEpm1jBpGqcQ8NGvmb2ZJlOE1j8,198
 dodal/__main__.py,sha256=kP2S2RPitnOWpNGokjZ1Yq-1umOtp5sNOZk2B3tBPLM,111
-dodal/_version.py,sha256=-Q-x6fbTDcv8A0qE6FFdxYCjVSPznhUJwbWxT9so9xg,706
+dodal/_version.py,sha256=0S_WOya-t7UDFMpZKDOCqr088G6Obb9i_ReErRJRu3o,706
 dodal/cli.py,sha256=yi8dXOp0hqzlg4ZZXCRGU-LpDa_ydaropDjyREWbZ5Y,4152
 dodal/log.py,sha256=Rt5O3hFZfMnJvQueZvgagQuXnPqHrFxhponOvVkpfrk,9871
 dodal/utils.py,sha256=abGitd4FLpLnmckF7lUqOKYUL88r5Ex_NGSVgO4gOf4,19305
@@ -19,8 +19,8 @@ dodal/beamlines/b16.py,sha256=rK00hEj8KLGNkLZr9omAuoMz_DyLN9rK4eUQssETR9E,1703
 dodal/beamlines/b18.py,sha256=ryxrGtcCdwoFgZ8ljWYgr1g9gKvoA7nxkARVxl1IE78,1189
 dodal/beamlines/b21.py,sha256=mN21vnOBmnwzG695HuV7P5DkuTtU8joflJI-evOpgwc,3333
 dodal/beamlines/i02_1.py,sha256=d2IyqFMgeaSEyZYm7GMSjTKr7_02SakyC_oARx-XwnY,1204
-dodal/beamlines/i03.py,sha256=4ZDmWoqHBz1fu0sgMOinQsxBDnH70oeGs78XIrgVMEs,16132
-dodal/beamlines/i04.py,sha256=MhKVuMdbw58YSYbLKaRmkoUHjOykqS10jEWp35d8H3Y,13228
+dodal/beamlines/i03.py,sha256=wYeOyVn7UKhj7NhoGSeiFzK3TduL6YHMIHg37tVmE18,16170
+dodal/beamlines/i04.py,sha256=mRzHnKSKHVmJzs6fwpfBi0QSiry72ixYqa-bs96-0gU,13717
 dodal/beamlines/i05.py,sha256=v4QKd8-neh4Og205oovm6NDRnAU6Oktu1WrxalXsI40,656
 dodal/beamlines/i05_1.py,sha256=R6JFFg8Bj-Izw355mx3mOd4IDvJb5ipB4p7_S0I_4Z0,670
 dodal/beamlines/i09.py,sha256=OrqOcVanJU4F7erRZZDkjLwV8VnLlUzz3LUduaCBgUc,1629
@@ -29,14 +29,15 @@ dodal/beamlines/i09_2.py,sha256=lyYO1rOaIsXNuVOL39Psh-8jQjkhQBXEQMpbXa-Zcw0,713
 dodal/beamlines/i10.py,sha256=0rSWOlIihkDtq7ZZaJ5O2jkMBrteRYjl4Hhqe8EP1Yc,5697
 dodal/beamlines/i11.py,sha256=rjb5iARfbToNzeP-gewYljTu0f__V7bYj3JkJ5bWkGE,4349
 dodal/beamlines/i13_1.py,sha256=VYVqMN8-njy7YSI08gskRccT-K2paRC9edAx0ah-Cwo,1602
+dodal/beamlines/i17.py,sha256=Nickt8CKQ9JcQ1D_ulNICUT4jjLF1Aib7D9jblSnzA4,987
 dodal/beamlines/i18.py,sha256=FuU8G-q1piu6BRou-Shj3BQEbNtsF7CUsSIqqkvCKZc,3615
 dodal/beamlines/i19_1.py,sha256=tg3eALJTn9p686VFV7GjfUvChGS1mrh8-98uzjdLj_g,2934
-dodal/beamlines/i19_2.py,sha256=xSMS2Vhk_6V5WYyefVo1SWXbC4UUyaqru7JVK8VTg00,2554
+dodal/beamlines/i19_2.py,sha256=qotmAulSL2zTLaoxG1Mf6UabeJV-X4iekL0cotTtTww,2929
 dodal/beamlines/i19_optics.py,sha256=8hdlDAAMgFrhcXrp5xCPZtLUlrDUEC9VwKnnuUAMbbU,1150
 dodal/beamlines/i20_1.py,sha256=Zsr1lsH7ySbOgK7RhMVMWzNWZAV-fuYW0iAjSEJZicY,2625
-dodal/beamlines/i22.py,sha256=VU5gz0q_K1D4zBHb88xnd1nAISAIBZOF6o8_YrGPGck,8103
+dodal/beamlines/i22.py,sha256=009Tk5cYyHfmm1DfIwR562WzomXRvyv_5chiBbPgQUs,8100
 dodal/beamlines/i23.py,sha256=ZXvPEiMA4mPbRTXOxvL1NcoVWDg4Deyl8k57cveDg90,3060
-dodal/beamlines/i24.py,sha256=f6SeNbMdxviurfTAnKps8S9NNbDpU7SFzr-J1_c0yn8,6833
+dodal/beamlines/i24.py,sha256=FvK7MqC_dX_alUFMEoS8L4HACThky9lQ7w7rwy0gXdA,6259
 dodal/beamlines/k11.py,sha256=sBOl-MLk7FMo10KFykuK5aLqH1zyW4FnI0XXmtQhUfg,978
 dodal/beamlines/p38.py,sha256=lxFGzmQhth0JhOFbTrZd9LEbUgvKmQdMtiHDW6UJgDs,5763
 dodal/beamlines/p45.py,sha256=tQ7EkWfr7o2okK7Prw1C7DNGYdKPU2ofqjm98wu_-G0,2158
@@ -57,13 +58,14 @@ dodal/common/watcher_utils.py,sha256=jWtXjr2a2NAcTy8A9OnvtB_hWh3GuuLvWxVWHouSvOs
 dodal/common/beamlines/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dodal/common/beamlines/beamline_parameters.py,sha256=nYTy5TDYegvon6iNCxf7Uez3hbdu9GCoLUmJhRO1qhE,2665
 dodal/common/beamlines/beamline_utils.py,sha256=UnDJlRs7p8srjv-peX05jHZBb8J2d2lPSyG9118x560,5286
+dodal/common/beamlines/commissioning_mode.py,sha256=KL24Ia4IOkSxi7M4CKRRQQW0T3HUDpj7K3Y5_DtALRA,1314
 dodal/common/beamlines/device_helpers.py,sha256=8sasAIFRDwo6ElHqLrXnpj_v7xcEg-29Zhey_e4r9u8,84
 dodal/devices/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dodal/devices/aperture.py,sha256=S7AoIoQg_kFxaQk7HUMijbm1kYkOEi2csbdj76kp1ys,427
 dodal/devices/aperturescatterguard.py,sha256=FH2oru3DU-I6BwOJOVEgHdFplLKIIknxtEBUBAXZ_WA,13946
 dodal/devices/apple2_undulator.py,sha256=KbAX1GstP01XOm-QpXlyWCJewfxXKKawnoqbsfsksyY,26265
 dodal/devices/backlight.py,sha256=y40kR6N3qSFVLRaGU8CjJJpwv_hq2QALf_85fLQqras,1415
-dodal/devices/baton.py,sha256=BnakfZxx3cIIX6Kxj8-abxn8Z9LaQODhcPbStbD0as4,485
+dodal/devices/baton.py,sha256=315I_0V73_DYYVT0PBs0luVy4CMqdPo0kLvHBi12MIU,606
 dodal/devices/bimorph_mirror.py,sha256=OGe6aCczG0gVco4OvIRLJVxn2kw5F2QG1e06uqhFLTw,4609
 dodal/devices/collimation_table.py,sha256=64HunSPJH-L2gZdfIj_RYdOlOuwRFEfMHfLHzu4BAKI,1681
 dodal/devices/common_dcm.py,sha256=8QSRE6Z10RQjfL3g4JZhyHRNI_aCKxWlzKSsDgiJHhE,3049
@@ -90,16 +92,16 @@ dodal/devices/robot.py,sha256=k4Vkjpd3R-wXWf6YbYC1225sSdjvTrZS54v5v6Qy_EU,7003
 dodal/devices/s4_slit_gaps.py,sha256=4KdarIQoRqX4ry3LUS1Km7fkjUFahA0VuTd2DvYEqQ8,446
 dodal/devices/scintillator.py,sha256=JresF8SY_-t1raibzR4f0UoMXnFi-Abh3ywGm2DjhKs,3003
 dodal/devices/slits.py,sha256=b_7ku2sHlzhMHTvWrwiRwee6ufrbxNX9JB_Z0lvk15o,1105
-dodal/devices/smargon.py,sha256=TC1ye35mDT1gLlrjIe3CcGeE2vEb78Cu7f0DbzUQR8M,5813
+dodal/devices/smargon.py,sha256=48oOBOKlsvPhlUlK41ozXzCMUKMp3QkQx-pVqKL2Xts,6569
 dodal/devices/status.py,sha256=hVrJS1yooQo6PRumRACoIEh-SKBUKxvBlQl-MtLFUMQ,327
 dodal/devices/synchrotron.py,sha256=OHBrTrm4K39XE8BrE9b_Jn_ZfMRyDp9CHCwvmiV-KOc,1989
 dodal/devices/tetramm.py,sha256=qBu2ClXRM4RFO-y4C2pXVKsp5sX4VpOelbVHOAkkUHQ,8936
-dodal/devices/thawer.py,sha256=UtikbirSZZGjcbZEDWO33n5CIsd_dSvmohIS4R65xWg,1571
+dodal/devices/thawer.py,sha256=HexahKZ1rUxF9jBMeULruqYt6I7fsl6OgXkvcxPQY3M,1963
 dodal/devices/turbo_slit.py,sha256=xhcnhfbdcTYSYozogw6Li4fF4ofoPsc350rEyrRdaNE,1460
-dodal/devices/undulator.py,sha256=3IRn1iOF1PLOuIzaMpsNLVYx-rGvAnr-PG7C3YupW-w,5266
+dodal/devices/undulator.py,sha256=SsgYvIEQUNs_zZiUPAzlw0yJPaSExdmBFltlq5ypbc8,5530
 dodal/devices/watsonmarlow323_pump.py,sha256=xNwjoxW3NJIDkeDWHfb0A8Yj95_KKRXMD9AghvX-WLk,1337
-dodal/devices/webcam.py,sha256=QUfOwblZr_xUGVqt5cMhTwfyQAL-jhSJ2ORQRNmZBrM,2436
-dodal/devices/xbpm_feedback.py,sha256=Uv_jML9gkMT5OcpUrckzxDmsBmktEwV1lga6USxeRyY,1065
+dodal/devices/webcam.py,sha256=UAx2KF0mKi6I-mJJUb5z56MHY-Wd89-tqyPcFbouQFg,2491
+dodal/devices/xbpm_feedback.py,sha256=HKLY3k52FPe2G-EAg8ir2LSdeUuGvhRD73ibDZ4mjH8,1418
 dodal/devices/aithre_lasershaping/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dodal/devices/aithre_lasershaping/goniometer.py,sha256=-2ewYMcdzB1DqP9sMpr4L1i4KeTCrGAJfngAt9-eFWw,1005
 dodal/devices/aithre_lasershaping/laser_robot.py,sha256=vy-I1ASYflFYIUYePhT2l3l7g2iekrIFzLxA0GLmKY8,717
@@ -181,6 +183,7 @@ dodal/devices/i13_1/merlin_controller.py,sha256=myfmByOEXyMrlJZfsjOxDHeGQVwZGfsR
 dodal/devices/i18/KBMirror.py,sha256=W4R3TeulSjosUqAFIIznyWzje_Y2AoEf9f8N-NkisYM,710
 dodal/devices/i18/diode.py,sha256=nk5kvn4LsbhczRpCwHOO0_jJTYOz7MP9qm_uvBWuv7c,1468
 dodal/devices/i19/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dodal/devices/i19/backlight.py,sha256=c3F8RTessUJmJHlCWATSj-W25qlkAttb-c95eS28lKs,662
 dodal/devices/i19/beamstop.py,sha256=JkcvkEmcC3eY3GHrvYNGqv2yDwrfgdpWKVZJWSadWW8,715
 dodal/devices/i19/blueapi_device.py,sha256=Tsl4vsREz7FM2d-kKJK-9tGrYbyKq4SLxnMlEKIM-g8,3966
 dodal/devices/i19/diffractometer.py,sha256=QCEi0Gko6Ja9_ec2vfdazwMspknvX63jcz8hQ2XW1xo,1182
@@ -192,12 +195,11 @@ dodal/devices/i22/fswitch.py,sha256=kpgegs4Wv_weBSzbrlXLXqXOOZdzTn3X9k5PlEN5F6c,
 dodal/devices/i22/nxsas.py,sha256=093GCM2H2LESt28RF-JfxEljJ8QzRPkL1ByXI2XVhoA,6012
 dodal/devices/i24/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dodal/devices/i24/aperture.py,sha256=dlH_g7OPTBc5QRMd-ADU3_GDTKh668kkMHo4k_JxUcY,770
-dodal/devices/i24/beam_center.py,sha256=m6LWsG9e_lhtPfZ8pc_hoLNyTYQQGGdRNav8J_2scTo,483
+dodal/devices/i24/beam_center.py,sha256=nQyOif6JtlU_qP7kZP-8wN1ldW81MIbFUykPC1bEm70,446
 dodal/devices/i24/beamstop.py,sha256=6tbiQLlcTlp4PCPhHJ_mlHtkv0kz5ArQ99zg9rwTnrw,1133
 dodal/devices/i24/dcm.py,sha256=l7qbJh2JKL-5ANlMYXDeU5EBYY6mDiLxn7kp_Z9KNaM,1206
 dodal/devices/i24/dual_backlight.py,sha256=N0R7M1mHPRmQ4fks5lGU1wrXjOvcW_ZKIXaRoC8aLDE,2084
 dodal/devices/i24/focus_mirrors.py,sha256=DYiYLpDw8FJ1LYHxLOxE_om5qGfUo2itzskgqhmQZlg,1763
-dodal/devices/i24/pilatus_metadata.py,sha256=I-AR8vd67qf6p0vZnRPTv4aNPN5T4KpSt2Iog4_jvn0,1781
 dodal/devices/i24/pmac.py,sha256=-HYf2HPzaqWvszp4T8TXohdp40-xmKqQq4V0mLvVri8,7028
 dodal/devices/i24/vgonio.py,sha256=sxSmcYZayVJPJz_D_91j9PmNor7Tbl1RGQFRrdtESlw,533
 dodal/devices/mx_phase1/beamstop.py,sha256=GeHLqHVf3XwJSszUHuxZ2JBwQlcDiFs6jVpdHuw7snM,3127
@@ -224,7 +226,6 @@ dodal/devices/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuF
 dodal/devices/util/adjuster_plans.py,sha256=c40PFZpXFw0YmJLh9jU4VIb8vRxHyafZlmvprTKAOhM,824
 dodal/devices/util/epics_util.py,sha256=4useFL8ngsVF08fhOn48BlnO4oh0T4sEKqjdS6mjvG0,4687
 dodal/devices/util/lookup_tables.py,sha256=jH9f_D8JbTSqzL-RKHUWOORLt8lEoNQL3o9HpXE98TY,3476
-dodal/devices/util/test_utils.py,sha256=tnKKmSBaHEyx-qTQjoR3COqraRMmTdRJe9s-pWjuTPk,1176
 dodal/devices/xspress3/xspress3.py,sha256=OerapEy-IuK7EFz13B5z0BzBmESVl6pYUlqAWHIwJck,4555
 dodal/devices/xspress3/xspress3_channel.py,sha256=w8tAx2lz5kJ_LeJ_eb_4o--Dtt8MRijsYNgDG6oEIVg,1626
 dodal/devices/zebra/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -250,11 +251,12 @@ dodal/plans/verify_undulator_gap.py,sha256=OcDN09-eCoMzsmhKGxvzsH5EapG2zYz0yGCqU
 dodal/plans/wrapped.py,sha256=BPMw__RcWvk9v5XnhMsi9_k4KsDEbmXogzD2n1ecbUg,2098
 dodal/plans/preprocessors/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dodal/plans/preprocessors/verify_undulator_gap.py,sha256=cBZEGq8TW1jrXFXB00iClQVXSEaE_jP_rHMY9WTgYyY,1813
-dodal/testing/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dodal/testing/__init__.py,sha256=AUYZKAvVOs7ZvxO1dVhL0pDTleRO34FQlO5MNe_cwgU,96
+dodal/testing/setup.py,sha256=8cQnrzE5MQD4Etf0eqMarmtr-opsUOMQww-k1V7DzIQ,2442
 dodal/testing/electron_analyser/__init__.py,sha256=-lc1opD2dCv0x678-J-ApOhHtvEvcslfOQ7E613U8-Y,118
 dodal/testing/electron_analyser/device_factory.py,sha256=tkMY6fW3iI02DTD1XXHi4lH6sjo8RHHZBGDHSuTdmNU,2243
-dls_dodal-1.56.0.dist-info/METADATA,sha256=NqXV5pD4dRmGxYRSjy-i--y0scKO6E0V14rJRehyguw,16928
-dls_dodal-1.56.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-dls_dodal-1.56.0.dist-info/entry_points.txt,sha256=bycw_EKUzup_rxfCetOwcauXV4kLln_OPpPT8jEnr-I,94
-dls_dodal-1.56.0.dist-info/top_level.txt,sha256=xIozdmZk_wmMV4wugpq9-6eZs0vgADNUKz3j2UAwlhc,6
-dls_dodal-1.56.0.dist-info/RECORD,,
+dls_dodal-1.58.0.dist-info/METADATA,sha256=FL_laMKISMqDK1hq8tvlBEF1M-r4XhFjVYBfT8yya5E,16928
+dls_dodal-1.58.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+dls_dodal-1.58.0.dist-info/entry_points.txt,sha256=bycw_EKUzup_rxfCetOwcauXV4kLln_OPpPT8jEnr-I,94
+dls_dodal-1.58.0.dist-info/top_level.txt,sha256=xIozdmZk_wmMV4wugpq9-6eZs0vgADNUKz3j2UAwlhc,6
+dls_dodal-1.58.0.dist-info/RECORD,,

dodal/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '1.56.0'
-__version_tuple__ = version_tuple = (1, 56, 0)
+__version__ = version = '1.58.0'
+__version_tuple__ = version_tuple = (1, 58, 0)
 
 __commit_id__ = commit_id = None

dodal/beamlines/i03.py

@@ -261,6 +261,7 @@ def undulator(daq_configuration_path: str | None = None) -> Undulator:
         f"{BeamlinePrefix(BL).insertion_prefix}-MO-SERVC-01:",
         # evaluate here not as parameter default to enable post-import mocking
         id_gap_lookup_table_path=f"{daq_configuration_path or DAQ_CONFIGURATION_PATH}/lookup/BeamLine_Undulator_toGap.txt",
+        baton=baton(),
     )
 
 
@@ -333,7 +334,7 @@ def xbpm_feedback() -> XBPMFeedback:
     """Get the i03 XBPM feeback device, instantiate it if it hasn't already been.
     If this is called when already instantiated in i03, it will return the existing object.
     """
-    return XBPMFeedback(f"{PREFIX.beamline_prefix}-EA-FDBK-01:")
+    return XBPMFeedback(f"{PREFIX.beamline_prefix}-EA-FDBK-01:", baton=baton())
 
 
 @device_factory()

dodal/beamlines/i04.py

@@ -1,3 +1,5 @@
+from ophyd_async.core import Reference
+
 from dodal.common.beamlines.beamline_parameters import get_beamline_parameters
 from dodal.common.beamlines.beamline_utils import (
     device_factory,
@@ -30,6 +32,7 @@ from dodal.devices.oav.oav_to_redis_forwarder import OAVToRedisForwarder
 from dodal.devices.oav.pin_image_recognition import PinTipDetection
 from dodal.devices.robot import BartRobot
 from dodal.devices.s4_slit_gaps import S4SlitGaps
+from dodal.devices.scintillator import Scintillator
 from dodal.devices.smargon import Smargon
 from dodal.devices.synchrotron import Synchrotron
 from dodal.devices.thawer import Thawer
@@ -357,3 +360,15 @@ def pin_tip_detection() -> PinTipDetection:
     If this is called when already instantiated in i04, it will return the existing object.
     """
     return PinTipDetection(f"{PREFIX.beamline_prefix}-DI-OAV-01:")
+
+
+@device_factory()
+def scintillator() -> Scintillator:
+    """Get the i04 scintillator device, instantiate it if it hasn't already been.
+    If this is called when already instantiated in i04, it will return the existing object.
+    """
+    return Scintillator(
+        f"{PREFIX.beamline_prefix}-MO-SCIN-01:",
+        Reference(aperture_scatterguard()),
+        get_beamline_parameters(),
+    )

dodal/beamlines/i17.py

@@ -0,0 +1,37 @@
+"""The I17 hardware doesn't exist yet, but this configuration file is useful for
+creating plans in sm-bluesky as devices build up."""
+
+from ophyd_async.core import StrictEnum
+
+from dodal.common.beamlines.beamline_utils import (
+    device_factory,
+)
+from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.devices.pgm import PGM
+from dodal.devices.synchrotron import Synchrotron
+from dodal.log import set_beamline as set_log_beamline
+from dodal.utils import BeamlinePrefix, get_beamline_name
+
+BL = get_beamline_name("i17")
+PREFIX = BeamlinePrefix(BL)
+set_log_beamline(BL)
+set_utils_beamline(BL)
+
+
+class I17Grating(StrictEnum):
+    AU_400 = "400 line/mm Au"
+    SI_400 = "400 line/mm Si"
+
+
+@device_factory()
+def synchrotron() -> Synchrotron:
+    return Synchrotron()
+
+
+@device_factory(skip=True)
+def pgm() -> PGM:
+    return PGM(
+        prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:",
+        grating=I17Grating,
+        gratingPv="NLINES2",
+    )

dodal/beamlines/i19_2.py

@@ -4,6 +4,7 @@ from dodal.common.beamlines.beamline_utils import (
 from dodal.common.beamlines.beamline_utils import (
     set_beamline as set_utils_beamline,
 )
+from dodal.devices.i19.backlight import BacklightPosition
 from dodal.devices.i19.beamstop import BeamStop
 from dodal.devices.i19.blueapi_device import HutchState
 from dodal.devices.i19.diffractometer import FourCircleDiffractometer
@@ -75,3 +76,11 @@ def synchrotron() -> Synchrotron:
     If this is called when already instantiated in i19-2, it will return the existing object.
     """
     return Synchrotron()
+
+
+@device_factory()
+def backlight() -> BacklightPosition:
+    """Get the i19-2 backlight device, instantiate it if it hasn't already been.
+    If this is called when already instantiated in i19-2, it will return the existing object.
+    """
+    return BacklightPosition(prefix=f"{PREFIX.beamline_prefix}-EA-IOC-12:")

dodal/beamlines/i22.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 
 from ophyd_async.epics.adaravis import AravisDetector
-from ophyd_async.epics.adcore import NDPluginStatsIO
+from ophyd_async.epics.adcore import NDPluginBaseIO
 from ophyd_async.epics.adpilatus import PilatusDetector
 from ophyd_async.fastcs.panda import HDFPanda
 
@@ -103,7 +103,7 @@ def i0() -> TetrammDetector:
         path_provider=get_path_provider(),
         type="Cividec Diamond XBPM",
         plugins={
-            "stats": NDPluginStatsIO(
+            "stats": NDPluginBaseIO(
                 prefix=f"{PREFIX.beamline_prefix}-EA-XBPM-02:SumAll:"
             )
         },
@@ -117,7 +117,7 @@ def it() -> TetrammDetector:
         path_provider=get_path_provider(),
         type="PIN Diode",
         plugins={
-            "stats": NDPluginStatsIO(
+            "stats": NDPluginBaseIO(
                 prefix=f"{PREFIX.beamline_prefix}-EA-TTRM-02:SumAll:"
             )
         },

dodal/beamlines/i24.py

@@ -11,7 +11,6 @@ from dodal.devices.i24.beamstop import Beamstop
 from dodal.devices.i24.dcm import DCM
 from dodal.devices.i24.dual_backlight import DualBacklight
 from dodal.devices.i24.focus_mirrors import FocusMirrorsMode
-from dodal.devices.i24.pilatus_metadata import PilatusMetadata
 from dodal.devices.i24.pmac import PMAC
 from dodal.devices.i24.vgonio import VerticalGoniometer
 from dodal.devices.motors import YZStage
@@ -100,8 +99,8 @@ def dcm() -> DCM:
     If this is called when already instantiated in i24, it will return the existing object.
     """
     return DCM(
-        prefix=f"{PREFIX.beamline_prefix}-DI-DCM-01",
-        motion_prefix=f"{PREFIX.beamline_prefix}-MO-DCM-01",
+        prefix=f"{PREFIX.beamline_prefix}-DI-DCM-01:",
+        motion_prefix=f"{PREFIX.beamline_prefix}-MO-DCM-01:",
     )
 
 
@@ -188,21 +187,3 @@ def eiger_beam_center() -> DetectorBeamCenter:
         f"{PREFIX.beamline_prefix}-EA-EIGER-01:CAM:",
         "eiger_bc",
     )
-
-
-@device_factory()
-def pilatus_beam_center() -> DetectorBeamCenter:
-    """A device for setting/reading the beamcenter from the pilatus on i24."""
-    return DetectorBeamCenter(
-        f"{PREFIX.beamline_prefix}-EA-PILAT-01:cam1:",
-        "pilatus_bc",
-    )
-
-
-@device_factory()
-def pilatus_metadata() -> PilatusMetadata:
-    """A small pilatus driver device for figuring out the filename template."""
-    return PilatusMetadata(
-        f"{PREFIX.beamline_prefix}-EA-PILAT-01:",
-        "pilatus_meta",
-    )

dodal/common/beamlines/commissioning_mode.py

@@ -0,0 +1,33 @@
+"""Functions relating to commissioning mode.
+
+Commissioning Mode can be enabled for a production beamline when there is no
+beam. The intent is that when it is enabled, bluesky plans may be run without beam
+and plans and devices will as far as is possible behave normally.
+"""
+
+import bluesky.plan_stubs as bps
+from bluesky.utils import MsgGenerator
+from ophyd_async.core import SignalR
+
+_commissioning_signal: SignalR | None = None
+
+
+def read_commissioning_mode() -> MsgGenerator[bool]:
+    """Utility method for reading the commissioning mode state from the context
+    of a bluesky plan, where a baton may or may not be present, or
+    commissioning mode is provided by some other mechanism."""
+    if _commissioning_signal:
+        return (yield from bps.rd(_commissioning_signal))
+    else:
+        return False
+
+
+def set_commissioning_signal(signal: SignalR[bool] | None):
+    """Commissioning mode is enabled by a PV which when set enables commissioning mode.
+    This allows beamline staff to ensure that commissioning mode is disabled prior
+    to production use, via their own 'good morning' startup scripts.
+    Args:
+        signal: The signal which will be read in order to determine whether
+        commissioning mode is enabled."""
+    global _commissioning_signal
+    _commissioning_signal = signal

dodal/devices/baton.py

@@ -1,6 +1,7 @@
 from typing import Annotated as A
 
 from ophyd_async.core import (
+    SignalR,
     SignalRW,
     StandardReadable,
 )
@@ -15,3 +16,6 @@ class Baton(StandardReadable, EpicsDevice):
     current_user: A[
         SignalRW[str], PvSuffix("CURRENT_USER"), Format.HINTED_UNCACHED_SIGNAL
     ]
+    commissioning: A[
+        SignalR[bool], PvSuffix("COMMISSIONING"), Format.HINTED_UNCACHED_SIGNAL
+    ]

dodal/devices/i19/backlight.py

@@ -0,0 +1,17 @@
+from bluesky.protocols import Movable
+from ophyd_async.core import AsyncStatus, StandardReadable
+from ophyd_async.epics.core import epics_signal_rw
+
+from dodal.common.enums import InOutUpper
+
+
+class BacklightPosition(StandardReadable, Movable[InOutUpper]):
+    """Device moves backlight to the IN or OUT position since controls side manages switching the light on/off"""
+
+    def __init__(self, prefix: str, name: str = "") -> None:
+        self.position = epics_signal_rw(InOutUpper, f"{prefix}AD1:choiceButton")
+        super().__init__(name)
+
+    @AsyncStatus.wrap
+    async def set(self, value: InOutUpper):
+        await self.position.set(value, wait=True)

dodal/devices/i24/beam_center.py

@@ -1,5 +1,4 @@
-"""A small temporary device to get the beam center positions from \
-    eiger or pilatus detector on i24"""
+"""A small temporary device to get the beam center positions on i24"""
 
 from ophyd_async.core import StandardReadable
 from ophyd_async.epics.core import epics_signal_rw

dodal/devices/smargon.py

@@ -3,7 +3,7 @@ from collections.abc import Collection, Generator
 from dataclasses import dataclass
 from enum import Enum
 from math import isclose
-from typing import NotRequired, TypedDict, cast
+from typing import TypedDict, cast
 
 from bluesky import plan_stubs as bps
 from bluesky.protocols import Movable
@@ -12,6 +12,7 @@ from ophyd_async.core import (
     AsyncStatus,
     Device,
     StrictEnum,
+    set_and_wait_for_value,
     wait_for_value,
 )
 from ophyd_async.epics.core import epics_signal_r, epics_signal_rw
@@ -104,15 +105,15 @@ class DeferMoves(StrictEnum):
     OFF = "Defer Off"
 
 
-class CombinedMove(TypedDict):
+class CombinedMove(TypedDict, total=False):
     """A move on multiple axes at once using a deferred move"""
 
-    x: NotRequired[float | None]
-    y: NotRequired[float | None]
-    z: NotRequired[float | None]
-    omega: NotRequired[float | None]
-    phi: NotRequired[float | None]
-    chi: NotRequired[float | None]
+    x: float | None
+    y: float | None
+    z: float | None
+    omega: float | None
+    phi: float | None
+    chi: float | None
 
 
 class Smargon(XYZStage, Movable):
@@ -123,6 +124,8 @@ class Smargon(XYZStage, Movable):
     Robot loading can nudge these and lead to errors.
     """
 
+    DEFERRED_MOVE_SET_TIMEOUT = 5
+
     def __init__(self, prefix: str, name: str = ""):
         with self.add_children_as_readables():
             self.chi = Motor(prefix + "CHI")
@@ -161,15 +164,29 @@ class Smargon(XYZStage, Movable):
 
     @AsyncStatus.wrap
     async def set(self, value: CombinedMove):
+        """This will move all motion together in a deferred move.
+
+        Once defer_move is on, sets to any axis do not immediately move the axis. Instead
+        the setpoint will go to that value. Then, when defer_move is switched off all
+        axes will move at the same time. The put callbacks on the axes themselves will
+        only come back after the motion on that axis finished.
+        """
         await self.defer_move.set(DeferMoves.ON)
         try:
-            tasks = []
-            for k, v in value.items():
-                if v is not None:
-                    tasks.append(getattr(self, k).set(v))
+            finished_moving = []
+            for motor_name, new_setpoint in value.items():
+                if new_setpoint is not None and isinstance(new_setpoint, int | float):
+                    axis: Motor = getattr(self, motor_name)
+                    await axis.check_motor_limit(
+                        await axis.user_setpoint.get_value(), new_setpoint
+                    )
+                    put_completion = await set_and_wait_for_value(
+                        axis.user_setpoint,
+                        new_setpoint,
+                        timeout=self.DEFERRED_MOVE_SET_TIMEOUT,
+                        wait_for_set_completion=False,
+                    )
+                    finished_moving.append(put_completion)
         finally:
             await self.defer_move.set(DeferMoves.OFF)
-        # The set() coroutines will not complete until after defer moves has been
-        # switched back off so we cannot wait for them until this point.
-        # see https://github.com/DiamondLightSource/dodal/issues/1315
-        await asyncio.gather(*tasks)
+        await asyncio.gather(*finished_moving)

dodal/devices/thawer.py

@@ -1,4 +1,4 @@
-from asyncio import Task, create_task, sleep
+from asyncio import CancelledError, Task, create_task, sleep
 
 from bluesky.protocols import Movable, Stoppable
 from ophyd_async.core import (
@@ -11,6 +11,8 @@ from ophyd_async.core import (
 )
 from ophyd_async.epics.core import epics_signal_rw
 
+from dodal.log import LOGGER
+
 
 class ThawingException(Exception):
     pass
@@ -24,19 +26,29 @@ class ThawingTimer(Device, Stoppable, Movable[float]):
 
     @AsyncStatus.wrap
     async def set(self, value: float):
-        await self._control_signal_ref().set(OnOff.ON)
-        if self._thawing_task and not self._thawing_task.done():
-            raise ThawingException("Thawing task already in progress")
+        if self._thawing_task:
+            LOGGER.info("Thawing task already in progress, resetting timer")
+            self._thawing_task.cancel()
+        else:
+            LOGGER.info("Thawing started")
+            await self._control_signal_ref().set(OnOff.ON)
         self._thawing_task = create_task(sleep(value))
         try:
             await self._thawing_task
-        finally:
+        except CancelledError:
+            LOGGER.info("Timer task cancelled.")
+            raise
+        else:
+            LOGGER.info("Thawing completed")
             await self._control_signal_ref().set(OnOff.OFF)
 
     @AsyncStatus.wrap
     async def stop(self, *args, **kwargs):
         if self._thawing_task:
             self._thawing_task.cancel()
+            self._thawing_task = None
+        LOGGER.info("Thawer stopped.")
+        await self._control_signal_ref().set(OnOff.OFF)
 
 
 class Thawer(StandardReadable, Stoppable):

dodal/devices/undulator.py

@@ -5,6 +5,7 @@ from bluesky.protocols import Movable
 from numpy import ndarray
 from ophyd_async.core import (
     AsyncStatus,
+    Reference,
     StandardReadable,
     StandardReadableFormat,
     soft_signal_r_and_setter,
@@ -15,6 +16,7 @@ from ophyd_async.epics.motor import Motor
 from dodal.common.enums import EnabledDisabledUpper
 from dodal.log import LOGGER
 
+from .baton import Baton
 from .util.lookup_tables import energy_distance_table
 
 
@@ -22,11 +24,6 @@ class AccessError(Exception):
     pass
 
 
-# Enable to allow testing when the beamline is down, do not change in production!
-TEST_MODE = False
-# will be made more generic in https://github.com/DiamondLightSource/dodal/issues/754
-
-
 # The acceptable difference, in mm, between the undulator gap and the DCM
 # energy, when the latter is converted to mm using lookup tables
 UNDULATOR_DISCREPANCY_THRESHOLD_MM = 2e-3
@@ -54,6 +51,7 @@ class Undulator(StandardReadable, Movable[float]):
         name: str = "",
         poles: int | None = None,
         length: float | None = None,
+        baton: Baton | None = None,
     ) -> None:
         """Constructor
 
@@ -64,6 +62,7 @@ class Undulator(StandardReadable, Movable[float]):
             name (str, optional): Name for device. Defaults to "".
         """
 
+        self.baton_ref = Reference(baton) if baton else None
         self.id_gap_lookup_table_path = id_gap_lookup_table_path
         with self.add_children_as_readables():
             self.gap_motor = Motor(prefix + "BLGAPMTR")
@@ -105,7 +104,8 @@ class Undulator(StandardReadable, Movable[float]):
 
     async def raise_if_not_enabled(self):
         access_level = await self.gap_access.get_value()
-        if access_level is EnabledDisabledUpper.DISABLED and not TEST_MODE:
+        commissioning_mode = await self._is_commissioning_mode_enabled()
+        if access_level is EnabledDisabledUpper.DISABLED and not commissioning_mode:
             raise AccessError("Undulator gap access is disabled. Contact Control Room")
 
     async def _set_undulator_gap(self, energy_kev: float) -> None:
@@ -124,21 +124,25 @@ class Undulator(StandardReadable, Movable[float]):
                 f"Undulator gap mismatch. {difference:.3f}mm is outside tolerance.\
                 Moving gap to nominal value, {target_gap:.3f}mm"
             )
-            if not TEST_MODE:
+            commissioning_mode = await self._is_commissioning_mode_enabled()
+            if not commissioning_mode:
                 # Only move if the gap is sufficiently different to the value from the
-                # DCM lookup table AND we're not in TEST_MODE
+                # DCM lookup table AND we're not in commissioning mode
                 await self.gap_motor.set(
                     target_gap,
                     timeout=STATUS_TIMEOUT_S,
                 )
             else:
-                LOGGER.debug("In test mode, not moving ID gap")
+                LOGGER.warning("In test mode, not moving ID gap")
         else:
             LOGGER.debug(
                 "Gap is already in the correct place for the new energy value "
                 f"{energy_kev}, no need to ask it to move"
             )
 
+    async def _is_commissioning_mode_enabled(self):
+        return self.baton_ref and await self.baton_ref().commissioning.get_value()
+
     async def _get_gap_to_match_energy(self, energy_kev: float) -> float:
         """
         get a 2d np.array from lookup table that

dodal/devices/webcam.py

@@ -51,6 +51,7 @@ class Webcam(StandardReadable, Triggerable):
                     )
                 try:
                     data = await response.read()
+                    Image.open(BytesIO(data)).verify()
                     LOGGER.info(f"Saving webcam image from {self.url} to {file_path}")
                 except Exception as e:
                     LOGGER.warning(

dodal/devices/xbpm_feedback.py

@@ -1,8 +1,10 @@
 from bluesky.protocols import Triggerable
-from ophyd_async.core import AsyncStatus, Device, StrictEnum, observe_value
+from ophyd_async.core import AsyncStatus, Device, Reference, StrictEnum, observe_value
 from ophyd_async.epics.core import epics_signal_r, epics_signal_rw
 
 from dodal.common.device_utils import periodic_reminder
+from dodal.devices.baton import Baton
+from dodal.log import LOGGER
 
 
 class Pause(StrictEnum):
@@ -14,15 +16,19 @@ class XBPMFeedback(Device, Triggerable):
     """The XBPM feedback device is an IOC that moves the DCM, HFM and VFM to automatically
     hold the beam into place, as measured by the XBPM sensor."""
 
-    def __init__(self, prefix: str, name: str = "") -> None:
+    def __init__(self, prefix: str, name: str = "", baton: Baton | None = None) -> None:
         self.pos_ok = epics_signal_r(float, prefix + "XBPM2POSITION_OK")
         self.pos_stable = epics_signal_r(float, prefix + "XBPM2_STABLE")
         self.pause_feedback = epics_signal_rw(Pause, prefix + "FB_PAUSE")
+        self.baton_ref = Reference(baton) if baton else None
         super().__init__(name=name)
 
     @AsyncStatus.wrap
     async def trigger(self):
-        async with periodic_reminder("Waiting for XBPM"):
-            async for value in observe_value(self.pos_stable):
-                if value:
-                    return
+        if self.baton_ref and await self.baton_ref().commissioning.get_value():
+            LOGGER.warning("Commissioning mode enabled, ignoring feedback")
+        else:
+            async with periodic_reminder("Waiting for XBPM"):
+                async for value in observe_value(self.pos_stable):
+                    if value:
+                        return

dodal/testing/__init__.py

@@ -0,0 +1,3 @@
+from .setup import patch_all_motors, patch_motor
+
+__all__ = ["patch_motor", "patch_all_motors"]

dodal/testing/setup.py

@@ -0,0 +1,67 @@
+from contextlib import ExitStack
+
+from ophyd_async.core import Device
+from ophyd_async.epics.motor import Motor
+from ophyd_async.testing import (
+    callback_on_mock_put,
+    set_mock_value,
+)
+
+
+def patch_motor(
+    motor: Motor,
+    initial_position: float = 0,
+    deadband: float = 0.001,
+    velocity: float = 3,
+    max_velocity: float = 5,
+    low_limit_travel: float = float("-inf"),
+    high_limit_travel: float = float("inf"),
+):
+    """
+    Patch a mock motor with sensible default values so that it can still be used in
+    tests and plans without running into errors as default values are zero.
+
+    Parameters:
+        motor: The mock motor to set mock values with.
+        initial_position: The default initial position of the motor to be set.
+        deadband: The tolerance between readback value and demand setpoint which the
+                  motor is considered at position.
+        velocity: Requested move speed when the mock motor moves.
+        max_velocity: The maximum allowable velocity that can be set for the motor.
+        low_limit_travel: The lower limit that the motor can move to.
+        high_limit_travel: The higher limit that the motor can move to.
+    """
+    set_mock_value(motor.user_setpoint, initial_position)
+    set_mock_value(motor.user_readback, initial_position)
+    set_mock_value(motor.deadband, deadband)
+    set_mock_value(motor.motor_done_move, 1)
+    set_mock_value(motor.velocity, velocity)
+    set_mock_value(motor.max_velocity, max_velocity)
+    set_mock_value(motor.low_limit_travel, low_limit_travel)
+    set_mock_value(motor.high_limit_travel, high_limit_travel)
+    return callback_on_mock_put(
+        motor.user_setpoint,
+        lambda pos, *args, **kwargs: set_mock_value(motor.user_readback, pos),
+    )
+
+
+def patch_all_motors(parent_device: Device):
+    """
+    Check all children of a device and patch any motors with mock values.
+
+    Parameters:
+        parent_device: The device that hold motor(s) as children.
+    """
+    motors = []
+
+    def recursively_find_motors(device: Device):
+        for _, child_device in device.children():
+            if isinstance(child_device, Motor):
+                motors.append(child_device)
+            recursively_find_motors(child_device)
+
+    recursively_find_motors(parent_device)
+    motor_patch_stack = ExitStack()
+    for motor in motors:
+        motor_patch_stack.enter_context(patch_motor(motor))
+    return motor_patch_stack

dodal/devices/i24/pilatus_metadata.py

@@ -1,44 +0,0 @@
-"""A small temporary device to set and read the filename template from the pilatus"""
-
-import re
-
-from ophyd_async.core import StandardReadable, derived_signal_r
-from ophyd_async.epics.core import epics_signal_r, epics_signal_rw
-
-
-class PilatusMetadata(StandardReadable):
-    def __init__(self, prefix: str, name: str = "") -> None:
-        self.filename = epics_signal_rw(str, prefix + "cam1:FileName")
-        self.template = epics_signal_r(str, prefix + "cam1:FileTemplate_RBV")
-        self.filenumber = epics_signal_r(int, prefix + "cam1:FileNumber_RBV")
-        with self.add_children_as_readables():
-            self.filename_template = derived_signal_r(
-                self._get_full_filename_template,
-                filename=self.filename,
-                filename_template=self.template,
-                file_number=self.filenumber,
-            )
-        super().__init__(name)
-
-    def _get_full_filename_template(
-        self, filename: str, filename_template: str, file_number: int
-    ) -> str:
-        """
-        Get the template file path by querying the detector PVs.
-        Mirror the construction that the PPU does.
-
-        Returns: A template string, with the image numbers replaced with '#'
-        """
-        # Exploit fact that passing negative numbers will put the - before the 0's
-        expected_filename = str(
-            filename_template % (filename, f"{file_number:05d}_", -9)
-        )
-        # Now, find the -09 part of this
-        numberpart = re.search(r"(-0+9)", expected_filename)
-        assert numberpart is not None
-        template_fill = "#" * len(numberpart.group(0))
-        return (
-            expected_filename[: numberpart.start()]
-            + template_fill
-            + expected_filename[numberpart.end() :]
-        )

dodal/devices/util/test_utils.py

@@ -1,37 +0,0 @@
-from contextlib import ExitStack
-
-from ophyd_async.core import Device
-from ophyd_async.epics.motor import Motor
-from ophyd_async.testing import (
-    callback_on_mock_put,
-    set_mock_value,
-)
-
-
-def patch_motor(motor: Motor, initial_position=0):
-    set_mock_value(motor.user_setpoint, initial_position)
-    set_mock_value(motor.user_readback, initial_position)
-    set_mock_value(motor.deadband, 0.001)
-    set_mock_value(motor.motor_done_move, 1)
-    set_mock_value(motor.velocity, 3)
-    set_mock_value(motor.max_velocity, 5)
-    return callback_on_mock_put(
-        motor.user_setpoint,
-        lambda pos, *args, **kwargs: set_mock_value(motor.user_readback, pos),
-    )
-
-
-def patch_all_motors(parent_device: Device):
-    motors = []
-
-    def recursively_find_motors(device: Device):
-        for _, child_device in device.children():
-            if isinstance(child_device, Motor):
-                motors.append(child_device)
-            recursively_find_motors(child_device)
-
-    recursively_find_motors(parent_device)
-    motor_patch_stack = ExitStack()
-    for motor in motors:
-        motor_patch_stack.enter_context(patch_motor(motor))
-    return motor_patch_stack