-
Notifications
You must be signed in to change notification settings - Fork 15.5k
feat(oot): support external MAVLink handler, stream, and dialect with opt in custom init scripts in Out of Tree modules #27415
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
Open
methodmissing
wants to merge
10
commits into
PX4:main
Choose a base branch
from
methodmissing:external-mods-flex
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
8bf6152
mavlink: add external handler and stream registries for out-of-tree M…
methodmissing 5b53083
cmake: add mavlink/ directory convention for external module MAVLink …
methodmissing cf80343
Add support for rate intervals
methodmissing d9b0cdc
Use mutex in mavlink_ext_handler_register
methodmissing cad563f
Add mavlink_ext_stream_set_interval and use mutex in ext_stream
methodmissing bf8f1f6
Prefer explicit shared cmake function px4_add_external_mavlink_dialect
methodmissing f2d0b99
Introduce support for optional external module auto-start / init scripts
methodmissing 1255684
Add documentation relevant to OOT support for startup sequence and MA…
methodmissing 80d1ef6
Cleanups
methodmissing 26f188d
Reverse boot order so that logging has precedence over OOT module inits
methodmissing File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| ############################################################################ | ||
| # | ||
| # Copyright (c) 2026 PX4 Development Team. All rights reserved. | ||
| # | ||
| # Redistribution and use in source and binary forms, with or without | ||
| # modification, are permitted provided that the following conditions | ||
| # are met: | ||
| # | ||
| # 1. Redistributions of source code must retain the above copyright | ||
| # notice, this list of conditions and the following disclaimer. | ||
| # 2. Redistributions in binary form must reproduce the above copyright | ||
| # notice, this list of conditions and the following disclaimer in | ||
| # the documentation and/or other materials provided with the | ||
| # distribution. | ||
| # 3. Neither the name PX4 nor the names of its contributors may be | ||
| # used to endorse or promote products derived from this software | ||
| # without specific prior written permission. | ||
| # | ||
| # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
| # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
| # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS | ||
| # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE | ||
| # COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, | ||
| # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, | ||
| # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS | ||
| # OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED | ||
| # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
| # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN | ||
| # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | ||
| # POSSIBILITY OF SUCH DAMAGE. | ||
| # | ||
| ############################################################################ | ||
|
|
||
| #============================================================================= | ||
| # | ||
| # px4_add_external_mavlink_dialect | ||
| # | ||
| # Registers an external MAVLink dialect XML for mavgen code generation. | ||
| # The dialect XML should <include>common.xml</include> (or another base | ||
| # dialect) so that all standard MAVLink messages remain available. | ||
| # | ||
| # Multiple external dialects are supported. The first registered dialect | ||
| # becomes the primary dialect (overrides CONFIG_MAVLINK_DIALECT from | ||
| # "common" if applicable). | ||
| # | ||
| # Usage: | ||
| # px4_add_external_mavlink_dialect( | ||
| # XML ${CMAKE_CURRENT_SOURCE_DIR}/../../mavlink/my_dialect.xml | ||
| # ) | ||
| # | ||
| # Effects: | ||
| # 1. Copies the XML into mavgen's message_definitions/v1.0/ search path | ||
| # 2. Appends the dialect name to PX4_EXTERNAL_MAVLINK_DIALECTS global property | ||
| # 3. Dialect override happens in root CMakeLists.txt after all add_subdirectory() | ||
| # calls have completed | ||
| # | ||
| function(px4_add_external_mavlink_dialect) | ||
| px4_parse_function_args( | ||
| NAME px4_add_external_mavlink_dialect | ||
| ONE_VALUE XML | ||
| REQUIRED XML | ||
| ARGN ${ARGN} | ||
| ) | ||
|
|
||
| if(NOT EXISTS "${XML}") | ||
| message(FATAL_ERROR "px4_add_external_mavlink_dialect: XML not found: ${XML}") | ||
| endif() | ||
|
|
||
| get_filename_component(_dialect_name "${XML}" NAME_WE) | ||
| set(_mavlink_defs "${PX4_SOURCE_DIR}/src/modules/mavlink/mavlink/message_definitions/v1.0") | ||
|
|
||
| configure_file("${XML}" "${_mavlink_defs}/${_dialect_name}.xml" COPYONLY) | ||
|
|
||
| set_property(GLOBAL APPEND PROPERTY PX4_EXTERNAL_MAVLINK_DIALECTS "${_dialect_name}") | ||
|
|
||
| message(STATUS "External MAVLink dialect registered: ${_dialect_name} (from ${XML})") | ||
| endfunction() |
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is cool, but what if I just want to send a message or command, not stream it?