-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update documentation with 2025 changes (#196)
* Update "Getting Started" section of docs * Add dark screenshot to docs welcome page * Update tab reference docs * Fix formatting * Update "More Features" section of docs
- Loading branch information
Showing
84 changed files
with
744 additions
and
452 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
--- | ||
sidebar_position: 4 | ||
--- | ||
|
||
# Keyboard Shortcuts | ||
|
||
AdvantageScope includes numerous keyboard shortcuts that allow for faster navigation. Shortcuts that use the `ctrl` key are replaced by the ⌘ key on macOS. | ||
|
||
### Data Sources | ||
|
||
<table> | ||
<tr><td>`Ctrl+O`</td><td>Open one or more log files</td></tr> | ||
<tr><td>`Ctrl+Shift+O`</td><td>Add one or more log files to the current visualization</td></tr> | ||
<tr><td>`Ctrl+K`</td><td>Connect to robot as a live source</td></tr> | ||
<tr><td>`Ctrl+Shift+K`</td><td>Connect to simulator as a live source</td></tr> | ||
<tr><td>`Ctrl+D`</td><td>Download log files from the robot</td></tr> | ||
<tr><td>`Option+Z`</td><td>Load Zebra MotionWorks™️ data</td></tr> | ||
</table> | ||
|
||
### Data Export | ||
|
||
<table> | ||
<tr><td>`Ctrl+E`</td><td>Export log data</td></tr> | ||
<tr><td>`Ctrl+P`</td><td>Publish log data to a NetworkTables server on the robot</td></tr> | ||
<tr><td>`Ctrl+Shift+P`</td><td>Publish log data to a NetworkTables server in simulation</td></tr> | ||
<tr><td>`Option+Ctrl+P`</td><td>Stop publishing to NetworkTables</td></tr> | ||
</table> | ||
|
||
### Window Controls | ||
|
||
<table> | ||
<tr><td>`Ctrl+N`</td><td>Create a new window</td></tr> | ||
<tr><td>`Ctrl+Shift+N`</td><td>Close the current window</td></tr> | ||
<tr><td>`Ctrl+Comma`</td><td>Open preferences window</td></tr> | ||
<tr><td>`Ctrl+Period`</td><td>Toggle sidebar visibility</td></tr> | ||
<tr><td>`Ctrl+Slash`</td><td>Toggle control pane visibility</td></tr> | ||
</table> | ||
|
||
### Tab Controls | ||
|
||
<table> | ||
<tr><td>`Ctrl+T`</td><td>Open dropdown to add a new tab</td></tr> | ||
<tr><td>`Ctrl+Shift+T`</td><td>Create a new pop-out window for the current tab</td></tr> | ||
<tr><td>`Ctrl+Left` and `Ctrl+Right`</td><td>Switch tabs</td></tr> | ||
<tr><td>`Ctrl+[` and `Ctrl+]`</td><td>Rearrange tabs</td></tr> | ||
<tr><td>`Ctrl+W`</td><td>Close current tab</td></tr> | ||
</table> | ||
|
||
**The shortcuts below can be used to quickly create new tabs:** | ||
|
||
<table> | ||
<tr> | ||
<td>`Option+G`</td><td>[📉 Line Graph](../tab-reference/line-graph.md)</td> | ||
<td>`Option+V`</td><td>[🎬 Video](../tab-reference/video.md)</td> | ||
</tr> | ||
<tr> | ||
<td>`Option+O`</td><td>[🗺 Odometry](../tab-reference/odometry.md)</td> | ||
<td>`Option+J`</td><td>[🎮 Joysticks](../tab-reference/joysticks.md)</td> | ||
</tr> | ||
<tr> | ||
<td>`Option+3`</td><td>[👀 3D Field](../tab-reference/3d-field.md)</td> | ||
<td>`Option+D`</td><td>[🦀 Swerve](../tab-reference/swerve.md)</td> | ||
</tr> | ||
<tr> | ||
<td>`Option+T`</td><td>[🔢 Table](../tab-reference/table.md)</td> | ||
<td>`Option+M`</td><td>[⚙️ Mechanism](../tab-reference/mechanism.md)</td> | ||
</tr> | ||
<tr> | ||
<td>`Option+C`</td><td>[💬 Console](../tab-reference/console.md)</td> | ||
<td>`Option+P`</td><td>[📍 Points](../tab-reference/points.md)</td> | ||
</tr> | ||
<tr> | ||
<td>`Option+S`</td><td>[📊 Statistics](../tab-reference/statistics.md)</td> | ||
<td>`Option+I`</td><td>[🔍 Metadata](../tab-reference/metadata.md)</td> | ||
</tr> | ||
</table> | ||
|
||
### Playback | ||
|
||
<table> | ||
<tr><td>`Space`</td><td>Toggle playback</td></tr> | ||
<tr><td>`Left` and `Right`</td><td>Step through log file</td></tr> | ||
<tr><td>`L`</td><td>Toggle lock when viewing live data</td></tr> | ||
</table> | ||
|
||
### Touch Bar | ||
|
||
On supported MacBook models, the Touch Bar can be used to scrub through the log and add new tabs. | ||
|
||
![Touch Bar scrubbing interface](./img/keyboard-1.png) | ||
![Touch Bar new tab interface](./img/keyboard-2.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
--- | ||
sidebar_position: 2 | ||
--- | ||
|
||
import PrefsImage from '../img/prefs.png'; | ||
import Image2 from './img/open-file-2.png'; | ||
|
||
# Managing Log Files | ||
|
||
## Supported Formats | ||
|
||
- **WPILOG (.wpilog)** - Produced by WPILib's [built-in data logging](https://docs.wpilib.org/en/stable/docs/software/telemetry/datalog.html) and AdvantageKit. [URCL](../more-features/urcl.md) can be used to capture signals from REV motor controllers to a WPILOG file. | ||
- **Driver Station logs (.dslog and .dsevents)** - Produced by the [FRC Driver Station](https://docs.wpilib.org/en/stable/docs/software/driverstation/driver-station.html). AdvantageScope automatically searches for the corresponding log file when opening either log type. | ||
- **Hoot (.hoot)** - Produced by CTRE's Phoenix 6 [signal logger](https://pro.docs.ctr-electronics.com/en/latest/docs/api-reference/api-usage/signal-logging.html). | ||
- **RLOG (.rlog)** - Legacy, produced by AdvantageKit 2022. | ||
|
||
:::warning | ||
Hoot files can **only be opened on Windows** and require an installation of [Phoenix Tuner X](https://v6.docs.ctr-electronics.com/en/stable/docs/tuner/index.html). | ||
::: | ||
|
||
## Opening Logs | ||
|
||
In the menu bar, click `File` > `Open Log(s)...`, then choose a one or more log files from the local disk. Dragging a log file from the system file browser to the AdvantageScope icon or window also causes it to open. | ||
|
||
:::info | ||
If multiple files are opened simultaneously, the timestamps will be aligned automatically. This enables easy comparison of log files from multiple sources. | ||
::: | ||
|
||
![Opening a saved log](./img/open-file-1.png) | ||
|
||
## Adding New Logs | ||
|
||
After opening a log file, additional logs can be easily added to the visualization. Timestamps will be realigned automatically to synchronize with existing data. | ||
|
||
In the menu bar, click `File` > `Add News Log(s)...`, then choose a one or more log files to add to the current visualization. The fields from each log will be recorded under tables named `Log0`, `Log1`, etc. | ||
|
||
## Downloading from a roboRIO | ||
|
||
<details> | ||
<summary>Configuration</summary> | ||
|
||
Open the preferences window by clicking `Help` > `Show Preferences...` (Windows/Linux) or `AdvantageScope` > `Settings...` (macOS). Update the roboRIO address and log folder. Click `File` > `Use USB roboRIO Address` to temporarily use the IP address `172.22.11.2` for all connections. | ||
|
||
<img src={PrefsImage} alt="Diagram of roboRIO preferences" height="350" /> | ||
</details> | ||
|
||
Click `File` > `Download Logs...` to open the download window. Once connected to the roboRIO, available logs are shown with the newest at the top. Select one or more log files to download (shift-click to select a range or **cmd/ctrl + A** to select all). Then click the ↓ symbol and select a save location. | ||
|
||
:::tip | ||
When downloading multiple files, AdvantageScope skips any that already exist in the destination folder. | ||
::: | ||
|
||
<img src={Image2} alt="Downloading log files" height="350" /> |
Oops, something went wrong.