ICub coding basics

Refer to iCub software to learn how to install, compile and update iCub software. Below we will link to tutorials that are useful for people starting up with iCub and YARP coding.

General guides

Highly recommended:

• http://wiki.icub.org/wiki/Summary_of_iCub_Software_Development_Guidelines
• http://wiki.icub.org/wiki/ICub_Documentation_Guidelines
• http://wiki.icub.org/wiki/ICub_File_Organization_Guidelines

Specific tutorials

• Tutorials on motor commands and basic image processing: http://wiki.icub.org/wiki/ICub_Tutorials

Resource Finder

• http://wiki.icub.org/wiki/Resource_finder_overview
• RFModule class documentation (new version of Module class): http://eris.liralab.it/yarpdoc/d9/d26/classyarp_1_1os_1_1RFModule.html
• Using the RFModule helper class to write a program: http://wiki.icub.org/iCub/main/dox/html/icub_resource_finder_basic.html and http://wiki.icub.org/iCub/dox/main/html/icub_resource_finder_advanced.html

YARP ports

• basic: http://wiki.icub.org/yarpdoc/df/d05/note_ports.html
• advanced: http://wiki.icub.org/yarpdoc/db/dfb/port_expert.html
• Bottle class, useful for exchanging data among modules: http://wiki.icub.org/yarpdoc/d3/d3e/classyarp_1_1os_1_1Bottle.html#_details

Examples of modules

The following are good examples of modules from the iCub repository that are generally compliant with iCub configuration guidelines (RFModule class), coding standards (configuration, graceful shut-down, thread-based execution, run-time user interaction) and documentation standards:

• demoModule
• http://wiki.icub.org/wiki/The_myModule_Example (referred to at the bottom of the Summary of iCub Software Development Guidelines)

See also

• How to write a module
• Software interface: standard port names for hardware devices