|
1 | | -.. lbr_fri_ros2_stack documentation master file, created by |
2 | | - sphinx-quickstart on Mon Apr 24 11:26:22 2023. |
3 | | - You can adapt this file completely to your liking, but it should at least |
4 | | - contain the root `toctree` directive. |
| 1 | +LBR-Stack |
| 2 | +========= |
| 3 | +The ``LBR-Stack`` hosts community contributed extensions to KUKA's Fast Robot Interface (FRI) for accelerated research and deployment. The FRI is KUKA's library for commanding the ``LBR`` over a UDP connection. |
5 | 4 |
|
6 | | -.. include:: lbr_fri_ros2_stack/README.md |
7 | | - :parser: myst_parser.sphinx_ |
| 5 | +The ``LBR-Stack`` provides ``CMake`` support for the FRI. This is further used for ``ROS 2`` integration and ``Python`` bindings, as shown :ref:`below <lbr_stack fri dependency architecture figure>`: |
| 6 | + |
| 7 | +.. _lbr_stack fri dependency architecture figure: |
| 8 | +.. thumbnail:: ../img/fri_dependency_architecture.svg |
| 9 | + :alt: fri_dependency_architecture |
| 10 | + |
| 11 | +Further documentation is available for: |
| 12 | + |
| 13 | +* `FRI CMake Support <fri/README.html>`_: To see available FRI versions. |
| 14 | +* `ROS 2 Integration <lbr_fri_ros2_stack/README.html>`_: ROS 2 packages around the FRI and the LBR (simulation, system integration, safe execution utilities, research, deployment). |
| 15 | +* `Python Bindings <pyfri/README.html>`_: Write custom FRI applications without compilation (reserach, experienced users). |
| 16 | +* :doc:`Hardware Setup <lbr_fri_ros2_stack/lbr_fri_ros2_stack/doc/hardware_setup>`: Java application installation instructions. |
| 17 | + |
| 18 | +.. toctree:: |
| 19 | + :hidden: |
| 20 | + :caption: FRI CMake Support |
| 21 | + |
| 22 | + fri |
8 | 23 |
|
9 | 24 | .. toctree:: |
10 | 25 | :hidden: |
11 | | - :caption: Packages |
| 26 | + :caption: ROS 2 Integration |
12 | 27 |
|
13 | 28 | lbr_fri_ros2_stack/lbr_fri_ros2_stack/doc/lbr_fri_ros2_stack |
14 | 29 | lbr_fri_ros2_stack/lbr_bringup/doc/lbr_bringup |
|
18 | 33 | lbr_fri_ros2_stack/docker/doc/docker |
19 | 34 | lbr_fri_ros2_stack/lbr_moveit_config/doc/lbr_moveit_config |
20 | 35 | lbr_fri_idl |
21 | | - fri |
| 36 | + |
| 37 | +.. toctree:: |
| 38 | + :hidden: |
| 39 | + :caption: Python Bindings |
| 40 | + |
| 41 | + pyfri/doc/pyfri |
22 | 42 |
|
23 | 43 | .. toctree:: |
24 | 44 | :hidden: |
|
34 | 54 | docs/kuka_documentation |
35 | 55 | Paper <https://arxiv.org/pdf/2311.12709> |
36 | 56 | contributing |
37 | | - Source Code <https://github.com/lbr-stack/lbr_fri_ros2_stack/tree/humble> |
38 | | - Changelog <https://github.com/lbr-stack/lbr_fri_ros2_stack/releases> |
| 57 | + source_code |
| 58 | + changelog |
0 commit comments