pcdsdevices.interface.BaseInterface

class pcdsdevices.interface.BaseInterface(*args, **kwargs)

Interface layer to attach to any Device for SLAC features.

This class defines an API and some defaults for filtering tab-completion results for new users to avoid confusion. The API involves setting the tab_whitelist attribute on any subclass of BaseInterface. When in non-engineering mode, only elements on the whitelists will be displayed to the user.

tab_whitelist

List of string regex to show in autocomplete for non-engineering mode.

Type:: list

Methods

post_elog_status(): Post device status to the primary elog, if possible.

screen()

Open a screen for controlling the device.

Default behavior is the typhos screen, but this method can be overridden for more specialized screens.

status() → str: Returns a str with the current pv values for the device.