<span \mainpage
The role of this code is to manage the Poppy 2.0 communication stack between all modules.
It is the basic library used to create new modules, you can use it to develop you own !
To understand how this protocole work, please read the protocol definition.
First of all you have to fork this repository to create your hown module on your github account. scr folder contain the lib source code you sould not modifying it to keep compliance with other modules. To avoid any trouble during future updates of the poppy-pross lib, take care to not modifying any files in the src folder or create a specific branch for all your developpements.
In this repo travis is used to create documentation, update readme, and pass some tests. To activate all this things you have to follow some steps :
- enable your repo on travis and on coveralls.
- Create an encrypted token for travis.
- replace your encrypted token to the .travis.yml file of this repo.
To have a perfect integration and declaration of your module into a poppy 2.0 network you have to:
- specify your module in the mod_list.h list.
- specify your MCU on the Makefile.
- specify your MAINCLOCK frequency on the Makefile.
- specify your SCLFREQ to specify the I2C max speed on the Makefile.
- create your specific hal folder if you need. To do that please read the new hal creation documentation.
You can use the template.c file to format your main file and use it as base.
If you have any question please describe it in the Poppy project forum.