Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update AdvantageScope docs #2418

Merged
merged 7 commits into from
Dec 14, 2023
Merged

Conversation

jwbonner
Copy link
Member

@jwbonner jwbonner commented Dec 6, 2023

These updates reflect AdvantageScope's inclusion in the WPILib installer for 2024, with a dedicated page and references from relevant locations in the rest of the docs. The idea is to keep the main AdvantageScope docs separate but make the tool more discoverable.

I think the main questions here relate to organization. The AdvantageScope page is under "Telemetry" in this version, but I could see arguments for putting it under "Dashboards" (with Glass, which is also a programmer's tool) or "Software Tools" (with OutlineViewer). I also added AdvantageScope references to the pages for Field2d, Mechanism2d, and plots; these are currently organized under "Glass", but the Field2d and plots pages are also part of "Robot Simulation" where I think the inclusion of AdvantageScope makes more sense. There's a bit of a disconnect now between those features and Glass, but maybe keeping AdvantageScope as a side reference on those pages is an OK solution? I'm open to suggestions.

I'm opening this as a draft for now since the explanation for how to open AdvantageScope won't actually work until it's included in the tools menu and file associations are added for Windows.

Copy link
Member

@jasondaming jasondaming left a comment

Choose a reason for hiding this comment

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

Good stuff I think we should merge this ASAP with a couple changes.

We can defer this to a different PR if you want but I really thing we should have a section on publishing swerve states (I don't remember the current state of structs?). For troubleshooting and getting started with Swerve this is one of the most helpful things teams can do

source/docs/software/telemetry/datalog.rst Show resolved Hide resolved
source/docs/software/telemetry/advantagescope.rst Outdated Show resolved Hide resolved
@jwbonner
Copy link
Member Author

A few changes:

  • I split the DataLog page in two to address Split On-Robot Telemetry Recording Into Data Logs into Recording and Downloading #2422, with sections for AdvantageScope and the DataLogTool. Another section for the DS could be added there in the future.
  • Based on the changes in Choosing a Dashboard #2428, I moved the main AdvantageScope page to "Dashboards". I think this fits better since the new data log download page mentions AdvantageScope already.
  • I added a section to the swerve drive kinematics page for AdvantageScope, which seemed like the most obvious place to talk about swerve visualization since the SwerveModuleState class is introduced on that page. There is example code for publishing the states to NT in Java and C++. Python should also be included, I just haven't had a chance to figure out how struct publishing works for that.

@jasondaming
Copy link
Member

I am not sure struct publishing is done for python. At least I couldn't find it.

@virtuald do you know how we would do this?

@virtuald
Copy link
Member

It is not implemented yet: robotpy/mostrobotpy#5

@jasondaming
Copy link
Member

I don't think there is anything preventing this from being merged with a little cleanup.

@jwbonner jwbonner marked this pull request as ready for review December 14, 2023 16:56
@jasondaming jasondaming merged commit b07b12e into wpilibsuite:main Dec 14, 2023
10 checks passed
@virtuald
Copy link
Member

FWIW python struct publishing is now merged: robotpy/mostrobotpy#50

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants