Skip to content

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

Open
@calcmogul

Description

@calcmogul

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”

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions