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.demo.demo_ad_sim_detector.DemoADSimDetector#

class ophyd_async.epics.demo.demo_ad_sim_detector.DemoADSimDetector(drv: ADBase, hdf: NDFileHDF, directory_provider: DirectoryProvider, name: str = '', config_sigs: Sequence[SignalR] = ())[source]#

Bases: StandardDetector

Methods

check_config_sigs

Checks configuration signals are named and connected.

children

collect_asset_docs

Collect stream datum documents for all indices written.

connect

Connect self and all child Devices.

describe

describe_configuration

read

Read the detector

read_configuration

set_name

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

stage

Disarm the detector, stop filewriting, and open file for writing.

trigger

Arm the detector and wait for it to finish.

unstage

Stop data writing.

Attributes

controller

name

Return the name of the Device

parent

The parent Device if it exists

writer

async check_config_sigs()#

Checks configuration signals are named and connected.

async collect_asset_docs() AsyncIterator[Tuple[Literal['resource'], PartialResource] | Tuple[Literal['datum'], Datum] | Tuple[Literal['stream_resource'], StreamResource] | Tuple[Literal['stream_datum'], StreamDatum]]#

Collect stream datum documents for all indices written.

async connect(sim: bool = False, timeout: float = 10.0)#

Connect self and all child Devices.

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

Parameters:
  • sim – If True then connect in simulation mode.

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

property name: str#

Return the name of the Device

async read() Dict[str, Reading]#

Read the detector

set_name(name: str)#

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

Parameters:

name – New name to set

stage() None#

Disarm the detector, stop filewriting, and open file for writing.

trigger() None#

Arm the detector and wait for it to finish.

unstage() None#

Stop data writing.