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

Removed reference to AT commands

Browse source
This commit is contained in:
jgromes 2021-11-14 11:34:13 +01:00
parent 8111bc058f
commit c6eb3ee94f
3 changed files with 10 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
extras/decoder/DebugDecoder.py
View file

@ -8,7 +8,6 @@ TODO list:
1. Parse macro values (the names of bits in all registers in header file) 1. Parse macro values (the names of bits in all registers in header file)
2. Failed SPI write handling 2. Failed SPI write handling
3. SX126x/SX128x handling 3. SX126x/SX128x handling
4. AT handling
''' '''

2
extras/template/ModuleTemplate.cpp
View file

@ -17,6 +17,6 @@ int16_t <module_name>::begin() {
/* /*
"begin" method SHOULD implement some sort of mechanism to verify the connection between Arduino and the module. "begin" method SHOULD implement some sort of mechanism to verify the connection between Arduino and the module.
For example, sending AT command for UART modules, or reading a version register for SPI/I2C modules For example, reading a version register
*/ */
} }

30
extras/template/ModuleTemplate.h
View file

@ -13,7 +13,7 @@
*/ */
#if !defined(_RADIOLIB_<module_name>_H) && !defined(RADIOLIB_EXCLUDE_<module_name>) #if !defined(_RADIOLIB_<module_name>_H) && !defined(RADIOLIB_EXCLUDE_<module_name>)
#ifndef _RADIOLIB_<module_name>_H #if !defined(_RADIOLIB_<module_name>_H)
#define _RADIOLIB_<module_name>_H #define _RADIOLIB_<module_name>_H
/* /*
@ -23,16 +23,6 @@
#include "../../Module.h" #include "../../Module.h"
#include "../../TypeDef.h" #include "../../TypeDef.h"
/*
Only use the following include if the module implements methods for OSI transport layer control.
This concerns only modules similar to e.g. ESP8266.
In this case, your class MUST implement all virtual methods of TransportLayer class.
You also MUST provide crystal oscillator frequency and frequency configuration divisor step resolution
to the TransportLayer constructor.
*/
//#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.
This concerns only modules similar to SX127x/RF69/CC1101 etc. This concerns only modules similar to SX127x/RF69/CC1101 etc.
@ -43,7 +33,7 @@
/* /*
Register map Register map
Definition of SPI/I2C register map SHOULD be placed here. The register map SHOULD have two parts: Definition of SPI register map SHOULD be placed here. The register map SHOULD have two parts:
1 - Address map: only defines register names and addresses. Register names MUST match names in 1 - Address map: only defines register names and addresses. Register names MUST match names in
official documentation (datasheets etc.). official documentation (datasheets etc.).
@ -52,11 +42,11 @@
See RF69 and SX127x header files for examples of register maps. See RF69 and SX127x header files for examples of register maps.
*/ */
// <module_name> register map | spaces up to this point // <module_name> register map | spaces up to this point
#define <module_name>_REG_<register_name> 0x00 #define RADIOLIB_<module_name>_REG_<register_name> 0x00
// <module_name>_REG_<register_name> MSB LSB DESCRIPTION // <module_name>_REG_<register_name> MSB LSB DESCRIPTION
#define <module_name>_<register_variable> 0b00000000 // 7 0 <description> #define RADIOLIB_<module_name>_<register_variable> 0b00000000 // 7 0 <description>
/* /*
@ -64,10 +54,8 @@
The module class MAY inherit from the following classes: The module class MAY inherit from the following classes:
1 - ISerial: Interface for Arduino Serial class, intended as a thin wrapper for modules that directly take 1 - PhysicalLayer: In case the module implements methods for OSI physical layer control (e.g. SX127x).
Serial input (e.g. HC-05). 2 - Common class: In case the module further specifies some more generic class (e.g. SX127x/SX1278)
2 - TransportLayer: In case the module implements methods for OSI transport layer control (e.g. ESP8266).
3 - PhysicalLayer: In case the module implements methods for OSI physical layer control (e.g. SX127x).
*/ */
class <module_name> { class <module_name> {
public: public:
@ -90,7 +78,7 @@ class <module_name> {
All implemented methods SHOULD return the status as int16_t type. All implemented methods SHOULD return the status as int16_t type.
*/ */
#ifndef RADIOLIB_GODMODE #if !defined(RADIOLIB_GODMODE)
private: private:
#endif #endif
/* /*