mesycontrol Package

app_context Module

class mesycontrol.app_context.Context(main_file, auto_load_device_modules=True, parent=None)

Bases: PyQt4.QtCore.QObject

add_shutdown_callback(cb)

get_config_directory_hint()

get_setup_directory_hint()

init_device_registry()

make_qsettings()

open_setup(filename)

reset_setup()

set_config_directory_hint(filename)

set_setup_directory_hint(filename)

setup

The contexts current setup object.

shutdown()

mesycontrol.app_context.make(*args, **kwds)

Creates and yields a Context object. Makes sure shutdown() is called on the context after use. Usage:

with app_context.make(...) as context:

do_things_with(context)

mesycontrol.app_context.use(*args, **kwds)

Same as make() but takes a Context instance instead of creating one.

app_model Module

class mesycontrol.app_model.AppObject(hardware=None, config=None, parent=None)

Bases: PyQt4.QtCore.QObject

cfg

config_set

self, old, new

get_config()

get_hardware()

hardware_set

self, old, new

has_cfg

has_hw

hw

set_config(cfg)

set_hardware(hw)

class mesycontrol.app_model.Device(bus, address, mrc=None, hw_device=None, cfg_device=None, hw_module=None, cfg_module=None, parent=None)

Bases: mesycontrol.app_model.AppObject

add_default_polling_subscription(subscriber)

address_conflict

cfg_extension_changed

cfg_idc

cfg_idc_changed

cfg_module

cfg_module_changed

cfg_parameter_changed

cfg_profile

cfg_profile_changed

config_applied

True if hardware and config values are equal.

config_applied_changed

create_config(name='', create_mrc_config=True)

Creates a config for this device using the default values from the device profile.

Preconditions:

• self.cfg must be None: device must not have a config yet
• self.profile must be set: a device profile is needed to create the config with the proper idc and initial values
• create_mrc_config must be True or self.mrc.cfg must be set

get_cfg_idc()

get_cfg_module()

get_cfg_profile()

get_config_parameters()

get_critical_config_parameters()

get_device_name()

get_hw_idc()

get_hw_module()

get_hw_profile()

get_idc()

get_module()

get_mrc()

get_non_critical_config_parameters()

get_profile()

has_address_conflict()

has_idc_conflict()

True if hardware and config IDCs differ.

has_specialized_class()

has_widget_class()

hw_extension_changed

hw_idc

hw_idc_changed

hw_module

hw_module_changed

hw_parameter_changed

hw_profile

hw_profile_changed

idc

idc_changed

idc_conflict

True if hardware and config IDCs differ.

idc_conflict_changed

is_config_applied()

True if hardware and config values are equal.

make_device_widget(display_mode, write_mode, make_settings=None, parent=None)

make_specialized_device(read_mode, write_mode)

module

module_changed

mrc

mrc_changed

profile

profile_changed

remove_polling_subscriber(subscriber)

set_cfg_module(module)

set_hw_module(module)

set_module(module)

set_mrc(mrc)

update_config_applied()

class mesycontrol.app_model.Director(app_registry, device_registry)

Bases: object

Manages the app_model tree. Subscribes to changes to both the hardware and config trees and updates the app_model tree.

class mesycontrol.app_model.MRC(url, mrc_registry=None, hw_mrc=None, cfg_mrc=None, parent=None)

Bases: mesycontrol.app_model.AppObject

add_device(device)

create_config()

device_about_to_be_removed

device_added

device_removed

devices

get_device(bus, address)

get_devices(bus=None)

get_display_url()

get_mrc_registry()

get_url()

mrc_registry

mrc_registry_changed

remove_device(device)

set_mrc_registry(registry)

url

class mesycontrol.app_model.MRCRegistry(hw_reg, cfg_reg, parent=None)

Bases: mesycontrol.app_model.AppObject

add_mrc(mrc)

find_mrc_by_config(cfg_mrc)

find_mrc_by_hardware(hw_mrc)

get_mrc(url)

get_mrcs()

mrc_about_to_be_removed

mrc_added

mrc_removed

mrcs

remove_mrc(mrc)

setup

async_util Module

class mesycontrol.async_util.DefaultGeneratorRunner(generator=None, parent_widget=None, parent=None)

Bases: mesycontrol.config_util.GeneratorRunner

basic_model Module

class mesycontrol.basic_model.Device(bus=None, address=None, idc=None, parent=None)

Bases: PyQt4.QtCore.QObject

address

address_changed

bus

bus_changed

clear_cached_memory()

Clears the memory cache. Returns True if any parameters where cleared. Otherwise False is returned.

clear_cached_parameter(address)

Removes the cached memory value at the given address. Emits parameter_changed and returns True if the parameter was present in the memory cache. Otherwise False is returned.

extension_added

extension_changed

extension_removed

extensions

get_address()

Get the devices address on the bus.

get_bus()

Returns the devices bus number.

get_cached_memory()

Returns a copy of the memory cache in the form of a dict.

get_cached_memory_ref()

Returns a reference to the memory cache (a dictionary).

get_cached_parameter(address)

Returns the integer value of the cached parameter at the given address or None if the parameter is not present in the cache. address must be within PARAM_RANGE, otherwise a ValueError will be raised.

get_extension(name)

get_extensions()

get_idc()

Get the devices identifier code.

get_mrc()

Get the MRC the device is connected to. Returns None if no MRC has been set.

get_parameter(address)

Get a parameter from the devices memory cache if available. Otherwise use Device.read_parameter() to read the parameter from the hardware. Returns a ResultFuture whose result is a ReadResult instance.

has_cached_parameter(address)

Returns True if the given address is in the memory cache.

has_extension(name)

idc

idc_changed

memory_about_to_be_cleared

memory

memory_cleared

mrc

mrc_changed

parameter_changed

address, value

read_parameter(address)

Read a parameter from the device. This method returns a ResultFuture whose result is a ReadResult instance. On read success the local memory cache is updated with the newly read value.

remove_extension(name)

set_address(address)

Set the devices address. address must be within DEV_RANGE.

set_bus(bus)

Set the devices bus number. Bus must be in BUS_RANGE.

set_cached_parameter(address, value)

Set the memory cache at the given address to the given value. Emits parameter_changed and returns True if the value changes. Otherwise no signal is emitted and False is returned. Raises ValueError if address is out of range.

set_extension(name, value)

set_idc(idc)

Set the devices identifier code.

set_mrc(mrc)

Set the MRC the device is connected to. Pass None to clear the current MRC.

set_parameter(address, value)

Set the parameter at the given address to the given value. Updates the local memory cache on success. This method returns a ResultFuture whose result is a SetResult instance.

exception mesycontrol.basic_model.IDCConflict

Bases: exceptions.RuntimeError

class mesycontrol.basic_model.MRC(url, parent=None)

Bases: PyQt4.QtCore.QObject

add_device(device)

device_about_to_be_removed

device_added

device_removed

get_device(bus, address)

get_devices(bus=None)

get_display_url()

get_url()

has_device(bus, address)

remove_device(device)

set_url(url)

url

url_changed

class mesycontrol.basic_model.MRCRegistry(parent=None)

Bases: PyQt4.QtCore.QObject

Manages MRC instances

add_mrc(mrc)

contains_devices()

get_mrc(url)

get_mrcs()

mrc_about_to_be_removed

mrc_added

mrc_removed

mrcs

remove_mrc(mrc)

class mesycontrol.basic_model.ReadResult

Bases: mesycontrol.basic_model.ReadResult

The result type for a read operation. A namedtuple with added conversion to int.

class mesycontrol.basic_model.ResultFuture

Bases: mesycontrol.future.Future

Future subclass used to hold ReadResult/SetResult instances. This class adds an int() conversion method to easily obtain the result value.

class mesycontrol.basic_model.SetResult

Bases: mesycontrol.basic_model.SetResult

The result type for a set operation. Adds requested_value to the fields of ReadResult and conversions to int and bool. The bool conversion returns True if value equals requested value.

basic_tree_model Module

class mesycontrol.basic_tree_model.BasicTreeModel(parent=None)

Bases: PyQt4.QtCore.QAbstractItemModel

add_node(node, parent_node, row)

clear()

data(idx, role=0)

find_node_by_ref(ref)

Find and return the node pointing to the given ref. If no node can be found None is returned.

flags(idx)

index(row, col, parent=<PyQt4.QtCore.QModelIndex object at 0xa3d2a04>)

index_for_node(node)

index_for_ref(ref)

notify_data_changed(node, col1=None, col2=None)

parent(idx)

remove_node(node)

rowCount(parent=<PyQt4.QtCore.QModelIndex object at 0xa3d2b1c>)

setData(idx, value, role=2)

class mesycontrol.basic_tree_model.BasicTreeNode(ref=None, parent=None)

Bases: object

Support class for implementing the nodes of a Qt tree model.

append_child(child)

data(column, role)

find_node_by_ref(ref)

Find and return the node pointing to the given ref. If no node can be found None is returned.

flags(column)

get_model()

Get this nodes model. If no model is set for this node return the parent nodes model. Return None if no model is set for the node hierarchy.

get_parent()

get_ref()

get_row()

has_ref()

model

Get this nodes model. If no model is set for this node return the parent nodes model. Return None if no model is set for the node hierarchy.

notify_all_columns_changed()

No argument variant of notify_data_changed(). Useful to connect to signals whose arguments are to be discarded (the args would take the place of col1 and col2 which is not desired).

notify_data_changed(col1=0, col2=None)

Calls notify_data_changed on the nodes model if a model is set. col1 and col2 specify the first and last column that changed. If col2 is None it will be set to the models column count. If the node has no model this method does nothing.

parent

ref

row

set_data(column, value, role)

set_model(model)

set_parent(parent)

set_ref(ref)

config_gui Module

class mesycontrol.config_gui.ApplyDeviceConfigRunner(device, parent_widget, parent=None)

Bases: mesycontrol.config_util.GeneratorRunner

class mesycontrol.config_gui.ApplyDeviceConfigsRunner(devices, parent_widget, parent=None)

Bases: mesycontrol.config_util.GeneratorRunner

progress_changed

class mesycontrol.config_gui.ApplySetupRunner(app_registry, device_registry, parent_widget, parent=None)

Bases: mesycontrol.config_util.GeneratorRunner

progress_changed

class mesycontrol.config_gui.FillDeviceConfigsRunner(devices, parent_widget, parent=None)

Bases: mesycontrol.config_util.GeneratorRunner

progress_changed

class mesycontrol.config_gui.ReadConfigParametersRunner(devices, parent_widget, parent=None)

Bases: mesycontrol.config_util.GeneratorRunner

progress_changed

class mesycontrol.config_gui.SubProgressDialog(title='', parent=None)

Bases: PyQt4.QtGui.QDialog

cancel()

canceled

set_progress(progress)

mesycontrol.config_gui.std_button_to_cfg_action(button)

config_model Module

class mesycontrol.config_model.Device(bus=None, address=None, idc=None, parent=None)

Bases: mesycontrol.basic_model.Device

clear_cached_memory(*args, **kwargs)

Clears the memory cache. Returns True if any parameters where cleared. Otherwise False is returned.

clear_cached_parameter(*args, **kwargs)

Removes the cached memory value at the given address. Emits parameter_changed and returns True if the parameter was present in the memory cache. Otherwise False is returned.

get_name()

is_modified()

modified

modified_changed

name

name_changed

remove_extension(*args, **kwargs)

set_address(*args, **kwargs)

Set the devices address. address must be within DEV_RANGE.

set_bus(*args, **kwargs)

Set the devices bus number. Bus must be in BUS_RANGE.

set_cached_parameter(*args, **kwargs)

Set the memory cache at the given address to the given value. Emits parameter_changed and returns True if the value changes. Otherwise no signal is emitted and False is returned. Raises ValueError if address is out of range.

set_extension(*args, **kwargs)

set_idc(*args, **kwargs)

Set the devices identifier code.

set_modified(b)

set_name(*args, **kwargs)

class mesycontrol.config_model.MRC(url=None, parent=None)

Bases: mesycontrol.basic_model.MRC

add_device(*args, **kwargs)

autoconnect

autoconnect_changed

get_autoconnect()

get_name()

is_modified()

modified

modified_changed

name

name_changed

remove_device(*args, **kwargs)

set_autoconnect(*args, **kwargs)

set_modified(b)

set_name(*args, **kwargs)

set_url(*args, **kwargs)

class mesycontrol.config_model.Setup(parent=None)

Bases: mesycontrol.basic_model.MRCRegistry

add_mrc(*args, **kwargs)

autoconnect

autoconnect_changed

filename

filename_changed

get_autoconnect()

get_filename()

is_modified()

modified

modified_changed

remove_mrc(*args, **kwargs)

set_autoconnect(*args, **kwargs)

set_filename(*args, **kwargs)

set_modified(b)

mesycontrol.config_model.make_device_config(bus, address, idc, name=u'', device_profile=None)

mesycontrol.config_model.modifies(f)

