-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Update references to that should be control_profile #11122
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
base: master
Are you sure you want to change the base?
Conversation
This is to clean up some old references that should have been `control_profile`. But, have remained as different options. Within the firmware, there are `controlProfile` (previously `controlRateProfile`) and `PIDProfile`. These are separate entities internal to the firmware. But, to the user, they only see `control_profile` which contains all the settings included within the firmware's separate `controlProfile` and `PIDProfile`. This PR aims to take confusion away from the user by just referencing `control_profile`. This was most noticeable in the automated `control_profile` switching available in the `battery_profile` and the `mixer_profile`. Neither of which reference the UI visible `control_profile`. But mentioned `controlrate_profile` and `PID Profile` respectively. Neither of which are separately defined in the UI or CLI. In future, it is worth remembering that the user sees all `PIDProfile` and `control_profile` settings within the `control_profile` in CLI or as a selectable **Control Profile** in Configurator.
Changed `control_profile` in the `battery_profile` to now be `use_control_profile`. Which separates the parameter name from being exactly what the profiles are called. Plus it makes the usage of the parameter a bit more obvious.
PR Compliance Guide 🔍Below is a summary of compliance checks for this PR:
Compliance status legend🟢 - Fully Compliant🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label |
||||||||||||||||||||||||
PR Code Suggestions ✨Explore these optional code suggestions:
|
|||||||||
Nice find AI code checker! No idea how long this bug has been there.
User description
This is to clean up some old references that should have been
control_profile. But, have remained as different options.Within the firmware, there are
controlProfile(previouslycontrolRateProfile) andPIDProfile. These are separate entities internal to the firmware. But, to the user, they only seecontrol_profilewhich contains all the settings included within the firmware's separatecontrolProfileandPIDProfile.This PR aims to take confusion away from the user by just referencing
control_profile. This was most noticeable in the automatedcontrol_profileswitching available in thebattery_profileand themixer_profile. Neither of which reference the UI visiblecontrol_profile. But mentionedcontrolrate_profileandPID Profilerespectively. Neither of which are separately defined in the UI or CLI.In future, it is worth remembering that the user sees all
PIDProfileandcontrol_profilesettings within thecontrol_profilein CLI or as a selectable Control Profile in Configurator.Requires iNavFlight/inav-configurator#2429
2025-11-19
I have tested the changes that are not just renamed variables. i.e. the changes that needed to be updated in Configurator too.
PR Type
Enhancement
Description
Rename
controlRateProfilereferences tocontrolProfilethroughout codebaseUpdate CLI parameter from
controlrate_profiletouse_control_profilein battery profilesRename type
controlRateConfig_ttocontrolConfig_tfor consistencyUpdate mixer profile setting from
PIDProfileLinkingtocontrolProfileLinkingRename parameter group from
PG_CONTROL_RATE_PROFILEStoPG_CONTROL_PROFILESDiagram Walkthrough
File Walkthrough
37 files
Update control profile references in PID calculationsUpdate MSP protocol to use control profile namingUpdate RC adjustments to use control profile typeUpdate OSD display to reference control profileUpdate DJI OSD to use control profile namingUpdate rate dynamics to use control profileUpdate core flight controller to use control profileUpdate EZ tune to reference control profileUpdate blackbox logging to use control profileUpdate throttle curve generation function signatureRename file and update function/variable namesUpdate autotune to use control profile namingUpdate CMS menu to use control profile constantRename battery profile control rate fieldUpdate config activation to use control profileUpdate fixed wing navigation to use control profileRename mixer profile PID linking to control profile linkingRename header file and update declarationsUpdate dashboard function signatureUpdate CLI to use control profile value typeRename settings value type constantUpdate function declaration with new type nameRename struct from controlRateConfig to controlConfigRename parameter group ID constantUpdate include to use control profile headerUpdate include to use control profile headerUpdate include to use control profile headerUpdate include to use control profile headerUpdate settings offset calculation for control profileUpdate include to use control profile headerRename battery profile control rate fieldUpdate include to use control profile headerUpdate include to use control profile headerUpdate function declaration with new type nameRename mixer profile linking fieldUpdate forward declaration with new type nameUpdate settings configuration and parameter names5 files
Update MSP protocol documentation commentUpdate comment to use control profile namingUpdate documentation for renamed settingsUpdate enum documentationUpdate documentation to reference control profile1 files
Update unit test counter names2 files
Add VSCode configuration entryRename source files in build configuration