Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 3.05 KB

README.md

File metadata and controls

71 lines (46 loc) · 3.05 KB
Raw

AdvantageScope

Build

AdvantageScope is a robot diagnostics, log review/analysis, and data visualization application for FIRST Robotics Competition teams developed by Team 6328. It reads logs in WPILOG, DS log, Hoot (CTRE), and RLOG file formats, plus live robot data viewing using NT4 or RLOG streaming. AdvantageScope can be used with any WPILib project, but is also optimized for use with our AdvantageKit log replay framework. Note that AdvantageKit is not required to use AdvantageScope.

AdvantageScope includes the following tools:

  • A wide selection of flexible graphs and charts
  • 2D and 3D field visualizations of odometry data, with customizable CAD-based robots
  • Synchronized video playback from a separately loaded match video
  • Joystick visualization, showing driver actions on customizable controller representations
  • Swerve drive module vector displays
  • Console message review
  • Log statistics analysis
  • Flexible export options, with support for CSV and WPILOG

View the online documentation or find it offline by clicking the 📖 icon in the tab bar.

Feedback, feature requests, and bug reports are welcome on the issues page. For non-public inquires, please send a message to software@team6328.org.

Example screenshot

Installation

  1. Find the latest release under "Releases".
  2. Download the appropriate build based on the OS & architecture. AdvantageScope supports Windows, macOS, and Linux on both x86 and ARM architectures.

Important

Before running AppImage builds on Ubuntu 23.10 or later, you must download the AppArmor profile from the releases page and copy it to /etc/apparmor.d.

Building

To install Node.js dependencies, run:

npm install

Emscripten also needs to be installed (instructions here).

To build for the current platform, run:

npm run build

To build for another platform, run:

npm run build -- --win --x64 # For full list of options, run "npx electron-builder help"

To build the WPILib version, set the environment variable ASCOPE_DISTRIBUTOR to WPILIB before building:

export ASCOPE_DISTRIBUTOR=WPILIB

For development, run:

npm run watch
npm start

Assets

For details on adding custom assets, see Custom Assets.

Bundled assets are stored under bundledAssets. Larger assets are downloaded automatically by AdvantageScope from the AdvantageScopeAssets repository.