pcdsdevices.analog_signals.Mesh

class pcdsdevices.analog_signals.Mesh(prefix, sp_ch, rb_ch, scale=1000.0, name=None)

Class for Mesh HV Supply that is connected to Acromag inputs and outputs.

The standard Device name parameter is ignored here and replaced with "mesh_raw".

Parameters:

  • prefix (str) – Prefix of Acromag to be used.

  • sp_ch (int) – Setpoint Acromag channel to which high voltage supply setpoint is connected. Range is 0 to 15.

  • rb_ch (int) – Read back Acromag channel to which high voltage readback is connected. Range is 0 to 15.

  • scale (float, optional) – Gain for high voltage supply to be controlled by the Acromag.

Ophyd Device Components

Attribute

Class

Suffix

Docs

Kind

Notes

write_sig (FCpt)

EpicsSignal

{self.prefix}:ao1:{self.sp_ch}

normal

read_sig (FCpt)

EpicsSignalRO

{self.prefix}:ai1:{self.rb_ch}

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.

get_mesh_voltage()

Get the current mesh voltage setpoint, i.e. the setpoint that the HV supply attempts to output.

get_raw_mesh_voltage()

Get the current acromag voltage that outputs to the HV supply, i.e. the voltage seen by the HV supply.

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_mesh_voltage(hv_sp, wait=True)

Set mesh voltage to an absolute value in V.

Parameters:

  • hv_sp (float) – Desired power supply setpoint in V. Acromag will output necessary voltage such that the HV supply achieves the value passed to hv_sp.

  • wait (bool, optional) – Indicates whether or not the program should pause when writing to a PV.

  • do_print (bool, optional) – Indicates whether or not the program should print it’s setpoint and readback values.

set_rel_mesh_voltage(delta_hv_sp, wait=True)

Increase/decrease the power supply setpoint by a specified amount.

Parameters:

delta_hv_sp (float) – Amount to increase/decrease the power supply setpoint (in V) from its current value. Use positive to increase and negative to decrease.

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.

tweak_mesh_voltage(delta_hv_sp, test_flag=False)

Increase/decrease power supply setpoint using the arrow keys.

Use ‘q’ or ^C to exit tweak mode.

Parameters:

  • delta_hv_sp (float) – Amount to change voltage from its current value at each step, measured in volts. After calling with specified step size, use arrow keys to keep changing. Use absolute value of increment size.

  • test_flag (bool, optional) – Flag used in testing functions to only run while True loop once - i.e. single tweak mode.

Attributes

configuration_attrs
connected
hints
kind
subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})