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

doc/instrumentation: Fix whitespace

Browse Source
This commit is contained in:
Brendan Jackman 2017-04-26 15:07:33 +01:00
parent 49b547a7f6
commit fc81477cf8
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/instrumentation.rst
View File

@ -28,7 +28,7 @@ Android target.
# a no-op, but is included here for completeness. # a no-op, but is included here for completeness.
In [4]: i.setup() In [4]: i.setup()
# Find out what the instrument is capable collecting from the # Find out what the instrument is capable collecting from the
# target. # target.
In [5]: i.list_channels() In [5]: i.list_channels()
Out[5]: Out[5]:
@ -40,7 +40,7 @@ Android target.
In [6]: i.reset(sites=['exynos-therm']) In [6]: i.reset(sites=['exynos-therm'])
# HWMON instrument supports INSTANTANEOUS collection, so invoking # HWMON instrument supports INSTANTANEOUS collection, so invoking
# take_measurement() will return a list of measurements take from # take_measurement() will return a list of measurements take from
# each of the channels configured during reset() # each of the channels configured during reset()
In [7]: i.take_measurement() In [7]: i.take_measurement()
Out[7]: [exynos-therm_temperature: 36.0 degrees] Out[7]: [exynos-therm_temperature: 36.0 degrees]
@ -68,7 +68,7 @@ Instrument
period of time via ``start()``, ``stop()``, and period of time via ``start()``, ``stop()``, and
``get_data()`` methods. ``get_data()`` methods.
.. note:: It's possible for one instrument to support more than a single .. note:: It's possible for one instrument to support more than a single
mode. mode.
.. attribute:: Instrument.active_channels .. attribute:: Instrument.active_channels
@ -133,9 +133,9 @@ Instrument
.. method:: Instrument.get_data(outfile) .. method:: Instrument.get_data(outfile)
Write collected data into ``outfile``. Must be called after :func:`stop()`. Write collected data into ``outfile``. Must be called after :func:`stop()`.
Data will be written in CSV format with a column for each channel and a row Data will be written in CSV format with a column for each channel and a row
for each sample. Column heading will be channel, labels in the form for each sample. Column heading will be channel, labels in the form
``<site>_<kind>`` (see :class:`InstrumentChannel`). The order of the coluns ``<site>_<kind>`` (see :class:`InstrumentChannel`). The order of the coluns
will be the same as the order of channels in ``Instrument.active_channels``. will be the same as the order of channels in ``Instrument.active_channels``.