Skip to content

Commit c3ae285

Browse files
author
Avi SZYCHTER
committed
Improved README for can-parse
1 parent d5cfc4d commit c3ae285

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,32 @@ C++ CAN Parser currently is compiled as a static library.
1212

1313
## can-parse
1414

15-
`can-parse` is a utility program that allows you to parse the content of a CAN database which is then output to the standard output. You can use it to see if the file content is valid or explore the content of the database.
16-
15+
`can-parse` is a utility program that allows you to parse the content of a CAN database which is then output to the standard output.
16+
17+
Different uses of `can-parse` are possible, mainly 4 operations are included in `can-parse`:
18+
* Print a summary of the whole database
19+
* Print a detailed view of a single entry of the database (very basic implementation for now)
20+
* CAN ID, DLC, Period, Comment
21+
* Signals' description
22+
* Name
23+
* Start bit
24+
* Length
25+
* Endianness
26+
* Signedness
27+
* Check the integrity of the whole database (a summary is given) (very basic implementation for now)
28+
* Check the integrity of a single frame (a detailed report is given) (very basic implementation for now)
29+
30+
The Command_Line Interface is very easy to use !
31+
32+
```bash
33+
Usage: ./can-parse [ACTION [ARGUMENTS]] <path/to/file>
34+
When no action is specified, defaults to printframe
35+
Possible actions:
36+
printframe [CAN ID] Print the content of the CAN database
37+
if CAN ID is specified, prints the details of the given frame
38+
checkframe [CAN ID] Check different properties of the CAN database
39+
if CAN ID is specified, print the check details of the given frame
40+
-h / --help Print the present help message
41+
```
1742
## Supported standards:
1843
* DBC (in progress)

0 commit comments

Comments
 (0)