Skip to content

Commit 08a3f3f

Browse files
committed
Improved documentation a bit
1 parent e0877ea commit 08a3f3f

File tree

4 files changed

+14
-6
lines changed

4 files changed

+14
-6
lines changed

cuckoo_time_translator/package.xml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22
<package format="2">
33
<name>cuckoo_time_translator</name>
44
<version>0.0.0</version>
5-
<description>cuckoo_time_translator</description>
5+
<description>This library intends to do most of the dirty work required within a device driver that emoploys one way device time translation.
6+
This includes:
7+
* handling the one way translator
8+
* sending special timing messages (DeviceTimestamp) for debugging and evaluation (e.g. with ctt_introspect in the cuckoo_time_translator_python package)
9+
* provide dynamic confiugration for the one way translation algorithm
10+
</description>
611

712
<author email="hannes.sommer@mavt.ethz.ch">Hannes Sommer</author>
813
<maintainer email="hannes.sommer@mavt.ethz.ch">Hannes Sommer</maintainer>

cuckoo_time_translator_algorithms/package.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<name>cuckoo_time_translator_algorithms</name>
44
<version>0.0.1</version>
55
<description>
6-
Algorithms for translating times emitted by other (cheap) clocks into local system time.
6+
Algorithms for translating times emitted by remote (cheap) clocks into local system time.
77
The dominant application is translating hardware timestamps of a sensor into the system time of a receiving computer system.
88
</description>
99

cuckoo_time_translator_python/package.xml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
<?xml version="1.0"?>
22
<package format="2">
33
<name>cuckoo_time_translator_python</name>
4-
<version>0.0.0</version>
5-
<description>cuckoo_time_translator_python</description>
4+
<version>0.0.1</version>
5+
<description>Export of some of the cuckoo_time_translator_algorithms functionality to python.
6+
In particular the one way translators.
7+
Additionally, there is the ctt_introspect.py scipt, that can help debugging and evaluating one way translators running in a hardware driver using cuckoo_time_translator.
8+
</description>
69

710
<author email="hannes.sommer@mavt.ethz.ch">Hannes Sommer</author>
811
<maintainer email="hannes.sommer@mavt.ethz.ch">Hannes Sommer</maintainer>

cuckoo_time_translator_python/scripts/ctt_introspect.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919
parser.add_argument('bag', nargs=1, help='The path to the bag file containing the DeviceTimestamp messages')
2020
parser.add_argument('-t,--topic', dest='topic', nargs='+', help='The path to the bag file containing the DeviceTimestamp messages')
2121
parser.add_argument('-v,--verbose', dest='verbose', action='count', help='Increase verbosity (counted)')
22-
parser.add_argument('-o,--output', dest='output', help='Output file to plot to (PDF)')
22+
parser.add_argument('-o,--output', dest='output', help='Output file to plot to (PDF format)')
2323
parser.add_argument('-b,--baseLine', dest='baseLine', default="LeastSquares", help='Use this batch-method as base line; LeastSquare, ConvexHull, Index')
24-
parser.add_argument('-f,--owts', dest='owts', default=OwtsDefault, help='Additional owts to compare with. Default: ' + OwtsDefault)
24+
parser.add_argument('-f,--owts', dest='owts', default=OwtsDefault, help='Additional OWTs (one way translators) to compare with. Default: ' + OwtsDefault)
2525
parser.add_argument('--dontPlotReceiveTimes', action='store_true', help='don\'t plot receive timestamps')
2626
parser.add_argument('--dontPlotPreTranslated', action='store_true', help='don\'t plot pre-translated timestamps, i.e., translated in the device driver')
2727
parser.add_argument('--invalidate', action='store_true', help='invalidate any possibly existing cache')

0 commit comments

Comments
 (0)