Skip to content
RAFCON (RMC advanced flow control) uses hierarchical state machines, featuring concurrent state execution, to represent robot programs. It ships with a graphical user interface supporting the creation of state machines and contains IDE like debugging mechanisms. Alternatively, state machines can programmatically be generated using RAFCON's API.
Python CSS Shell
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github chore(pull_request_template): remove anoying line break Feb 1, 2019
.idea chore(idea config): disable pygobject warning Nov 25, 2019
bin docs(i18-gen-msg): Add comments Aug 29, 2018
doc Merge pull request #785 from common/fix/set-pane-positions Nov 25, 2019
documents docs(preview): Shrink size Jul 9, 2019
idea_default_configs chore(idea): move project file to idea_default_configs Aug 5, 2018
share fix(installation): make font installation work Nov 21, 2019
source/rafcon fix(gui_config): use dark style as gui style Dec 4, 2019
tests fix(backward_preemptive_test): synchronize two parallel branches Nov 22, 2019
.gitignore fix(gitignore): add idea_tests folder Jun 19, 2019
.readthedocs.yaml docs(.readthedocs): Configure RTD using a YAML config file Mar 14, 2019
.zenodo.json chore(CITATION): Make RAFCON citable by providing CITATION.css Dec 5, 2018
AUTHORS docs(AUTHORS): Update list of authors Jul 4, 2018
CITATION.cff chore(VERSION,CITATION): Increase minor Jul 29, 2019
CLA_entities.rst update CLAs May 4, 2017
CLA_individuals.rst update CLAs May 4, 2017
CODE_OF_CONDUCT.rst docs(CODE_OF_CONDUCT): Link to code of conduct from root dir Aug 27, 2018
CONTRIBUTING.rst Link correct file for CONTRIBUTING May 3, 2017
Changelog.rst Documentation: Refactor Dec 16, 2016
LICENSE.md chore(LICENSE): Add full license text markdown-formatted, fixes #621 Nov 20, 2018
MANIFEST.in chore(MANIFEST.in): Include pyproject.toml, required by older setuptools Jul 11, 2019
README.rst docs(install instructions): fix instructions for Ubuntu 18.04 Dec 4, 2019
RMC-Jenkinsfile chore(Jenkinsfile): Use symlink 'default' instead of 'stable/1.2.1' Nov 5, 2019
VERSION docs(VERSION): bump version for release Aug 28, 2019
pyproject.toml chore(pyproject.toml): pytest-runner and libsass are not required Jul 11, 2019
pytest.ini chore(pytest.ini): Use native Python tracebacks for pytest exceptions Jul 26, 2019
rafcon.pt fix(rafcon): path to libraries was changed Jul 12, 2019
requirements-py3.txt fix(requirements): pyyaml is now dependency of yaml_configuration May 7, 2019
requirements.txt fix(requirements): pyyaml is now dependency of yaml_configuration May 7, 2019
seqm.yaml chore(seqm.yaml): Checked and updated each requirement in seqmedit GUI Apr 26, 2019
setup.cfg chore(setup.cfg): build mo files when building dists Jul 25, 2019
setup.py chore(setup.py): fix path to theme for build_sass Aug 1, 2019
tox.ini chore(tox.ini): there should be no need to specify RAFCON_LIB_PATH Jul 12, 2019
tox_external.ini chore(tox.ini): there should be no need to specify RAFCON_LIB_PATH Jul 12, 2019

README.rst

Develop branch: build_status_develop

RAFCON

Screenshot showing RAFCON with a big state machine

Develop your robotic tasks using an intuitive graphical user interface

RAFCON uses hierarchical state machines, featuring concurrent state execution, to represent robot programs. It ships with a graphical user interface supporting the creation of state machines and contains IDE like debugging mechanisms. Alternatively, state machines can programmatically be generated using RAFCON's API.

Universal application

RAFCON is written in Python, can be extended with plugins and is hard- and middleware independent.

Visual programming

The sophisticated graphical editor can be used for the creation, execution and debugging of state machines.

Collaborative working

Share and reuse your state machines in form of libraries, stored as JSON strings in text files.
Example on how to create a simple state machine

Installation preparations

Before installing RAFCON, Python >=2.7, pip and setuptools are required on your system. Most of the other dependencies are automatically resolved by pip/setuptools, but not all of them. Those need be be installed manually, too:

Installation requirements for Ubuntu 16.04

# rafcon needs gtk > 3.20; the easiest way to install it is installing gnome3
sudo add-apt-repository ppa:gnome3-team/gnome3-staging
sudo add-apt-repository ppa:gnome3-team/gnome3
sudo apt update sudo apt dist-upgrade

# restart system

sudo apt-get install python-dev python-pip libcairo2-dev gir1.2-gtksource-3.0 python-gi-cairo
sudo -H pip install --upgrade pip
sudo -H pip install --upgrade setuptools

Installation requirements for Ubuntu 18.04

sudo apt-get install python-dev python-pip build-essential glade python-gi-cairo
sudo -H pip install --upgrade pip
sudo -H pip install --upgrade setuptools

General requirements

If you are not using Ubuntu 16.04 or 18.04, please make sure that the following packages are installed:

  • Python >=2.7
  • pip (recent version required: v18 known to be working)
  • python-setuptools (recent version required: v40 known to be working)

Installing RAFCON

pip install rafcon --user

The --user flag is optional. If not set, RAFCON is installed globally (in this case you normaly need to have root privileges).

If during the installation the error ImportError: No module named cairo occurs, please install pycairo directly via:

pip install --user "pycairo<2.0.0,>=1.10.0"

If you are using Python 3.4, you will need a pip version <= 8. Run the following command, to downgrade pip:

pip install --user --upgrade pip==8

Of course you can also directly use the RAFCON sources from GitHub.

cd /install/directory
git clone https://github.com/DLR-RM/RAFCON rafcon

Start RAFCON

No matter which installation option you choose, RAFCON can be started from any location using (make sure /usr/local/bin or ~/.local/bin is in your PATH environment variable):

rafcon

Uninstallation

If you want to uninstall RAFCON, all you need to do is call

pip uninstall rafcon
You can’t perform that action at this time.