pcdsdevices.signal.PVStateSignal
- class pcdsdevices.signal.PVStateSignal(*, name, **kwargs)
Signal that implements the
PVStatePositionerstate logic.See AggregateSignal for more information.
Methods
- add_signal_by_attr_name(name: str) Signal
Add a signal from which to aggregate information.
This must be called before any subscriptions are made to the signal. Duplicate signals will not be re-added.
- Parameters:
name (str) – The attribute name of the signal, relative to the parent device.
- Returns:
sig (ophyd.Signal) – The signal referenced by the attribute name.
- Raises:
RuntimError – If called after .subscribe() or used without a parent Device.
- get(**kwargs)
Update all values and recalculate.
- Parameters:
**kwargs – Keyword arguments are passed to each
signal.get(**kwargs).
- read()
Put the status of the signal into a simple dictionary format for data acquisition
- Returns:
dict
- read_configuration()
Dictionary mapping names to value dicts with keys: value, timestamp
- set(value, *, timeout=None, settle_time=None, **kwargs)
Set the value of the Signal and return a Status object.
- Returns:
st (Status) – This status object will be finished upon return in the case of basic soft Signals
- trigger()
Call that is used by bluesky prior to read()
Attributes
- SUB_META = 'meta'
- connected
Are all relevant signals connected?
- enum_strs
Mimic the epics signal property for enum strings.
- high_limit
The high, inclusive control limit for the Signal
- hints
Field hints for plotting
- kind
- limits
The control limits (low, high), such that low <= value <= high
- low_limit
The low, inclusive control limit for the Signal
- metadata
A copy of the metadata dictionary associated with the signal
- metadata_keys
Metadata keys that will be passed along on value subscriptions
- read_access
Can the signal be read?
- source_name
- timestamp
Timestamp of the readback value
- tolerance
The absolute tolerance associated with the value.
- value
The signal’s value
- write_access
Can the signal be written to?