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.AsyncReadable

class ophyd_async.core.AsyncReadable(*args, **kwargs)

Bases: HasName, Protocol

Methods

describe	Return an OrderedDict with exactly the same keys as the read method, here mapped to per-scan metadata about each field.
read	Return an OrderedDict mapping string field name(s) to dictionaries of values and timestamps and optional per-point metadata.

Attributes

name	Used to populate object_keys in the Event DataKey

abstract async read() → Dict[str, Reading]

Return an OrderedDict mapping string field name(s) to dictionaries of values and timestamps and optional per-point metadata.

Example return value:

OrderedDict(('channel1',
             {'value': 5, 'timestamp': 1472493713.271991}),
             ('channel2',
             {'value': 16, 'timestamp': 1472493713.539238}))

abstract async describe() → Dict[str, DataKey]

Return an OrderedDict with exactly the same keys as the read method, here mapped to per-scan metadata about each field.

Example return value:

OrderedDict(('channel1',
             {'source': 'XF23-ID:SOME_PV_NAME',
              'dtype': 'number',
              'shape': []}),
            ('channel2',
             {'source': 'XF23-ID:SOME_PV_NAME',
              'dtype': 'number',
              'shape': []}))

abstract property name: str

Used to populate object_keys in the Event DataKey

https://blueskyproject.io/event-model/event-descriptors.html#object-keys