Skip to content

Commit

Permalink
Merge pull request #107 in SWDEV/docs from feature/PRCUN-2284-introdu…
Browse files Browse the repository at this point in the history
…ce-franka-robotics-naming to master

* commit 'e6b1ed294d934b4ce63f52781dd6d1447ac4fe67':
  chore: Updating Franka Emika to Franka Robotics
  • Loading branch information
AndreasKuhner committed Dec 22, 2023
2 parents 75912b9 + e6b1ed2 commit 89c6e3b
Show file tree
Hide file tree
Showing 11 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion NOTICE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
docs

Copyright 2017 Franka Emika GmbH
Copyright 2023 Franka Robotics GmbH

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion source/compatibility.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ are part of libfranka-common repository, a submodule of libfranka repository.
Franka Matlab compatible versions are located :ref:`here<compatibility-franka-matlab>`.

.. caution::
Franka Emika currently does not provide any support for Windows or Arm
Franka Robotics currently does not provide any support for Windows or Arm

Compatibility with the kernel
-----------------------------
Expand Down
4 changes: 2 additions & 2 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@

# General information about the project.
project = 'Franka Control Interface (FCI)'
copyright = '2017, Franka Emika GmbH'
author = 'Franka Emika GmbH'
copyright = '2023, Franka Robotics GmbH'
author = 'Franka Robotics GmbH'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down
2 changes: 1 addition & 1 deletion source/fr3-certification-remarks.csv
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Chapter,Content,Applicable for FR3,Comment
1,ABOUT FRANKA EMIKA,fully,
1,ABOUT Franka Robotics,fully,
2,RIGHTS OF USE AND PROPERTY RIGHTS,fully,
2.1,General,fully,
2.2,Identification,fully,
Expand Down
6 changes: 3 additions & 3 deletions source/franka_matlab/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@

# General information about the project.
project = 'Franka Control Interface (FCI)'
copyright = '2017, Franka Emika GmbH'
author = 'Franka Emika GmbH'
copyright = '2023, Franka Robotics GmbH'
author = 'Franka Robotics GmbH'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -163,4 +163,4 @@
'Franka Control Interface Documentation', author,
'fci', 'Franka Control Interface',
'Miscellaneous'),
]
]
8 changes: 4 additions & 4 deletions source/franka_matlab/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ Franka Matlab
The design of the current libraries and tools in the package take as a given that the **build & execution will be performed in the same machine that is running the current Matlab session**. Therefore when we use the term
**"deployment", the local PC is targeted**. Manual deployment to other target PCs is of course possible.

Franka Matlab contains the following main components for interfacing the Franka Emika Robot through Matlab & Simulink:
Franka Matlab contains the following main components for interfacing the Franka Robotics Robot through Matlab & Simulink:

* ``Simulink Franka Library``, a set of simulink blocks for interfacing the Franka Emika Robot, for rapid-prototyping and evaluation of control algorithms.
* ``Simulink Franka Library``, a set of simulink blocks for interfacing the Franka Robotics Robot, for rapid-prototyping and evaluation of control algorithms.

.. figure:: _static/simulink_library_browser.png
:align: center
:figclass: align-center

Simulink Library for rapid-prototyping of controllers for the Franka Emika robot.
Simulink Library for rapid-prototyping of controllers for the Franka Robotics robot.

* ``Matlab Franka Library``, a set of helper matlab functions for reading current the robot state and applying some simple open loop motion commands.

Expand All @@ -39,4 +39,4 @@ Franka Matlab contains the following main components for interfacing the Franka
simulink_library
matlab_library
franka_matlab_changelog
troubleshooting
troubleshooting
4 changes: 2 additions & 2 deletions source/franka_matlab/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ FR3 robot. For installing the previous libfranka version you can initialize the
>> mex_franka_matlab_library();
After the init script is completed you can start utilizing the Simulink and Matlab scripts for the Franka Emika robot.
After the init script is completed you can start utilizing the Simulink and Matlab scripts for the Franka Robotics robot.

.. hint::
It is highly recommended to start with the provided Simulink demos before writing custom applications from scratch.
Expand Down Expand Up @@ -105,4 +105,4 @@ or for the previous libfranka version:
>> init_franka_matlab('0.9.2');
Press `Y` when prompted for automatically installing libfranka.
Press `Y` when prompted for automatically installing libfranka.
4 changes: 2 additions & 2 deletions source/franka_matlab/simulink_library.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Get Model

Get robot model numeric values Simulink Block.

This Simulink block will deliver the numerical values of the Model of the Franka Emika robot. For an analytical
This Simulink block will deliver the numerical values of the Model of the Franka Robotics robot. For an analytical
description of the available signals see -->
`Robot Model Signals <https://frankaemika.github.io/libfranka/classfranka_1_1Model.html>`_

Expand All @@ -116,4 +116,4 @@ The get gripper state block will inform the application about the current grippe
.. hint::
Highly recommended to have a look at the
`GripperState Struct Reference <https://frankaemika.github.io/libfranka/structfranka_1_1GripperState.html>`_
for the list of available signals and the demo `grasp_objects.slx` which is provided for getting started.
for the list of available signals and the demo `grasp_objects.slx` which is provided for getting started.
2 changes: 1 addition & 1 deletion source/franka_ros.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ the URDF format according to the `URDF XML documentation <http://wiki.ros.org/ur

In case you want to simulate the Panda robot, you can pass a ``gazebo`` argument to the XACRO file.
Then the URDF will contain *estimated* inertias values, i.e. link masses and inertia tensors based
on the `Dynamic Identification of the Franka Emika Panda Robot With Retrieval of Feasible Parameters Using
on the `Dynamic Identification of the Franka Robotics Panda Robot With Retrieval of Feasible Parameters Using
Penalty-Based Optimization <https://hal.inria.fr/hal-02265293/file/IROS_19_Panda.pdf>`_.

.. code-block:: shell
Expand Down
4 changes: 2 additions & 2 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Franka Control Interface Documentation
.. note::

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

.. todolist::

Expand All @@ -14,7 +14,7 @@ for improvements.

These components are:

* ``libfranka``, a C++ library that provides low-level control of Franka Emika research robots.
* ``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 <https://wiki.ros.org/franka_ros>`_, including support for
Expand Down
2 changes: 1 addition & 1 deletion source/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You also get access to the robot model library which provides:
* Jacobian matrix of all robot joints.
* Dynamics: inertia matrix, Coriolis and centrifugal vector and gravity vector.

In addition, ``franka_ros`` connects Franka Emika research robots with the entire ROS ecosystem.
In addition, ``franka_ros`` connects Franka Robotics research robots with the entire ROS ecosystem.
It integrates ``libfranka`` into `ROS Control <https://wiki.ros.org/ros_control>`_.
Additionally, it includes `URDF <https://wiki.ros.org/urdf>`_ models and detailed 3D meshes of our
robots and end effectors, which allows visualization (e.g. RViz) and kinematic simulations.
Expand Down

0 comments on commit 89c6e3b

Please sign in to comment.