Improve pidTuningIdleMinRpmHelp Tooltip text

[leocb]

This phrase is more concise, direct to the point and uses less technical jargon that's better for the end-user that does not care to what happens under the hood. Please correct me if I defined something wrong.

[mikeller]

The backslashes in the string need to be escaped: \"

[leocb]

Done. how the hell did the Travis CI build succeeded with this major flaw?! JS sure is forgiving

[mikeller]

@leocb: It's not about being 'forgiving', it's about being lazy and only evaluating most things at runtime (and then happily crashing).
But you are making a good point - it might make sense to add a test for this. And I am halfway surprised that SonarCloud does not do a correctness check for JSON.

[ctzsnooze]

The change may unintentionally cause confusion.

When dynamic idle is active, the DShot value becomes a minimum throttle value. The actual DShot minimum value is zero.

Therefore it is not correct to say, "Set this parameter to dynamically adjust the minimum DShot value based on the rpm..." because it doesn't do that.

What rpm filtering actually does is to permanently set the minimum DShot value to zero, and then dynamically modifies the values sent to each motor, individually, to prevent its rpm from falling below the specified minimum.

I think my original introductory sentence that says, "Set this parameter to provide an rpm based floor-value as a safety net against motor desync." is technically correct and simple to understand.

[asizon]

The first phrase is wrong to describe Dynamic Idle. Maybe we can use same like this(from new updated Dynamic Idlea entry):

Dynamic Idle improves how Betaflight controls the motors at the low end of the rpm range based on the rpm data to avoid motor desyncs.

[ctzsnooze]

There remain some unknowns about dynamic idle for racing. I am certain that this, below, is true, and am comfortable with this text for 4.2.

Dynamic Idle improves how Betaflight controls the motors at the low end of the rpm range. It uses rpm data to provide a safety net against motor desyncs, and also improves stability in drops and motor braking under positive airflow conditions. For longer inverted hang time, reduce DShot idle value and minimum rpm together, but not so low as to cause desyncs. The Dynamic Idle rpm value should be set to about 20% below the rpm of the currently configured Dshot idle value, as described in the wiki.

[leocb]

That's a very good suggestion, may I try to improve it a bit more?
I think it's valid to keep in mind that people that care about performance will read the wiki, so we should keep the tooltip easy for non technical people that want to get the most of their craft without diving too deep into the specifics.

Dynamic Idle improves how Betaflight controls the motors at low rpm. It uses the rpm data to reduce(eliminate?) motor desyncs, improves motor braking on straight lines, stability during drops and the PID performance at zero throttle. For a longer inverted hang time, reduce DShot idle value and minimum rpm together, but not so low as to cause desyncs. The Dynamic Idle rpm value should be set to about 20% below the rpm of your Dshot idle value, for more info, see <this wiki page>(link)

"safety net" may be hard for translators, so it's better to use similar, but different phrasing, just wondering if I should use reduce or eliminate. I believe reduce is more realistic?

[McGiverGim]

I don't think safety net can be a problem for translations. Some languages will translate it without problems, and others maybe need to "change" a little the phrase, but nothing that our advanced translator can't do :P
But if we find a better word/phrase, perfect.

[ctzsnooze]

Maybe as a compromise,
Dynamic Idle improves how Betaflight controls the motors at low rpm. It uses the rpm data to reduce the chance of motor desyncs, improves motor braking when airflow into the props is positive, and improves low throttle stability and responsiveness. For longer inverted hang times, the DShot idle and minimum rpm values should be reduced together, but not so low as to cause desyncs. The Dynamic Idle rpm value should be set to about 20% below the rpm of your Dshot idle value, for more info, see <this wiki page>(link)

Rationale:

• depending on configuration, dynamic idle cannot absolutely eliminate desyncs. If the user tunes it with very low values to optimised inverted hang time, they will run a real risk of desyncs.
• braking is improved in all kinds of manoeuvres, not just straight, but curves and inverted drops and turns; but ONLY when there is strongly positive airflow into the props, strong enough to keep the rpm above the minimum.

[leocb]

Here's my suggestion based on ctzsnooze comments on slack:
suggestion n.1:
Dynamic Idle improves how Betaflight controls the motors at low rpm and reduces the chances of motor desync, to achieve this, it responds to the effect of the wind speeding up or slowing down the props, allowing more authority to the PID; This improves the craft stability, motor braking and responsiveness at zero throttle. For racing, higher values are recommended, for freestyle and high-rate setups lower values are better, but not too low as to cause desyncs. In both cases, it's recommended to set the Dynamic Idle rpm to be about 20% below the rpm of what Dshot Idle achieves (get it from the <motors> tab). For a longer inverted hang time, DShot idle value and Minimum rpm should be lowered together. This setting can be tricky to tune, please read <this Wiki page> to learn more.

But this is too much text to cram into a tool tip, suggestion n.2 is:
Dynamic Idle improves the motors control at low rpm and reduces desync, it responds to the effect of the wind speeding up or slowing down the props, giving more authority to the PID; This improves stability, motor braking and responsiveness. For racing, higher values are recommended, for freestyle and high-rate setups lower values are better, but not too low as to cause desyncs. In both cases, it's recommended to set the Dynamic Idle rpm to be about 20% below the rpm of Dshot Idle (see the <motors> tab). For a longer inverted hang time, DShot idle value and Minimum rpm should be lowered together. Please read <this Wiki page> to learn how to tune this properly

[ctzsnooze]

We have no experience about optimal settings for racing.
Recommending low idle values for freestyle will lead to many complaints about pitch wobble.
I will revise the wiki soon, but the notes there about racing and freestyle were inherited from an earlier draft and I don't think they are entirely correct.
This text seems about right to me, I think it's all we should be saying in a tooltip. They should refer to the wiki for more info.
Dynamic Idle improves control at low rpm and reduces risk of desyncs. It corrects problems caused by airflow speeding up or slowing down the props, improving PID authority, stability, motor braking and responsiveness. The Dynamic Idle rpm should be set to be about 20% below the rpm of your Dshot Idle value (see the <motors> tab). Usually there is no need to change your DShot idle value from defaults. For longer inverted hang time, DShot idle value and Minimum rpm should be lowered together.

[leocb]

I completely agree with ctzsnooze, and thanks for your time! the text on his last comment is perfect IMO.
really glad we could define a good tooltip for this feature.

The PR has been updated accordingly

[asizon]

Seems that you forgot wiki entry reference :) is one of the most important part of this tooltip, originaly added due to the difficulty of adjusting and understanding this feature, and to take advantage of our current resources.
<br><br>Visit this <a href=\"https://github.com/betaflight/betaflight/wiki/Tuning-Dynamic-Idle\"target=\"_blank\" rel=\"noopener noreferrer\">wiki</a> entry for more info

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities (and 0 Security Hotspots to review)
0 Code Smells

No Coverage information
0.7% Duplication

[leocb]

added wiki entry and rebased