Method decorator which executes `wrapped_object.set_modified(True)’ if the wrapped method returns a non-false value.

config_tree_model Module

class mesycontrol.config_tree_model.BusNode(bus_number, parent=None)

Bases: mesycontrol.basic_tree_model.BasicTreeNode

data(column, role)

class mesycontrol.config_tree_model.ConfigTreeModel(device_registry, parent=None)

Bases: mesycontrol.basic_tree_model.BasicTreeModel

columnCount(parent=<PyQt4.QtCore.QModelIndex object at 0xa5a156c>)

headerData(section, orientation, role=0)

class mesycontrol.config_tree_model.ConfigTreeNode(ref, parent)

Bases: mesycontrol.basic_tree_model.BasicTreeNode

class mesycontrol.config_tree_model.DeviceNode(device, parent=None)

Bases: mesycontrol.config_tree_model.ConfigTreeNode

data(column, role)

flags(column)

set_data(column, value, role)

class mesycontrol.config_tree_model.MRCNode(mrc, parent=None)

Bases: mesycontrol.config_tree_model.ConfigTreeNode

data(column, role)

flags(column)

set_data(column, value, role)

class mesycontrol.config_tree_model.SetupNode(setup, parent=None)

Bases: mesycontrol.config_tree_model.ConfigTreeNode

data(column, role)

config_util Module

exception mesycontrol.config_util.Aborted

Bases: exceptions.RuntimeError

class mesycontrol.config_util.GeneratorRunner(generator=None, parent=None)

Bases: PyQt4.QtCore.QObject

close()

progress_changed

start()

Start execution of the generator. Requires a running Qt event loop (or calls to processEvents()). Returns a Future that fullfills on generator termination.

exception mesycontrol.config_util.MissingDestinationDevice(url, bus, dev)

Bases: exceptions.RuntimeError

exception mesycontrol.config_util.MissingDestinationMRC(url)

Bases: exceptions.RuntimeError

class mesycontrol.config_util.ProgressUpdate(current, total, text='')

Bases: object

current

get_current()

get_total()

increment(delta=1)

set_current(cur)

set_total(total)

total

exception mesycontrol.config_util.RcOff(device)

Bases: exceptions.RuntimeError

exception mesycontrol.config_util.SetParameterError(set_result, device=None)

Bases: exceptions.RuntimeError

mesycontrol.config_util.apply_device_config(device)

Device may be an app_model.Device instance or a DeviceBase subclass.

mesycontrol.config_util.apply_device_configs(devices)

Applies config values to the hardware for each of the given devices. Required MRC connections are established.

mesycontrol.config_util.apply_parameters(source, dest, criticals, non_criticals)

Write parameters from source to dest. First criticals are set to their safe value, then non_criticals are written to the destination and finally criticals are set to the value they have in the source device.

mesycontrol.config_util.apply_setup(app_registry, device_registry)

mesycontrol.config_util.connect_and_apply_setup(app_registry, device_registry)

mesycontrol.config_util.establish_connections(setup, hardware_registry)

mesycontrol.config_util.fill_device_configs(devices)

For each of the given devices read config parameters from the hardware and use them to fill the device config. Device extensions will also be copied from hardware to config.

mesycontrol.config_util.read_config_parameters(devices)

mesycontrol.config_util.run_callables_generator(callables)

config_xml Module

class mesycontrol.config_xml.CommentTreeBuilder(element_factory=None)

Bases: xml.etree.ElementTree.TreeBuilder

comment(data)

mesycontrol.config_xml.dict2xml(tb, d)

mesycontrol.config_xml.list2xml(tb, l)

mesycontrol.config_xml.read_device_config(source)

mesycontrol.config_xml.read_setup(source)

Load a Setup from the given source. Source may be a filename or a file like object.

mesycontrol.config_xml.value2xml(tb, value)

mesycontrol.config_xml.write_device_config(device_config, dest, parameter_names={})

Write the given device config to destination. The optional parameter_names should map parameter_address to parameter_name. These names will be added as comments in the resulting XML.

mesycontrol.config_xml.write_setup(setup, dest, idc_to_parameter_names={})

Write the given setup to the given destination. Dest may be a filename or a file like object opened for writing. idc_to_parameter_names should map device_idc to a dictionary of param_address -> param_name.

mesycontrol.config_xml.xml2dict(node)

mesycontrol.config_xml.xml2list(node)

mesycontrol.config_xml.xml2value(node)

device_profile Module

class mesycontrol.device_profile.DeviceProfile(idc)

Bases: object

add_parameter(param)

get_config_parameters()

get_critical_parameters()

get_extension(name)

get_extensions()

get_non_critical_config_parameters()

get_non_critical_parameters()

get_parameter_by_address(address)

get_parameter_by_name(name)

get_parameter_names()

get_parameters()

get_static_addresses()

get_volatile_addresses()

has_parameter(param)

idc = None

Device Identifier Code

name = None

Device name (e.g. MHV4). Should be unique.

set_extension(ext)

exception mesycontrol.device_profile.DuplicateParameter

Bases: exceptions.RuntimeError

class mesycontrol.device_profile.ParameterProfile(address)

Bases: object

address = None

Numeric address of the parameter.

critical = None

True if this parameter affects a critical

default

do_not_store = None

True if this parameters value should not be stored

static fromDict(d)

get_default()

get_name()

get_unit(label_or_name)

has_index()

index = None

Index number of this parameter if it is part of a sequence

is_named()

name

poll = None

True if this parameter should be polled repeatedly.

range = None

Range instance limiting this parameters values.

read_only = None

True if this parameter is read only. Its

safe_value = None

Optional safe value if this parameter is critical.

set_default(value)

set_name(name)

should_be_stored()

units = None

Optional list of Unit definitions for this parameter.

class mesycontrol.device_profile.Range(min_value, max_value)

Bases: object

in_range(value)

limit_to(value)

to_tuple()

class mesycontrol.device_profile.Unit(label, factor=1.0, offset=0.0, name=None)

Bases: object

factor

Factor used for value<->unit conversion.

static fromDict(d)

get_factor()

get_offset()

offset

Offset used for value<->unit conversion.

raw_value(unit_value)

set_factor(factor)

set_offset(offset)

unit_value(raw_value)

mesycontrol.device_profile.from_dict(d)

mesycontrol.device_profile.make_generic_profile(device_idc)

device_registry Module

class mesycontrol.device_registry.DeviceRegistry(auto_load_modules=False)

Bases: object

Provides access to device modules.

get_device_class(idc)

get_device_module(idc)

get_device_name(idc)

get_device_names()

Returns a list of (idc, name) tuples.

get_device_profile(idc)

get_device_profiles()

get_device_ui_class(idc)

get_parameter_name_mapping()

Returns a mapping of device_idc to a dictionary of param_address -> param_name. Basically the known parameter names for each device.

get_parameter_names(idc)

load_device_module(module_name)

Load device class and device UI class from the module specified by `module_name’. The module has to define three variables: `idc’, `device_class’ and `device_ui_class’ containing the device idc, the device class and the device UI class to use.

load_system_modules()

Load all built-in device modules.

class mesycontrol.device_registry.VirtualDeviceModule(idc)

Bases: object

has_specialized_class()

has_widget_class()

device_tableview Module

class mesycontrol.device_tableview.DeviceTableItemDelegate(parent=None)

Bases: PyQt4.QtGui.QStyledItemDelegate

createEditor(parent, options, proxy_idx)

class mesycontrol.device_tableview.DeviceTableModel(device, display_mode, write_mode, parent=None)

Bases: PyQt4.QtCore.QAbstractTableModel

columnCount(parent=<PyQt4.QtCore.QModelIndex object at 0xab2c3e4>)

data(idx, role=0)

device

display_mode

editing_ignore_parameter_ranges

flags(idx)

get_device()

get_display_mode()

get_editing_ignore_parameter_ranges()

get_profile()

get_write_mode()

headerData(section, orientation, role=0)

profile

rowCount(parent=<PyQt4.QtCore.QModelIndex object at 0xab2c454>)

setData(idx, value, role=2)

set_device(device)

set_display_mode(mode)

set_editing_ignore_parameter_ranges(do_ignore)

set_write_mode(mode)

write_mode

class mesycontrol.device_tableview.DeviceTableSortFilterProxyModel(parent=None)

Bases: PyQt4.QtGui.QSortFilterProxyModel

QSortFilterProxyModel subclass to be used with the DeviceTableView. Filtering capabilities:

• known addresses
• read / write addresses
• addresses with the poll flag set

filterAcceptsRow(src_row, src_parent)

filter_readonly

filter_static

filter_unknown

filter_volatile

get_filter_readonly()

get_filter_static()

get_filter_unknown()

get_filter_volatile()

set_filter_readonly(on_off)

set_filter_static(on_off)

set_filter_unknown(on_off)

If enabled any unknown parameter addresses are filtered out. `Unknown’ means that the devices DeviceProfile does not contain the address.

set_filter_volatile(on_off)

class mesycontrol.device_tableview.DeviceTableView(model, parent=None)

Bases: PyQt4.QtGui.QTableView

contextMenuEvent(event)

device

display_mode

display_mode_changed

does_show_config()

does_show_hardware()

get_display_mode()

get_profile()

get_toolbar()

get_write_mode()

profile

set_display_mode(mode)

set_write_mode(mode)

write_mode

write_mode_changed

class mesycontrol.device_tableview.DeviceTableWidget(device, display_mode=3, write_mode=3, parent=None)

Bases: PyQt4.QtGui.QWidget

device

display_mode

display_mode_changed

get_toolbar()

write_mode

write_mode_changed

eventloop_callback Module

class mesycontrol.eventloop_callback.ref(method)

Bases: object

A weak method implementation

is_dead()

Returns True if the referenced callable was a bound method and the instance no longer exists. Otherwise, return False.

class mesycontrol.eventloop_callback.proxy(method, quiet=False)

Bases: mesycontrol.eventloop_callback.ref

Exactly like ref, but calling it will cause the referent method to be called with the same arguments. If the referent’s object no longer lives, ReferenceError is raised.

If quiet is True, then a ReferenceError is not raise and the callback silently fails if it is no longer valid.

class mesycontrol.eventloop_callback.CallbackEvent(func, *args, **kwargs)

Bases: PyQt4.QtCore.QEvent

A custom QEvent that contains a callback reference

Also provides class methods for conveniently executing arbitrary callback, to be dispatched to the event loop.

EVENT_TYPE = 65535

callback()

Convenience method to run the callable.

Equivalent to:

self.func(*self.args, **self.kwargs)

classmethod post(func, *args, **kwargs)

Post a callable to run in the main thread

classmethod post_to(receiver, func, *args, **kwargs)

Post a callable to be delivered to a specific receiver as a CallbackEvent.

It is the responsibility of this receiver to handle the event and choose to call the callback.

class mesycontrol.eventloop_callback.CallbackThreadPool(processes=None, initializer=None, initargs=())

Bases: multiprocessing.pool.ThreadPool

Simple wrapper around ThreadPool to wrap callbacks in a weakref that get posted as CallbackEvents in the main thread.

apply_async(fn, args=None, kwargs=None, callback=None)

map_async(fn, iterable, chunk=None, callback=None)

future Module

exception mesycontrol.future.CancelledError

Bases: exceptions.RuntimeError

class mesycontrol.future.Future

Bases: object

add_done_callback(fn, unique=True)

add_progress_callback(fn, unique=True)

cancel()

cancelled()

done()

exception()

progress()

progress_max()

progress_min()

progress_range()

progress_text()

result()

running()

set_exception(exception)

set_progress(progress)

set_progress_range(min_or_tuple, max_or_none=None)

set_progress_text(txt)

set_result(result)

set_running_or_notify_cancel()

If the method returns False then the Future was cancelled. Otherwise the Future will be put in running state and True is returned.

exception mesycontrol.future.FutureIsDone

Bases: exceptions.RuntimeError

exception mesycontrol.future.FutureIsRunning

Bases: exceptions.RuntimeError

class mesycontrol.future.FutureObserver(the_future=None, parent=None)

Bases: PyQt4.QtCore.QObject

Qt wrapper around a Future object using Qt signals to notify about state changes.

cancelled

done

future

get_future()

progress_changed

progress_range_changed

progress_text_changed

set_future(the_future)

exception mesycontrol.future.IncompleteFuture

Bases: exceptions.RuntimeError

mesycontrol.future.all_done(*futures)

Returns a future that completes once all of the given futures complete. The returned futures result will be a list of futures in order of completion.

mesycontrol.future.future_progress_dialog(cancelable=True)

mesycontrol.future.progress_forwarder(source, dest)

mesycontrol.future.set_exception_on(result_future)

mesycontrol.future.set_result_on(result_future)

gui Module

class mesycontrol.gui.GUIApplication(context, mainwindow)

Bases: PyQt4.QtCore.QObject

GUI logic

TOOLBAR_FONT_SIZE = 10

TOOLBAR_ICON_SIZE = PyQt4.QtCore.QSize(12, 12)

active_subwindow()

app_registry

device_registry

eventFilter(watched_object, event)

get_linked_mode()

get_mainwindow()

linked_mode

mainwindow

quit()

Non-blocking method to quit the application. Needs a running event loop.

set_linked_mode(linked_mode)

mesycontrol.gui.extensions_to_ptree(extensions, device_profile)

mesycontrol.gui.on_tree_state_changed(emitting_param, changes)

gui_mainwindow Module

class mesycontrol.gui_mainwindow.MCMdiArea(parent=None)

Bases: PyQt4.QtGui.QMdiArea

class mesycontrol.gui_mainwindow.MainWindow(context, parent=None)

Bases: PyQt4.QtGui.QMainWindow

closeEvent(event)

on_actionAbout_Qt_triggered()

on_actionAbout_triggered()

restore_settings()

store_settings()

gui_tutorial Module

class mesycontrol.gui_tutorial.TutorialTextBrowser(parent=None, **kwargs)

Bases: PyQt4.QtGui.QTextBrowser

href_hover

mouseMoveEvent(event)

class mesycontrol.gui_tutorial.TutorialWidget(gui_app, parent=None)

Bases: PyQt4.QtGui.QWidget

class mesycontrol.gui_tutorial.UIFlasher(widget, flashcount=10, interval_ms=500, autostart=False, parent=None)

Bases: PyQt4.QtCore.QObject

set_widget(widget, autostart=True)

start()

stop()

gui_util Module

class mesycontrol.gui_util.DeviceNotesWidget(device, parent=None)

Bases: PyQt4.QtGui.QWidget

ADD_PIXELS_PER_ROW = 5

DISPLAY_ROWS = 3

commit()

get_plain_text()

is_modified()

class mesycontrol.gui_util.DeviceSubWindow(widget, window_name_prefix, parent=None, **kwargs)

Bases: PyQt4.QtGui.QMdiSubWindow

device

display_mode

get_device()

get_display_mode()

get_linked_mode()

get_toolbar()

get_write_mode()

has_combined_display()

has_toolbar()

linked_mode

set_display_mode(mode)

set_linked_mode(linked_mode)

set_write_mode(mode)

update_title_and_name()

Updates the window title and the object name taking into account the display_mode and the device state.

write_mode

class mesycontrol.gui_util.DeviceTableSubWindow(widget, parent=None)

Bases: mesycontrol.gui_util.DeviceSubWindow

get_toolbar()

has_combined_display()

has_toolbar()

class mesycontrol.gui_util.DeviceWidgetSubWindow(widget, parent=None)

Bases: mesycontrol.gui_util.DeviceSubWindow

get_device()

get_specialized_device()

get_toolbar()

has_combined_display()

has_toolbar()

class mesycontrol.gui_util.NotesTextEdit(parent=None)

Bases: PyQt4.QtGui.QPlainTextEdit

mouseDoubleClickEvent(event)

setReadOnly(ro)

class mesycontrol.gui_util.ServerLogView(server_process, max_lines=10000, line_wrap=1, parent=None)

Bases: PyQt4.QtGui.QPlainTextEdit

mesycontrol.gui_util.get_mrc(node)

mesycontrol.gui_util.is_bus(node)

mesycontrol.gui_util.is_config(node)

mesycontrol.gui_util.is_device(node)

mesycontrol.gui_util.is_device_cfg(node)

mesycontrol.gui_util.is_device_hw(node)

mesycontrol.gui_util.is_hardware(node)

mesycontrol.gui_util.is_mrc(node)

mesycontrol.gui_util.is_registry(node)

mesycontrol.gui_util.is_setup(node)

mesycontrol.gui_util.restore_subwindow_state(subwin, settings)

mesycontrol.gui_util.run_add_device_config_dialog(device_registry, registry, mrc, bus=None, address=None, parent_widget=None)

mesycontrol.gui_util.run_add_mrc_config_dialog(registry, parent_widget=None)

mesycontrol.gui_util.run_add_mrc_connection_dialog(registry, parent_widget=None)

mesycontrol.gui_util.run_close_setup(context, parent_widget)

mesycontrol.gui_util.run_edit_device_config(device_registry, registry, device, parent_widget=None)

mesycontrol.gui_util.run_edit_mrc_config(mrc, registry, parent_widget=None)

mesycontrol.gui_util.run_load_device_config(device, context, parent_widget)

mesycontrol.gui_util.run_open_setup_dialog(context, parent_widget)

mesycontrol.gui_util.run_save_device_config(device, context, parent_widget)

mesycontrol.gui_util.run_save_setup(context, parent_widget)

mesycontrol.gui_util.run_save_setup_as_dialog(context, parent_widget)

mesycontrol.gui_util.store_subwindow_state(subwin, settings)

hardware_controller Module

class mesycontrol.hardware_controller.Controller(connection)

Bases: object

Link between hardware_model.MRC and MRCConnection. Reacts to changes to the connection state and updates the hardware model accordingly. Also takes requests from the hardware model and forwards them to the connection.

acquire_write_access(force=False)

add_poll_item(subscriber, bus, address, item)

Add a poll subscription for the given (bus, address, item). Item may be a single parameter address or a tuple of (lower, upper) addresses to poll. The poll item is removed if the given subscriber is destroyed.

add_poll_items(subscriber, items)

connect(timeout_ms=10000)

disconnect()

get_mrc()

mrc

read_parameter(bus, device, address)

Read the parameter at (bus, device address). Returns a basic_model.ResultFuture containing a basic_model.ReadResult instance on success.

release_write_access()

remove_polling_subscriber(subscriber)

scanbus(bus)

set_mrc(mrc)

Set the hardware_model.MRC instance this controller should work with.

set_parameter(bus, device, address, value)

Set the parameter at (bus, device, address) to the given value. Returns a basic_model.ResultFuture containing a basic_model.SetResult instance on success.

set_rc(bus, device, on_off)

set_silenced(silenced)

exception mesycontrol.hardware_controller.ErrorResponse

Bases: exceptions.RuntimeError

exception mesycontrol.hardware_controller.TimeoutError

Bases: exceptions.RuntimeError

hardware_model Module

exception mesycontrol.hardware_model.AddressConflict

Bases: exceptions.RuntimeError

class mesycontrol.hardware_model.Device(bus, address, idc, parent=None)

Bases: mesycontrol.basic_model.Device

add_poll_item(subscriber, item)

Add parameters that should be polled repeatedly. As long as the given subscriber object is alive and the device is connected, the given item will be polled. Item may be a single parameter address or a tuple of (lower, upper) addresses to poll. If the server and mrc support reading parameter ranges and a tuple is given, the read range command will be used.

add_poll_items(subscriber, items)

address_conflict

address_conflict_changed

connected

connecting

connection_error

error object

controller

disconnected

get_controller()

get_last_connection_error()

get_rc()

has_address_conflict()

is_connected()

is_connecting()

is_disconnected()

rc

rc_changed

remove_polling_subscriber(subscriber)

set_address_conflict(conflict)

set_rc(on_off)

Sends a ON/OFF command to the MRC. On successful command execution the local RC flag is updated.

update_rc(rc)

Updates the local RC flag of this device.

class mesycontrol.hardware_model.MRC(url, parent=None)

Bases: mesycontrol.basic_model.MRC

acquire_write_access(force=False)

add_device(device)

address_conflict_changed

can_acquire_write_access()

connect(timeout_ms=10000)

connected

connecting

future object

connection

connection_error

error object

controller

disconnect()

disconnected

get_connection()

get_controller()

get_status()

has_write_access()

is_connected()

is_connecting()

is_disconnected()

is_silenced()

read_parameter(bus, device, address)

release_write_access()

remove_device(device)

scanbus(bus)

set_connected()

set_connecting(the_future)

set_connection_error(error)

set_controller(controller)

Set the hardware controller this MRC should use. The MRC holds a strong reference to the controller.

set_disconnected()

set_parameter(bus, device, address, value)

set_silenced(silenced)

set_status(status)

set_write_access(has_write_access, can_acquire)

Updates the local write access and can_acquire flags. Emits write_access_changed() if one of the two flags changed.

silenced

silenced_changed

is_silenced

status_changed

proto.MRCStatus

update_silenced(silenced)

write_access

write_access_changed

has_write_access, can_acquire

hardware_tree_model Module

class mesycontrol.hardware_tree_model.BusNode(bus_number, parent=None)

Bases: mesycontrol.basic_tree_model.BasicTreeNode

data(column, role)

class mesycontrol.hardware_tree_model.DeviceNode(device, parent=None)

Bases: mesycontrol.hardware_tree_model.HardwareTreeNode

data(column, role)

flags(column)

set_data(column, value, role)

class mesycontrol.hardware_tree_model.HardwareTreeModel(device_registry, parent=None)

Bases: mesycontrol.basic_tree_model.BasicTreeModel

