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

Integrate ros2_control and add user documentation #162

Merged
merged 39 commits into from
Apr 20, 2024

Conversation

evan-palmer
Copy link
Collaborator

Changes Made

This is a pretty significant PR that makes several API-breaking changes. In particular, the following breaking changes were made:

  1. blue_dynamics has been ported to hydrodynamics. The new project cleans up the original dynamics implementation and will also make it easier to add new features that are unrelated to Blue (e.g., parsing hydrodynamic parameters from a URDF/SDF file).
  2. blue_control has been re-written using ros2_control and ported to auv_controllers. Controllers will now be easier to implement and are vehicle-agnostic.
  3. ArduSub-specific packages/files including sitl.launch.py, blue_joy, blue_manager, and the PWM passthrough handling have all been ported to ardusub_driver.
    • In the new repo, SITL, MAVROS, and the ArduSub manager can all be launched using the launch files available in
      ardusub_bringup.
    • PWM passthrough is now accomplished in the thruster_hardware package and is implemented as a ros2_control
      hardware interface
    • blue_manager now lives in ardusub_manager and has been cleaned up.
    • The blue_joy package has become ardusub_teleop and now has a joystick configuration file tailored specifically to
      ArduSub.
  4. Launch files were re-written using the new YAML syntax. The new launch files are a MAJOR improvement over the verbose Python launch files that were originally used.
  5. blue_utils has been removed.

Outside of these breaking changes, user documentation has been added with pipelines that deploy the documentation on push to main. The documentation is written using Docusaurus.

Associated Issues

Testing

Testing was done in simulation using SITL.

* Added docs

* Started reintegrating demos

* Cleaned up devcontainer config

* Added demos and vehicle images

* Added links to demo readme

* Added tutorials

* Cleaned up site visualizations and styling

* Updated readme

* Moved citation

* Fixed issues in tutorials

* Fixed ci

* Removed codespell

* Fixed spelling errors

* Fixed dockerignore
@evan-palmer evan-palmer linked an issue Apr 19, 2024 that may be closed by this pull request
@evan-palmer evan-palmer self-assigned this Apr 19, 2024
README.md Outdated Show resolved Hide resolved
@evan-palmer
Copy link
Collaborator Author

CI will continue to fail for rolling until the newest version officially releases here in a month

@evan-palmer evan-palmer merged commit 3709432 into main Apr 20, 2024
5 of 9 checks passed
@evan-palmer evan-palmer deleted the 33-feature-ros2-control branch April 20, 2024 00:53
@evan-palmer
Copy link
Collaborator Author

@mergify backport humble

@evan-palmer
Copy link
Collaborator Author

@mergify backport iron

Copy link

mergify bot commented Apr 20, 2024

backport humble

✅ Backports have been created

Copy link

mergify bot commented Apr 20, 2024

backport iron

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Apr 20, 2024
* Started migration to new controller package and ardusub interface

* Replaced launch files with yaml

* Started integrating new control framework

* Removed old scripts and configuration files; continued ardusub manager integration

* Fixed launch files and started debugging manager

* Fixed mavros configuration file

* Added vscode file

* Working state - need to finish updates to joy package

* Working state all vehicles updated

* Save point before I break things

* Waiting to add demos until i add documentation

* Added docs

* Started reintegrating demos

* Cleaned up devcontainer config

* Added demos and vehicle images

* Added links to demo readme

* Added tutorials

* Cleaned up site visualizations and styling

* Updated readme

* Moved citation

* Fixed issues in tutorials

* Fixed ci

* Removed codespell

* Fixed spelling errors

* Fixed dockerignore

* Added user documentation (#160)

* Added docs

* Started reintegrating demos

* Cleaned up devcontainer config

* Added demos and vehicle images

* Added links to demo readme

* Added tutorials

* Cleaned up site visualizations and styling

* Updated readme

* Moved citation

* Fixed issues in tutorials

* Fixed ci

* Removed codespell

* Fixed spelling errors

* Fixed dockerignore

* Testing docs cd pipeline

* Fixed reference to package-lock

* Added path to docs

* prolly wont work but worth a shot

* take 2

* Another attempt

* Testing

* Removed previous change

* Added separate ci docs pipeline

* Added fixes and switched back to rolling

* Fixed dockerfile ros version

* Fixed readme

(cherry picked from commit 3709432)

# Conflicts:
#	.devcontainer/nouveau/devcontainer.json
#	.devcontainer/nvidia/devcontainer.json
#	blue.repos
mergify bot pushed a commit that referenced this pull request Apr 20, 2024
* Started migration to new controller package and ardusub interface

* Replaced launch files with yaml

* Started integrating new control framework

* Removed old scripts and configuration files; continued ardusub manager integration

* Fixed launch files and started debugging manager

* Fixed mavros configuration file

* Added vscode file

* Working state - need to finish updates to joy package

* Working state all vehicles updated

* Save point before I break things

* Waiting to add demos until i add documentation

* Added docs

* Started reintegrating demos

* Cleaned up devcontainer config

* Added demos and vehicle images

* Added links to demo readme

* Added tutorials

* Cleaned up site visualizations and styling

* Updated readme

* Moved citation

* Fixed issues in tutorials

* Fixed ci

* Removed codespell

* Fixed spelling errors

* Fixed dockerignore

* Added user documentation (#160)

* Added docs

* Started reintegrating demos

* Cleaned up devcontainer config

* Added demos and vehicle images

* Added links to demo readme

* Added tutorials

* Cleaned up site visualizations and styling

* Updated readme

* Moved citation

* Fixed issues in tutorials

* Fixed ci

* Removed codespell

* Fixed spelling errors

* Fixed dockerignore

* Testing docs cd pipeline

* Fixed reference to package-lock

* Added path to docs

* prolly wont work but worth a shot

* take 2

* Another attempt

* Testing

* Removed previous change

* Added separate ci docs pipeline

* Added fixes and switched back to rolling

* Fixed dockerfile ros version

* Fixed readme

(cherry picked from commit 3709432)

# Conflicts:
#	.devcontainer/nouveau/devcontainer.json
#	.devcontainer/nvidia/devcontainer.json
#	blue.repos
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant