ecli_core – ECLI Core module

ecli_core.caget(self, arg)

%caget pv [pv ...]

Get one or more PV’s values over channel access

positional arguments:

pv PV(s) to get

ecli_core.camonitor(self, arg)

%camonitor pvs [pvs ...]

$ monitor pv1 [[pv2] [pv3]...] Monitor until Ctrl-C is pressed

positional arguments:

pvs PV(s) to monitor

ecli_core.caput(self, arg)

%caput pv value

Put (set) a process variable’s (PV) value over channel access

positional arguments:

pv PV to set value

ecli_core.find_field(*args, **kwargs)

Search the field information database for ‘text’. If the first argument is a PV it will detect its record type, otherwise use a record type (.RTYP) to start with.

ecli_core.shell_function_wrapper(exe_)

(decorator) Allows for shell commands to be directly added to IPython’s user namespace

ecli_core.showcaerrors(*args, **kwargs)

$ showcaerrors Toggle display of CA errors / warnings

class ecli_core.ECLICore(shell, config)

add_callback(name, fcn, extension='ECLICore')

Calls fcn when the named callback is triggered

check_requirements(requirements)

Do a basic check on a list of extension requirements

Parameters:requirements – Each requirement should be in the format of a tuple: (‘name’, minimum_version)

exit()

Called before the user exits IPython, notifying each registered plugin

get_aliased_name(name)

Returns an aliased name if it exists (e.g., if PREFIX:PV is aliased to pv, it returns pv)

get_variable(name)

Get a variable’s value from the user namespace (visible to user on the command line)

register_callback(name, extension='ECLICore')

Define a callback for an extension, allowing other extensions to be notified when it is triggered

register_extension(plugin_class, globals_=None, class_magic=True, **kwargs)

Register an extension with ECLI

Parameters:

• plugin_class (class) – The class of the extension/plugin
• globals (dict) – if specified, the global namespace will be checked for magicargument/ECLIExport decorators, automatically exporting those to the user namespace
• class_magic (bool) – if enabled, the class will be checked for magic args/ ECLIExport decorators
• kwargs (dict) – passed to the plugin class initializer

run_callback(name, extension, handle_exceptions=True, show_traceback=None, **kwargs)

Trigger a previously registered callback

set_variable(name, value)

Set a variable in the user namespace (visible to user on the command line)

unregister_callback(name, extension='ECLICore')

Unregister a previously defined callback

unregister_extension(name)

Unregister an extension by name (remove its callbacks, etc.)