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

ArduSub: document used parameters #29

Open
1 of 3 tasks
ES-Alexander opened this issue May 12, 2022 · 3 comments
Open
1 of 3 tasks

ArduSub: document used parameters #29

ES-Alexander opened this issue May 12, 2022 · 3 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@ES-Alexander
Copy link
Collaborator

ES-Alexander commented May 12, 2022

Would be useful if each ArduSub version specifies the parameters it actually uses. That should avoid confusing issues where someone tries to set a documented parameter, but it doesn't do anything because it exists but isn't used in the firmware.

Would likely be quite a bit of work to determine which existing parameters are unused, but shouldn't be too bad to maintain beyond that, and would be helpful for people wanting to use ArduSub vehicles to know what is definitely supported.

  • Document specifications for parameters with some form of implementation in the source code (ArduSub 4.1 Initial Docs #52)
  • Determine which parameters are unused
  • Create more intuitive docs based on just the used parameters
@ES-Alexander ES-Alexander added documentation Improvements or additions to documentation enhancement New feature or request labels May 12, 2022
@ES-Alexander
Copy link
Collaborator Author

@Williangalvani has mentioned that we can remove the sub tag from unused parameters in ArduPilot, which then means the auto-generated output can be correct for what a given ArduSub version actually supports.

Still requires determining which parameters are used, but this is likely the best mechanism for communicating that once it's determined.

@ES-Alexander
Copy link
Collaborator Author

Some internal discussion about SERVOn_FUNCTION values here.

Key points are

  • hardcoded RCINx values may as well have labels representing their function (e.g. RCIN9 -> RCIN9 Lights1Level)
  • other functions need to be tested to confirm what does and doesn't work
  • changes need to happen in ArduPilot repo, before parameter docs can be re-built and transferred to these docs

@ES-Alexander ES-Alexander mentioned this issue Jan 21, 2023
35 tasks
@ES-Alexander
Copy link
Collaborator Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant