mirror of
https://github.com/ARM-software/devlib.git
synced 2025-01-31 02:00:45 +00:00
Instrumentation/Instrumentation: Update timestamp
documentation
This commit is contained in:
parent
eeb5e93e6f
commit
c62905cfdc
@ -139,6 +139,14 @@ Instrument
|
|||||||
``<site>_<kind>`` (see :class:`InstrumentChannel`). The order of the columns
|
``<site>_<kind>`` (see :class:`InstrumentChannel`). The order of the columns
|
||||||
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``.
|
||||||
|
|
||||||
|
If reporting timestamps, one channel must have a ``site`` named ``"timestamp"``
|
||||||
|
and a ``kind`` of a :class:`MeasurmentType` of an appropriate time unit which will
|
||||||
|
be used, if appropriate, during any post processing.
|
||||||
|
|
||||||
|
.. note:: Currently supported time units are seconds, milliseconds and
|
||||||
|
microseconds, other units can also be used if an appropriate
|
||||||
|
conversion is provided.
|
||||||
|
|
||||||
This returns a :class:`MeasurementCsv` instance associated with the outfile
|
This returns a :class:`MeasurementCsv` instance associated with the outfile
|
||||||
that can be used to stream :class:`Measurement`\ s lists (similar to what is
|
that can be used to stream :class:`Measurement`\ s lists (similar to what is
|
||||||
returned by ``take_measurement()``.
|
returned by ``take_measurement()``.
|
||||||
@ -211,27 +219,31 @@ be reported as "power" in Watts, and never as "pwr" in milliWatts. Currently
|
|||||||
defined measurement types are
|
defined measurement types are
|
||||||
|
|
||||||
|
|
||||||
+-------------+---------+---------------+
|
+-------------+-------------+---------------+
|
||||||
| name | units | category |
|
| name | units | category |
|
||||||
+=============+=========+===============+
|
+=============+=============+===============+
|
||||||
| time | seconds | |
|
| time | seconds | |
|
||||||
+-------------+---------+---------------+
|
+-------------+-------------+---------------+
|
||||||
|
| time | microseconds| |
|
||||||
|
+-------------+-------------+---------------+
|
||||||
|
| time | milliseconds| |
|
||||||
|
+-------------+-------------+---------------+
|
||||||
| temperature | degrees | |
|
| temperature | degrees | |
|
||||||
+-------------+---------+---------------+
|
+-------------+-------------+---------------+
|
||||||
| power | watts | power/energy |
|
| power | watts | power/energy |
|
||||||
+-------------+---------+---------------+
|
+-------------+-------------+---------------+
|
||||||
| voltage | volts | power/energy |
|
| voltage | volts | power/energy |
|
||||||
+-------------+---------+---------------+
|
+-------------+-------------+---------------+
|
||||||
| current | amps | power/energy |
|
| current | amps | power/energy |
|
||||||
+-------------+---------+---------------+
|
+-------------+-------------+---------------+
|
||||||
| energy | joules | power/energy |
|
| energy | joules | power/energy |
|
||||||
+-------------+---------+---------------+
|
+-------------+-------------+---------------+
|
||||||
| tx | bytes | data transfer |
|
| tx | bytes | data transfer |
|
||||||
+-------------+---------+---------------+
|
+-------------+-------------+---------------+
|
||||||
| rx | bytes | data transfer |
|
| rx | bytes | data transfer |
|
||||||
+-------------+---------+---------------+
|
+-------------+-------------+---------------+
|
||||||
| tx/rx | bytes | data transfer |
|
| tx/rx | bytes | data transfer |
|
||||||
+-------------+---------+---------------+
|
+-------------+-------------+---------------+
|
||||||
|
|
||||||
|
|
||||||
.. instruments:
|
.. instruments:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user