acid-drop

- Hacking the planet from a LilyGo T-Deck using custom firmware
git clone git://git.acid.vegas/acid-drop.git
Log | Files | Refs | Archive | README | LICENSE

Si4431.h (1790B)

      1 #if !defined(_RADIOLIB_SI4431_H)
      2 #define _RADIOLIB_SI4431_H
      3 
      4 #include "../../TypeDef.h"
      5 
      6 #if !defined(RADIOLIB_EXCLUDE_SI443X)
      7 
      8 #include "../../Module.h"
      9 #include "Si4432.h"
     10 
     11 /*!
     12   \class Si4431
     13 
     14   \brief Derived class for %Si4431 modules.
     15 */
     16 class Si4431: public Si4432 {
     17   public:
     18 
     19     // constructor
     20 
     21     /*!
     22       \brief Default constructor.
     23 
     24       \param mod Instance of Module that will be used to communicate with the radio chip.
     25     */
     26     Si4431(Module* mod);
     27 
     28     // basic methods
     29 
     30     /*!
     31       \brief Initialization method. Must be called at least once from Arduino sketch to initialize the module.
     32 
     33       \param freq Carrier frequency in MHz. Allowed values range from 240.0 MHz to 930.0 MHz.
     34 
     35       \param br Bit rate of the FSK transmission in kbps (kilobits per second). Allowed values range from 0.123 to 256.0 kbps.
     36 
     37       \param freqDev Frequency deviation of the FSK transmission in kHz. Allowed values range from 0.625 to 320.0 kbps.
     38 
     39       \param rxBw Receiver bandwidth in kHz. Allowed values range from 2.6 to 620.7 kHz.
     40 
     41       \param power Transmission output power in dBm. Allowed values range from -8 to 13 dBm in 3 dBm steps.
     42 
     43       \param preambleLen Preamble Length in bits. Defaults to 16 bits.
     44 
     45       \returns \ref status_codes
     46     */
     47     int16_t begin(float freq = 434.0, float br = 4.8, float freqDev = 5.0, float rxBw = 181.1, int8_t power = 10, uint8_t preambleLen = 16);
     48 
     49     // configuration methods
     50 
     51     /*!
     52       \brief Sets output power. Allowed values range from -8 to 13 dBm in 3 dBm steps.
     53 
     54       \param power Output power to be set in dBm.
     55 
     56       \returns \ref status_codes
     57     */
     58     int16_t setOutputPower(int8_t power);
     59 
     60 
     61 #if !defined(RADIOLIB_GODMODE)
     62   protected:
     63 #endif
     64 
     65 #if !defined(RADIOLIB_GODMODE)
     66   private:
     67 #endif
     68 };
     69 
     70 #endif
     71 
     72 #endif