Skip to content

Rover: Remove deprecated module #25054

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

Merged
merged 4 commits into from
Jul 10, 2025
Merged

Conversation

chfriedrich98
Copy link
Contributor

@chfriedrich98 chfriedrich98 commented Jun 16, 2025

Solved Problem

Remove the old rover module. its gazebo classic airframes, the related mavros test and the documentation.
This module has been fully replaced by the new rover type specific modules for ackermann, differential and mecanum.

@chfriedrich98 chfriedrich98 requested a review from sfuhrer June 16, 2025 13:46
@chfriedrich98 chfriedrich98 self-assigned this Jun 16, 2025
@chfriedrich98 chfriedrich98 added the Rover 🚙 Rovers and other UGV label Jun 16, 2025
Copy link
Contributor

@sfuhrer sfuhrer left a comment

Choose a reason for hiding this comment

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

Did you check if you also have to remove some documentation? E.g. for the gazebo classic rover frames?

@chfriedrich98 chfriedrich98 force-pushed the pr-rover_remove_deprecated_module branch from 1288e36 to bfe60cc Compare June 17, 2025 09:55
@chfriedrich98
Copy link
Contributor Author

rebased on main (no changes)

@chfriedrich98
Copy link
Contributor Author

@sfuhrer

Did you check if you also have to remove some documentation? E.g. for the gazebo classic rover frames?

Good point!
Removed the documentation for the deprecated module and for the gazebo classic simulation

@chfriedrich98 chfriedrich98 requested a review from sfuhrer June 17, 2025 11:05
@sfuhrer
Copy link
Contributor

sfuhrer commented Jun 17, 2025

@hamishwillee can you advise on this CI failure?
Christian removed an asset the surrounding text from the English docs, but now the other language versions are missing the asset.

@chfriedrich98 chfriedrich98 force-pushed the pr-rover_remove_deprecated_module branch from a565643 to 6115696 Compare June 18, 2025 06:27
@chfriedrich98
Copy link
Contributor Author

rebased on main and cleaned up commits (no changes)

@chfriedrich98 chfriedrich98 moved this to 👀 In Review in PX4 Rover Jun 18, 2025
sfuhrer
sfuhrer previously approved these changes Jun 18, 2025
@chfriedrich98
Copy link
Contributor Author

Rebase on main to fix the merge issues in the documentation caused by #25103.
No changes to the first 2 commits.

@chfriedrich98 chfriedrich98 force-pushed the pr-rover_remove_deprecated_module branch from a5e447e to a80c094 Compare June 25, 2025 09:19
Copy link
Member

@Jaeyoung-Lim Jaeyoung-Lim left a comment

Choose a reason for hiding this comment

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

Does this mean that we don't support rover in gz classic anymore?

@chfriedrich98
Copy link
Contributor Author

@Jaeyoung-Lim

Does this mean that we don't support rover in gz classic anymore?

Yes. The new rover modules never supported gz classic and the thought process is that since that version of gazebo has reached its end of life in january, it is not worth the effort to make the new modules "backwards compatible" (which is not straight forward).
What is your opinion on this?

Also I am currently working on overhauling the gz harmonic simulations for rovers by adding more/improved models and solving the licencing issues we had in PX4/PX4-gazebo-models#67.

@Jaeyoung-Lim
Copy link
Member

Jaeyoung-Lim commented Jun 25, 2025

@chfriedrich98 Makes sense from a maintanance perspective, but might be sad for some people who have been using rover.

However, I think this is your call and probably best for rover moving forward. Could you then please remove all the rover models from gazebo classic submodule as well?

@hamishwillee hamishwillee force-pushed the pr-rover_remove_deprecated_module branch from a80c094 to a45b9f0 Compare June 26, 2025 04:19
@hamishwillee
Copy link
Contributor

hamishwillee commented Jun 26, 2025

@hamishwillee can you advise on this CI failure? Christian removed an asset the surrounding text from the English docs, but now the other language versions are missing the asset.

Not caused by this. There was a file that should have been deleted referencing a removed asset.

