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

"Routine" in the SysId docs and code needs a better definition #2961

Open
calcmogul opened this issue Jan 24, 2025 · 1 comment
Open

"Routine" in the SysId docs and code needs a better definition #2961

calcmogul opened this issue Jan 24, 2025 · 1 comment

Comments

@calcmogul
Copy link
Member

See https://www.chiefdelphi.com/t/need-more-data-for-sysid/475208/4:

The nomenclature in the linked documentation is rather confusing. Specifically the use of the word “Routine” is ambiguous and conflicting between the documentation and the code. The documentation has the statement “A standard motor identification routine consists of two types of tests:” and later the warning “Only log files with a single routine in them are usable for analysis”

However, writing the code the for the two tests, each run forward and backward, consists of executing four SysIdRoutine based commands. Luckily I ran all four tests at once before seeing the warning. So when I later broke them up into separate logs for each SysIdRoutine command and analysis failed, it led me here.

I would suggest simply picking another word like “procedure” for the documentation to disambiguate the use of “routine”

@builder173
Copy link

I think where it went off the rails for me was the following statement, because I had modified the standard button-bound tests into four autonomous routines.

" SysIdRoutine provides command factories that may be used to run the tests, for example as part of an autonomous routine."

And later, the intro to a video saying:
"The entire routine should look something like this:"

At this point a new reader (me, and hopefully the target for all of this documentation) is contemplating the following definitions of "Routine" as they parse the information:

  1. Routine could mean this thing that I'm doing, running some tests and getting some config for PathPlanner/Choreo
  2. Could mean a class in the wpilib library
  3. Could mean an autonomous routine with one or more tests

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

No branches or pull requests

2 participants