columnCount(parent=<PyQt4.QtCore.QModelIndex object at 0xadf83ac>)

headerData(section, orientation, role=0)

class mesycontrol.hardware_tree_model.HardwareTreeNode(ref, parent)

Bases: mesycontrol.basic_tree_model.BasicTreeNode

class mesycontrol.hardware_tree_model.MRCNode(mrc, parent=None)

Bases: mesycontrol.hardware_tree_model.HardwareTreeNode

data(column, role)

class mesycontrol.hardware_tree_model.RegistryNode(registry, parent=None)

Bases: mesycontrol.hardware_tree_model.HardwareTreeNode

data(column, role)

hardware_util Module

mesycontrol.hardware_util.refresh_device_memory(devices)

Refreshes the memory of the given devices using device.hw.read_parameter(). The set of parameters to (re-)read is the combination of the hardware profile parameters and the parameters already present in the devices memory cache.

log_view Module

class mesycontrol.log_view.LogView(max_lines=10000, line_wrap=1, parent=None)

Bases: PyQt4.QtGui.QTextEdit

append(text, prepend_time=True)

contextMenuEvent(event)

handle_exception(exc_type, exc_value, exc_trace)

handle_log_record(log_record)

mc_treeview Module

class mesycontrol.mc_treeview.AutoPopupComboBox(parent=None)

Bases: PyQt4.QtGui.QComboBox

QComboBox subclass which automatically shows its popup on receiving a non-spontaneous showEvent.

hidePopup()

showEvent(event)

class mesycontrol.mc_treeview.ConfigTreeView(parent=None)

Bases: PyQt4.QtGui.QTreeView

class mesycontrol.mc_treeview.DoubleClickSplitter(orientation=1, parent=None)

Bases: PyQt4.QtGui.QSplitter

QSplitter using DoubleClickSplitterHandles.

createHandle()

class mesycontrol.mc_treeview.DoubleClickSplitterHandle(orientation, parent)

Bases: PyQt4.QtGui.QSplitterHandle

Double click support for QSplitterHandle. Emits the doubleClicked signal if a double click occured on the handle and the mouse button is released within 200ms (if the mouse button is not released the user is most likely dragging the handle).

doubleClicked

mouseDoubleClickEvent(event)

mouseReleaseEvent(event)

sizeHint()

class mesycontrol.mc_treeview.HardwareTreeView(parent=None)

Bases: PyQt4.QtGui.QTreeView

class mesycontrol.mc_treeview.MCTreeDirector(app_registry, device_registry, linked_mode_on=False)

Bases: object

cfg_idx_for_hw_idx(hw_idx)

get_linked_mode()

hw_idx_for_cfg_idx(cfg_idx)

linked_mode

set_linked_mode(on_off)

class mesycontrol.mc_treeview.MCTreeItemDelegate(tree_director, parent=None)

Bases: PyQt4.QtGui.QStyledItemDelegate

createEditor(parent, options, idx)

paint(painter, option, index)

setEditorData(editor, idx)

setModelData(editor, model, idx)

class mesycontrol.mc_treeview.MCTreeView(app_registry, device_registry, linked_mode_on=False, parent=None)

Bases: PyQt4.QtGui.QWidget

cfg_context_menu_requested

node, idx, position, view

cfg_idx_for_hw_idx(hw_idx)

get_linked_mode()

hw_context_menu_requested

node, idx, position, view

hw_idx_for_cfg_idx(cfg_idx)

linked_mode

linked_mode_changed

node_activated

node_selected

select_config_node(node)

select_config_node_by_ref(ref)

select_hardware_node(node)

select_hardware_node_by_ref(ref)

select_node(node)

set_linked_mode(on_off)

mesycontrol.mc_treeview.find_insertion_index(items, test_fun)

mesycontrol_pb2 Module

model_util Module

mesycontrol.model_util.add_mrc_connection(hardware_registry, url, do_connect, connect_timeout_ms=10000)

