Franka Control Interface Documentation
Note
The software and its documentation support two different robots, the Franka Research 3 (FR3) and an older Franka Robotics Robot (FER or Panda).
The Franka Control Interface (FCI) can be accessed via several open source components which we provide on GitHub. We welcome contributions and suggestions for improvements.
These components are:
libfranka
, a C++ library that provides low-level control of Franka Robotics research robots. Its source code is available at https://github.com/frankaemika/libfranka. API documentation is available at https://frankaemika.github.io/libfranka.
franka_ros
, our ROS integration, including support for ROS Control and MoveIt!. It also containsfranka_description
, a collection of URDF models and 3D meshes that can be useful outside of ROS. The repository is available at https://github.com/frankaemika/franka_ros.
franka_ros2
The repository is available at https://github.com/frankaemika/franka_ros2.
Franka MATLAB®
provides a Simulink and a Matlab API, together with helper functions and tools, for rapid-prototyping in Real-Time on the Franka Robot” Franka MATLAB® artifacts can be obtained at Franka World.
The source code of this documentation is also available online.
Important
Before you start using the FCI, please read through the documents shipped with the robot and the Minimum system and network requirements chapter.
Note
Using a robot with system version 4.2.0 or higher requires to enable the FCI mode. To do that open Desk -> expand the menu in the sidebar -> press ‘Activate FCI’. Further information about Single Point of Control (SPoC) can be found in the manual shipped with the robot.
- Overview
- Minimum system and network requirements
- Compatible versions
- Installation on Linux
- Installation on Windows
- Getting started
- libfranka
- libfranka changelog
- 0.14.0 - 2024-09-05
- 0.13.4 - 2024-09-05
- 0.13.3 - 2024-01-18
- 0.13.2 - 2023-12-04
- 0.13.1 - 2023-11-30
- 0.13.0 - 2023-11-16
- 0.12.1 - 2023-09-20
- 0.12.0 - 2023-09-14
- 0.11.0 - 2023-08-16
- 0.10.0 - 2022-09-02
- 0.9.2 - 2022-08-31
- 0.9.1 - 2022-08-26
- 0.9.0 - 2022-03-25
- 0.8.0 - 2020-04-29
- 0.7.1 - 2019-07-08
- 0.7.0 - 2019-07-05
- 0.6.0 - 2019-02-06
- 0.5.0 - 2018-08-08
- 0.4.0 - 2018-06-21
- 0.3.0 - 2018-02-22
- 0.2.0 - 2018-01-29
- 0.1.0 - 2017-09-15
- franka_ros
- franka_ros changelog
- 0.10.2 - UNRELEASED
- 0.10.1 - 2022-09-15
- 0.10.0 - 2022-09-02
- 0.9.1 - 2022-08-29
- 0.9.0 - 2022-03-29
- 0.8.2 - 2022-02-22
- 0.8.1 - 2021-09-08
- 0.8.0 - 2021-08-03
- 0.7.1 - 2020-10-22
- 0.7.0 - 2020-07-15
- 0.6.0 - 2018-08-08
- 0.5.0 - 2018-06-28
- 0.4.1 - 2018-06-21
- 0.4.0 - 2018-03-26
- 0.3.0 - 2018-02-22
- 0.2.2 - 2018-01-31
- 0.2.1 - 2018-01-30
- 0.2.0 - 2018-01-29
- 0.1.2 - 2017-10-10
- 0.1.1 - 2017-10-09
- 0.1.0 - 2017-09-15
- franka_ros2
- franka_ros2 changelog
- 0.1.15 - 2024-06-21
- 0.1.14 - 2024-05-13
- 0.1.13 - 2024-01-18
- 0.1.12 - 2024-01-12
- 0.1.11 - 2023-12-20
- 0.1.10 - 2023-12-04
- 0.1.9 - 2023-12-04
- 0.1.8 - 2023-11-16
- 0.1.7 - 2023-11-10
- 0.1.6 - 2023-11-03
- 0.1.5 - 2023-10-13
- 0.1.4 - 2023-09-26
- 0.1.3 - 2023-08-24
- 0.1.2 - 2023-08-21
- 0.1.1 - 2023-08-21
- 0.1.0 - 2023-07-28
- Franka MATLAB Toolbox
- Franka MATLAB Toolbox changelog
- Robot and interface specifications
- FR3 certification remarks
- Troubleshooting
- Cannot boot realtime kernel because of “Invalid Signature”
- Running a libfranka executable fails with “Connection timeout”
- Motion stopped due to discontinuities or
communication_constraints_violation
- Robot is not reachable
- Running a libfranka executable fails with “UDP receive: Timeout”
- Network bandwidth, delay and jitter test
- Running a libfranka executable fails with “Incompatible Library Version”
- Running a libfranka executable fails with “command rejected due to activated safety function!” or “command preempted due to activated safety function!”
- FAQ