pcdsdevices.lasers.elliptec.EllRotation

class pcdsdevices.lasers.elliptec.EllRotation(prefix, port=0, channel=1, **kwargs)

Class for Thorlabs ELL14/18 (rotation) stages.

Parameters

  • prefix (str) – The PV base of the stage.

  • channel (str) – The motor channel on the controller (0-F)

  • port (str) – The port of the Elliptec controller (typically 0)

Examples

ell14 = EllRotation(‘LM1K4:COM_DP1_TF1_ROT1:ELL’, port=0, channel=1,

name=’ell14’)

Ophyd Device Components

Attribute

Class

Suffix

Docs

Kind

Notes

set_position (FCpt)

EpicsSignal

{prefix}:M{self._channel}:CURPOS

normal

Inherited from EllLinear

jog_fwd (FCpt)

EpicsSignal

{prefix}:M{self._channel}:MOVE_FWD

normal

Inherited from EllLinear

jog_bwd (FCpt)

EpicsSignal

{prefix}:M{self._channel}:MOVE_BWD

normal

Inherited from EllLinear

status (FCpt)

EpicsSignalRO

{prefix}:M{self._channel}:STATUS

normal

Inherited from EllLinear

optimize (FCpt)

EpicsSignal

{prefix}:M{self._channel}:OPTIMIZE

omitted

Inherited from EllLinear

_from_addr (FCpt)

EpicsSignal

{prefix}:PORT{self._port}:FROM_ADDR

omitted

Inherited from EllLinear

_to_addr (FCpt)

EpicsSignal

{prefix}:PORT{self._port}:TO_ADDR

omitted

Inherited from EllLinear

_save (FCpt)

EpicsSignal

{prefix}:PORT{self._port}:SAVE

omitted

Inherited from EllLinear

_command (FCpt)

EpicsSignal

{prefix}:PORT{self._port}:CMD

omitted

Inherited from EllLinear

_response (FCpt)

EpicsSignalRO

{prefix}:PORT{self._port}:RESPONSE

omitted

Inherited from EllLinear

home (FCpt)

EpicsSignal

{prefix}:M{self._channel}:HOME

config

Inherited from EllLinear

jog_step (FCpt)

EpicsSignal

{prefix}:M{self._channel}:GET_JOG

config

Inherited from EllLinear

clean (FCpt)

EpicsSignal

{prefix}:M{self._channel}:CLEAN_MECH

omitted

Inherited from EllLinear

stop_optimize (FCpt)

EpicsSignal

{prefix}:M{self._channel}:STOP

omitted

Inherited from EllLinear

current_egu (FCpt)

EpicsSignal

{prefix}:M{self._channel}:CURPOS.EGU

omitted

Inherited from EllLinear

target_egu (FCpt)

EpicsSignal

{prefix}:M{self._channel}:MOVE.EGU

omitted

Inherited from EllLinear

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.

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