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.HardwareTriggeredFlyable#

class ophyd_async.core.HardwareTriggeredFlyable(trigger_logic: TriggerLogic[T], configuration_signals: Sequence[SignalR] = (), name: str = '')[source]#

Bases: Device, Stageable, Preparable, Flyable, Generic[T]

Methods

`children`
`complete`
`connect`	Connect self and all child Devices.
`describe_configuration`
`kickoff`
`prepare`	Setup trajectories
`read_configuration`
`set_name`	Set `self.name=name` and each `self.child.name=name+"-child"`.
`stage`
`unstage`

Attributes

`log`
`name`	Return the name of the Device
`parent`	The parent Device if it exists
`trigger_logic`

property trigger_logic: TriggerLogic[T]#

stage() → None[source]#

unstage() → None[source]#

prepare(value: T) → AsyncStatus[source]#: Setup trajectories

kickoff() → None[source]#

complete() → None[source]#

async describe_configuration() → Dict[str, DataKey][source]#

async read_configuration() → Dict[str, Reading][source]#

children() → Iterator[Tuple[str, Device]]#

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 log#

property name: str#: Return the name of the Device

parent: 'Device' | None = None#: The parent Device if it exists

set_name(name: str)#

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

Parameters:: name – New name to set