ICub coding basics: Difference between revisions
Jump to navigation
Jump to search
m (→myModule) |
m (moved RobotCub coding basics to ICub coding basics: RobotCub -> iCub) |
||
(20 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
Refer to [[ | 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 = | = General guides = | ||
Highly recommended: | Highly recommended: | ||
* http:// | * http://wiki.icub.org/wiki/Summary_of_iCub_Software_Development_Guidelines | ||
* http:// | * http://wiki.icub.org/wiki/ICub_Documentation_Guidelines | ||
* http:// | * http://wiki.icub.org/wiki/ICub_File_Organization_Guidelines | ||
= Specific tutorials = | = Specific tutorials = | ||
* | * Tutorials on motor commands and basic image processing: http://wiki.icub.org/wiki/ICub_Tutorials | ||
== Resource Finder == | == Resource Finder == | ||
* http:// | * 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 | * 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:// | * 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 == | == YARP ports == | ||
* basic: http:// | * basic: http://wiki.icub.org/yarpdoc/df/d05/note_ports.html | ||
* advanced: http:// | * advanced: http://wiki.icub.org/yarpdoc/db/dfb/port_expert.html | ||
* Bottle class, useful for exchanging data among modules: http:// | * 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 = | = 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 and documentation standards | 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: | ||
* [http://robotcub.svn.sf.net/viewvc/robotcub/trunk/iCub/main/src/examples/demoModule/ demoModule] | |||
* http:// | * http://wiki.icub.org/wiki/The_myModule_Example (referred to at the bottom of the [http://wiki.icub.org/wiki/Summary_of_iCub_Software_Development_Guidelines Summary of iCub Software Development Guidelines]) | ||
= | = See also = | ||
* [http://wiki.icub.org/wiki/How_to_write_a_module How to write a module] | |||
* http:// | * [http://wiki.icub.org/wiki/Software_interface:_standard_port_names_for_hardware_devices Software interface: standard port names for hardware devices] | ||
* http:// | |||
[[Category:Vislab]] | [[Category:Vislab]] | ||
[[Category:C++]] | [[Category:C++]] | ||
[[Category:YARP]] | [[Category:YARP]] |
Latest revision as of 10:31, 7 April 2014
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)