Skip to content

Commit

Permalink
updating doc
Browse files Browse the repository at this point in the history
  • Loading branch information
mhubii committed May 13, 2024
1 parent 8100e25 commit 5a4fd86
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ ROS 2 packages for the KUKA LBR, including communication to the real robot via t
</body>

## Documentation
Full documentation available [here](https://lbr-stack.readthedocs.io/en/latest).
Full documentation available on [Read the Docs](https://lbr-stack.readthedocs.io/en/latest).

## Quick Start
1. Install ROS 2 development tools
Expand Down Expand Up @@ -67,7 +67,7 @@ Full documentation available [here](https://lbr-stack.readthedocs.io/en/latest).
> [!TIP]
> List all arguments for the launch file via `ros2 launch lbr_bringup bringup.launch.py -s`

Now, run the [demos](https://lbr-fri-ros2-stack-doc.readthedocs.io/en/humble/lbr_fri_ros2_stack/lbr_demos/doc/lbr_demos.html). To get started with the real robot, checkout the [Documentation](https://lbr-stack.readthedocs.io/en/latest) above.
Now, run the [demos](https://lbr-stack.readthedocs.io/en/latest/lbr_fri_ros2_stack/lbr_demos/doc/lbr_demos.html). To get started with the real robot, checkout the [Hardware Setup](https://lbr-stack.readthedocs.io/en/latest/lbr_fri_ros2_stack/lbr_fri_ros2_stack/doc/hardware_setup.html).

## Citation
If you enjoyed using this repository for your work, we would really appreciate ❤️ if you could cite it, as it helps us to continue offering support.
Expand Down
2 changes: 1 addition & 1 deletion docker/doc/docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To run the ``lbr_fri_ros2_stack`` in a Docker container, follow the instructions
cp -r src/lbr_fri_ros2_stack/docker/* .
chmod +x container_build.sh
sudo ./container_build.sh 1.15 # replace by your FRI client version
sudo ./container_build.sh
#. Inside the container, launch e.g. simulation via (might require re-launch after Gazebo launched first time)

Expand Down
2 changes: 1 addition & 1 deletion lbr_demos/doc/lbr_demos.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
lbr_demos
=========
Contolling the LBR through ROS 2 control.
Contolling the LBR through ``ros2_control``.

.. note::
Some demos require a real robot. Make sure you followed :doc:`Hardware Setup <../../lbr_fri_ros2_stack/doc/hardware_setup>` first.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Admittance Controller

.. code-block:: bash
ros2 run lbr_demos_a dvanced_cpp admittance_control --ros-args \
ros2 run lbr_demos_advanced_cpp admittance_control --ros-args \
-r __ns:=/lbr \
--params-file `ros2 pkg prefix lbr_demos_advanced_cpp`/share/lbr_demos_advanced_cpp/config/admittance_control.yaml
Expand Down
4 changes: 2 additions & 2 deletions lbr_fri_ros2/doc/lbr_fri_ros2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ The ``lbr_fri_ros2`` package extends the FRI with:
#. :lbr_fri_ros2:`AsyncClient <lbr_fri_ros2::AsyncClient>` for asynchronous communication to the hardware
#. :lbr_fri_ros2:`App <lbr_fri_ros2::App>` for running the :lbr_fri_ros2:`AsyncClient <lbr_fri_ros2::AsyncClient>` asynchronously

An overview of the software architecture is shown :ref:`below <software architecture figure>`:
The software architecture is shown :ref:`below <lbr_fri_ros2 software architecture figure>` (click to expand):

.. _software architecture figure:
.. _lbr_fri_ros2 software architecture figure:
.. thumbnail:: img/lbr_fri_ros2_v1.5.0.svg
:alt: lbr_fri_ros2

Expand Down
22 changes: 22 additions & 0 deletions lbr_ros2_control/doc/lbr_ros2_control.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,24 @@
lbr_ros2_control
================
.. note::

- This package builds on top of :ref:`lbr_fri_ros2`
- For demo usage refer to :ref:`lbr_demos`
- Refer to `ros2_control <https://control.ros.org/humble/index.html>`_ for additional documentation

Relation to ros2_control
------------------------
The ``ros2_control`` relation is shown :ref:`below <lbr_ros2_control software architecture figure>` (click to expand):

.. _lbr_ros2_control software architecture figure:
.. thumbnail:: img/lbr_ros2_control_v1.5.0.svg
:alt: lbr_ros2_control




async etc
controller manager
system interface
controllers
lbr_fri_ros2

0 comments on commit 5a4fd86

Please sign in to comment.