Chipmunk CLI Tool Open Tasks

[AmmarAbouZor]

Overview

Feature	dlt-receiver	chipmunk-cli
Connections
Connecting via TCP	Yes	Yes
Connecting via UDP	Yes	Yes
Connecting via Serial	Yes	?
Connection Features
Reconnection	No	Yes
Displaying Data (stdout)
Parsed Headers	Yes	No
Parsed Payload	No	Yes
Payload as HEX	Yes	No
Payload as ASCII	Yes	No
Showing Only Headers	Yes	No
Splitting DLT Content and Logs (1)	No	No
Storing Data into File
Saving into DLT	Yes	Yes
Chunking File (by Size) (2)	Yes	No
Customizing ECU ID for Storage Header (3)	Yes	No
Saving as a text	no	yes
Serial Port Specifications
Full Range of Options	No	Yes
UDP Specifications
Multiple Broadcast IPs	No	Yes
Customizable IP	No	Yes
TCP Specifications
Customizable IP	No	Yes
Filters
Filtering by Header Fields	Yes	No
Filtering by Matches in Content	No	No
Passing Filters as CLI Argument	No	No
Passing Filters as Path to a Filter File	Yes	No
Not implemented Features
Save settings into a file to reuse
Get preset of settings from a file

Notes

1. Splitting DLT Content and Logs:
   When printing DLT messages to stdout, log messages may also be printed. It would be useful to have a feature that always prints DLT messages to stdout while saving logs separately into a file.

2. Chunking File (by Size):
   In dlt-receiver, users can define the maximum size of an output file. When the maximum size is reached, a new file is automatically created.

3. Customizing ECU ID for Storage Header:
   DLT messages from a source (stream) come without a Storage Header, which is required to save the message into a file. The ECU ID is a field in the Storage Header.

Integration plan

Here is a list of the open tasks that still need to be done on Chipmunk CLI tool:

• Improve app UI to provide app status alongside with printing the log to stdout. One suggestion is to have a similar approach for package managers tools like pacman and compiler like cargo, by having the state updated on the last line while printing the logs (with table?) above.
• Format DLT messages with fixed columns lengths for the know columns.
• Provide configuration files as additional way to configure the tool besides cli arguments.
• Dlt attachments are ignored for now.
• Filtering is missing as well.
• Snapshot testing.
• Include in the releases.
• Move the deprecated indexer-cli from indexer manifest.
• Provide simple TUI enabling users from selecting and configuring the parser and source without having to pass them as CLI arguments. This should be an alternative way for the cli arguments and shouldn't replace it.