from pathlib import Path
from ophyd_async.epics.areadetector import AravisDetector
from ophyd_async.panda import HDFPanda
from dodal.common.beamlines.beamline_utils import (
device_instantiation,
get_directory_provider,
set_directory_provider,
)
from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
from dodal.common.beamlines.device_helpers import numbered_slits
from dodal.common.visit import LocalDirectoryServiceClient, StaticVisitDirectoryProvider
from dodal.devices.focusing_mirror import FocusingMirror
from dodal.devices.i22.dcm import CrystalMetadata, DoubleCrystalMonochromator
from dodal.devices.i22.fswitch import FSwitch
from dodal.devices.linkam3 import Linkam3
from dodal.devices.slits import Slits
from dodal.devices.tetramm import TetrammDetector
from dodal.devices.undulator import Undulator
from dodal.log import set_beamline as set_log_beamline
from dodal.utils import BeamlinePrefix, get_beamline_name, skip_device
BL = get_beamline_name("p38")
set_log_beamline(BL)
set_utils_beamline(BL)
# Currently we must hard-code the visit, determining the visit at runtime requires
# infrastructure that is still WIP.
# Communication with GDA is also WIP so for now we determine an arbitrary scan number
# locally and write the commissioning directory. The scan number is not guaranteed to
# be unique and the data is at risk - this configuration is for testing only.
set_directory_provider(
StaticVisitDirectoryProvider(
BL,
Path("/dls/p38/data/2024/cm37282-2/bluesky"),
client=LocalDirectoryServiceClient(),
)
)
[docs]
def d3(
wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
) -> AravisDetector:
return device_instantiation(
AravisDetector,
"d3",
"-DI-DCAM-01:",
wait_for_connection,
fake_with_ophyd_sim,
drv_suffix="DET:",
hdf_suffix="HDF5:",
directory_provider=get_directory_provider(),
)
# Disconnected
@skip_device
def d11(
wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
) -> AravisDetector:
return device_instantiation(
AravisDetector,
"d11",
"-DI-DCAM-03:",
wait_for_connection,
fake_with_ophyd_sim,
drv_suffix="DET:",
hdf_suffix="HDF5:",
directory_provider=get_directory_provider(),
)
[docs]
def d12(
wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
) -> AravisDetector:
return device_instantiation(
AravisDetector,
"d12",
"-DI-DCAM-04:",
wait_for_connection,
fake_with_ophyd_sim,
drv_suffix="DET:",
hdf_suffix="HDF5:",
directory_provider=get_directory_provider(),
)
[docs]
def i0(
wait_for_connection: bool = True,
fake_with_ophyd_sim: bool = False,
) -> TetrammDetector:
return device_instantiation(
TetrammDetector,
"i0",
"-EA-XBPM-01:",
wait_for_connection,
fake_with_ophyd_sim,
directory_provider=get_directory_provider(),
)
#
# The following devices are created as fake by default since P38 has no optics,
# but having mock devices here means they will be reflected in downstream data
# processing, where they may be required.
#
[docs]
def slits_1(
wait_for_connection: bool = True,
fake_with_ophyd_sim: bool = True,
) -> Slits:
return numbered_slits(
1,
wait_for_connection,
fake_with_ophyd_sim,
)
[docs]
def slits_2(
wait_for_connection: bool = True,
fake_with_ophyd_sim: bool = True,
) -> Slits:
return numbered_slits(
2,
wait_for_connection,
fake_with_ophyd_sim,
)
[docs]
def slits_3(
wait_for_connection: bool = True,
fake_with_ophyd_sim: bool = True,
) -> Slits:
return numbered_slits(
3,
wait_for_connection,
fake_with_ophyd_sim,
)
[docs]
def slits_4(
wait_for_connection: bool = True,
fake_with_ophyd_sim: bool = True,
) -> Slits:
return numbered_slits(
4,
wait_for_connection,
fake_with_ophyd_sim,
)
[docs]
def slits_5(
wait_for_connection: bool = True,
fake_with_ophyd_sim: bool = True,
) -> Slits:
return numbered_slits(
5,
wait_for_connection,
fake_with_ophyd_sim,
)
[docs]
def slits_6(
wait_for_connection: bool = True,
fake_with_ophyd_sim: bool = True,
) -> Slits:
return numbered_slits(
6,
wait_for_connection,
fake_with_ophyd_sim,
)
[docs]
def fswitch(
wait_for_connection: bool = True,
fake_with_ophyd_sim: bool = True,
) -> FSwitch:
return device_instantiation(
FSwitch,
"fswitch",
"-MO-FSWT-01:",
wait_for_connection,
fake_with_ophyd_sim,
lens_geometry="paraboloid",
cylindrical=True,
lens_material="Beryllium",
)
[docs]
def vfm(
wait_for_connection: bool = True,
fake_with_ophyd_sim: bool = True,
) -> FocusingMirror:
return device_instantiation(
FocusingMirror,
"vfm",
"-OP-KBM-01:VFM:",
wait_for_connection,
fake_with_ophyd_sim,
)
[docs]
def hfm(
wait_for_connection: bool = True,
fake_with_ophyd_sim: bool = True,
) -> FocusingMirror:
return device_instantiation(
FocusingMirror,
"hfm",
"-OP-KBM-01:HFM:",
wait_for_connection,
fake_with_ophyd_sim,
)
[docs]
def dcm(
wait_for_connection: bool = True,
fake_with_ophyd_sim: bool = True,
) -> DoubleCrystalMonochromator:
return device_instantiation(
DoubleCrystalMonochromator,
"dcm",
"",
wait_for_connection,
fake_with_ophyd_sim,
bl_prefix=False,
motion_prefix=f"{BeamlinePrefix(BL).beamline_prefix}-MO-DCM-01:",
temperature_prefix=f"{BeamlinePrefix(BL).beamline_prefix}-DI-DCM-01:",
crystal_1_metadata=CrystalMetadata(
usage="Bragg",
type="silicon",
reflection=(1, 1, 1),
d_spacing=3.13475,
),
crystal_2_metadata=CrystalMetadata(
usage="Bragg",
type="silicon",
reflection=(1, 1, 1),
d_spacing=3.13475,
),
)
[docs]
def undulator(
wait_for_connection: bool = True,
fake_with_ophyd_sim: bool = True,
) -> Undulator:
return device_instantiation(
Undulator,
"undulator",
f"{BeamlinePrefix(BL).insertion_prefix}-MO-SERVC-01:",
wait_for_connection,
fake_with_ophyd_sim,
bl_prefix=False,
poles=80,
length=2.0,
)
# Must find which PandA IOC(s) are compatible
# Must document what PandAs are physically connected to
# See: https://github.com/bluesky/ophyd-async/issues/284
@skip_device
def panda1(
wait_for_connection: bool = True,
fake_with_ophyd_sim: bool = False,
) -> HDFPanda:
return device_instantiation(
HDFPanda,
"panda1",
"-EA-PANDA-01:",
wait_for_connection,
fake_with_ophyd_sim,
directory_provider=get_directory_provider(),
)
@skip_device
def panda2(
wait_for_connection: bool = True,
fake_with_ophyd_sim: bool = False,
) -> HDFPanda:
return device_instantiation(
HDFPanda,
"panda2",
"-EA-PANDA-02:",
wait_for_connection,
fake_with_ophyd_sim,
directory_provider=get_directory_provider(),
)
@skip_device
def panda3(
wait_for_connection: bool = True,
fake_with_ophyd_sim: bool = False,
) -> HDFPanda:
return device_instantiation(
HDFPanda,
"panda3",
"-EA-PANDA-03:",
wait_for_connection,
fake_with_ophyd_sim,
directory_provider=get_directory_provider(),
)
@skip_device
def linkam(
wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
) -> Linkam3:
return device_instantiation(
Linkam3,
"linkam",
"-EA-LINKM-02:",
wait_for_connection,
fake_with_ophyd_sim,
)
