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

fix documentation

Browse source
This commit is contained in:
Mestery 2023-04-16 21:05:35 +02:00
parent e141f4f151
commit 6695133576
3 changed files with 17 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
keywords.txt
View file

@ -9,6 +9,8 @@
RadioLib KEYWORD1 RadioLib KEYWORD1
RadioShield KEYWORD1 RadioShield KEYWORD1
Module KEYWORD1 Module KEYWORD1
Hal KEYWORD1
ArduinoHal KEYWORD1
# modules # modules
CC1101 KEYWORD1 CC1101 KEYWORD1

11
src/ArduinoHal.h
View file

@ -16,7 +16,18 @@
class ArduinoHal : public Hal { class ArduinoHal : public Hal {
public: public:
/*!
\brief Arduino Hal constructor. Will use the default SPI interface and automatically initialize it.
*/
ArduinoHal(); ArduinoHal();
/*!
\brief Arduino Hal constructor. Will not attempt SPI interface initialization.
\param spi SPI interface to be used, can also use software SPI implementations.
\param spiSettings SPI interface settings.
*/
ArduinoHal(SPIClass& spi, SPISettings spiSettings = RADIOLIB_DEFAULT_SPI_SETTINGS); ArduinoHal(SPIClass& spi, SPISettings spiSettings = RADIOLIB_DEFAULT_SPI_SETTINGS);
void init() override; void init() override;

8
src/Module.h
View file

@ -106,13 +106,13 @@ class Module {
\param hal A Hardware abstraction layer instance. An ArduinoHal instance for example. \param hal A Hardware abstraction layer instance. An ArduinoHal instance for example.
\param cs Arduino pin to be used as chip select. \param cs Pin to be used as chip select.
\param irq Arduino pin to be used as interrupt/GPIO. \param irq Pin to be used as interrupt/GPIO.
\param rst Arduino pin to be used as hardware reset for the module. \param rst Pin to be used as hardware reset for the module.
\param gpio Arduino pin to be used as additional interrupt/GPIO. \param gpio Pin to be used as additional interrupt/GPIO.
*/ */
Module(Hal *hal, uint8_t cs, uint8_t irq, uint8_t rst, uint8_t gpio = RADIOLIB_NC); Module(Hal *hal, uint8_t cs, uint8_t irq, uint8_t rst, uint8_t gpio = RADIOLIB_NC);