pcdsdevices.mpod_apalis.MPODApalisModule

class pcdsdevices.mpod_apalis.MPODApalisModule(*args, **kwargs)

MPODApalis Module Object.

Parameters:

• card_prefix (str) – The EPICS base of the MPOD Module, e.g. ‘TMO:MPOD:01:M6’.

• name (str) – A name to refer to the device.

Ophyd Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
voltage_ramp_speed	EpicsSignal	:VoltageRampSpeed	MPOD module Voltage Ramp Rate [%/sec*Vnom]	normal
current_ramp_speed	EpicsSignal	:CurrentRampSpeed	MPOD module current Ramp Rate [%/sec*Inom]	normal
temperature	EpicsSignalRO	:Temperature	MPOD Temperature [C]	normal
supply_status	EpicsSignalRO	:isSupplyGood	Supply voltages are within range	normal
module_status	EpicsSignalRO	:isModuleGood	Module health status	normal
fine_adjustment_status	EpicsSignalRO	:isFineAdjustment	Fine adjustment mode status	normal
input_status	EpicsSignalRO	:isInputError	Input error in connection with a module access	normal
live_insertion_status	EpicsSignalRO	:isLiveInsertion	Live insertion mode status	normal
saftey_loop_status	EpicsSignalRO	:isSafetyLoopGood	Saftey loop status	normal
kill	EpicsSignal	:isKillEnable	Module-wide kill functionality	normal
faults	EpicsSignal	:isEventActive	Clears all MPOD module faults	normal

Methods

clear_faults()

Clears all module faults

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.

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_ramp_speed(ramp_speed)

Set the current ramp speed in %/sec*Inom.

It sets the current ramp speed for the entire card.

Parameters:

ramp_speed (number) – Current ramp speed [%/sec*Vnom].

set_voltage_ramp_speed(ramp_speed)

Set the voltage ramp speed in %/sec*Vnom.

It sets the voltage ramp speed for the entire card.

Parameters:

ramp_speed (number) – Voltage rise rate [%/sec*Vnom].

stage_group_instances() → Iterator[OphydObject]

Yields an iterator of subdevices that should be staged.

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

hints

kind

needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

stage_group: list[Component] = None

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