Skip to content

Latest commit

 

History

History
47 lines (26 loc) · 3.63 KB

OPEN-LIVE.md

File metadata and controls

47 lines (26 loc) · 3.63 KB

Connecting to Live Sources

< Return to homepage

All visualizations in AdvantageScope are designed to receive live data from a robot or simulator in addition to log files. This section describes how to connect to real time data sources.

Configuration

Open the preferences window by pressing cmd/ctrl + comma or clicking "Help" > "Show Preferences..." (Windows/Linux) or "AdvantageScope" > "Preferences..." (macOS).

Diagram of live preferences

roboRIO Address

Enter the roboRIO address using a 10.TE.AM.2 IP address as described in the WPILib docs. Click "File" > "Use USB roboRIO Address" to temporarily use the IP address "172.22.11.2" for all connections.

Live Source

The following sources of live data are supported by AdvantageScope:

  • NetworkTables 4: This is the default networking protocol starting in WPILib 2023, and is commonly used by dashboards, coprocessors, etc. See the WPILib documentation for more details. Note that NetworkTables 3 (used by WPILib 2022 and older) is not supported by AdvantageScope.
  • NetworkTables 4 (AdvantageKit): This mode is designed for use with robot code running AdvantageKit, which publishes to the "/AdvantageKit" table in NetworkTables. The only difference from the NetworkTables 4 mode is that the "/AdvantageKit" table is used as the root, which allows for easier switching between an NT4 connection and an AdvantageKit log file.
  • RLOG Server: This protocol is used by AdvantageKit v1 (2022), and is included for compatibility with older code bases. Note that the "RLOG Server Port" must be set to use this mode.

Live Mode

When NetworkTables is used as the live source, the following live modes can be selected:

  • Low Bandwidth (Default): AdvantageScope only requests data from the server for fields that are actively being used. Data published before a field was selected will not be available. This mode is highly recommended when running in an environment with limited network bandwidth, such as on the field.
  • Logging: AdvantageScope requests data for all fields regardless of whether they are actively being used. This means that fields can be viewed retroactively by pausing the stream of live data (see below). This mode is often useful during development but should NOT be used on the field.

Starting the Connection

To start the connection to a robot (using the configured "roboRIO Address") or a simulator (using "127.0.0.1"), follow these steps:

  • Robot: Click "File" > "Connect to Robot" or press cmd/ctrl + K
  • Simulator: Click "File" > "Connect to Simulator" or press shift + cmd/ctrl + K

The window title displays the IP address and the text "Searching" until the robot/sim is connected. It attempts to reconnect automatically using the same settings after a disconnect.

Viewing Live Data

When connected to a live source, AdvantageScope locks all tabs to the current time by default. Views like the line graph and table autoscroll, and views like odometry and joysticks display the current values of each field. Clicking the red arrow button in the navigation bar toggles this lock, enabling viewing and replay of past data.

Note: Scrolling to the left in the line graph also unlocks from the current time, and scrolling all the way to the right locks to the current time again.

Live viewing controls