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

RC_Channel: options in alphabetical order #25963

Closed

Conversation

rmackay9
Copy link
Contributor

@rmackay9 rmackay9 commented Jan 12, 2024

Our list of RCx_OPTION parameter values is very long and users struggle to find what they are looking for.

This PR reorders them mostly in alphabetical order with some exceptions:

  1. "Do Nothing" remains at the top
  2. Flight modes are at the top
  3. Developer only items (or perhaps dangerous options) are right at the bottom including (e.g. "GPS Disable", "KillIMU")

There are some small issues that I could have fixed but put off for a follow-up PR to keep it easier to verify and merge:

a. some lines still have multiple items on them (e.g. "300:Scripting1, 301:Scripting2.." and "166:Camera Record Video, 167:Camera Zoom)
b. some items are badly named, (e.g. "use Custom Controller")
c. some are used to define the channel is used for control (e.g. Roll, Walking Height). We could group these, perhaps below the modes

I have carefully verified that no items have been lost in this change. I asked ChatGPT to do it first but it failed so I resorted to a spreadsheet with multiple cross checks.

@andyp1per
Copy link
Collaborator

This is purely a doc change so it looks better in MP, right?

@rmackay9
Copy link
Contributor Author

@andyp1per,

Yes, that's right. It has no functional change in terms of the flight code. It's just for the GCSs.

@Hwurzburg
Copy link
Collaborator

will require considerable wiki work on this page: common-auxiliary-functions.rst, but its a good change...have made a suggestion while we are at it.

@@ -104,146 +104,147 @@ const AP_Param::GroupInfo RC_Channel::var_info[] = {
// @User: Advanced
AP_GROUPINFO("DZ", 5, RC_Channel, dead_zone, 0),


// @Param: OPTION
// @DisplayName: RC input option
// @Description: Function assigned to this RC channel
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
// @Description: Function assigned to this RC channel
// @Description: Function assigned to this RC channel. Normally intended as a 2 or 3 position switch, functions in the 200/300 ranges are normally intended for continuous input range control.

@Hwurzburg Hwurzburg added the WikiNeeded needs wiki update label Jan 12, 2024
@IamPete1
Copy link
Member

I wonder if we could just have the param parser do this for us automatically....

@tridge
Copy link
Contributor

tridge commented Jan 15, 2024

I wonder if we could just have the param parser do this for us automatically....

we could have an optional "@SortedOptions" line which would cause it sort

@rmackay9
Copy link
Contributor Author

I'm happy with the SortedOptions idea if we're happy not to have the flight modes at the top.

@rmackay9
Copy link
Contributor Author

An alternative change is here #25996

@rmackay9
Copy link
Contributor Author

Closing in favour of PeterB's PR.

@rmackay9 rmackay9 closed this Jan 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
WikiNeeded needs wiki update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants