Description
This aims to improve the structure of the packages, by renaming, deleting unnecessary code and adding proper documentation before it is released:
Now we have epuck_ros2_cpp but it should be language agnostic, so I think it should be renamed to epuck_ros2_driver
There is a Python implementation of the driver in epuck_ros2. That implementation doesn't implement as many features as in epuck_ros2_cpp and we have much better performances with epuck_ros2_cpp. To avoid maintaining the code and not to create confusion I think this should be deleted.
epuck_ros2 should depend on epuck_ros2_cpp and epuck_ros2_camera, and it should provide a mechanism to launch nodes from these packages.
[x] Delete Python driver implementation from epuck_ros2
[x] Create launch file in epuck_ros2 that is able to run nodes from epuck_ros2_driver and epuck_ros2_camera
[x] Add documentation
[x] epuck_ros2 does not depends on epuck_ros2_camera and epuck_ros2_camera is ignored. This has to be resolved
[x] Exclude MMAL related files from build process in CI (if -DAVOID_EPUCK_CAMERA_BUILD is defined MMAL will be excluded from the build process, otherwise no changes)
[x] As epuck_ros2_camera is now part of code quality verification resolve linter errors
[x] Verify if everything works on Raspberry Pi
Additional Context
ROS2 installation tutorial will be properly written later with #18.
For organizing documentation I followed this package:
short documentation in the repo root, with CI and references to more thoughtful documentation,
in the main package (epuck_ros2 in our case) there is no README,
every other package has a short explanation and
most of the documentation is located on the external website.
Description This aims to improve the structure of the packages, by renaming, deleting unnecessary code and adding proper documentation before it is released:
epuck_ros2_cppbut it should be language agnostic, so I think it should be renamed toepuck_ros2_driverepuck_ros2. That implementation doesn't implement as many features as inepuck_ros2_cppand we have much better performances withepuck_ros2_cpp. To avoid maintaining the code and not to create confusion I think this should be deleted.epuck_ros2should depend onepuck_ros2_cppandepuck_ros2_camera, and it should provide a mechanism to launch nodes from these packages.Related Issues Fixes #9 Also, this is related to this PR: https://github.com/cyberbotics/webots_ros2/pull/69
Tasks
epuck_ros2_cpptoepuck_ros2_driverepuck_ros2epuck_ros2that is able to run nodes fromepuck_ros2_driverandepuck_ros2_cameraepuck_ros2does not depends onepuck_ros2_cameraandepuck_ros2_camerais ignored. This has to be resolved-DAVOID_EPUCK_CAMERA_BUILDis defined MMAL will be excluded from the build process, otherwise no changes)epuck_ros2_camerais now part of code quality verification resolve linter errorsAdditional Context ROS2 installation tutorial will be properly written later with #18.
For organizing documentation I followed this package:
epuck_ros2in our case) there is no README,Building the packages in development on RPi: