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

status() → str

Returns a str with the current pv values for the device.