sascha/devlib
1
0
Fork 0
mirror of https://github.com/ARM-software/devlib.git synced 2025-01-31 10:10:46 +00:00
Code Issues Releases Wiki Activity

Merge pull request #171 from bjackman/instrument-fix-reset

Browse Source 
instrument: Clear up Instrument.reset semantics
This commit is contained in:
setrofim 2017-09-15 13:34:09 +01:00 committed by GitHub
commit 25ad53feff
2 changed files with 29 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
devlib/instrument/__init__.py
View File

@ -258,20 +258,25 @@ class Instrument(object):
pass pass
def reset(self, sites=None, kinds=None, channels=None): def reset(self, sites=None, kinds=None, channels=None):
self.active_channels = []
if kinds is None and sites is None and channels is None: if kinds is None and sites is None and channels is None:
self.active_channels = sorted(self.channels.values(), key=lambda x: x.label) self.active_channels = sorted(self.channels.values(), key=lambda x: x.label)
else: elif channels is not None:
if isinstance(sites, basestring): if sites is not None or kinds is not None:
sites = [sites] raise ValueError(
if isinstance(kinds, basestring): 'sites and kinds should not be set if channels is set')
kinds = [kinds] for chan_name in channels:
self.active_channels = []
for chan_name in (channels or []):
try: try:
self.active_channels.append(self.channels[chan_name]) self.active_channels.append(self.channels[chan_name])
except KeyError: except KeyError:
msg = 'Unexpected channel "{}"; must be in {}' msg = 'Unexpected channel "{}"; must be in {}'
raise ValueError(msg.format(chan_name, self.channels.keys())) raise ValueError(msg.format(chan_name, self.channels.keys()))
else:
if isinstance(sites, basestring):
sites = [sites]
if isinstance(kinds, basestring):
kinds = [kinds]
else:
for chan in self.channels.values(): for chan in self.channels.values():
if (kinds is None or chan.kind in kinds) and \ if (kinds is None or chan.kind in kinds) and \
(sites is None or chan.site in sites): (sites is None or chan.site in sites):

19
doc/instrumentation.rst
View File

@ -99,14 +99,21 @@ Instrument
``teardown()`` has been called), but see documentation for the instrument ``teardown()`` has been called), but see documentation for the instrument
you're interested in. you're interested in.
.. method:: Instrument.reset([sites, [kinds]]) .. method:: Instrument.reset(sites=None, kinds=None, channels=None)
This is used to configure an instrument for collection. This must be invoked This is used to configure an instrument for collection. This must be invoked
before ``start()`` is called to begin collection. ``sites`` and ``kinds`` before ``start()`` is called to begin collection. This methods sets the
parameters may be used to specify which channels measurements should be ``active_channels`` attribute of the ``Instrument``.
collected from (if omitted, then measurements will be collected for all
available sites/kinds). This methods sets the ``active_channels`` attribute If ``channels`` is provided, it is a list of names of channels to enable and
of the ``Instrument``. ``sites`` and ``kinds`` must both be ``None``.
Otherwise, if one of ``sites`` or ``kinds`` is provided, all channels
matching the given sites or kinds are enabled. If both are provided then all
channels of the given kinds at the given sites are enabled.
If none of ``sites``, ``kinds`` or ``channels`` are provided then all
available channels are enabled.
.. method:: Instrument.take_measurment() .. method:: Instrument.take_measurment()