pcdsdevices.mpod_apalis.MPODApalisChannel

class pcdsdevices.mpod_apalis.MPODApalisChannel(*args, **kwargs)

MPODApalis Channel Object. Takes voltage limit from the parent module, and as such MUST only be used as a Component of MPODApalisModule for limits to make sense

Parameters:

prefix (str) – The EPICS base of the MPOD Channel, e.g. ‘TMO:MPOD:01:M6:C6’.
name (str, keyword-only) – A name to refer to the device.

Ophyd Device Components
Attribute	Class	Suffix	Docs	Kind
voltage	`EpicsSignalEditMD`	`:VoltageMeasure`	MPOD Channel Voltage Measurement [V]. The value of this signal is the actual measured voltage of the channel. If you put to this signal it will change the channel’s voltage setpoint.	normal
max_voltage	`EpicsSignalRO`	`:VoltageNominal`	MPOD Channel Maximum Voltage [V]	normal
current	`EpicsSignalEditMD`	`:CurrentMeasure`	MPOD Channel Current Measurement [A]. The value of this signal is the actual measured current of the channel. If you put to this signal it will change the channel’s current setpoint.	normal
max_current	`EpicsSignalRO`	`:CurrentNominal`	MPOD Channel Current Maximum	normal
state	`EpicsSignal`	`:isOn`	MPOD Channel State [Off/On]	normal
desc	`EpicsSignal`	`:VoltageMeasure.DESC`	MPOD Channel Description	normal
last_voltage_set	`EpicsSignalRO`	`:VoltageSet`	Readback to verify the MPOD Channel Voltage Setpoint [V]. This is used to compare the measured readback voltage with the last value we set to the channel. To change the voltage, use the voltage signal or the set_voltage helper method.	normal
is_trip	`EpicsSignalRO`	`:isTrip`	True if MPOD channel is tripped.	omitted
event_trip	`EpicsSignalRO`	`:EventTrip`	Latching bit that event supply is not good.External supply exceeds lower or upper limits.	normal

Methods

configure(d: Dict[str, Any]) → Tuple[Dict[str, Any], Dict[str, Any]]

Configure the device for something during a run

This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

Parameters:

d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

Returns:

(old, new) tuple of dictionaries
Where old and new are pre- and post-configure configuration states.

describe() → OrderedDictType[str, Dict[str, Any]]

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.

get(**kwargs)

Get the value of all components in the device

Keyword arguments are passed onto each signal.get(). Components beginning with an underscore will not be included.

off(): Set mpod channel Off.

on(): Set mpod channel On.

post_elog_status(): Post device status to the primary elog, if possible.

read() → OrderedDictType[str, Dict[str, Any]]

Read data from the device.

This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in trigger().

The OrderedDict returned by this method must have identical keys (in the same order) as the OrderedDict returned by describe().

By convention, the first key in the return is the ‘primary’ key and maybe used by heuristics in bluesky.

The values in the ordered dictionary must be dict (-likes) with the keys {'value', 'timestamp'}. The 'value' may have any type, the timestamp must be a float UNIX epoch timestamp in UTC.

Returns:: data (OrderedDict) – The keys must be strings and the values must be dict-like with the keys {'value', 'timestamp'}

read_configuration() → OrderedDictType[str, Dict[str, Any]]

Dictionary mapping names to value dicts with keys: value, timestamp

To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

screen()

Open a screen for controlling the device.

Default behavior is the typhos screen, but this method can be overridden for more specialized screens.

set_current(current_number: float) → None

Set mpod channel current in A.

Values above or below the channel’s range will be clamped to the range.

Parameters:: current_number (number) – Current in A.

classmethod set_defaults(*, connection_timeout=10.0)

Set class-wide defaults for device communications

This may be called only before any instances of Device are made.

This setting applies to the class it is called on and all its subclasses. For example,

>>> Device.set_defaults(...)

will apply to any Device subclass.

Parameters:: connection_timeout (float, optional) – Time (seconds) allocated for establishing a connection with the IOC.
Raises:: RuntimeError – If called after EpicsSignalBase has been instantiated for the first time.

set_voltage(voltage_number: float) → None

Set mpod channel voltage in V.

Values above or below the channel’s range will be clamped to the range.

Parameters:: voltage_number (number) – Voltage in V.

status() → str: Returns a str with the current pv values for the device.

stop(*, success=False): Stop the Device and all (instantiated) subdevices

summary()

trigger() → StatusBase

Trigger the device and return status object.

This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

If there is an appreciable time between triggering the device and it being able to be read (via the read() method) then this method is also responsible for arranging that the StatusBase object returned by this method is notified when the device is ready to be read.

If there is no delay between triggering and being readable, then this method must return a StatusBase object which is already completed.

Returns:: status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

Attributes

configuration_attrs

connected

connection_timeout

hints

kind

subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

voltage_setpoint: Name alias for backwards compatibility.