Skip to content

AdvantageKit.md

Latest commit

 

History

History
96 lines (61 loc) · 6.29 KB

AdvantageKit.md

File metadata and controls

96 lines (61 loc) · 6.29 KB
Raw

AdvantageKit 2027 Alpha

Important

Please see the known issues section before installing or using AdvantageKit.

To install the 2027 alpha of AdvantageKit, follow the instructions in the WPILib documentation for installing vendor libraries and choose "AdvantageKit" from the list. Altneratively, choose "WPILib: Manage Vendor Libraries" > "Install new libraries (online)" from the command palette in VSCode and paste the URL below. Note that only the skeleton template project is currently available for 2027 releases.

https://github.com/Mechanical-Advantage/AdvantageKit/releases/download/v27.0.0-alpha-4/AdvantageKit.json

Zip files for offline installation are attached to each GitHub release (linked below).

Changelog

v27.0.0-alpha-4

  • Compatibility: WPILib 2027.0.0-alpha-6, Systemcore alpha/beta 11
  • Added support for WPILib Alpha 6 (#271, @blaze-developer and @jwbonner)
  • Updated to Java 25
  • Added skeleton project download
  • Added support for updated Driver Station data, including OpModes and joysticks
  • Updated SystemStats logging for the latest Systemcore release
  • Removed all support for mutable units
  • Added unit metadata to built-in match time logging
  • Applied all changes from v26.0.0-beta-1, v26.0.0, v26.0.1, and v26.0.2

v27.0.0-alpha-3

  • Compatibility: WPILib 2027.0.0-alpha-2, Systemcore release 163 & 166
  • Added support for WPILib Alpha 2
  • Removed 2025 deprecated features (Logger.getRealTimestamp and duplicate LoggedDashboard classes)

v27.0.0-alpha-2

  • Compatibility: WPILib 2027.0.0-alpha-1, Systemcore release 161 & 162
  • Added logging for landscape and portrait IMU orientations
  • Added logging for wall clock validity and wait to rename logs until updated
  • Added logging for CAN bus metadata (max bandwidth, FD state, availability, etc)
  • Added logging for NT clients (name, connection status, IP address, etc)
    • This feature will also be included in the 2026 beta of AdvantageKit

v27.0.0-alpha-1

  • Compatibility: WPILib 2027.0.0-alpha-1, Systemcore release 157
  • Updated battery, epoch time, team number, and watchdog logging for Systemcore compatibility
  • Added support for VH-109 radio logging on Systemcore (requires team number to be configured)
  • Added support for console logging from the robot program on Systemcore
  • Added resource logging for CPU usage and temperature, memory usage, and storage usage
  • Added network stats logging for CAN, Ethernet, Wi-Fi, and USB tethering
  • Added system stats logging for IMU data
    • Note that this data is not used during replay, so the onboard IMU must be isolated to an IO implementation with standard input logging when accessed in robot code.

Known Issues

Alert logging is not supported

Alerts are not supported by WPILib Alpha 6, so AdvantageKit alert logging is temporarily disabled. This will be fixed in a future release.

OpModeRobot is not supported

Users can continue to use LoggedRobot, which is the equivalent of WPILib's TimedRobot class. An equivalent for WPILib's OpModeRobot will be available in a future release.

Console logging may be delayed by ~250ms

Console data captured by AdvantageKit may be delayed by up to ~250ms from when it was generated by the robot program. This is a side effect of the console capture pipeline through the OS and will be fixed in a future release.

Joystick visualization with POVs is inaccurate in AdvantageScope

Fixed by AdvantageScope v27.0.0-alpha-5

AdvantageKit records joystick POV values using a new format to align with the OS and WPILib, which causes the visualization in AdvantageScope to display inaccurate data. See here for details.

Timestamps in filenames use UTC

Fixed by Systemcore release 163

Autogenerated filenames for log files represent timestamps in UTC instead of the correct local time. See this issue for details.

Log filenames do not include the date and time

Fixed by Systemcore release 161

Time synchronization from the Driver Station is not currently implemented on Systemcore, so the robot program has no knowledge of the current date and time. Log filenames therefore use a randomized identifier rather than the date and time that the log was produced. When running on the field, the event name and match number will still be included.

Log files are very zoomed out in AdvantageScope

Fixed by AdvantageScope v27.0.0-alpha-2

WPILib (and AdvantageKit by extension) currently use epoch timestamps on Systemcore, which are not properly handled by AdvantageScope. See here for details.

USB drives do not mount consistently

Fixed by Systemcore release 159

When logging data to a USB drive (the default option for WPILOGWriter), note that USB mounting on Systemcore is currently unreliable. Users can also choose to log to the internal storage by specifying the path /home/systemcore/logs. See wpilibsuite#31 for details.