Repository Summary
Checkout URI | https://github.com/frankaemika/libfranka.git |
VCS Type | git |
VCS Version | main |
Last Updated | 2024-09-13 |
Dev Status | DEVELOPED |
CI status | No Continuous Integration |
Released | RELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
Name | Version |
---|---|
libfranka | 0.15.0 |
README
libfranka: C++ Library for Franka Robotics Research Robots
libfranka is a C++ library that provides low-level control of Franka Robotics research robots. The generated API documentation offers an overview of its capabilities, while the Franka Control Interface (FCI) documentation provides more information on setting up the robot and utilizing its features and functionalities.
To find the appropriate version to use, please refer to the Compatibility Matrix.
Key Features
- Low-level control: Access precise motion control for research robots.
- Real-time communication: Interact with the robot in real-time.
Getting Started
1. System Requirements
Before using libfranka, ensure your system meets the following requirements:
- Operating System: Linux with PREEMPT_RT patched kernel (Ubuntu 16.04 or later, Ubuntu 22.04 recommended)
- Compiler: GCC 7 or later
- CMake: Version 3.10 or later
- Robot: Franka Robotics robot with FCI feature installed
2. Installing dependencies
sudo apt-get update
sudo apt-get install -y \
build-essential \
cmake \
git \
libpoco-dev \
libeigen3-dev \
dpkg
To use libfranka version 0.14.0
or later, you will need to install pinocchio and some more dependencies:
sudo apt-get install -y \
liburdfdom-headers-dev \
libconsole-bridge-dev \
libtinyxml2-dev
sudo apt-get install -qqy lsb-release curl
mkdir -p /etc/apt/keyrings
curl http://robotpkg.openrobots.org/packages/debian/robotpkg.asc \
| sudo tee /etc/apt/keyrings/robotpkg.asc
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
sudo apt-get update \
&& sudo apt-get install -qqy robotpkg-pinocchio
3. Building and Installation from Source
Before building and installing from source, please uninstall existing installations of libfranka to avoid conflicts:
sudo apt remove "*libfranka*"
Clone the Repository
You can clone the repository and choose the version you need by selecting a specific tag:
# Clone the repository
git clone --recursive https://github.com/frankaemika/libfranka.git
cd libfranka
# List available tags
git tag -l
# Checkout a specific tag (e.g., 0.14.1)
git checkout 0.14.1
# Update submodules
git submodule update
# Create a build directory and navigate to it
mkdir build
cd build
# Configure the project and build
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=OFF ..
cmake --build .
Installing libfranka as a Debian Package (Optional but recommended)
Building a Debian package is optional but recommended for easier installation and management. In the build folder, execute:
cpack -G DEB
This command creates a Debian package named libfranka-
sudo dpkg -i libfranka*.deb
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.
4. Usage
After installation, check the Minimum System and Network Requirements for network settings, the Operating System and PC Configuration for system setup, and the Getting Started Manual for initial steps. Once configured, you can control the robot using the example applications provided in the examples folder.
To run a sample program, navigate to the build folder and execute the following command:
./examples/communication_test <robot-ip>
License
libfranka
is licensed under the Apache 2.0 license.
CONTRIBUTING
Repository Summary
Checkout URI | https://github.com/frankaemika/libfranka.git |
VCS Type | git |
VCS Version | master |
Last Updated | 2022-08-31 |
Dev Status | DEVELOPED |
CI status | No Continuous Integration |
Released | RELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
README
libfranka: C++ library for Franka Emika research robots
With this library, you can control research versions of Franka Emika robots. See the Franka Control Interface (FCI) documentation for more information about what libfranka
can do and how to set it up. The generated API documentation also gives an overview of its capabilities.
License
libfranka
is licensed under the Apache 2.0 license.
CONTRIBUTING
Repository Summary
Checkout URI | https://github.com/frankaemika/libfranka.git |
VCS Type | git |
VCS Version | master |
Last Updated | 2022-08-31 |
Dev Status | DEVELOPED |
CI status | No Continuous Integration |
Released | RELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
README
libfranka: C++ library for Franka Emika research robots
With this library, you can control research versions of Franka Emika robots. See the Franka Control Interface (FCI) documentation for more information about what libfranka
can do and how to set it up. The generated API documentation also gives an overview of its capabilities.
License
libfranka
is licensed under the Apache 2.0 license.
CONTRIBUTING
Repository Summary
Checkout URI | https://github.com/frankaemika/libfranka.git |
VCS Type | git |
VCS Version | master |
Last Updated | 2022-08-31 |
Dev Status | DEVELOPED |
CI status | No Continuous Integration |
Released | RELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
README
libfranka: C++ library for Franka Emika research robots
With this library, you can control research versions of Franka Emika robots. See the Franka Control Interface (FCI) documentation for more information about what libfranka
can do and how to set it up. The generated API documentation also gives an overview of its capabilities.
License
libfranka
is licensed under the Apache 2.0 license.
CONTRIBUTING
Repository Summary
Checkout URI | https://github.com/frankaemika/libfranka.git |
VCS Type | git |
VCS Version | master |
Last Updated | 2022-08-31 |
Dev Status | DEVELOPED |
CI status | No Continuous Integration |
Released | RELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
README
libfranka: C++ library for Franka Emika research robots
With this library, you can control research versions of Franka Emika robots. See the Franka Control Interface (FCI) documentation for more information about what libfranka
can do and how to set it up. The generated API documentation also gives an overview of its capabilities.
License
libfranka
is licensed under the Apache 2.0 license.