Franka Control Interface Documentation
======================================

.. note::

  The software and its documentation support two different robots, the
  `Franka Research 3 (FR3) <https://franka.de/research>`_ and an older Franka Robotics Robot (FER or Panda).

.. note::
  此页面为 `官方英文版 <https://frankarobotics.github.io/docs/>`_ 的中文翻译版本， 非官方翻译。

  该中文版本由 专注具身智能的  具力智能 维护，如有歧义或未及时更新，请以英文版本为准。
  该文档根据 Apache 2.0 许可证进行授权，转载时请注明来自 **Franka Robotic**，中文翻译来自 **具力智能**。
  
 深圳具力智能是一家专注于智能机器人研发与应用落地的创新型公司，致力于为国内高校、科研机构与企业提供基于 Franka 机器人 的全套智能操作解决方案。公司深耕模仿学习（Imitation Learning）、强化学习（Reinforcement Learning）、扩散策略（Diffusion Policy）与 VLA（Vision-Language-Action）等前沿方向，构建了从数据采集、策略训练到真实部署的一体化平台。具力智能能够为实验室快速搭建具身智能研究环境，提供软硬件集成、教学示例、算法模板与长期技术支持，帮助研究团队高效推进机器人操作、智能交互与自主决策等前沿课题的落地与突破。
 
联系人：WANG CHAO
座机： +86 185 8843 3689
电话：+86 185 8843 3689

.. todolist::

The Franka Control Interface (FCI) can be accessed via several open source components which we
provide on `GitHub <https://github.com/frankarobotics>`_. 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/frankarobotics/libfranka. API documentation is
   available at https://frankarobotics.github.io/libfranka.
 * ``franka_ros``, our `ROS integration <https://wiki.ros.org/franka_ros>`_, including support for
   ROS Control and MoveIt!. It also contains ``franka_description``, a collection of URDF models and
   3D meshes that can be useful outside of ROS.
   The repository is available at https://github.com/frankarobotics/franka_ros.
 * ``franka_ros2`` The repository is available at https://github.com/frankarobotics/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 <https://franka.world/>`_.

The source code of this documentation is also `available online
<https://github.com/frankarobotics/docs>`_.

.. important::
    Before you start using the FCI, please read through the documents shipped with the robot and
    the :doc:`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.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   overview
   requirements
   compatibility
   installation_linux
   getting_started
   libfranka
   franka_ros
   franka_ros2/docs/index
   franka_matlab/index
   franka_matlab/franka_matlab_changelog
   control_parameters
   fr3-certification-remarks
   troubleshooting
   faq