pcdsdevices.pim.XPIMLED

class pcdsdevices.pim.XPIMLED(*args, **kwargs)

Controllable illumination with auto-on, auto-off, and shutdown timer.

The power signal will read back the current LED power state, and can be used to set the power state if we are not in auto_mode.

The power_timeout signal can be used to configure the LED shutdown in units of minutes. If power_timeout is zero, there will not be a timeout and the LED is permitted to stay on indefinitely.

The time_remaining signal is the number of minutes remaining until the power timeout elapses. This can be put to if the user wants to stall the timer without reconfiguring the timeout.

The auto_mode signal switches us between automatic and manual modes. In automatic mode, we’ll turn the LED on when in the reticle state and off when leaving the reticle state. This is the only time when the LED is useful. Disable this if the state configuration is wrong.

Ophyd Device Components
Attribute	Class	Suffix	Docs	Kind
power	`PytmcSignal`	`:PWR`	LED power state, either on or off.	normal
power_timeout	`PytmcSignal`	`:CLK:TIMEOUT`	Configured auto-shutdown timeout for the led.	config
time_remaining	`PytmcSignal`	`:CLK:REMAINING`	Remaining time before auto-shutoff.	config
auto_mode	`PytmcSignal`	`:AUTO`	Configure auto mode vs manual mode for turning the LED on and off.	config

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() → ophyd.device.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.

read() → ophyd.device.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() → ophyd.device.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.

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() → ophyd.status.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