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

Boolean parameters not clearly highlighted #12546

Closed
hamishwillee opened this issue Jul 24, 2019 · 6 comments · Fixed by #13269
Closed

Boolean parameters not clearly highlighted #12546

hamishwillee opened this issue Jul 24, 2019 · 6 comments · Fixed by #13269

Comments

@hamishwillee
Copy link
Contributor

By example, consider COM_RC_OVERRIDE which is defined as a boolean:

/**
 * Enable RC stick override of auto modes
 *
 * When an auto mode is active (except a critical battery reaction) moving the RC sticks
 * gives control back to the pilot in manual position mode immediately.
 *
 * Only has an effect on multicopters and VTOLS in multicopter mode.
 *
 * @boolean
 * @group Commander
 */
PARAM_DEFINE_INT32(COM_RC_OVERRIDE, 1);

However the rendering doesn't undersand that this is a boolean, and expects a max, min, interval in the left column and units in the right:

image

Proposal is to update rendering to make it obvious that a variable is a boolean. Open to ideas. @bkueng What do you recommend? Something like this?
image

@bkueng
Copy link
Member

bkueng commented Jul 24, 2019

Doesn't QGC show as 'Enabled/Disabled'? If so I'd go for that instead of True/False. And maybe turn it around: Enabled (1).

@dagar
Copy link
Member

dagar commented Jul 25, 2019

After #11318 I was planning on introducing a real boolean type at some point.

@hamishwillee
Copy link
Contributor Author

@dagar Re "was planning on introducing a real boolean type at some point." - what sort of timeframe? I guess it makes no difference if I do this early.

@dagar
Copy link
Member

dagar commented Jul 26, 2019

Could be sooner if it actually matters for anyone. I viewed it as a small optimization within the param system.

What was your solution going to be @hamishwillee?

Even shorter term as an incremental step we could probably "add" a boolean type that's still using a full int32 internally.

@stale
Copy link

stale bot commented Oct 24, 2019

This issue has been automatically marked as stale because it has not had recent activity. Thank you for your contributions.

@stale stale bot added the stale label Oct 24, 2019
@hamishwillee hamishwillee self-assigned this Oct 24, 2019
@stale stale bot removed the stale label Oct 24, 2019
@hamishwillee
Copy link
Contributor Author

What was your solution going to be

For me this is just a docs fix - I will do as Beat suggested here #12546 (comment). It is posted here because the generation tools are in this repo.

Whether it is worth implementing it as a boolean is something for you guys (a separate issue).

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

Successfully merging a pull request may close this issue.

4 participants