You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**libfranka** is a C++ library that provides low-level control of Franka Robotics research robots. The `API References <https://frankarobotics.github.io/docs/libfranka/docs/api_references.html>`_ offers an overview of its capabilities, while the `Franka Control Interface (FCI) documentation <https://frankarobotics.github.io/docs>`_ provides more information on setting up the robot and utilizing its features and functionalities.
8
+
**libfranka** is a C++ library that provides low-level control of Franka Robotics research robots.
9
+
The `API References <https://frankarobotics.github.io/docs/libfranka/docs/api_references.html>`_ offers an overview of its capabilities,
10
+
while the `Franka Control Interface (FCI) documentation <https://frankarobotics.github.io/docs>`_ provides more information on setting up the robot and utilizing its features and functionalities.
9
11
10
12
To find the appropriate version to use, please refer to the `Robot System Version Compatibility <https://frankarobotics.github.io/docs/libfranka/docs/compatibility_with_images.html>`_.
11
13
@@ -40,26 +42,33 @@ Before using **libfranka**, ensure your system meets the following requirements:
To use libfranka version ``0.14.0`` or later, you will need to install `pinocchio <https://stack-of-tasks.github.io/pinocchio/download.html>`_ and some more dependencies:
45
+
3. Install from Debian Package - Generic Pattern
46
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
47
+
48
+
**Check your architecture:**
44
49
45
50
.. code-block:: bash
46
51
47
-
sudo apt-get install -y lsb-release curl
48
-
sudo mkdir -p /etc/apt/keyrings
49
-
curl -fsSL http://robotpkg.openrobots.org/packages/debian/robotpkg.asc | sudo tee /etc/apt/keyrings/robotpkg.asc
52
+
dpkg --print-architecture
53
+
54
+
**Download and install:**
50
55
51
56
.. code-block:: bash
52
57
53
-
echo"deb [arch=amd64 signed-by=/etc/apt/keyrings/robotpkg.asc] http://robotpkg.openrobots.org/packages/debian/pub $(lsb_release -cs) robotpkg"| sudo tee /etc/apt/sources.list.d/robotpkg.list
Replace ``<version>`` with the desired release version (e.g., ``0.18.1``) and ``<architecture>`` with your system architecture (e.g., ``amd64`` or ``arm64``).
If you prefer to build **libfranka** inside a Docker container, you can use the provided Docker setup. This ensures a consistent build environment and avoids dependency conflicts on your host system.
@@ -231,7 +240,7 @@ Expected output:
231
240
232
241
.. _building-from-source:
233
242
234
-
4. Building and Installation from Source
243
+
5. Building and Installation from Source
235
244
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
236
245
237
246
Before building and installing from source, please uninstall existing installations of libfranka to avoid conflicts:
@@ -299,14 +308,18 @@ This command creates a Debian package named libfranka-<version>-<architecture>.d
299
308
300
309
sudo dpkg -i libfranka*.deb
301
310
302
-
Installing via a Debian package simplifies the process compared to building from source every time. Additionally the package integrates better with system tools and package managers, which can help manage updates and dependencies more effectively.
311
+
Installing via a Debian package simplifies the process compared to building from source every time. Additionally the package integrates better with
312
+
system tools and package managers, which can help manage updates and dependencies more effectively.
303
313
304
314
.. _usage:
305
315
306
-
5. Usage
316
+
6. Usage
307
317
~~~~~~~~
308
318
309
-
After installation, check the `Minimum System and Network Requirements <https://frankarobotics.github.io/docs/requirements.html>`_ for network settings, the `Operating System and PC Configuration <https://frankarobotics.github.io/docs/installation_linux.html#setting-up-the-real-time-kernel>`_ for system setup, and the `Getting Started Manual <https://frankarobotics.github.io/docs/getting_started.html#>`_ for initial steps. Once configured, you can control the robot using the example applications provided in the examples folder.
319
+
After installation, check the `Minimum System and Network Requirements <https://frankarobotics.github.io/docs/libfranka/docs/system_requirements.html>`_ for network settings,
320
+
the `Setting up the Real-Time Kernel <https://frankarobotics.github.io/docs/libfranka/docs/real_time_kernel.html>`_ for system setup,
321
+
and the `Getting Started Manual <https://frankarobotics.github.io/docs/libfranka/docs/getting_started.html>`_ for initial steps. Once configured,
322
+
you can control the robot using the example applications provided in the examples folder (`Usage Examples <https://frankarobotics.github.io/docs/libfranka/docs/usage_examples.html>`_).
310
323
311
324
To run a sample program, navigate to the build folder and execute the following command:
312
325
@@ -316,14 +329,16 @@ To run a sample program, navigate to the build folder and execute the following
316
329
317
330
.. _pylibfranka:
318
331
319
-
6. Pylibfranka
332
+
7. Pylibfranka
320
333
~~~~~~~~~~~~~~
321
334
322
-
Pylibfranka is a Python binding for libfranka, allowing you to control Franka robots using Python. It is included in the libfranka repository and can be built alongside libfranka. For more details, see ``pylibfranka`` and its `README <pylibfranka/README.md>`_. The `generated API documentation <https://frankarobotics.github.io/libfranka/pylibfranka/latest>`_ offers an overview of its capabilities.
335
+
Pylibfranka is a Python binding for libfranka, allowing you to control Franka robots using Python. It is included in the libfranka repository and
336
+
can be built alongside libfranka. For more details, see ``pylibfranka`` and its `README <pylibfranka/README.md>`_.
337
+
The `generated API documentation <https://frankarobotics.github.io/libfranka/pylibfranka/latest>`_ offers an overview of its capabilities.
323
338
324
339
.. _development-information:
325
340
326
-
7. Development Information
341
+
8. Development Information
327
342
~~~~~~~~~~~~~~~~~~~~~~~~~~
328
343
329
344
If you actively contribute to this repository, you should install and set up pre-commit hooks:
@@ -333,7 +348,8 @@ If you actively contribute to this repository, you should install and set up pre
333
348
pip install pre-commit
334
349
pre-commit install
335
350
336
-
This will install pre-commit and set up the git hooks to automatically run checks before each commit. The hooks will help maintain code quality by running various checks like code formatting, linting, and other validations.
351
+
This will install pre-commit and set up the git hooks to automatically run checks before each commit.
352
+
The hooks will help maintain code quality by running various checks like code formatting, linting, and other validations.
337
353
338
354
To manually run the pre-commit checks on all files:
0 commit comments