Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sawmill: A CLI tool for exporting and trimming WPILib DataLogs #7656

Draft
wants to merge 31 commits into
base: main
Choose a base branch
from

Conversation

DeltaDizzy
Copy link
Contributor

@DeltaDizzy DeltaDizzy commented Jan 8, 2025

Motivation

While the existing DataLogTool can load multiple DataLogs from local and remote locations and export them as CSVs, that code is heavily tied to the GUI and so substantial code duplication would be inevitable.

Features

  • Convert a DataLog to CSV or JSON with the ability to include Control records if desired
  • Selectively export a single entry in either format
  • Trim DataLogs based on either a start and end time or a start time and a duration

Usage

Converting a DataLog to a non-binary format

sawmill export json LOGFILE EXPORT-FILE [--mode <export-mode>]
sawmill export csv LOGFILE EXPORT-FILE [--mode <export-mode>]

LOGFILE is a valid path to a .wpilog file, and EXPORT-FILE is a valid path to a CSV or JSON file. All directories in EXPORT-FILE must exist, but the file itself will be created if it does not exist.

Extracting an entry

sawmill extract ENTRY LOGFILE EXPORTFILE [--format <export-format>]
ENTRY is the case-sensitive name of an entry that exists in LOGFILE. --format must be either "json" or "csv" and defaults to CSV.

Trimming a DataLog

sawmill trim LOGFILE [ENTRY] --start <timestamp> --duration <duration> [--format <export-format>]
sawmill trim LOGFILE [ENTRY] --start <timestamp> --end <timestamp> [--format <export-format>]

TODO:

  • CSV Export (partially done)
  • JSON Export (partially done)
  • Entry extraction
  • Trimming

@github-actions github-actions bot added component: wpiutil WPI utility library component: datalogtool DataLog Tool component: sysid SysId app labels Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant