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.core.StandardDetector#

class ophyd_async.core.StandardDetector(controller: DetectorControl, writer: DetectorWriter, config_sigs: Sequence[SignalR] = (), name: str = '', writer_timeout: float = 10.0)[source]#

Useful detector base class for step and fly scanning detectors. Aggregates controller and writer logic together.

Constructor

Args:: controller: Logic for arming and disarming the detector writer: Logic for making the detector write persistent data config_sigs: Signals to read when describe and read configuration are called. Defaults to (). name: Device name. Defaults to “”. writer_timeout: Timeout for frame writing to start, if the timeout is reached, ophyd-async assumes the detector has a problem and raises an error. Defaults to DEFAULT_TIMEOUT.

Methods

`children`
`collect_asset_docs`
`complete`
`connect`	Connect self and all child Devices.
`describe`
`describe_collect`
`describe_configuration`
`get_index`
`kickoff`
`prepare`
`read`
`read_configuration`
`set_name`	Set `self.name=name` and each `self.child.name=name+"-child"`.
`stage`
`trigger`
`unstage`

Attributes

`controller`
`name`	Return the name of the Device
`parent`	The parent Device if it exists
`writer`

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:

set_name(name: str)#

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