Skip to content

Add docs for usbtop#2378

Merged
samfreund merged 2 commits intoPhotonVision:mainfrom
samfreund:usbtop
Mar 2, 2026
Merged

Add docs for usbtop#2378
samfreund merged 2 commits intoPhotonVision:mainfrom
samfreund:usbtop

Conversation

@samfreund
Copy link
Member

@samfreund samfreund commented Feb 26, 2026

Description

This PR adds documentation for using usbtop, a program for monitoring USB bus bandwidth. Many teams have been having issues with USB bus bandwidth, and including a tool with the PhotonVision image that allows them to monitor said bandwidth will likely prove beneficial.

This PR also documents lsusb, which can be used to get the max bandwidth on USB buses. This is helpful as it gives us a basline for debugging with usbtop.

Meta

Merge checklist:

  • Pull Request title is short, imperative summary of proposed changes
  • The description documents the what and why, including events that led to this PR
  • If this PR changes behavior or adds a feature, user documentation is updated
  • If this PR touches photon-serde, all messages have been regenerated and hashes have not changed unexpectedly
  • If this PR touches configuration, this is backwards compatible with all settings going back to the previous seasons's last release (seasons end after champs ends)
  • If this PR touches pipeline settings or anything related to data exchange, the frontend typing is updated
  • If this PR addresses a bug, a regression test for it is added
  • If this PR adds a dependency, the license has been checked for compatibility and steps taken to follow it

@samfreund samfreund requested a review from a team as a code owner February 26, 2026 18:41
@github-actions github-actions bot added the documentation Anything relating to https://docs.photonvision.org label Feb 26, 2026
@samfreund samfreund requested a review from mcm001 March 2, 2026 21:31
Copy link
Contributor

@mcm001 mcm001 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Longer term I think we need to make more clear success/fail criteria to identify usb issues but this is enough for now

@samfreund samfreund merged commit 6b6e2c3 into PhotonVision:main Mar 2, 2026
58 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Anything relating to https://docs.photonvision.org

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants