pcdsdevices.mpod.MPODChannelLV

class pcdsdevices.mpod.MPODChannelLV(channel_prefix, card_prefix=None, name='MPOD', **kwargs)

MPOD Low Voltage Channel Object.

Parameters:
  • channel_prefix (str) – The EPICS base of the MPOD Channel. E.g.: XPP:R39:MPD:CH:0

  • card_prefix (None) – The EPICS base of the MPOD HV Module.

  • name (str)

  • device. (A name to refer to the)

Ophyd Device Components

Attribute

Class

Suffix

Docs

Kind

Notes

voltage

EpicsSignal

:GetVoltageMeasurement

MPOD Channel Voltage Measurement [V]

normal

Inherited from MPODChannel

max_voltage

EpicsSignalRO

:GetMaxVoltage

MPOD Channel Maximum Voltage [V]

normal

Inherited from MPODChannel

terminal_voltage

EpicsSignalRO

:GetTerminalVoltageMeasurement

MPOD Terminal Voltage [V]

normal

Inherited from MPODChannel

current

EpicsSignal

:GetCurrentMeasurement

MPOD Channel Current Measurement [A]

normal

Inherited from MPODChannel

max_current

EpicsSignalRO

:GetMaxCurrent

MPOD Channel Max Current [A]

normal

Inherited from MPODChannel

temperature

EpicsSignalRO

:GetTemperature

MPOD Temperature [C]

normal

Inherited from MPODChannel

status_string

EpicsSignalRO

:GetStatusString

MPOD Channel Status String

normal

Inherited from MPODChannel

state

EpicsSignal

:GetSwitch

MPOD Channel State [Off/On/Reset/EmerOff/ClrEvnt]

normal

Inherited from MPODChannel

voltage_high_limit

EpicsSignal

:SetVoltage.DRVH

normal

Inherited from MPODChannel

voltage_rise_rate

EpicsSignal

:GetVoltageRiseRate

MPOD Channel Voltage Rise Rate [V/sec]

normal

voltage_fall_rate

EpicsSignal

:GetVoltageFallRate

MPOD Channel Set Voltage Fall Rate [V/sec]

normal

Methods

clr_evnt()

Clear Event.

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.

emer_off()

Set the EmerOff state.

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.

get_max_voltage()
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.

reset()

Reset mpod channel.

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)

Set mpod channel current in A.

Parameters:

current (number) – Current in A.

set_voltage(voltage)

Set mpod channel voltage in V.

Parameters:

voltage (number) – Voltage in V.

set_voltage_fall_rate(fall_rate)

Set the voltage fall rate in V/sec.

For the Low Voltage channels, it sets the voltage fall rate for each channel. For the High Voltage channels, it sets the voltage fall rate for the entire card.

Parameters:

fall_rate (number) – Voltage fall rate [V/sec].

set_voltage_rise_rate(rise_rate)

Set the voltage rise rate in V/sec.

For the Low Voltage channels, it sets the voltage rise rate for each channel. For the High Voltage channels, it sets the voltage rise rate for the entire card.

Parameters:

rise_rate (number) – Voltage rise rate [V/sec].

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
subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})