Skip to content

Commit fc01600

Browse files
authored
add documentation for .asc-reader and .log-format
Add some documentation for ,asc-Reader and .log-format
1 parent 004c512 commit fc01600

1 file changed

Lines changed: 26 additions & 3 deletions

File tree

doc/listeners.rst

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,9 @@ SqliteWriter
5858
:members:
5959

6060

61-
ASCWriter
61+
ASC (.asc Logging format)
6262
---------
63-
64-
Logs CAN data to an ASCII log file compatible with other CAN tools such as
63+
ASCWriter logs CAN data to an ASCII log file compatible with other CAN tools such as
6564
Vector CANalyzer/CANoe and other.
6665
Since no official specification exists for the format, it has been reverse-
6766
engineered from existing log files. One description of the format can be found `here
@@ -70,6 +69,30 @@ engineered from existing log files. One description of the format can be found `
7069
.. autoclass:: can.ASCWriter
7170
:members:
7271

72+
ASCReader reads CAN data from ASCII log files .asc
73+
as further references can-utils can be used:
74+
`asc2log <https://github.com/linux-can/can-utils/blob/master/asc2log.c>`_,
75+
`log2asc <https://github.com/linux-can/can-utils/blob/master/log2asc.c>`_.
76+
77+
.. autoclass:: can.ASCReader
78+
:members:
79+
80+
Log (.log can-utils Logging format)
81+
---------
82+
canutilsLogWriter logs CAN data to an ASCII log file compatible with `can-utils <https://github.com/linux-can/can-utils>`
83+
As specification following references can-utils can be used:
84+
`asc2log <https://github.com/linux-can/can-utils/blob/master/asc2log.c>`_,
85+
`log2asc <https://github.com/linux-can/can-utils/blob/master/log2asc.c>`_.
86+
87+
88+
.. autoclass:: can.canutilsLogWriter
89+
:members:
90+
91+
canutilsLogReader reads CAN data from ASCII log files .log
92+
93+
.. autoclass:: can.canutilsLogReader
94+
:members:
95+
7396

7497
BLF (Binary Logging Format)
7598
---------------------------

0 commit comments

Comments
 (0)