diff --git a/keywords.txt b/keywords.txt index 664dee11..ab7dcfdb 100644 --- a/keywords.txt +++ b/keywords.txt @@ -9,6 +9,8 @@ RadioLib KEYWORD1 RadioShield KEYWORD1 Module KEYWORD1 +Hal KEYWORD1 +ArduinoHal KEYWORD1 # modules CC1101 KEYWORD1 diff --git a/src/ArduinoHal.h b/src/ArduinoHal.h index 79df17b3..8a0044c5 100644 --- a/src/ArduinoHal.h +++ b/src/ArduinoHal.h @@ -16,7 +16,18 @@ class ArduinoHal : public Hal { public: + /*! + \brief Arduino Hal constructor. Will use the default SPI interface and automatically initialize it. + */ 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); void init() override; diff --git a/src/Module.h b/src/Module.h index ce0ee954..4ff07380 100644 --- a/src/Module.h +++ b/src/Module.h @@ -106,13 +106,13 @@ class Module { \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);