by RoboLab, Aston University, ISIS and many other collaborators.
RoboComp is an open-source Robotics framework providing the tools to create and modify software components that communicate through public interfaces. Components may require, subscribe, implement or publish interfaces in a seamless way. Building new components is done using two domain specific languages, IDSL and CDSL. With IDSL you define an interface and with CDSL you specify how the component will communicate with the world. With this information, a code generator creates C++ and/or Python sources, based on CMake, that compile and execute flawlessly. When some of these features have to be changed, the component can be easily regenerated and all the user specific code is preserved thanks to a simple inheritance mechanism.
If you already have RoboComp installed, jump to tutorials to start coding!
โ If you have a question please look for it in the FAQ.
Coming soon...
Tested in Ubuntu 18.04 (for 16.04 some packages have a different name. Ask in gitter/robocomp)
Make sure you have installed the following packages from the Ubuntu repository:
sudo apt-get update
sudo apt-get install git git-annex cmake g++ libgsl-dev libopenscenegraph-dev cmake-qt-gui zeroc-ice-all-dev freeglut3-dev libboost-system-dev libboost-thread-dev qt4-dev-tools python-pip python-pyparsing python-numpy python-pyside pyside-tools libxt-dev libboost-test-dev libboost-filesystem-dev python-libxml2 python-xmltodict libccd-dev python-zeroc-ice zeroc-ice-all-runtime
sudo pip install networkx
It is recommendable to install the following packages::
sudo apt-get install yakuake qt4-designer
Note: RoboComp uses python2 for now, so make sure that you set python2 as your deafult choide if you also have python3 installed on your system. You can do so by adding this line into your ~/.bashrc file and then save it:
alias python=python2
cd to your home directory (you are probably in it already) and type:
git clone https://github.com/robocomp/robocomp.git
Now we will create a symbolic link so RoboComp can find everything. You will have to enter your password:
sudo ln -s ~ /home/robocomp
(the ~ is in Alt-4)
Edit your ~/.bashrc file
gedit ~/.bashrc
Add these lines at the end:
export ROBOCOMP=~/robocomp
export PATH=$PATH:/opt/robocomp/bin
make bash process the modified file by typing:
source ~/.bashrc
Done! Now let's compile and install the whole thing:
sudo [ -d /opt/robocomp ] && rm -r /opt/robocomp
cd robocomp
mkdir build
cd build
cmake ..
make
sudo make install
If you want to compile Robocomp with support for FCL, follow the instructions in the Robocomp with FCL tutorial.
The RoboComp's core libraries and simulator should now be compiled and installed in /opt/robocomp
.
Let's now tell Linux where to find RoboComp's libraries:
sudo nano /etc/ld.so.conf
and add the following line:
/opt/robocomp/lib/
save the file and type:
sudo ldconfig
Done! Now let's have some fun.
We will first fetch some meshes and textures used by the simulator (it will take a while):
cd ~/robocomp
git annex get .
Now let's run the simulator.
cd ~/robocomp/files/innermodel
rcis simpleworld.xml
You can also use the default innermodel simpleworld.xml anywhere if you have set the ROBOCOMP environment variable.
rcis
Congratulations! RCIS should be up and running with a simple robot endowed with a laser and an RGBD camera, moving on a wooden floor. Don't forget to turn around the floor to see the robot from above.
The software of the robots using RoboComp is composed of different software components working together, communicating among them. What we just installed is just the core of RoboComp (the simulator, a component generator and some libraries). To have other features like joystick control we have to run additional software components available from other repositories, for example robocomp-robolab:
cd ~/robocomp/components
git clone https://github.com/robocomp/robocomp-robolab.git
The RoboLab's set of basic robotics components are now dowloaded. You can see them in ~/robocomp/components/robocomp-robolab/components
If you have a joystick around, connect it to the USB port and:
cd ~/robocomp/components/robocomp-robolab/components/joystickComp
cmake .
make
cd bin
sudo addgroup your-user dialout // To solve some permissions issues in Ubuntu
./startJoyStick.sh
Your joystick should be now running. It will make the robot advance and turn at your will. If the component does not start or the robot does not move stop joystickcomp with:
./forceStopJoyStickComp.sh
and check where the joystick device file has been created (e.g., /dev/input/js0
). If it is not /dev/input/js0
, edit ~/robocomp/components/robocomp-robolab/components/joystickComp/etc/config
change it accordingly and restart. Note that you might want to save the config file to the component's home directory so it does not interfere with future github updates.
If you don't have a JoyStick install this component,
cd ~/robocomp/components/robocomp-robolab/components/keyboardrobotcontroller
cmake .
make
src/keyboardrobotcontroller.py etc/config
and use the arrow keys to navigate the robot, the space bar to stop it an 'q' to exit.
Note 1: You must have your simulator running in a terminal and only then you can run a component in another terminal. You will get an error message if you run the above component without having RCIS already running.
Note 2: If you have anaconda installed (for python 3), It is recommended to uninstall anaconda first and then install robocomp. (It is only applicable if you have faced errors while running above commands.)
You can find more tutorials on RoboComp in tutorials
Drop comments and ask questions in:
Please, report any bugs to [email protected]
If you have any suggestions to improve the repository, like features or tutorials, please contact: [email protected]