pcdsdevices.signal.InternalSignal

class pcdsdevices.signal.InternalSignal(*args, **kwargs)

Class Signal that stores info but should only be updated by the class.

SignalRO can be updated with _readback, but this does not process callbacks. For the signal to behave normally, we need to bypass the put override.

To put to one of these signals, simply call put with force=True

Methods

describe()

Provide schema and meta-data for read()

This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

This provides schema related information, (ex shape, dtype), the source (ex PV name), and if available, units, limits, precision etc.

Returns:: data_keys (OrderedDict) – The keys must be strings and the values must be dict-like with the event_model.event_descriptor.data_key schema.

read()

Put the status of the signal into a simple dictionary format for data acquisition

read_configuration(): Dictionary mapping names to value dicts with keys: value, timestamp

set(value, *, timestamp=None, force=False)

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

Attributes

connected: Is the signal connected to its associated hardware, and ready to use?

metadata_keys: Metadata keys that will be passed along on value subscriptions