Note

Ophyd async is included on a provisional basis until the v1.0 release and may change API on minor release numbers before then

ophyd_async.epics.adsimdetector.SimDetector#

class ophyd_async.epics.adsimdetector.SimDetector(prefix: str, path_provider: PathProvider, drv_suffix='cam1:', hdf_suffix='HDF1:', name: str = '', config_sigs: Sequence[SignalR] = ())[source]#

Bases: StandardDetector

Methods

children

collect_asset_docs

complete

connect

Connect self and all child Devices.

describe

describe_collect

describe_configuration

get_index

kickoff

prepare

Arm detector.

read

read_configuration

set_name

Set self.name=name and each self.child.name=name+"-child".

stage

trigger

unstage

Attributes

controller

log

name

Return the name of the Device

parent

The parent Device if it exists

writer

children() Iterator[Tuple[str, Device]]#
async collect_asset_docs(index: int | None = None) AsyncIterator[Tuple[Literal['stream_resource'], StreamResource] | Tuple[Literal['stream_datum'], StreamDatum]]#
complete()#
async connect(mock: bool = False, timeout: float = 10.0, force_reconnect: bool = False)#

Connect self and all child Devices.

Contains a timeout that gets propagated to child.connect methods.

Parameters:
  • mock – If True then use MockSignalBackend for all Signals

  • timeout – Time to wait before failing with a TimeoutError.

property controller: DetectorControl#
async describe() Dict[str, DataKey]#
async describe_collect() Dict[str, DataKey]#
async describe_configuration() Dict[str, DataKey]#
async get_index() int#
kickoff()#
property log#
property name: str#

Return the name of the Device

parent: 'Device' | None = None#

The parent Device if it exists

prepare(value: TriggerInfo) None#

Arm detector.

Prepare the detector with trigger information. This is determined at and passed in from the plan level.

This currently only prepares detectors for flyscans and stepscans just use the trigger information determined in trigger.

To do: Unify prepare to be use for both fly and step scans.

Args:

value: TriggerInfo describing how to trigger the detector

async read() Dict[str, Reading]#
async read_configuration() Dict[str, Reading]#
set_name(name: str)#

Set self.name=name and each self.child.name=name+"-child".

Parameters:

name – New name to set

stage() None#
trigger() None#
unstage() None#
property writer: DetectorWriter#