Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 3.58 KB

EXPORT.md

File metadata and controls

39 lines (29 loc) · 3.58 KB
Raw

Exporting Log Data

< Return to homepage

AdvantageScope includes a flexible system for exporting log data as a CSV, WPILOG, or MCAP file. The export functions work when viewing a log file or when connected to a live data source. Possible use cases include:

  • Converting a WPILOG file to CSV or MCAP for analysis in other applications.
  • Exporting a WPILOG file based on NetworkTables data, for later access.
  • Saving a WPILOG with a limited number of fields (and duplicate values removed) to reduce file size.

To view options for exporting, click "File" > "Export Data..." or press cmd/ctrl + E.

Export options

Options

The following options are provided when exporting:

  • Format: Sets the general format of the exported file. See options below.
    • CSV (Table): Comma separated values, where each row represents a distinct timestamp and each column represents a field (plus a column for the timestamp value). Each row can represent a value in multiple fields.
    • CSV (List): Comma separated values, where each row represents a value in a single field with columns for timestamp, key, and value.
    • WPILOG: Standard WPILOG file that can be opened again in AdvantageScope.
    • MCAP: Standard MCAP file that can be opened in Foxglove.
  • Timestamps: Only for "CSV (Table)". Sets the method for creating new rows. See options below.
    • All Changes: Create new rows/entries only when the values of the fields are updated. Minimizes the file size of the export.
    • Fixed Period: Create new rows/entries at a fixed interval, useful for logs without timestamp synchronization (when many fields are being logged with similar, but not identical, timestamps). Note that all values are included, regardless of whether there was a change between sample points.
    • AdvantageKit Cycles: Create a new row/entry for each AdvantageKit synchronized loop cycle. Note that all values are included, regardless of whether there was a change between loop cycles.
  • Period: Only when "Fixed Period" is selected. Sets the period in milliseconds between each sample. Typically, this should match the loop cycle period of the robot code.
  • Prefixes: If blank, include all fields. Otherwise, only include fields that match the prefixes provided (separated with commas). See examples below.
    • "/DriverStation/Joystick0": Include all fields starting with "/DriverStation/Joystick0" (data from the first joystick).
    • "Flywheels,DS:enabled": Include all fields starting with "/Flywheels" or "DS:enabled" (all data from the flywheel, plus the robot's enabled status).
    • "Drive/LeftPosition,Drive/RightPosition": Only include the fields "/Drive/LeftPosition" and "/Drive/RightPosition".
  • Field Set: See options below. Generated fields are created by AdvantageScope to break down complex types, and are displayed with gray text in the sidebar. This includes the individual components of arrays, structs, and other schemas.
    • Include Generated: Export all viewable fields, which includes generated fields. Recommended if the exported data will be opened in an application not capable of parsing complex types.
    • Original Only: Only export fields that were present in the original log file, which excludes generated fields. Recommended if the exported data will be opened in AdvantageScope or another application capable of parsing complex types.

An example CSV file exported from AdvantageScope is shown below, in the "CSV (Table)" format with timestamps set to "All Changes":

CSV table