I fixed in another PR and rebased this on main, and it should disappear.

@chfriedrich98 It can be useful to delete a translation along with the English version of a file. I normally leave that though and sort it all out in a post process.

@hamishwillee
Copy link
Contributor

@chfriedrich98

  1. Did you also search for the filenames of the deleted files? I think there might be a break in the v1.16 release note
  2. Can you add a doc release note in main.md
  3. Thank you. LGTM.

I think this is a good thing to do, though I would love it if it was a "swap" - i.e. new rover enabled in firmware by default and the old rover something you could add with a module. But perhaps a clean break is for the best - this is already much better.

Does this mean there will be room for the new rover modules in standard builds?

@hamishwillee hamishwillee added the Documentation 📑 Anything improving the documentation of the code / ecosystem label Jun 26, 2025
@chfriedrich98
Copy link
Contributor Author

@Jaeyoung-Lim

Could you then please remove all the rover models from gazebo classic submodule as well?

Will do 👍

@chfriedrich98
Copy link
Contributor Author

@hamishwillee

Does this mean there will be room for the new rover modules in standard builds?

For some boards it might, but boards like v5x or v6x didn't have the old module enabled so unfortunately this doesn't clear up any space on those.

@chfriedrich98 chfriedrich98 force-pushed the pr-rover_remove_deprecated_module branch from a45b9f0 to 701a7a1 Compare June 30, 2025 07:08
@chfriedrich98 chfriedrich98 force-pushed the pr-rover_remove_deprecated_module branch from 701a7a1 to e5efa2e Compare June 30, 2025 07:15
@chfriedrich98
Copy link
Contributor Author

Rebased to get doc changes from #25103.

@chfriedrich98
Copy link
Contributor Author

@hamishwillee

It can be useful to delete a translation along with the English version of a file.

Deleted the translation files in e5efa2e.

Can you add a doc release note in main.md

Added in e5efa2e.

@Pedro-Roque
Copy link
Member

@chfriedrich98 perhaps a way to address Jaey's comment would be to have a doc linked, with the release notes of the deprecated module, explaining how to get the same funcitonality from the new ones.

@chfriedrich98
Copy link
Contributor Author

@Pedro-Roque

perhaps a way to address Jaey's comment would be to have a doc linked, with the release notes of the deprecated module, explaining how to get the same funcitonality from the new ones.

I created a complete step-by-step guide on how to setup rovers and the new modules offer way more features/costumization then the old one.
The documentation for the old module was very limited, so if someone wants to start using PX4 for rovers (or used the old module) they are much better off by following the new step-by-step guide than searching for similarities between the old and new modules.

@chfriedrich98 chfriedrich98 force-pushed the pr-rover_remove_deprecated_module branch from e5efa2e to 53c41c0 Compare July 2, 2025 06:29
@chfriedrich98
Copy link
Contributor Author

Rebased on main to resolve merge issues caused by #25139 and combined doc commits into one.
No actual changes.

@Jaeyoung-Lim
Copy link
Member

@chfriedrich98 Reminder to remove models from gz classic

Could you then please remove all the rover models from gazebo classic submodule as well?

@chfriedrich98 chfriedrich98 force-pushed the pr-rover_remove_deprecated_module branch from 53c41c0 to 49109ec Compare July 9, 2025 06:43
@chfriedrich98
Copy link
Contributor Author

rebased to resolve merge issues of the docs changes

@chfriedrich98
Copy link
Contributor Author

@Jaeyoung-Lim

Reminder to remove models from gz classic

Removed them here: PX4/PX4-SITL_gazebo-classic#1071

Copy link

No flaws found

@chfriedrich98 chfriedrich98 merged commit 14c0908 into main Jul 10, 2025
73 checks passed
@chfriedrich98 chfriedrich98 deleted the pr-rover_remove_deprecated_module branch July 10, 2025 08:12
@github-project-automation github-project-automation bot moved this from 👀 In Review to ✅ Done in PX4 Rover Jul 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation 📑 Anything improving the documentation of the code / ecosystem Rover 🚙 Rovers and other UGV
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

5 participants