This is the official iCub user-manual. It includes description of the procedures to install (Chapter 14) and maintain the platform, both at the hardware (Chapter 2) and software (Chapters 7 8 9) level. The sections describing the software will also describe how to install and use what is available with the robot and provide guidelines on how to develop new capabilities and algorithms.
- Structure of the manual: this document is an attempt in coalescing the robot knowledge into a linear document/manual. Emphasis on linear.
- How get additional help: please write any question to the robotcub-hackers mailing list.
- How to contribute: we welcome contributions and suggestions, but please add new pages to Section 16. From time to time we will incorporate new pages into the other sections of the manual.
- Citing our work: as researchers we live on citations. We provide a list of papers you are invited to cite in your papers that use the iCub or some of its components, see Section Acknowledgements (below).
- 1 One. Hardware of the iCub
- 2 Two. Troubleshooting of the hardware
- 3 Three. Calibration
- 4 Four. Protocols
- 5 Five. Kinematics and Dynamics
- 6 Six. Software, Installing YARP and iCub
- 7 Seven. Software, YARP
- 8 Eight. Software, dependencies
- 9 Nine. Software, iCub
- 10 Ten. Robot configuration
- 11 Eleven. Standardization of methods
- 12 Twelve. Guidelines
- 13 Thirteen. Documentation
- 14 Fourteen. Committing changes
- 15 Fifteen. How to install the robot
- 16 Sixteen. The iKart mobile platform
- 17 Seventeen. Talking head
- 18 Eighteen. Unofficial documentation
- 19 Nineteen. Known issues and troubleshooting
- 20 Twenty. Doxygen documentation links
- 21 Acknowledgments
One. Hardware of the iCub
To obtain the 3D mechanical drawings (CAD) and 2D production drawings describing the mechanical and electronic parts, please check out the: iCub SVN Repository.
This section overlaps consistently with the Deliverable 8.1 (specifications of the iCub open system). This section of the manual is meant to be used by first opening the bill of materials, reading the component type and then consulting the corresponding description in the subsections below.
The philosophy of this chapter is to provide links and references to the technical documentation and not necessarily to substitute it.
- ICub Project Mechanical Documentation and Design Conventions
- Brushless motors
- DC motors
- Controller cards
- Motorola DSP and CodeWarrior
- Other boards datasheets
- Inertial sensing
- CAN bus interface for debugging (ESD)
- CFW CAN bus interface
- Hall-effect readings, electronics
- Force/torque sensors, electronics
- Face specifications and control
- Power supply
- Wiring, general diagrams and details of the connections NEW!!!
- Encoder magnets
- Springs, belts and cables
- CPU board PC104
- Ball bearings
- Commercial mechanical parts
- Commercial electronic parts
- iCub stand
- iCub plastic covers
- Available iCub versions
Two. Troubleshooting of the hardware
- Tendons replacement
- Common problems and solutions
- iCub required maintenance and cabling tool: list as xls file
- In any case you can post your questions to the robotcub-hackers mailing list.
- Initial calibration of the iCub:
- Fine calibration of the iCub:
- Calibration types available on iCub and R1 robots
Five. Kinematics and Dynamics
- iCub joints specification: naming, conventions
- iCub joints limits: CAD, hardware, software limits
- iCub Forward Kinematic specification, D-H parameters (unmodified convention):
- Vergence, version and binocular disparity quantities for motor control Vergence, Version and Disparity.
- iKin: library for forward\inverse kinematic and control tasks; some iKin-based modules (e.g. iKinArmCtrlIF) are available as well. iKin requires IPOPT. Look how to install IPOPT here: Installing IPOPT.
- iCub dynamics
- iDyn: generic library for dynamics
Six. Software, Installing YARP and iCub
Seven. Software, YARP
- The architecture
- The YARP companion and YARP executables
- Scriptable stuff
- CMake files, preparation
- Basic OS classes
- Basic communication classes
- Advanced OS classes
- Advanced communication classes
- Device drivers, existing
- Device drivers, how to write a new one, tutorial on building a new device in YARP. Important: see also how to compile the iCub devices
- YARP documentation, a general tutorial, and additional Wiki pages on Yarp
Eight. Software, dependencies
Compiling YARP and iCub requires some dependencies are met.
- Libraries, supported compilers and tools:
- List of Dependencies
- Installation instructions: see Section 6.
- On the robot: Device drivers
Nine. Software, iCub
This section explains how the software is organized. Here you will find more details about how we the repository, modules and applications.
- The Linux on the pc104
- Configuration files
- iCub architecture, an introduction
- Software interface: standard port names for hardware devices
- Documentation of key modules
- iCubInterface documentation and configuration file description.
- Framegrabber parameters: Dragonfly Parameters
- Getting 640x480 images at framerate: Getting 640x480 images
- ControlBoard config file
- Using force control on iCub
- >>> NEW: controlling the iCub with new Yarp interfaces iControlMode and iInteractionMode <<<
- Camera Calibration
- The ODE simulator is installed with the software (see Section 6)
- Firmware update tools
- List of CAN addresses and associated firmware.
- Other software tools:
- Online documentation for tools: http://wiki.icub.org/iCub/main/dox/html/group__icub__tools.html
- Guis: http://wiki.icub.org/iCub/main/dox/html/group__icub__guis.html
- Note on firmware versions: firmware versions
- Firmware source and build: more firmware in repository
- Starting up the iCub: see here
- Learning about the software:
- Some iCub code tutorials: http://wiki.icub.org/iCub/main/dox/html/icub_tutorials.html
- Interoperability with other languages and middleware
Ten. Robot configuration
- documentation regarding the configuration of ethernet based robots: see here
Eleven. Standardization of methods
- Organization of the repository:
- Organization of sources, binaries, applications and config files
- New repository. This page contains a long description of the new build system, namespaces and file conventions.
- Applications. This page contains a descriptions about how applications are stored in the repository and installed.
- CMake Usage
- Modules, standardization, configuration
Here we describe better practices for software development on the iCub.
- Writing new documentation
- Where is the documentation?
- Documents that aren't connected to the source code
Fourteen. Committing changes
Fifteen. How to install the robot
ADDED NEW VIDEOS !!!
- How to install the robot: Installation of the robot.
- Installation instructions for the iCub laptop/server: Laptop installation instructions.
- Temporary page: upgrading repositories to svn: Upgrading the pc104 software repositories to subversion.
Sixteen. The iKart mobile platform
- Installation and usage of the iKart mobile platform is described in the iKart manual
Seventeen. Talking head
- Talking head documentation
Eighteen. Unofficial documentation
Place here pages contributed by users.
- Instructions for compilation on Mac OS have been moved to the installation page (see Section 6).
- SSH remote calls. Getting SSH to read your environment variables
Nineteen. Known issues and troubleshooting
In this section we include a list of known issues and suggestions on how to troubleshoot them:
See Chapter 12 for iCub and YARP documentation.
A list of links to existing documentation for various iCub-related projects.
From non-standard repositories...
- the EU CHRIS project (FP7 ICT-215805): click here
- the EU ITALK project (FP7 ICT-214668):click here
- the EU EFAA project (FP7 ICT-270490): click here
- the EU Xperience project (FP7 ICT-270273): click here
In need of documentation...
- the EU RoboSKIN project middleware (FP7 ICT-231500), see www.roboskin.eu
This is a list of people how contributed to the manual: List people who contributed to this manual.
Citing our work. We warmly invite you to cite the following papers when you use the iCub or one of its components in your work: Citations.