docs: Mode Requirements detailed docs #26084
Draft
+836
−27
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
/en/flight_modes/mode_requirements.md
|
hamishwillee
commented
Dec 11, 2025
|
|
||
| ::: | ||
|
|
||
| <!--@include: ../flight_modes_fw/mode_requirements_fixed_wing_offboard.md--> |
Contributor
Author
There was a problem hiding this comment.
FYI this is an inclusion - so I import another doc at this point containing just the requirements.
hamishwillee
commented
Dec 11, 2025
| - The mission will start once the vehicle is armed. | ||
| - This mode is automatic - no user intervention is _required_ to control the vehicle. | ||
| - RC control switches can be used to change flight modes on any vehicle. | ||
| - RC control switches can be used to switch out of mission mode on any vehicle. |
Contributor
Author
There was a problem hiding this comment.
Just switches or also sticks?
hamishwillee
commented
Dec 11, 2025
Comment on lines
+333
to
+342
| invalid_modes = ['mode_requirements_fixed_wing_position_slow.md', | ||
| 'mode_requirements_fixed_wing_auto_vtol_takeoff.md', | ||
| 'mode_requirements_fixed_wing_altitude_cruise.md', | ||
| 'mode_requirements_fixed_wing_termination.md', | ||
|
|
||
| 'mode_requirements_rotary_wing_auto_precland.md', | ||
| 'mode_requirements_rotary_wing_auto_vtol_takeoff.md', | ||
| 'mode_requirements_rotary_wing_descend.md', | ||
| 'mode_requirements_rotary_wing_manual.md', | ||
| 'mode_requirements_rotary_wing_termination.md' ] |
Contributor
Author
There was a problem hiding this comment.
These don't seem to map to "real modes" that we have documented. Though perhaps precland is, and we should add that requirement.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds detailed docs on the mode requirements.
The docs are generated by
docs/scripts/get_mode_requirements.pyfrom the requirements code and docs. This is mostly to allow easy update if we get new requirements.This is still wip.