Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mechanical-advantage/advantagescope
Robot telemetry application for FRC
https://github.com/mechanical-advantage/advantagescope
advantagescope data-visualization first-robotics-competition frc logging
Last synced: 7 days ago
JSON representation
Robot telemetry application for FRC
- Host: GitHub
- URL: https://github.com/mechanical-advantage/advantagescope
- Owner: Mechanical-Advantage
- License: mit
- Created: 2021-08-14T01:00:54.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T04:38:16.000Z (9 days ago)
- Last Synced: 2024-10-28T07:11:58.272Z (9 days ago)
- Topics: advantagescope, data-visualization, first-robotics-competition, frc, logging
- Language: TypeScript
- Homepage: https://docs.advantagescope.org/
- Size: 648 MB
- Stars: 175
- Watchers: 10
- Forks: 52
- Open Issues: 53
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
[](https://github.com/Mechanical-Advantage/AdvantageScope/actions/workflows/build.yml)
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](https://docs.advantagekit.org) 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](https://docs.advantagescope.org) or find it offline by clicking the 📖 icon in the tab bar.**
Feedback, feature requests, and bug reports are welcome on the [issues page](https://github.com/Mechanical-Advantage/AdvantageScope/issues). For non-public inquires, please send a message to [email protected].
## Installation
1. Find the [latest release](https://github.com/Mechanical-Advantage/AdvantageScope/releases/latest) 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:
```bash
npm install
```
[Emscripten](https://emscripten.org) also needs to be installed (instructions [here](https://emscripten.org/docs/getting_started/downloads.html)).
To build for the current platform, run:
```bash
npm run build
```
To build for another platform, run:
```bash
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:
```bash
export ASCOPE_DISTRIBUTOR=WPILIB
```
For development, run:
```bash
npm run watch
npm start
```
## Assets
For details on adding custom assets, see [Custom Assets](https://docs.advantagescope.org/more-features/custom-assets).
Bundled assets are stored under [`bundledAssets`](/bundledAssets/). Larger assets are downloaded automatically by AdvantageScope from the [AdvantageScopeAssets](https://github.com/Mechanical-Advantage/AdvantageScopeAssets/releases) repository.