Difference between revisions of "Modules - Standard v0.1"

From Asibot & HOAP3 & TEO Wiki
Jump to navigation Jump to search
Line 1: Line 1:
 
This page should contain guidelines for designing new modules for the software architecture. The intention of this is to keep internal coherence and compatability with RoboticsLab robot modules who follow this standard. A list of available modules can be found at the [http://roborepo.uc3m.es/w/index.php/A_Description_of_Modules description of modules] page.
 
This page should contain guidelines for designing new modules for the software architecture. The intention of this is to keep internal coherence and compatability with RoboticsLab robot modules who follow this standard. A list of available modules can be found at the [http://roborepo.uc3m.es/w/index.php/A_Description_of_Modules description of modules] page.
−
 
−
* Each directory in the trunk folder structure should contains modules that represent the same single block in the control block diagram.
 
−
* Interfaces should be the same throughout all the modules in the same directory, to assure interchangability.
 
−
* When the module is a hardware interface, it is recommended to create a dummy (fake) module too for debugging purposes of other modules in absence of hardware component or simulator equivalent.
 
−
* Each module name should contain (in order, lower-cased, and separated by underscores):
 
−
** A three letter prefix that represents the name of the parent directory.
 
−
** A description of its implementation.
 
−
* Each port should contain:
 
−
** The description of the module implementation.
 
−
** The short-nomenclature data type identifier.
 
−
* Each internal variable related with communication (bottle, int...) should contain:
 
−
** The descriptor such as 'bottle', 'int'...
 
−
** The short-nomenclature data type identifier.
 
−
** The I/O identifier: 'i' for input, 'o' for output, 'io' for input/output.
 
−
 
−
\** Example **\
 
−
Parent Directory: drivers
 
−
  Module: drv_fake
 
−
  Ports: fake_q
 
−
  Internal Parameters: bottle_q_i, bottle_q_o, double_q_i[], double_q_o[]...
 

Revision as of 19:17, 8 March 2010

This page should contain guidelines for designing new modules for the software architecture. The intention of this is to keep internal coherence and compatability with RoboticsLab robot modules who follow this standard. A list of available modules can be found at the description of modules page.

Retrieved from "https://apps-robots.uc3m.es/robots/w/index.php?title=Modules_-_Standard_v0.1&oldid=119"