Adds an MRC connection using the given url to the hardware_registry. If `do_connect’ is True this function will start a connection attempt and return the corresponding Future object. Otherwise the newly added MRC will be in disconnected state and None is returned.

mesycontrol.model_util.set_default_device_extensions(device, device_registry)

mrc_connection Module

class mesycontrol.mrc_connection.AbstractConnection(parent=None)

Bases: PyQt4.QtCore.QObject

connect()

connected

connected and ready to send requests

connecting

Establishing the connection. The argument is a

connection_error

error object

disconnect()

disconnected

disconnected; not ready to handle requests

error_message_received

Message

get_queue_size()

get_url()

is_connected()

is_connecting()

is_disconnected()

message_received

Message

notification_received

Message

queue_empty

queue_request(request)

queue_size_changed

request_queued

request, Future

request_sent

request, Future

response_received

request, response, Future

url

exception mesycontrol.mrc_connection.IsConnected

Bases: exceptions.Exception

exception mesycontrol.mrc_connection.IsConnecting

Bases: exceptions.Exception

class mesycontrol.mrc_connection.LocalMRCConnection(server_options={}, parent=None)

Bases: mesycontrol.mrc_connection.AbstractConnection

connect()

connect_delay_ms = 1000

delay between server startup and connection attempt

disconnect()

get_queue_size()

get_url()

is_connected()

is_connecting()

queue_request(request)

class mesycontrol.mrc_connection.MRCConnection(host, port, parent=None)

Bases: mesycontrol.mrc_connection.AbstractConnection

connect()

disconnect()

get_queue_size()

get_url()

is_connected()

is_connecting()

queue_request(request)

mesycontrol.mrc_connection.factory(**kwargs)

Connection factory. Supported keyword arguments in order of priority:

• config: MRCConnectionConfig instance specifying the details of the connection.
• url: A string that is passed to util.parse_connection_url(). The resulting dictionary will then be used to create the connection.
• mc_host, mc_port: Creates a MRCConnection to the given host and port.
• serial_port, baud_rate: Creates a LocalMRCConnection using the given serial port and baud rate.
• host, port: Creates a LocalMRCConnection connecting to the MRC on the given host and port.

Additionally ‘parent’ may specify a parent QObject for the resulting connection.

parameter_binding Module

class mesycontrol.parameter_binding.AbstractParameterBinding(device, profile, target, display_mode, write_mode=None, fixed_modes=False, **kwargs)

Bases: object

add_update_callback(method_or_func, *args, **kwargs)

Adds a callback to be invoked when this binding updates its target.

The callback will be called with the result_future that caused the update as its first argument and the optional args and kwargs as the following arguments.

If the given method_or_func is a bound method a weak reference to the corresponding object will be stored. This way the parameter binding won’t keep any objects alive just because they’re registered as a callback.

http://stackoverflow.com/questions/1673483/how-to-store-callback-methods

address

device

display_mode

get_address()

get_device()

get_display_mode()

get_read_address()

get_read_profile()

get_write_address()

get_write_mode()

get_write_profile()

has_rw_profile()

populate()

Gets the value of this bindings parameter and updates the target display once the value is retrieved.

read_address

read_profile

set_display_mode(mode)

set_write_mode(mode)

write_address

write_mode

write_profile

class mesycontrol.parameter_binding.CheckBoxParameterBinding(**kwargs)

Bases: mesycontrol.parameter_binding.DefaultParameterBinding

class mesycontrol.parameter_binding.ComboBoxParameterBinding(**kwargs)

Bases: mesycontrol.parameter_binding.DefaultParameterBinding

class mesycontrol.parameter_binding.DefaultParameterBinding(**kwargs)

Bases: mesycontrol.parameter_binding.AbstractParameterBinding

class mesycontrol.parameter_binding.DoubleSpinBoxParameterBinding(unit_name, **kwargs)

Bases: mesycontrol.parameter_binding.DefaultParameterBinding

class mesycontrol.parameter_binding.Factory

Bases: object

append_classinfo_binding(target_classinfo, binding_class)

append_predicate_binding(predicate, binding_class)

get_binding_class(target_object)

insert_classinfo_binding(idx, target_classinfo, binding_class)

insert_predicate_binding(idx, predicate, binding_class)

make_binding(**kwargs)

class mesycontrol.parameter_binding.LCDNumberParameterBinding(unit_name=None, precision=2, **kwargs)

Bases: mesycontrol.parameter_binding.DefaultParameterBinding

class mesycontrol.parameter_binding.LabelParameterBinding(unit_name, prec=2, **kwargs)

Bases: mesycontrol.parameter_binding.DefaultParameterBinding

exception mesycontrol.parameter_binding.ParameterUnavailable(*args, **kwargs)

Bases: exceptions.Exception

class mesycontrol.parameter_binding.RadioButtonGroupParameterBinding(**kwargs)

Bases: mesycontrol.parameter_binding.DefaultParameterBinding

static predicate(target)

class mesycontrol.parameter_binding.ReadWriteProfile

Bases: mesycontrol.parameter_binding.ReadWriteProfile

get_range()

get_unit(unit_name)

get_units()

range

units

class mesycontrol.parameter_binding.SliderParameterBinding(unit_name=None, update_on='value_changed', **kwargs)

Bases: mesycontrol.parameter_binding.DefaultParameterBinding

class mesycontrol.parameter_binding.SpinBoxEditingObserver(the_binding, parent=None)

Bases: PyQt4.QtCore.QObject

eventFilter(obj, event)

class mesycontrol.parameter_binding.SpinBoxParameterBinding(**kwargs)

Bases: mesycontrol.parameter_binding.DefaultParameterBinding

class mesycontrol.parameter_binding.TargetlessParameterBinding(**kwargs)

Bases: mesycontrol.parameter_binding.AbstractParameterBinding

Usefull if there’s no target widget but the add_update_callback() functionality is needed.

set_display_mode(mode)

set_write_mode(mode)

proto Module

exception mesycontrol.proto.MessageError(message=None, request=None, text='', *args)

Bases: exceptions.RuntimeError

mesycontrol.proto.is_error_response(msg)

mesycontrol.proto.is_notification(msg)

mesycontrol.proto.is_request(msg)

mesycontrol.proto.is_response(msg)

qt Module

resources Module

mesycontrol.resources.qCleanupResources()

mesycontrol.resources.qInitResources()

server_process Module

mesycontrol.server_process.BASE_PORT = 23000

The default port to listen on

mesycontrol.server_process.MAX_PORT = 65535

The maximum port number.

exception mesycontrol.server_process.ServerError

Bases: exceptions.Exception

exception mesycontrol.server_process.ServerIsRunning

Bases: mesycontrol.server_process.ServerError

exception mesycontrol.server_process.ServerIsStarting

Bases: mesycontrol.server_process.ServerError

exception mesycontrol.server_process.ServerIsStopped

Bases: mesycontrol.server_process.ServerError

exception mesycontrol.server_process.ServerIsStopping

Bases: mesycontrol.server_process.ServerError

class mesycontrol.server_process.ServerProcess(binary='mesycontrol_server', listen_address='127.0.0.1', listen_port=23000, serial_port=None, baud_rate=0, tcp_host=None, tcp_port=4001, verbosity=0, output_buffer_maxlen=10000, parent=None)

Bases: PyQt4.QtCore.QObject

error

exit_code()

static exit_code_string(code)

exit_codes = {0: 'exit_success', 1: 'exit_options_error', 2: 'exit_address_in_use', 3: 'exit_address_not_available', 4: 'exit_permission_denied', 5: 'exit_bad_listen_address', 127: 'exit_unknown_error'}

finished

exit_status, exit_code, exit_code_string

is_running()

is_starting()

kill()

output

start()

started

startup_delay_ms = 200

stop(kill=False)

stopped

class mesycontrol.server_process.ServerProcessPool(parent=None)

Bases: PyQt4.QtCore.QObject

Keeps track of running ServerProcesses and the listen ports they use.

create_process(options={}, parent=None)

mesycontrol.server_process.get_exit_code_string(exit_code)

specialized_device Module

class mesycontrol.specialized_device.DeviceBase(app_device, read_mode, write_mode, parent=None)

Bases: PyQt4.QtCore.QObject

Acts as a decorator for an app_model.Device. Should be subclassed to create device specific classes, e.g. class MHV4(DeviceBase).

cfg_idc_changed

cfg_module_changed

cfg_profile_changed

config_applied_changed

config_set

self, old, new

extension_changed

get_cfg_parameter(address_or_name)

get_display_string()

get_extension(name)

get_extensions()

get_hw_parameter(address_or_name)

get_module()

get_parameter(address_or_name)

get_profile()

get_read_mode()

get_write_mode()

hardware_set

self, old, new

hw_idc_changed

hw_module_changed

hw_profile_changed

idc_changed

idc_conflict

idc_conflict_changed

module

module_changed

mrc_changed

parameter_changed

profile

profile_changed

read_cfg_parameter(address_or_name)

read_hw_parameter(address_or_name)

read_mode

read_mode_changed

set_cfg_parameter(address_or_name, value)

set_extension(name, value)

set_hw_parameter(address_or_name, value)

set_parameter(address_or_name, value)

set_read_mode(mode)

set_write_mode(mode)

write_mode

write_mode_changed

class mesycontrol.specialized_device.DeviceWidgetBase(specialized_device, display_mode, write_mode, parent=None)

Bases: PyQt4.QtGui.QWidget

Base class for device specific widgets.

clear_parameter_bindings()

closeEvent(event)

display_mode

display_mode_changed

event(e)

get_display_mode()

get_parameter_bindings()

get_toolbar()

get_write_mode()

hardware_connected_changed

has_toolbar()

notes_visible()

set_display_mode(display_mode)

set_notes_visible(visible)

set_write_mode(write_mode)

showEvent(event)

write_mode

write_mode_changed

tcp_client Module

class mesycontrol.tcp_client.MCTCPClient(parent=None)

Bases: PyQt4.QtCore.QObject

Mesycontrol TCP client

connect(host, port)

Connect to the given host and port. Returns a Future that fullfills once the connection has been established or an errors occurs. Disconnects if the client currently is connected.

connected

connecting

disconnect()

Disconnect. Returns a Future that fullfills once the connection has been disconnected or an error occurs.

disconnected

error_received

Message

get_host()

get_port()

get_queue_size()

host

is_busy()

is_connected()

True if connected, False otherwise.

is_connecting()

is_disconnected()

is_idle()

message_received

Message

notification_received

Message

port

queue_empty

queue_request(request)

Adds the given request to the outgoing queue. Returns a Future that fullfills once a response is received or an error occurs.

queue_size_changed

request_queued

request, Future

request_sent

request, Future

response_received

request, response, Future

socket_error

instance of SocketError

class mesycontrol.tcp_client.RequestResult

Bases: tuple

RequestResult(request, response)

request

Alias for field number 0

response

Alias for field number 1

util Module

class mesycontrol.util.AnyValue

Bases: object

class mesycontrol.util.CallbackHandler

Bases: logging.Handler

Logging handler passing log_records to callbacks.

add_callback(callback)

emit(log_record)

get_callbacks()

remove_callback(callback)

class mesycontrol.util.ChannelGroupHelper(num_channels, num_groups)

Bases: object

channel_to_group(channel_num)

channels_per_group()

group_channel_range(group_num)

class mesycontrol.util.DelayedDoubleSpinBox(parent=None, delay=0.5)

Bases: PyQt4.QtGui.QDoubleSpinBox

blockSignals(b)

delayed_valueChanged

setValue(value)

class mesycontrol.util.DelayedSpinBox(delay=0.5, parent=None)

Bases: PyQt4.QtGui.QSpinBox

delayed_valueChanged

exception mesycontrol.util.Disconnected

Bases: exceptions.Exception

class mesycontrol.util.ExceptionHookRegistry

Bases: object

Exception handler registry for use with sys.excepthook. Contains a list of handler objects which will get called in the order they where registered when an exception occurs.

get_handlers()

register_handler(handler)

unregister_handler(handler)

class mesycontrol.util.FixedWidthVerticalToolBar(parent=None)

Bases: PyQt4.QtGui.QWidget

Like a vertical QToolBar but having a fixed width. I did not manage to get a QToolBar to have a fixed width. That’s the only reason this class exists.

addAction(action)

class mesycontrol.util.GarbageCollector(parent=None, debug=False)

Bases: PyQt4.QtCore.QObject

Disable automatic garbage collection and instead collect manually every INTERVAL milliseconds.

This is done to ensure that garbage collection only happens in the GUI thread, as otherwise Qt can crash.

INTERVAL = 1000

check()

debug_cycles()

class mesycontrol.util.HasExceptionFilter

Bases: object

filter(log_record)

class mesycontrol.util.MinimumLevelFilter(minimum_level)

Bases: object

Log records with a level greater or equal to minimum_level will pass through this filter.

filter(log_record)

class mesycontrol.util.OrderedSet(iterable=None)

Bases: _abcoll.MutableSet

add(key)

discard(key)

pop(last=True)

class mesycontrol.util.QtLoggingBridge(parent=None)

Bases: PyQt4.QtCore.QObject

log_record

class mesycontrol.util.ReadOnlyCheckBox(*args, **kwargs)

Bases: PyQt4.QtGui.QCheckBox

mousePressEvent(event)

mouseReleaseEvent(event)

class mesycontrol.util.SimpleToolBar(orientation=1, parent=None)

Bases: PyQt4.QtGui.QWidget

addAction(action)

addWidget(widget)

exception mesycontrol.util.SocketError(error_code, error_string)

Bases: exceptions.Exception

exception mesycontrol.util.URLParseError

Bases: exceptions.Exception

mesycontrol.util.block_signals(*args, **kwds)

mesycontrol.util.build_connection_url(serial_port=None, baud_rate=0, host=None, port=4001, mc_host=None, mc_port=23000)

mesycontrol.util.display_url(url)

mesycontrol.util.hline(parent=None)

mesycontrol.util.list_serial_ports(type_mask=3)

mesycontrol.util.list_serial_ports_linux(type_mask)

mesycontrol.util.list_serial_ports_windows(type_mask)

Uses the Win32 registry to return an iterator of serial (COM) ports existing on this computer. Source: http://eli.thegreenplace.net/2009/07/31/listing-all-serial-ports-on-windows-with-python/

mesycontrol.util.loadUi(filename, baseinstance=None)

This version of PyQts uic.loadUi() adds support for loading from resource files.

mesycontrol.util.make_apply_common_button_layout(input_spinbox, tooltip, on_clicked)

mesycontrol.util.make_icon(source)

mesycontrol.util.make_logging_source_adapter(module_name, object_instance)

mesycontrol.util.make_spinbox(min_value=None, max_value=None, value=None, limits=None, prefix=None, suffix=None, single_step=None, parent=None)

mesycontrol.util.make_standard_icon(icon, option=None, widget=None)

mesycontrol.util.make_title_label(title)

mesycontrol.util.mrc_urls_match(url1, url2)

mesycontrol.util.parse_connection_url(url)

Parses the given connection URL. Returns a dictionary ready to be passed to mrc_connection.factory() to create a connection instance. Supported URL formats: - For serial connections:

<serial_port>@<baud> serial://<serial_port>[@<baud=9600>]

• For TCP connections (serial server connected to an MRC1):

  <host>:<port> tcp://<host>[:<port=4001>]

• For connections to a mesycontrol server:

  mc://<host>[:<port=23000>]

mesycontrol.util.vline(parent=None)

mesycontrol.util.wait_for_signal(signal, expected_args=None, timeout_ms=0, emitting_callable=None)

Uses a local Qt event loop to wait for the given signal to arrive.

expected_args specifies which arguments are expected once the signal is emitted. If expected_args is None any arguments are valid. To specify a placeholder argument use the AnyValue class above (put the class directly into the argument sequence, don’t instantiate it).

timeout_ms gives the maximum time in milliseconds to wait for the signal. If 0 this function will wait forever.

emitting_callable can be used to pass a callable object to the function. This callable will be invoked from within the internal event loop. This is neccessary to avoid missing signals connected via Qt’s direct connection mechanism (the signal would arrive before the event loop was started and thus it would be missed completely).

The return value is True if the signal arrived within the given timeout and with the correct arguments. Otherwise False is returned.

mesycontrol.util.which(program)

Subpackages

• devices Package
  • devices Package
  • mcfd16 Module
  • mcfd16_profile Module
  • mhv4 Module
  • mhv4_profile Module
  • mhv4_v20 Module
  • mhv4_v20_profile Module
  • mpd4 Module
  • mpd4_profile Module
  • mpd8 Module
  • mpd8_profile Module
  • mprb16 Module
  • mprb16_profile Module
  • mprb16dr Module
  • mprb16dr_profile Module
  • mscf16 Module
  • mscf16_profile Module
  • mux16 Module
  • mux16_profile Module
  • stm16 Module
  • stm16_profile Module