Skip to content

Commit

Permalink
docs: split for better copy
Browse files Browse the repository at this point in the history
  • Loading branch information
jlblancoc committed Jan 24, 2025
1 parent b8cf132 commit cbf79c4
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,8 @@ How to install all MOLA modules:
ros-$ROS_DISTRO-mola-state-estimation \
ros-$ROS_DISTRO-mola-lidar-odometry
.. code-block:: bash
# (OPTIONAL) Install example small datasets to run demos/unit tests:
sudo apt install ros-$ROS_DISTRO-mola-test-datasets
Expand All @@ -195,6 +197,8 @@ How to install all MOLA modules:
# If a GUI app is opened, it means installation was successful.
mm-viewer
.. code-block:: bash
# You can also test the mola LO cli interface:
mola-lidar-odometry-cli --help
Expand Down
8 changes: 8 additions & 0 deletions docs/source/ros2api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -216,10 +216,13 @@ Documented parameters:
ros2 service call /mola_runtime_param_set mola_msgs/srv/MolaRuntimeParamSet \
"{parameters: \"mola::LidarOdometry:lidar_odom:\n active: true\n\"}"
.. code-block:: bash
# active: false
ros2 service call /mola_runtime_param_set mola_msgs/srv/MolaRuntimeParamSet \
"{parameters: \"mola::LidarOdometry:lidar_odom:\n active: false\n\"}"
- ``mapping_enabled``: Whether MOLA-LO should update the localmap (``true``) or just use
it in localization-only mode (``false``).

Expand All @@ -231,10 +234,13 @@ Documented parameters:
ros2 service call /mola_runtime_param_set mola_msgs/srv/MolaRuntimeParamSet \
"{parameters: \"mola::LidarOdometry:lidar_odom:\n mapping_enabled: true\n\"}"
.. code-block:: bash
# mapping_enabled: false
ros2 service call /mola_runtime_param_set mola_msgs/srv/MolaRuntimeParamSet \
"{parameters: \"mola::LidarOdometry:lidar_odom:\n mapping_enabled: false\n\"}"
- ``generate_simplemap``: Whether MOLA-LO should build the keyframes-based map (apart of the local metric map),
so you end up with a ``*.simplemap`` file.

Expand All @@ -246,6 +252,8 @@ Documented parameters:
ros2 service call /mola_runtime_param_set mola_msgs/srv/MolaRuntimeParamSet \
"{parameters: \"mola::LidarOdometry:lidar_odom:\n generate_simplemap: true\n\"}"
.. code-block:: bash
# generate_simplemap: false
ros2 service call /mola_runtime_param_set mola_msgs/srv/MolaRuntimeParamSet \
"{parameters: \"mola::LidarOdometry:lidar_odom:\n generate_simplemap: false\n\"}"

0 comments on commit cbf79c4

Please sign in to comment.