forks/RadioLibSmol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated module template

Browse source
This commit is contained in:
jgromes 2020-07-04 15:09:14 +02:00
parent 57b46386e8
commit e60435d57c
1 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
extras/ModuleTemplate.h
View file

@ -12,14 +12,16 @@
If at any point you are unsure about the required style, please refer to the rest of the modules. If at any point you are unsure about the required style, please refer to the rest of the modules.
*/ */
#if !defined(_RADIOLIB_<module_name>_H) && !defined(RADIOLIB_EXCLUDE_<module_name>)
#ifndef _RADIOLIB_<module_name>_H #ifndef _RADIOLIB_<module_name>_H
#define _RADIOLIB_<module_name>_H #define _RADIOLIB_<module_name>_H
/* /*
Header file for each module MUST include Module.h. Header file for each module MUST include Module.h and TypeDef.h in the src folder.
The header file MAY include additional header files. The header file MAY include additional header files.
*/ */
#include "Module.h" #include "../../Module.h"
#include "../../TypeDef.h"
/* /*
Only use the following include if the module implements methods for OSI transport layer control. Only use the following include if the module implements methods for OSI transport layer control.
@ -29,7 +31,7 @@
You also MUST provide crystal oscillator frequency and frequency configuration divisor step resolution You also MUST provide crystal oscillator frequency and frequency configuration divisor step resolution
to the TransportLayer constructor. to the TransportLayer constructor.
*/ */
//#include "../protocols/TransportLayer.h" //#include "../../protocols/PhysicalLayer/TransportLayer.h"
/* /*
Only use the following include if the module implements methods for OSI physical layer control. Only use the following include if the module implements methods for OSI physical layer control.
@ -37,7 +39,7 @@
In this case, your class MUST implement all virtual methods of PhysicalLayer class. In this case, your class MUST implement all virtual methods of PhysicalLayer class.
*/ */
//#include "../protocols/PhysicalLayer.h" //#include "../../protocols/PhysicalLayer/PhysicalLayer.h"
/* /*
Register map Register map
@ -74,7 +76,7 @@ class <module_name> {
The class MAY implement additional overloaded constructors. The class MAY implement additional overloaded constructors.
*/ */
// constructor // constructor
<module_name>(Module* module); <module_name>(Module* mod);
/* /*
The class MUST implement at least one basic method called "begin". The class MUST implement at least one basic method called "begin".
@ -105,3 +107,5 @@ class <module_name> {
}; };
#endif #endif
#endif