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

ArduSub 4.1 Initial Docs #52

Conversation

ES-Alexander
Copy link
Collaborator

@ES-Alexander ES-Alexander commented Dec 16, 2022

First incremental info - just params and MAVLink messages. I wanted to do this as a more complete whole, but it's taking too long / going too slowly with the other stuff that's going on, so I'm figuring (partly after discussing with @Williangalvani) that it's better to make the "ready" high quality stuff generally available since it's already a potentially useful resource.

Generation Commands

For future-proofing, assumes that ArduPilot/ardupilot#22424 has been merged, and that ArduPilot/ardupilot#22424 has been merged and backported to the Sub-4.1 branch.

MAVLink parser script requires Python >= 3.11, and should use the most recent version of pymavlink for an up to date list of MAVLink messages and commands.

BRANCH=Sub-4.1
git clone -b $BRANCH https://github.com/ArduPilot/ardupilot.git
cd ardupilot
git submodule update --init --recursive

BRDOC=1
export BRDOC
python3 Tools/autotest/param_metadata/param_parse.py --vehicle ArduSub --format md
unset BRDOC

python3 Tools/scripts/mavlink_parse.py --vehicle ArduSub --header ArduSub --include-commands --include-stream-groups --include-unsupported

Copy link
Member

@patrickelectric patrickelectric left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work!

It would be nice if you could add in the PR body the code that was used to generate such files, or add as a comment in the generated files with the necessary arguments.

developers/mavlink_messages.md Show resolved Hide resolved
@patrickelectric patrickelectric merged commit 5ff8a72 into bluerobotics:ArduSub-4.1 Dec 16, 2022
@ES-Alexander ES-Alexander deleted the ArduSub-4.1-transfer-initial branch December 17, 2022 02:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants