Creating modules¶
Modules in RIOT are well-defined units of code that provide a set of features to your application. This includes also drivers and to a certain extent ports for CPUs and boards (with some exceptions, see the porting guide for further information).
The general structure ¶
Like applications, modules are directories containing source files and a Makefile. Additionally their API can be defined in one or more header files, residing in the include path of their super-module.
E.g. the Shell module is implemented in sys/shell and defines its API in sys/include/shell.h and the ISL29020 light sensor driver is implemented in drivers/isl29020 and defines its API in drivers/include/isl29020.h.
A module’s Makefile just needs to include Makefile.base in the RIOT repository:
1 | include $(RIOTBASE)/Makefile.base
|
If your module’s name differs from the name of the directory it resides in you need to set the MODULE macro in addition.
When compiled a module always provides a MODULE_<MODULENAME> macro to the system. This way, other modules can check if the module is available in the current configuration or not.
Modules can be used by adding their name to the USEMODULE macro of your application’s Makefile.