The software needed to control the NICO robot is based on PyPot and other Python libraries and offers a ROS interface. It also includes all necessary files to simulate a NICO in V-REP. Please be aware that the development of the NICO is an ongoing process, which means that both the software and the virtual NICO model are not final and may contain errors depending on the functionality that you need.
To install the software, please follow the steps below:
1. Cloning repository
The first step is to clone the repository. You can achieve this by using the following command:
$ git clone https://github.com/knowledgetechnologyuhh/NICO-software.git
2. Setup API
The setup of the API is automatically done via a setup script which installs all necessary libraries and builds the API with all interfaces. For the setup to succeed, make sure you have ROS installed (catkin_make is started by the installer) and that the ROS environment variables are correctly set (i.e. by "source /opt/ros/indigo/setup.bash" on Ubuntu)
Start the setup script with:
$ source api/NICO-setup.bash
If you need additional python libraries in conjunction with the API, include them in the setup script by adding the corresponding "pip install" commands to it or contact the current API maintainer to do so.
The API and the script have been tested on the following system and software versions:
Framework/Dependency |
Version(s) |
Comments |
Ubuntu |
14.04 |
|
Python |
2.7 |
Should be compatible with Python3 |
PyPot |
3.0.3 |
|
V-REP |
V.3.3.0 64Bit |
|
Gazebo |
|
|
ROS |
Indigo |
|
Dependencies will be updated and the API tested on the new version at the beginning of each semester. We will update the table with each successful install. If you have successfully installed the API on a version not listed, please let us( strahl"AT"informatik.uni-hamburg.de) know!
3. Build Documentation
We use Sphinx to build the documentation. Install Sphinx, either from a distribution package or from PyPI with
$ pip install Sphinx
To build the API documentation change to the "api-doc" folder and run (depending on what documentation you want to build):
$ make <target>
The resulting documentation can be found at the api-doc/_build folder.
Example: For a stand-alone HTML documentation, run
$ make html
The resulting documentation can be found _build/html/.