diff --git a/_module_8h_source.html b/_module_8h_source.html index e7833134..ed3fea0d 100644 --- a/_module_8h_source.html +++ b/_module_8h_source.html @@ -135,235 +135,261 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
136 
140  uint8_t SPIwriteCommand = 0b10000000;
141 
-
146  bool SPIstreamType = false;
-
147 
-
151  typedef int16_t (*SPIparseStatusCb_t)(uint8_t in);
-
152 
-
157  SPIparseStatusCb_t SPIparseStatusCb = nullptr;
-
158 
-
159  #if defined(RADIOLIB_INTERRUPT_TIMING)
-
160 
-
164  typedef void (*TimerSetupCb_t)(uint32_t len);
-
165 
-
169  TimerSetupCb_t TimerSetupCb = nullptr;
-
170 
-
174  volatile bool TimerFlag = false;
-
175 
-
176  #endif
-
177 
-
178  // basic methods
-
179 
-
183  void init();
-
184 
-
188  void term();
-
189 
-
190  // SPI methods
-
191 
-
203  int16_t SPIgetRegValue(uint8_t reg, uint8_t msb = 7, uint8_t lsb = 0);
+
145  uint8_t SPInopCommand = 0x00;
+
146 
+
150  uint8_t SPIstatusCommand = 0x00;
+
151 
+
155  uint8_t SPIaddrWidth = 8;
+
156 
+
161  bool SPIstreamType = false;
+
162 
+
166  int16_t SPIstreamError = RADIOLIB_ERR_UNKNOWN;
+
167 
+
171  typedef int16_t (*SPIparseStatusCb_t)(uint8_t in);
+
172 
+
177  SPIparseStatusCb_t SPIparseStatusCb = nullptr;
+
178 
+
179  #if defined(RADIOLIB_INTERRUPT_TIMING)
+
180 
+
184  typedef void (*TimerSetupCb_t)(uint32_t len);
+
185 
+
189  TimerSetupCb_t TimerSetupCb = nullptr;
+
190 
+
194  volatile bool TimerFlag = false;
+
195 
+
196  #endif
+
197 
+
198  // basic methods
+
199 
+
203  void init();
204 
-
222  int16_t SPIsetRegValue(uint8_t reg, uint8_t value, uint8_t msb = 7, uint8_t lsb = 0, uint8_t checkInterval = 2, uint8_t checkMask = 0xFF);
-
223 
-
233  void SPIreadRegisterBurst(uint8_t reg, uint8_t numBytes, uint8_t* inBytes);
-
234 
-
242  uint8_t SPIreadRegister(uint8_t reg);
+
208  void term();
+
209 
+
210  // SPI methods
+
211 
+
223  int16_t SPIgetRegValue(uint16_t reg, uint8_t msb = 7, uint8_t lsb = 0);
+
224 
+
242  int16_t SPIsetRegValue(uint16_t reg, uint8_t value, uint8_t msb = 7, uint8_t lsb = 0, uint8_t checkInterval = 2, uint8_t checkMask = 0xFF);
243 
-
253  void SPIwriteRegisterBurst(uint8_t reg, uint8_t* data, uint8_t numBytes);
+
253  void SPIreadRegisterBurst(uint16_t reg, uint8_t numBytes, uint8_t* inBytes);
254 
-
262  void SPIwriteRegister(uint8_t reg, uint8_t data);
+
262  uint8_t SPIreadRegister(uint16_t reg);
263 
-
277  void SPItransfer(uint8_t cmd, uint8_t reg, uint8_t* dataOut, uint8_t* dataIn, uint8_t numBytes);
-
278 
-
300  int16_t SPItransferStream(uint8_t* cmd, uint8_t cmdLen, bool write, uint8_t* dataOut, uint8_t* dataIn, uint8_t numBytes, bool waitForGpio, uint32_t timeout);
-
301 
-
302  // pin number access methods
-
303 
-
309  RADIOLIB_PIN_TYPE getCs() const { return(_cs); }
-
310 
-
316  RADIOLIB_PIN_TYPE getIrq() const { return(_irq); }
-
317 
-
323  RADIOLIB_PIN_TYPE getRst() const { return(_rst); }
-
324 
-
330  RADIOLIB_PIN_TYPE getGpio() const { return(_gpio); }
-
331 
-
348  void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);
-
349 
-
412  void setRfSwitchTable(const RADIOLIB_PIN_TYPE (&pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[]);
-
413 
-
423  const RfSwitchMode_t *findRfSwitchMode(uint8_t mode) const;
-
424 
-
429  void setRfSwitchState(uint8_t mode);
+
273  void SPIwriteRegisterBurst(uint16_t reg, uint8_t* data, uint8_t numBytes);
+
274 
+
282  void SPIwriteRegister(uint16_t reg, uint8_t data);
+
283 
+
297  void SPItransfer(uint8_t cmd, uint16_t reg, uint8_t* dataOut, uint8_t* dataIn, uint8_t numBytes);
+
298 
+
304  int16_t SPIcheckStream();
+
305 
+
321  int16_t SPIreadStream(uint8_t cmd, uint8_t* data, uint8_t numBytes, bool waitForGpio = true, bool verify = true);
+
322 
+
340  int16_t SPIreadStream(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, uint8_t numBytes, bool waitForGpio = true, bool verify = true);
+
341 
+
357  int16_t SPIwriteStream(uint8_t cmd, uint8_t* data, uint8_t numBytes, bool waitForGpio = true, bool verify = true);
+
358 
+
376  int16_t SPIwriteStream(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, uint8_t numBytes, bool waitForGpio = true, bool verify = true);
+
377 
+
399  int16_t SPItransferStream(uint8_t* cmd, uint8_t cmdLen, bool write, uint8_t* dataOut, uint8_t* dataIn, uint8_t numBytes, bool waitForGpio, uint32_t timeout);
+
400 
+
401  // pin number access methods
+
402 
+
408  RADIOLIB_PIN_TYPE getCs() const { return(_cs); }
+
409 
+
415  RADIOLIB_PIN_TYPE getIrq() const { return(_irq); }
+
416 
+
422  RADIOLIB_PIN_TYPE getRst() const { return(_rst); }
+
423 
+
429  RADIOLIB_PIN_TYPE getGpio() const { return(_gpio); }
430 
-
439  void waitForMicroseconds(uint32_t start, uint32_t len);
-
440 
-
441  // Arduino core overrides
-
442 
-
450  void pinMode(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode);
-
451 
-
459  void digitalWrite(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS value);
-
460 
-
468  RADIOLIB_PIN_STATUS digitalRead(RADIOLIB_PIN_TYPE pin);
-
469 
-
477  void tone(RADIOLIB_PIN_TYPE pin, uint16_t value, uint32_t duration = 0);
-
478 
-
484  void noTone(RADIOLIB_PIN_TYPE pin);
-
485 
-
495  void attachInterrupt(RADIOLIB_PIN_TYPE interruptNum, void (*userFunc)(void), RADIOLIB_INTERRUPT_STATUS mode);
-
496 
-
502  void detachInterrupt(RADIOLIB_PIN_TYPE interruptNum);
-
503 
-
507  void yield();
-
508 
-
514  void delay(uint32_t ms);
-
515 
-
521  void delayMicroseconds(uint32_t us);
-
522 
-
526  uint32_t millis();
-
527 
-
531  uint32_t micros();
-
532 
-
536  uint32_t pulseIn(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS state, uint32_t timeout);
-
537 
-
541  void begin();
-
542 
-
546  void beginTransaction();
-
547 
-
551  uint8_t transfer(uint8_t b);
-
552 
-
556  void endTransaction();
-
557 
-
561  void end();
-
562 
-
563  // helper functions to set up SPI overrides on Arduino
-
564  #if defined(RADIOLIB_BUILD_ARDUINO)
-
565  void SPIbegin();
-
566  void SPIend();
-
567  #endif
-
568  virtual void SPIbeginTransaction();
-
569  virtual uint8_t SPItransfer(uint8_t b);
-
570  virtual void SPIendTransaction();
-
571 
-
575  static uint8_t flipBits(uint8_t b);
-
576 
-
580  static uint16_t flipBits16(uint16_t i);
-
581 
-
589  static void hexdump(uint8_t* data, size_t len);
-
590 
-
598  void regdump(uint8_t start, uint8_t len);
-
599 
-
600 #if !defined(RADIOLIB_GODMODE)
-
601  private:
-
602 #endif
-
603 
-
604  // pins
-
605  RADIOLIB_PIN_TYPE _cs = RADIOLIB_NC;
-
606  RADIOLIB_PIN_TYPE _irq = RADIOLIB_NC;
-
607  RADIOLIB_PIN_TYPE _rst = RADIOLIB_NC;
-
608  RADIOLIB_PIN_TYPE _gpio = RADIOLIB_NC;
-
609 
-
610  // SPI interface (Arduino only)
-
611  #if defined(RADIOLIB_BUILD_ARDUINO)
-
612  SPIClass* _spi = NULL;
-
613  SPISettings _spiSettings = RADIOLIB_DEFAULT_SPI_SETTINGS;
-
614  bool _initInterface = false;
-
615  #endif
-
616 
-
617  // RF switch pins and table
-
618  RADIOLIB_PIN_TYPE _rfSwitchPins[RFSWITCH_MAX_PINS] = { RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC };
-
619  const RfSwitchMode_t *_rfSwitchTable = nullptr;
-
620 
-
621  #if defined(RADIOLIB_INTERRUPT_TIMING)
-
622  uint32_t _prevTimingLen = 0;
-
623  #endif
-
624 
-
625  // hardware abstraction layer callbacks
-
626  // this is placed at the end of Module class because the callback generator macros
-
627  // screw with the private/public access specifiers
-
628  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_PIN_MODE);
-
629  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DIGITAL_WRITE);
-
630  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DIGITAL_READ);
-
631  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_TONE);
-
632  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_NO_TONE);
-
633  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_ATTACH_INTERRUPT);
-
634  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DETACH_INTERRUPT);
-
635  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_YIELD);
-
636  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DELAY);
-
637  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DELAY_MICROSECONDS);
-
638  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_MILLIS);
-
639  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_MICROS);
-
640  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_PULSE_IN);
+
447  void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);
+
448 
+
511  void setRfSwitchTable(const RADIOLIB_PIN_TYPE (&pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[]);
+
512 
+
522  const RfSwitchMode_t *findRfSwitchMode(uint8_t mode) const;
+
523 
+
528  void setRfSwitchState(uint8_t mode);
+
529 
+
538  void waitForMicroseconds(uint32_t start, uint32_t len);
+
539 
+
540  // Arduino core overrides
+
541 
+
549  void pinMode(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode);
+
550 
+
558  void digitalWrite(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS value);
+
559 
+
567  RADIOLIB_PIN_STATUS digitalRead(RADIOLIB_PIN_TYPE pin);
+
568 
+
576  void tone(RADIOLIB_PIN_TYPE pin, uint16_t value, uint32_t duration = 0);
+
577 
+
583  void noTone(RADIOLIB_PIN_TYPE pin);
+
584 
+
594  void attachInterrupt(RADIOLIB_PIN_TYPE interruptNum, void (*userFunc)(void), RADIOLIB_INTERRUPT_STATUS mode);
+
595 
+
601  void detachInterrupt(RADIOLIB_PIN_TYPE interruptNum);
+
602 
+
606  void yield();
+
607 
+
613  void delay(uint32_t ms);
+
614 
+
620  void delayMicroseconds(uint32_t us);
+
621 
+
625  uint32_t millis();
+
626 
+
630  uint32_t micros();
+
631 
+
635  uint32_t pulseIn(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS state, uint32_t timeout);
+
636 
+
640  void begin();
641 
-
642  #if defined(RADIOLIB_BUILD_ARDUINO)
-
643  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_BEGIN);
-
644  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_BEGIN_TRANSACTION);
-
645  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_TRANSFER);
-
646  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_END_TRANSACTION);
-
647  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_END);
-
648  #else
-
649  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_BEGIN);
-
650  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_BEGIN_TRANSACTION);
-
651  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_TRANSFER);
-
652  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_END_TRANSACTION);
-
653  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_END);
-
654  #endif
-
655 };
+
645  void beginTransaction();
+
646 
+
650  uint8_t transfer(uint8_t b);
+
651 
+
655  void endTransaction();
656 
-
657 #endif
+
660  void end();
+
661 
+
662  // helper functions to set up SPI overrides on Arduino
+
663  #if defined(RADIOLIB_BUILD_ARDUINO)
+
664  void SPIbegin();
+
665  void SPIend();
+
666  #endif
+
667  virtual void SPIbeginTransaction();
+
668  virtual uint8_t SPItransfer(uint8_t b);
+
669  virtual void SPIendTransaction();
+
670 
+
674  static uint8_t flipBits(uint8_t b);
+
675 
+
679  static uint16_t flipBits16(uint16_t i);
+
680 
+
688  static void hexdump(uint8_t* data, size_t len);
+
689 
+
697  void regdump(uint8_t start, uint8_t len);
+
698 
+
699 #if !defined(RADIOLIB_GODMODE)
+
700  private:
+
701 #endif
+
702 
+
703  // pins
+
704  RADIOLIB_PIN_TYPE _cs = RADIOLIB_NC;
+
705  RADIOLIB_PIN_TYPE _irq = RADIOLIB_NC;
+
706  RADIOLIB_PIN_TYPE _rst = RADIOLIB_NC;
+
707  RADIOLIB_PIN_TYPE _gpio = RADIOLIB_NC;
+
708 
+
709  // SPI interface (Arduino only)
+
710  #if defined(RADIOLIB_BUILD_ARDUINO)
+
711  SPIClass* _spi = NULL;
+
712  SPISettings _spiSettings = RADIOLIB_DEFAULT_SPI_SETTINGS;
+
713  bool _initInterface = false;
+
714  #endif
+
715 
+
716  // RF switch pins and table
+
717  RADIOLIB_PIN_TYPE _rfSwitchPins[RFSWITCH_MAX_PINS] = { RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC };
+
718  const RfSwitchMode_t *_rfSwitchTable = nullptr;
+
719 
+
720  #if defined(RADIOLIB_INTERRUPT_TIMING)
+
721  uint32_t _prevTimingLen = 0;
+
722  #endif
+
723 
+
724  // hardware abstraction layer callbacks
+
725  // this is placed at the end of Module class because the callback generator macros
+
726  // screw with the private/public access specifiers
+
727  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_PIN_MODE);
+
728  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DIGITAL_WRITE);
+
729  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DIGITAL_READ);
+
730  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_TONE);
+
731  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_NO_TONE);
+
732  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_ATTACH_INTERRUPT);
+
733  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DETACH_INTERRUPT);
+
734  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_YIELD);
+
735  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DELAY);
+
736  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DELAY_MICROSECONDS);
+
737  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_MILLIS);
+
738  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_MICROS);
+
739  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_PULSE_IN);
+
740 
+
741  #if defined(RADIOLIB_BUILD_ARDUINO)
+
742  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_BEGIN);
+
743  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_BEGIN_TRANSACTION);
+
744  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_TRANSFER);
+
745  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_END_TRANSACTION);
+
746  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_END);
+
747  #else
+
748  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_BEGIN);
+
749  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_BEGIN_TRANSACTION);
+
750  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_TRANSFER);
+
751  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_END_TRANSACTION);
+
752  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_END);
+
753  #endif
+
754 };
+
755 
+
756 #endif
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
-
Module::endTransaction
void endTransaction()
Arduino core SPI endTransaction override.
Definition: Module.cpp:573
+
Module::endTransaction
void endTransaction()
Arduino core SPI endTransaction override.
Definition: Module.cpp:653
+
Module::SPIgetRegValue
int16_t SPIgetRegValue(uint16_t reg, uint8_t msb=7, uint8_t lsb=0)
SPI read method that automatically masks unused bits. This method is the preferred SPI read mechanism...
Definition: Module.cpp:132
+
Module::SPIstatusCommand
uint8_t SPIstatusCommand
Basic SPI status read command. Defaults to 0x00.
Definition: Module.h:150
+
Module::SPIsetRegValue
int16_t SPIsetRegValue(uint16_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF)
Overwrite-safe SPI write method with verification. This method is the preferred SPI write mechanism.
Definition: Module.cpp:142
Module::RFSWITCH_MAX_PINS
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:27
-
Module::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: Module.cpp:681
+
Module::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: Module.cpp:761
Module::Module
Module(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio=RADIOLIB_NC)
Default constructor.
Definition: Module.cpp:83
-
Module::SPIsetRegValue
int16_t SPIsetRegValue(uint8_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF)
Overwrite-safe SPI write method with verification. This method is the preferred SPI write mechanism.
Definition: Module.cpp:142
-
Module::pulseIn
uint32_t pulseIn(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS state, uint32_t timeout)
Arduino core pulseIn override.
Definition: Module.cpp:539
-
Module::delayMicroseconds
void delayMicroseconds(uint32_t us)
Arduino core delayMicroseconds override.
Definition: Module.cpp:518
-
Module::flipBits16
static uint16_t flipBits16(uint16_t i)
Function to reflect bits within an integer.
Definition: Module.cpp:628
-
Module::SPIreadRegister
uint8_t SPIreadRegister(uint8_t reg)
SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be use...
Definition: Module.cpp:195
-
Module::millis
uint32_t millis()
Arduino core millis override.
Definition: Module.cpp:525
-
Module::yield
void yield()
Arduino core yield override.
Definition: Module.cpp:502
-
Module::tone
void tone(RADIOLIB_PIN_TYPE pin, uint16_t value, uint32_t duration=0)
Arduino core tone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPPOR...
Definition: Module.cpp:426
-
Module::SPIstreamType
bool SPIstreamType
Whether the SPI interface is stream-type (e.g. SX126x) or register-type (e.g. SX127x)....
Definition: Module.h:146
-
Module::beginTransaction
void beginTransaction()
Arduino core SPI beginTransaction override.
Definition: Module.cpp:555
+
Module::pulseIn
uint32_t pulseIn(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS state, uint32_t timeout)
Arduino core pulseIn override.
Definition: Module.cpp:619
+
Module::delayMicroseconds
void delayMicroseconds(uint32_t us)
Arduino core delayMicroseconds override.
Definition: Module.cpp:598
+
Module::flipBits16
static uint16_t flipBits16(uint16_t i)
Function to reflect bits within an integer.
Definition: Module.cpp:708
+
Module::millis
uint32_t millis()
Arduino core millis override.
Definition: Module.cpp:605
+
Module::yield
void yield()
Arduino core yield override.
Definition: Module.cpp:582
+
Module::tone
void tone(RADIOLIB_PIN_TYPE pin, uint16_t value, uint32_t duration=0)
Arduino core tone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPPOR...
Definition: Module.cpp:506
+
Module::SPIstreamType
bool SPIstreamType
Whether the SPI interface is stream-type (e.g. SX126x) or register-type (e.g. SX127x)....
Definition: Module.h:161
+
Module::beginTransaction
void beginTransaction()
Arduino core SPI beginTransaction override.
Definition: Module.cpp:635
+
Module::SPIreadRegisterBurst
void SPIreadRegisterBurst(uint16_t reg, uint8_t numBytes, uint8_t *inBytes)
SPI burst read method.
Definition: Module.cpp:191
+
Module::SPIwriteRegister
void SPIwriteRegister(uint16_t reg, uint8_t data)
SPI basic write method. Use of this method is reserved for special cases, SPIsetRegValue should be us...
Definition: Module.cpp:220
Module::term
void term()
Terminate low-level module control.
Definition: Module.cpp:119
-
Module::transfer
uint8_t transfer(uint8_t b)
Arduino core SPI transfer override.
Definition: Module.cpp:564
-
Module::digitalWrite
void digitalWrite(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS value)
Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin.
Definition: Module.cpp:407
-
Module::waitForMicroseconds
void waitForMicroseconds(uint32_t start, uint32_t len)
Wait for time to elapse, either using the microsecond timer, or the TimerFlag. Note that in interrupt...
Definition: Module.cpp:382
+
Module::transfer
uint8_t transfer(uint8_t b)
Arduino core SPI transfer override.
Definition: Module.cpp:644
+
Module::SPInopCommand
uint8_t SPInopCommand
Basic SPI no-operation command. Defaults to 0x00.
Definition: Module.h:145
+
Module::digitalWrite
void digitalWrite(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS value)
Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin.
Definition: Module.cpp:487
+
Module::waitForMicroseconds
void waitForMicroseconds(uint32_t start, uint32_t len)
Wait for time to elapse, either using the microsecond timer, or the TimerFlag. Note that in interrupt...
Definition: Module.cpp:462
+
Module::SPItransfer
void SPItransfer(uint8_t cmd, uint16_t reg, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes)
SPI single transfer method.
Definition: Module.cpp:229
Module::END_OF_MODE_TABLE
static const RfSwitchMode_t END_OF_MODE_TABLE
Definition: Module.h:65
Module::operator=
Module & operator=(const Module &mod)
Overload for assignment operator.
Definition: Module.cpp:98
-
Module::findRfSwitchMode
const RfSwitchMode_t * findRfSwitchMode(uint8_t mode) const
Find a mode in the RfSwitchTable.
Definition: Module.cpp:703
+
Module::findRfSwitchMode
const RfSwitchMode_t * findRfSwitchMode(uint8_t mode) const
Find a mode in the RfSwitchTable.
Definition: Module.cpp:783
Module::OpMode_t
OpMode_t
Definition: Module.h:46
Module::MODE_TX
@ MODE_TX
Definition: Module.h:56
Module::MODE_IDLE
@ MODE_IDLE
Definition: Module.h:52
Module::MODE_RX
@ MODE_RX
Definition: Module.h:54
Module::MODE_END_OF_TABLE
@ MODE_END_OF_TABLE
Definition: Module.h:50
-
Module::detachInterrupt
void detachInterrupt(RADIOLIB_PIN_TYPE interruptNum)
Arduino core detachInterrupt override.
Definition: Module.cpp:495
-
Module::SPIreadRegisterBurst
void SPIreadRegisterBurst(uint8_t reg, uint8_t numBytes, uint8_t *inBytes)
SPI burst read method.
Definition: Module.cpp:191
-
Module::regdump
void regdump(uint8_t start, uint8_t len)
Function to dump device registers as hex into the debug port.
Definition: Module.cpp:668
-
Module::SPItransferStream
int16_t SPItransferStream(uint8_t *cmd, uint8_t cmdLen, bool write, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes, bool waitForGpio, uint32_t timeout)
SPI single transfer method for modules with stream-type SPI interface (SX126x, SX128x etc....
Definition: Module.cpp:256
-
Module::digitalRead
RADIOLIB_PIN_STATUS digitalRead(RADIOLIB_PIN_TYPE pin)
Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin.
Definition: Module.cpp:414
-
Module::flipBits
static uint8_t flipBits(uint8_t b)
Function to reflect bits within a byte.
Definition: Module.cpp:621
+
Module::SPIcheckStream
int16_t SPIcheckStream()
Method to check the result of last SPI stream transfer.
Definition: Module.cpp:316
+
Module::detachInterrupt
void detachInterrupt(RADIOLIB_PIN_TYPE interruptNum)
Arduino core detachInterrupt override.
Definition: Module.cpp:575
+
Module::SPIstreamError
int16_t SPIstreamError
The last recorded SPI stream error.
Definition: Module.h:166
+
Module::regdump
void regdump(uint8_t start, uint8_t len)
Function to dump device registers as hex into the debug port.
Definition: Module.cpp:748
+
Module::SPItransferStream
int16_t SPItransferStream(uint8_t *cmd, uint8_t cmdLen, bool write, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes, bool waitForGpio, uint32_t timeout)
SPI single transfer method for modules with stream-type SPI interface (SX126x, SX128x etc....
Definition: Module.cpp:336
+
Module::digitalRead
RADIOLIB_PIN_STATUS digitalRead(RADIOLIB_PIN_TYPE pin)
Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin.
Definition: Module.cpp:494
+
Module::flipBits
static uint8_t flipBits(uint8_t b)
Function to reflect bits within a byte.
Definition: Module.cpp:701
Module::SPIreadCommand
uint8_t SPIreadCommand
Basic SPI read command. Defaults to 0x00.
Definition: Module.h:135
-
Module::setRfSwitchTable
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: Module.cpp:696
-
Module::getIrq
RADIOLIB_PIN_TYPE getIrq() const
Access method to get the pin number of interrupt/GPIO.
Definition: Module.h:316
-
Module::attachInterrupt
void attachInterrupt(RADIOLIB_PIN_TYPE interruptNum, void(*userFunc)(void), RADIOLIB_INTERRUPT_STATUS mode)
Arduino core attachInterrupt override.
Definition: Module.cpp:488
-
Module::SPIparseStatusCb_t
int16_t(* SPIparseStatusCb_t)(uint8_t in)
SPI status parsing callback typedef.
Definition: Module.h:151
-
Module::SPIwriteRegisterBurst
void SPIwriteRegisterBurst(uint8_t reg, uint8_t *data, uint8_t numBytes)
SPI burst write method.
Definition: Module.cpp:201
-
Module::end
void end()
Arduino core SPI end override.
Definition: Module.cpp:582
-
Module::SPIwriteRegister
void SPIwriteRegister(uint8_t reg, uint8_t data)
SPI basic write method. Use of this method is reserved for special cases, SPIsetRegValue should be us...
Definition: Module.cpp:205
-
Module::hexdump
static void hexdump(uint8_t *data, size_t len)
Function to dump data as hex into the debug port.
Definition: Module.cpp:636
+
Module::setRfSwitchTable
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: Module.cpp:776
+
Module::getIrq
RADIOLIB_PIN_TYPE getIrq() const
Access method to get the pin number of interrupt/GPIO.
Definition: Module.h:415
+
Module::attachInterrupt
void attachInterrupt(RADIOLIB_PIN_TYPE interruptNum, void(*userFunc)(void), RADIOLIB_INTERRUPT_STATUS mode)
Arduino core attachInterrupt override.
Definition: Module.cpp:568
+
Module::SPIparseStatusCb_t
int16_t(* SPIparseStatusCb_t)(uint8_t in)
SPI status parsing callback typedef.
Definition: Module.h:171
+
Module::SPIwriteRegisterBurst
void SPIwriteRegisterBurst(uint16_t reg, uint8_t *data, uint8_t numBytes)
SPI burst write method.
Definition: Module.cpp:211
+
Module::SPIreadRegister
uint8_t SPIreadRegister(uint16_t reg)
SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be use...
Definition: Module.cpp:200
+
Module::end
void end()
Arduino core SPI end override.
Definition: Module.cpp:662
+
Module::SPIreadStream
int16_t SPIreadStream(uint8_t cmd, uint8_t *data, uint8_t numBytes, bool waitForGpio=true, bool verify=true)
Method to perform a read transaction with SPI stream.
Definition: Module.cpp:282
+
Module::SPIaddrWidth
uint8_t SPIaddrWidth
SPI address width. Defaults to 8, currently only supports 8 and 16-bit addresses.
Definition: Module.h:155
+
Module::hexdump
static void hexdump(uint8_t *data, size_t len)
Function to dump data as hex into the debug port.
Definition: Module.cpp:716
Module::init
void init()
Initialize low-level module control.
Definition: Module.cpp:109
-
Module::SPIgetRegValue
int16_t SPIgetRegValue(uint8_t reg, uint8_t msb=7, uint8_t lsb=0)
SPI read method that automatically masks unused bits. This method is the preferred SPI read mechanism...
Definition: Module.cpp:132
-
Module::getRst
RADIOLIB_PIN_TYPE getRst() const
Access method to get the pin number of hardware reset pin.
Definition: Module.h:323
-
Module::getCs
RADIOLIB_PIN_TYPE getCs() const
Access method to get the pin number of SPI chip select.
Definition: Module.h:309
+
Module::SPIwriteStream
int16_t SPIwriteStream(uint8_t cmd, uint8_t *data, uint8_t numBytes, bool waitForGpio=true, bool verify=true)
Method to perform a write transaction with SPI stream.
Definition: Module.cpp:299
+
Module::getRst
RADIOLIB_PIN_TYPE getRst() const
Access method to get the pin number of hardware reset pin.
Definition: Module.h:422
+
Module::getCs
RADIOLIB_PIN_TYPE getCs() const
Access method to get the pin number of SPI chip select.
Definition: Module.h:408
Module::SPIwriteCommand
uint8_t SPIwriteCommand
Basic SPI write command. Defaults to 0x80.
Definition: Module.h:140
-
Module::getGpio
RADIOLIB_PIN_TYPE getGpio() const
Access method to get the pin number of second interrupt/GPIO.
Definition: Module.h:330
-
Module::SPItransfer
void SPItransfer(uint8_t cmd, uint8_t reg, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes)
SPI single transfer method.
Definition: Module.cpp:209
-
Module::delay
void delay(uint32_t ms)
Arduino core delay override.
Definition: Module.cpp:511
-
Module::micros
uint32_t micros()
Arduino core micros override.
Definition: Module.cpp:532
-
Module::begin
void begin()
Arduino core SPI begin override.
Definition: Module.cpp:546
-
Module::SPIparseStatusCb
SPIparseStatusCb_t SPIparseStatusCb
Callback to function that will parse the module-specific status codes to RadioLib status codes....
Definition: Module.h:157
-
Module::pinMode
void pinMode(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode)
Arduino core pinMode override that checks RADIOLIB_NC as alias for unused pin.
Definition: Module.cpp:400
-
Module::noTone
void noTone(RADIOLIB_PIN_TYPE pin)
Arduino core noTone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPP...
Definition: Module.cpp:461
-
Module::setRfSwitchState
void setRfSwitchState(uint8_t mode)
Set RF switch state.
Definition: Module.cpp:713
+
Module::getGpio
RADIOLIB_PIN_TYPE getGpio() const
Access method to get the pin number of second interrupt/GPIO.
Definition: Module.h:429
+
Module::delay
void delay(uint32_t ms)
Arduino core delay override.
Definition: Module.cpp:591
+
Module::micros
uint32_t micros()
Arduino core micros override.
Definition: Module.cpp:612
+
Module::begin
void begin()
Arduino core SPI begin override.
Definition: Module.cpp:626
+
Module::SPIparseStatusCb
SPIparseStatusCb_t SPIparseStatusCb
Callback to function that will parse the module-specific status codes to RadioLib status codes....
Definition: Module.h:177
+
Module::pinMode
void pinMode(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode)
Arduino core pinMode override that checks RADIOLIB_NC as alias for unused pin.
Definition: Module.cpp:480
+
Module::noTone
void noTone(RADIOLIB_PIN_TYPE pin)
Arduino core noTone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPP...
Definition: Module.cpp:541
+
Module::setRfSwitchState
void setRfSwitchState(uint8_t mode)
Set RF switch state.
Definition: Module.cpp:793
+
RADIOLIB_ERR_UNKNOWN
#define RADIOLIB_ERR_UNKNOWN
There was an unexpected, unknown error. If you see this, something went incredibly wrong....
Definition: TypeDef.h:108
Module::RfSwitchMode_t
Definition: Module.h:34
diff --git a/_s_t_m32_w_lx_8h_source.html b/_s_t_m32_w_lx_8h_source.html index 2bea8b63..c5d0fb92 100644 --- a/_s_t_m32_w_lx_8h_source.html +++ b/_s_t_m32_w_lx_8h_source.html @@ -171,7 +171,7 @@ $(document).ready(function(){initNavTree('_s_t_m32_w_lx_8h_source.html',''); ini
STM32WLx::MODE_IDLE
@ MODE_IDLE
Definition: STM32WLx.h:57
STM32WLx::beginFSK
int16_t beginFSK(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=156.2, int8_t power=10, uint16_t preambleLength=16, float tcxoVoltage=1.6, bool useRegulatorLDO=false)
Initialization method for FSK modem.
Definition: STM32WLx.cpp:33
SX1262
Derived class for SX1262 modules.
Definition: SX1262.h:19
-
SX126x::setRfSwitchTable
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX126x.cpp:1296
+
SX126x::setRfSwitchTable
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX126x.cpp:1311
Module::RfSwitchMode_t
Definition: Module.h:34
diff --git a/_s_x1262_8h_source.html b/_s_x1262_8h_source.html index b2f47541..4b089295 100644 --- a/_s_x1262_8h_source.html +++ b/_s_x1262_8h_source.html @@ -133,7 +133,7 @@ $(document).ready(function(){initNavTree('_s_x1262_8h_source.html',''); initResi
SX1262::begin
int16_t begin(float freq=434.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX126X_SYNC_WORD_PRIVATE, int8_t power=10, uint16_t preambleLength=8, float tcxoVoltage=1.6, bool useRegulatorLDO=false)
Initialization method for LoRa modem.
Definition: SX1262.cpp:8
SX1262::setOutputPower
virtual int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are in range from -9 to 22 dBm. This method is virtual to allow ove...
Definition: SX1262.cpp:84
SX1262::setFrequency
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values are in range from 150.0 to 960.0 MHz.
Definition: SX1262.cpp:50
-
SX126x
Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...
Definition: SX126x.h:368
+
SX126x
Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...
Definition: SX126x.h:393
diff --git a/_s_x1268_8h_source.html b/_s_x1268_8h_source.html index 5808851e..f4bb801d 100644 --- a/_s_x1268_8h_source.html +++ b/_s_x1268_8h_source.html @@ -133,7 +133,7 @@ $(document).ready(function(){initNavTree('_s_x1268_8h_source.html',''); initResi
SX1268::setFrequency
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values are in range from 410.0 to 810.0 MHz.
Definition: SX1268.cpp:50
SX1268::begin
int16_t begin(float freq=434.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX126X_SYNC_WORD_PRIVATE, int8_t power=10, uint16_t preambleLength=8, float tcxoVoltage=1.6, bool useRegulatorLDO=false)
Initialization method for LoRa modem.
Definition: SX1268.cpp:8
SX1268::beginFSK
int16_t beginFSK(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=156.2, int8_t power=10, uint16_t preambleLength=16, float tcxoVoltage=1.6, bool useRegulatorLDO=false)
Initialization method for FSK modem.
Definition: SX1268.cpp:32
-
SX126x
Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...
Definition: SX126x.h:368
+
SX126x
Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...
Definition: SX126x.h:393
diff --git a/_s_x126x_8h_source.html b/_s_x126x_8h_source.html index 133ccd6a..c7bfd829 100644 --- a/_s_x126x_8h_source.html +++ b/_s_x126x_8h_source.html @@ -200,487 +200,504 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
112 #define RADIOLIB_SX126X_REG_RANDOM_NUMBER_3 0x081C
113 #define RADIOLIB_SX126X_REG_RX_GAIN 0x08AC
114 #define RADIOLIB_SX126X_REG_TX_CLAMP_CONFIG 0x08D8
-
115 #define RADIOLIB_SX126X_REG_OCP_CONFIGURATION 0x08E7
-
116 #define RADIOLIB_SX126X_REG_RTC_CTRL 0x0902
-
117 #define RADIOLIB_SX126X_REG_XTA_TRIM 0x0911
-
118 #define RADIOLIB_SX126X_REG_XTB_TRIM 0x0912
-
119 #define RADIOLIB_SX126X_REG_DIO3_OUT_VOLTAGE_CTRL 0x0920
-
120 #define RADIOLIB_SX126X_REG_EVENT_MASK 0x0944
-
121 
-
122 // undocumented registers
-
123 #define RADIOLIB_SX126X_REG_SENSITIVITY_CONFIG 0x0889 // SX1268 datasheet v1.1, section 15.1
-
124 #define RADIOLIB_SX126X_REG_RX_GAIN_RETENTION_0 0x029F // SX1268 datasheet v1.1, section 9.6
-
125 #define RADIOLIB_SX126X_REG_RX_GAIN_RETENTION_1 0x02A0 // SX1268 datasheet v1.1, section 9.6
-
126 #define RADIOLIB_SX126X_REG_RX_GAIN_RETENTION_2 0x02A1 // SX1268 datasheet v1.1, section 9.6
-
127 
-
128 
-
129 // SX126X SPI command variables
-
130 //RADIOLIB_SX126X_CMD_SET_SLEEP MSB LSB DESCRIPTION
-
131 #define RADIOLIB_SX126X_SLEEP_START_COLD 0b00000000 // 2 2 sleep mode: cold start, configuration is lost (default)
-
132 #define RADIOLIB_SX126X_SLEEP_START_WARM 0b00000100 // 2 2 warm start, configuration is retained
-
133 #define RADIOLIB_SX126X_SLEEP_RTC_OFF 0b00000000 // 0 0 wake on RTC timeout: disabled
-
134 #define RADIOLIB_SX126X_SLEEP_RTC_ON 0b00000001 // 0 0 enabled
-
135 
-
136 //RADIOLIB_SX126X_CMD_SET_STANDBY
-
137 #define RADIOLIB_SX126X_STANDBY_RC 0x00 // 7 0 standby mode: 13 MHz RC oscillator
-
138 #define RADIOLIB_SX126X_STANDBY_XOSC 0x01 // 7 0 32 MHz crystal oscillator
-
139 
-
140 //RADIOLIB_SX126X_CMD_SET_RX
-
141 #define RADIOLIB_SX126X_RX_TIMEOUT_NONE 0x000000 // 23 0 Rx timeout duration: no timeout (Rx single mode)
-
142 #define RADIOLIB_SX126X_RX_TIMEOUT_INF 0xFFFFFF // 23 0 infinite (Rx continuous mode)
-
143 
-
144 //RADIOLIB_SX126X_CMD_SET_TX
-
145 #define RADIOLIB_SX126X_TX_TIMEOUT_NONE 0x000000 // 23 0 Tx timeout duration: no timeout (Tx single mode)
-
146 
-
147 //RADIOLIB_SX126X_CMD_STOP_TIMER_ON_PREAMBLE
-
148 #define RADIOLIB_SX126X_STOP_ON_PREAMBLE_OFF 0x00 // 7 0 stop timer on: sync word or header (default)
-
149 #define RADIOLIB_SX126X_STOP_ON_PREAMBLE_ON 0x01 // 7 0 preamble detection
-
150 
-
151 //RADIOLIB_SX126X_CMD_SET_REGULATOR_MODE
-
152 #define RADIOLIB_SX126X_REGULATOR_LDO 0x00 // 7 0 set regulator mode: LDO (default)
-
153 #define RADIOLIB_SX126X_REGULATOR_DC_DC 0x01 // 7 0 DC-DC
-
154 
-
155 //RADIOLIB_SX126X_CMD_CALIBRATE
-
156 #define RADIOLIB_SX126X_CALIBRATE_IMAGE_OFF 0b00000000 // 6 6 image calibration: disabled
-
157 #define RADIOLIB_SX126X_CALIBRATE_IMAGE_ON 0b01000000 // 6 6 enabled
-
158 #define RADIOLIB_SX126X_CALIBRATE_ADC_BULK_P_OFF 0b00000000 // 5 5 ADC bulk P calibration: disabled
-
159 #define RADIOLIB_SX126X_CALIBRATE_ADC_BULK_P_ON 0b00100000 // 5 5 enabled
-
160 #define RADIOLIB_SX126X_CALIBRATE_ADC_BULK_N_OFF 0b00000000 // 4 4 ADC bulk N calibration: disabled
-
161 #define RADIOLIB_SX126X_CALIBRATE_ADC_BULK_N_ON 0b00010000 // 4 4 enabled
-
162 #define RADIOLIB_SX126X_CALIBRATE_ADC_PULSE_OFF 0b00000000 // 3 3 ADC pulse calibration: disabled
-
163 #define RADIOLIB_SX126X_CALIBRATE_ADC_PULSE_ON 0b00001000 // 3 3 enabled
-
164 #define RADIOLIB_SX126X_CALIBRATE_PLL_OFF 0b00000000 // 2 2 PLL calibration: disabled
-
165 #define RADIOLIB_SX126X_CALIBRATE_PLL_ON 0b00000100 // 2 2 enabled
-
166 #define RADIOLIB_SX126X_CALIBRATE_RC13M_OFF 0b00000000 // 1 1 13 MHz RC osc. calibration: disabled
-
167 #define RADIOLIB_SX126X_CALIBRATE_RC13M_ON 0b00000010 // 1 1 enabled
-
168 #define RADIOLIB_SX126X_CALIBRATE_RC64K_OFF 0b00000000 // 0 0 64 kHz RC osc. calibration: disabled
-
169 #define RADIOLIB_SX126X_CALIBRATE_RC64K_ON 0b00000001 // 0 0 enabled
-
170 #define RADIOLIB_SX126X_CALIBRATE_ALL 0b01111111 // 6 0 calibrate all blocks
-
171 
-
172 //RADIOLIB_SX126X_CMD_CALIBRATE_IMAGE
-
173 #define RADIOLIB_SX126X_CAL_IMG_430_MHZ_1 0x6B
-
174 #define RADIOLIB_SX126X_CAL_IMG_430_MHZ_2 0x6F
-
175 #define RADIOLIB_SX126X_CAL_IMG_470_MHZ_1 0x75
-
176 #define RADIOLIB_SX126X_CAL_IMG_470_MHZ_2 0x81
-
177 #define RADIOLIB_SX126X_CAL_IMG_779_MHZ_1 0xC1
-
178 #define RADIOLIB_SX126X_CAL_IMG_779_MHZ_2 0xC5
-
179 #define RADIOLIB_SX126X_CAL_IMG_863_MHZ_1 0xD7
-
180 #define RADIOLIB_SX126X_CAL_IMG_863_MHZ_2 0xDB
-
181 #define RADIOLIB_SX126X_CAL_IMG_902_MHZ_1 0xE1
-
182 #define RADIOLIB_SX126X_CAL_IMG_902_MHZ_2 0xE9
-
183 
-
184 //RADIOLIB_SX126X_CMD_SET_PA_CONFIG
-
185 #define RADIOLIB_SX126X_PA_CONFIG_HP_MAX 0x07
-
186 #define RADIOLIB_SX126X_PA_CONFIG_PA_LUT 0x01
-
187 #define RADIOLIB_SX126X_PA_CONFIG_SX1262_8 0x00
-
188 
-
189 //RADIOLIB_SX126X_CMD_SET_RX_TX_FALLBACK_MODE
-
190 #define RADIOLIB_SX126X_RX_TX_FALLBACK_MODE_FS 0x40 // 7 0 after Rx/Tx go to: FS mode
-
191 #define RADIOLIB_SX126X_RX_TX_FALLBACK_MODE_STDBY_XOSC 0x30 // 7 0 standby with crystal oscillator
-
192 #define RADIOLIB_SX126X_RX_TX_FALLBACK_MODE_STDBY_RC 0x20 // 7 0 standby with RC oscillator (default)
-
193 
-
194 //RADIOLIB_SX126X_CMD_SET_DIO_IRQ_PARAMS
-
195 #define RADIOLIB_SX126X_IRQ_LR_FHSS_HOP 0b0100000000000000 // 14 14 PA ramped up during LR-FHSS hop
-
196 #define RADIOLIB_SX126X_IRQ_TIMEOUT 0b0000001000000000 // 9 9 Rx or Tx timeout
-
197 #define RADIOLIB_SX126X_IRQ_CAD_DETECTED 0b0000000100000000 // 8 8 channel activity detected
-
198 #define RADIOLIB_SX126X_IRQ_CAD_DONE 0b0000000010000000 // 7 7 channel activity detection finished
-
199 #define RADIOLIB_SX126X_IRQ_CRC_ERR 0b0000000001000000 // 6 6 wrong CRC received
-
200 #define RADIOLIB_SX126X_IRQ_HEADER_ERR 0b0000000000100000 // 5 5 LoRa header CRC error
-
201 #define RADIOLIB_SX126X_IRQ_HEADER_VALID 0b0000000000010000 // 4 4 valid LoRa header received
-
202 #define RADIOLIB_SX126X_IRQ_SYNC_WORD_VALID 0b0000000000001000 // 3 3 valid sync word detected
-
203 #define RADIOLIB_SX126X_IRQ_RADIOLIB_PREAMBLE_DETECTED 0b0000000000000100 // 2 2 preamble detected
-
204 #define RADIOLIB_SX126X_IRQ_RX_DONE 0b0000000000000010 // 1 1 packet received
-
205 #define RADIOLIB_SX126X_IRQ_TX_DONE 0b0000000000000001 // 0 0 packet transmission completed
-
206 #define RADIOLIB_SX126X_IRQ_ALL 0b0100001111111111 // 14 0 all interrupts
-
207 #define RADIOLIB_SX126X_IRQ_NONE 0b0000000000000000 // 14 0 no interrupts
-
208 
-
209 //RADIOLIB_SX126X_CMD_SET_DIO2_AS_RF_SWITCH_CTRL
-
210 #define RADIOLIB_SX126X_DIO2_AS_IRQ 0x00 // 7 0 DIO2 configuration: IRQ
-
211 #define RADIOLIB_SX126X_DIO2_AS_RF_SWITCH 0x01 // 7 0 RF switch control
-
212 
-
213 //RADIOLIB_SX126X_CMD_SET_DIO3_AS_TCXO_CTRL
-
214 #define RADIOLIB_SX126X_DIO3_OUTPUT_1_6 0x00 // 7 0 DIO3 voltage output for TCXO: 1.6 V
-
215 #define RADIOLIB_SX126X_DIO3_OUTPUT_1_7 0x01 // 7 0 1.7 V
-
216 #define RADIOLIB_SX126X_DIO3_OUTPUT_1_8 0x02 // 7 0 1.8 V
-
217 #define RADIOLIB_SX126X_DIO3_OUTPUT_2_2 0x03 // 7 0 2.2 V
-
218 #define RADIOLIB_SX126X_DIO3_OUTPUT_2_4 0x04 // 7 0 2.4 V
-
219 #define RADIOLIB_SX126X_DIO3_OUTPUT_2_7 0x05 // 7 0 2.7 V
-
220 #define RADIOLIB_SX126X_DIO3_OUTPUT_3_0 0x06 // 7 0 3.0 V
-
221 #define RADIOLIB_SX126X_DIO3_OUTPUT_3_3 0x07 // 7 0 3.3 V
-
222 
-
223 //RADIOLIB_SX126X_CMD_SET_PACKET_TYPE
-
224 #define RADIOLIB_SX126X_PACKET_TYPE_GFSK 0x00 // 7 0 packet type: GFSK
-
225 #define RADIOLIB_SX126X_PACKET_TYPE_LORA 0x01 // 7 0 LoRa
-
226 #define RADIOLIB_SX126X_PACKET_TYPE_LR_FHSS 0x03 // 7 0 LR-FHSS
-
227 
-
228 //RADIOLIB_SX126X_CMD_SET_TX_PARAMS
-
229 #define RADIOLIB_SX126X_PA_RAMP_10U 0x00 // 7 0 ramp time: 10 us
-
230 #define RADIOLIB_SX126X_PA_RAMP_20U 0x01 // 7 0 20 us
-
231 #define RADIOLIB_SX126X_PA_RAMP_40U 0x02 // 7 0 40 us
-
232 #define RADIOLIB_SX126X_PA_RAMP_80U 0x03 // 7 0 80 us
-
233 #define RADIOLIB_SX126X_PA_RAMP_200U 0x04 // 7 0 200 us
-
234 #define RADIOLIB_SX126X_PA_RAMP_800U 0x05 // 7 0 800 us
-
235 #define RADIOLIB_SX126X_PA_RAMP_1700U 0x06 // 7 0 1700 us
-
236 #define RADIOLIB_SX126X_PA_RAMP_3400U 0x07 // 7 0 3400 us
-
237 
-
238 //RADIOLIB_SX126X_CMD_SET_MODULATION_PARAMS
-
239 #define RADIOLIB_SX126X_GFSK_FILTER_NONE 0x00 // 7 0 GFSK filter: none
-
240 #define RADIOLIB_SX126X_GFSK_FILTER_GAUSS_0_3 0x08 // 7 0 Gaussian, BT = 0.3
-
241 #define RADIOLIB_SX126X_GFSK_FILTER_GAUSS_0_5 0x09 // 7 0 Gaussian, BT = 0.5
-
242 #define RADIOLIB_SX126X_GFSK_FILTER_GAUSS_0_7 0x0A // 7 0 Gaussian, BT = 0.7
-
243 #define RADIOLIB_SX126X_GFSK_FILTER_GAUSS_1 0x0B // 7 0 Gaussian, BT = 1
-
244 #define RADIOLIB_SX126X_GFSK_RX_BW_4_8 0x1F // 7 0 GFSK Rx bandwidth: 4.8 kHz
-
245 #define RADIOLIB_SX126X_GFSK_RX_BW_5_8 0x17 // 7 0 5.8 kHz
-
246 #define RADIOLIB_SX126X_GFSK_RX_BW_7_3 0x0F // 7 0 7.3 kHz
-
247 #define RADIOLIB_SX126X_GFSK_RX_BW_9_7 0x1E // 7 0 9.7 kHz
-
248 #define RADIOLIB_SX126X_GFSK_RX_BW_11_7 0x16 // 7 0 11.7 kHz
-
249 #define RADIOLIB_SX126X_GFSK_RX_BW_14_6 0x0E // 7 0 14.6 kHz
-
250 #define RADIOLIB_SX126X_GFSK_RX_BW_19_5 0x1D // 7 0 19.5 kHz
-
251 #define RADIOLIB_SX126X_GFSK_RX_BW_23_4 0x15 // 7 0 23.4 kHz
-
252 #define RADIOLIB_SX126X_GFSK_RX_BW_29_3 0x0D // 7 0 29.3 kHz
-
253 #define RADIOLIB_SX126X_GFSK_RX_BW_39_0 0x1C // 7 0 39.0 kHz
-
254 #define RADIOLIB_SX126X_GFSK_RX_BW_46_9 0x14 // 7 0 46.9 kHz
-
255 #define RADIOLIB_SX126X_GFSK_RX_BW_58_6 0x0C // 7 0 58.6 kHz
-
256 #define RADIOLIB_SX126X_GFSK_RX_BW_78_2 0x1B // 7 0 78.2 kHz
-
257 #define RADIOLIB_SX126X_GFSK_RX_BW_93_8 0x13 // 7 0 93.8 kHz
-
258 #define RADIOLIB_SX126X_GFSK_RX_BW_117_3 0x0B // 7 0 117.3 kHz
-
259 #define RADIOLIB_SX126X_GFSK_RX_BW_156_2 0x1A // 7 0 156.2 kHz
-
260 #define RADIOLIB_SX126X_GFSK_RX_BW_187_2 0x12 // 7 0 187.2 kHz
-
261 #define RADIOLIB_SX126X_GFSK_RX_BW_234_3 0x0A // 7 0 234.3 kHz
-
262 #define RADIOLIB_SX126X_GFSK_RX_BW_312_0 0x19 // 7 0 312.0 kHz
-
263 #define RADIOLIB_SX126X_GFSK_RX_BW_373_6 0x11 // 7 0 373.6 kHz
-
264 #define RADIOLIB_SX126X_GFSK_RX_BW_467_0 0x09 // 7 0 467.0 kHz
-
265 #define RADIOLIB_SX126X_LORA_BW_7_8 0x00 // 7 0 LoRa bandwidth: 7.8 kHz
-
266 #define RADIOLIB_SX126X_LORA_BW_10_4 0x08 // 7 0 10.4 kHz
-
267 #define RADIOLIB_SX126X_LORA_BW_15_6 0x01 // 7 0 15.6 kHz
-
268 #define RADIOLIB_SX126X_LORA_BW_20_8 0x09 // 7 0 20.8 kHz
-
269 #define RADIOLIB_SX126X_LORA_BW_31_25 0x02 // 7 0 31.25 kHz
-
270 #define RADIOLIB_SX126X_LORA_BW_41_7 0x0A // 7 0 41.7 kHz
-
271 #define RADIOLIB_SX126X_LORA_BW_62_5 0x03 // 7 0 62.5 kHz
-
272 #define RADIOLIB_SX126X_LORA_BW_125_0 0x04 // 7 0 125.0 kHz
-
273 #define RADIOLIB_SX126X_LORA_BW_250_0 0x05 // 7 0 250.0 kHz
-
274 #define RADIOLIB_SX126X_LORA_BW_500_0 0x06 // 7 0 500.0 kHz
-
275 #define RADIOLIB_SX126X_LORA_CR_4_5 0x01 // 7 0 LoRa coding rate: 4/5
-
276 #define RADIOLIB_SX126X_LORA_CR_4_6 0x02 // 7 0 4/6
-
277 #define RADIOLIB_SX126X_LORA_CR_4_7 0x03 // 7 0 4/7
-
278 #define RADIOLIB_SX126X_LORA_CR_4_8 0x04 // 7 0 4/8
-
279 #define RADIOLIB_SX126X_LORA_LOW_DATA_RATE_OPTIMIZE_OFF 0x00 // 7 0 LoRa low data rate optimization: disabled
-
280 #define RADIOLIB_SX126X_LORA_LOW_DATA_RATE_OPTIMIZE_ON 0x01 // 7 0 enabled
-
281 
-
282 //RADIOLIB_SX126X_CMD_SET_PACKET_PARAMS
-
283 #define RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_OFF 0x00 // 7 0 GFSK minimum preamble length before reception starts: detector disabled
-
284 #define RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_8 0x04 // 7 0 8 bits
-
285 #define RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_16 0x05 // 7 0 16 bits
-
286 #define RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_24 0x06 // 7 0 24 bits
-
287 #define RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_32 0x07 // 7 0 32 bits
-
288 #define RADIOLIB_SX126X_GFSK_ADDRESS_FILT_OFF 0x00 // 7 0 GFSK address filtering: disabled
-
289 #define RADIOLIB_SX126X_GFSK_ADDRESS_FILT_NODE 0x01 // 7 0 node only
-
290 #define RADIOLIB_SX126X_GFSK_ADDRESS_FILT_NODE_BROADCAST 0x02 // 7 0 node and broadcast
-
291 #define RADIOLIB_SX126X_GFSK_PACKET_FIXED 0x00 // 7 0 GFSK packet type: fixed (payload length known in advance to both sides)
-
292 #define RADIOLIB_SX126X_GFSK_PACKET_VARIABLE 0x01 // 7 0 variable (payload length added to packet)
-
293 #define RADIOLIB_SX126X_GFSK_CRC_OFF 0x01 // 7 0 GFSK packet CRC: disabled
-
294 #define RADIOLIB_SX126X_GFSK_CRC_1_BYTE 0x00 // 7 0 1 byte
-
295 #define RADIOLIB_SX126X_GFSK_CRC_2_BYTE 0x02 // 7 0 2 byte
-
296 #define RADIOLIB_SX126X_GFSK_CRC_1_BYTE_INV 0x04 // 7 0 1 byte, inverted
-
297 #define RADIOLIB_SX126X_GFSK_CRC_2_BYTE_INV 0x06 // 7 0 2 byte, inverted
-
298 #define RADIOLIB_SX126X_GFSK_WHITENING_OFF 0x00 // 7 0 GFSK data whitening: disabled
-
299 #define RADIOLIB_SX126X_GFSK_WHITENING_ON 0x01 // 7 0 enabled
-
300 #define RADIOLIB_SX126X_LORA_HEADER_EXPLICIT 0x00 // 7 0 LoRa header mode: explicit
-
301 #define RADIOLIB_SX126X_LORA_HEADER_IMPLICIT 0x01 // 7 0 implicit
-
302 #define RADIOLIB_SX126X_LORA_CRC_OFF 0x00 // 7 0 LoRa CRC mode: disabled
-
303 #define RADIOLIB_SX126X_LORA_CRC_ON 0x01 // 7 0 enabled
-
304 #define RADIOLIB_SX126X_LORA_IQ_STANDARD 0x00 // 7 0 LoRa IQ setup: standard
-
305 #define RADIOLIB_SX126X_LORA_IQ_INVERTED 0x01 // 7 0 inverted
-
306 
-
307 //RADIOLIB_SX126X_CMD_SET_CAD_PARAMS
-
308 #define RADIOLIB_SX126X_CAD_ON_1_SYMB 0x00 // 7 0 number of symbols used for CAD: 1
-
309 #define RADIOLIB_SX126X_CAD_ON_2_SYMB 0x01 // 7 0 2
-
310 #define RADIOLIB_SX126X_CAD_ON_4_SYMB 0x02 // 7 0 4
-
311 #define RADIOLIB_SX126X_CAD_ON_8_SYMB 0x03 // 7 0 8
-
312 #define RADIOLIB_SX126X_CAD_ON_16_SYMB 0x04 // 7 0 16
-
313 #define RADIOLIB_SX126X_CAD_GOTO_STDBY 0x00 // 7 0 after CAD is done, always go to STDBY_RC mode
-
314 #define RADIOLIB_SX126X_CAD_GOTO_RX 0x01 // 7 0 after CAD is done, go to Rx mode if activity is detected
-
315 #define RADIOLIB_SX126X_CAD_PARAM_DEFAULT 0xFF // 7 0 used by the CAD methods to specify default parameter value
-
316 #define RADIOLIB_SX126X_CAD_PARAM_DET_MIN 10 // 7 0 default detMin CAD parameter
-
317 
-
318 //RADIOLIB_SX126X_CMD_GET_STATUS
-
319 #define RADIOLIB_SX126X_STATUS_MODE_STDBY_RC 0b00100000 // 6 4 current chip mode: STDBY_RC
-
320 #define RADIOLIB_SX126X_STATUS_MODE_STDBY_XOSC 0b00110000 // 6 4 STDBY_XOSC
-
321 #define RADIOLIB_SX126X_STATUS_MODE_FS 0b01000000 // 6 4 FS
-
322 #define RADIOLIB_SX126X_STATUS_MODE_RX 0b01010000 // 6 4 RX
-
323 #define RADIOLIB_SX126X_STATUS_MODE_TX 0b01100000 // 6 4 TX
-
324 #define RADIOLIB_SX126X_STATUS_DATA_AVAILABLE 0b00000100 // 3 1 command status: packet received and data can be retrieved
-
325 #define RADIOLIB_SX126X_STATUS_CMD_TIMEOUT 0b00000110 // 3 1 SPI command timed out
-
326 #define RADIOLIB_SX126X_STATUS_CMD_INVALID 0b00001000 // 3 1 invalid SPI command
-
327 #define RADIOLIB_SX126X_STATUS_CMD_FAILED 0b00001010 // 3 1 SPI command failed to execute
-
328 #define RADIOLIB_SX126X_STATUS_TX_DONE 0b00001100 // 3 1 packet transmission done
-
329 #define RADIOLIB_SX126X_STATUS_SPI_FAILED 0b11111111 // 7 0 SPI transaction failed
-
330 
-
331 //RADIOLIB_SX126X_CMD_GET_PACKET_STATUS
-
332 #define RADIOLIB_SX126X_GFSK_RX_STATUS_PREAMBLE_ERR 0b10000000 // 7 7 GFSK Rx status: preamble error
-
333 #define RADIOLIB_SX126X_GFSK_RX_STATUS_SYNC_ERR 0b01000000 // 6 6 sync word error
-
334 #define RADIOLIB_SX126X_GFSK_RX_STATUS_ADRS_ERR 0b00100000 // 5 5 address error
-
335 #define RADIOLIB_SX126X_GFSK_RX_STATUS_CRC_ERR 0b00010000 // 4 4 CRC error
-
336 #define RADIOLIB_SX126X_GFSK_RX_STATUS_LENGTH_ERR 0b00001000 // 3 3 length error
-
337 #define RADIOLIB_SX126X_GFSK_RX_STATUS_ABORT_ERR 0b00000100 // 2 2 abort error
-
338 #define RADIOLIB_SX126X_GFSK_RX_STATUS_PACKET_RECEIVED 0b00000010 // 2 2 packet received
-
339 #define RADIOLIB_SX126X_GFSK_RX_STATUS_PACKET_SENT 0b00000001 // 2 2 packet sent
-
340 
-
341 //RADIOLIB_SX126X_CMD_GET_DEVICE_ERRORS
-
342 #define RADIOLIB_SX126X_PA_RAMP_ERR 0b100000000 // 8 8 device errors: PA ramping failed
-
343 #define RADIOLIB_SX126X_PLL_LOCK_ERR 0b001000000 // 6 6 PLL failed to lock
-
344 #define RADIOLIB_SX126X_XOSC_START_ERR 0b000100000 // 5 5 crystal oscillator failed to start
-
345 #define RADIOLIB_SX126X_IMG_CALIB_ERR 0b000010000 // 4 4 image calibration failed
-
346 #define RADIOLIB_SX126X_ADC_CALIB_ERR 0b000001000 // 3 3 ADC calibration failed
-
347 #define RADIOLIB_SX126X_PLL_CALIB_ERR 0b000000100 // 2 2 PLL calibration failed
-
348 #define RADIOLIB_SX126X_RC13M_CALIB_ERR 0b000000010 // 1 1 RC13M calibration failed
-
349 #define RADIOLIB_SX126X_RC64K_CALIB_ERR 0b000000001 // 0 0 RC64K calibration failed
-
350 
-
351 
-
352 // SX126X SPI register variables
-
353 //RADIOLIB_SX126X_REG_HOPPING_ENABLE
-
354 #define RADIOLIB_SX126X_HOPPING_ENABLED 0b00000001 // 0 0 intra-packet hopping for LR-FHSS: enabled
-
355 #define RADIOLIB_SX126X_HOPPING_DISABLED 0b00000000 // 0 0 (disabled)
-
356 
-
357 //RADIOLIB_SX126X_REG_LORA_SYNC_WORD_MSB + LSB
-
358 #define RADIOLIB_SX126X_SYNC_WORD_PUBLIC 0x34 // actually 0x3444 NOTE: The low nibbles in each byte (0x_4_4) are masked out since apparently, they're reserved.
-
359 #define RADIOLIB_SX126X_SYNC_WORD_PRIVATE 0x12 // actually 0x1424 You couldn't make this up if you tried.
-
360 
-
361 
-
368 class SX126x: public PhysicalLayer {
-
369  public:
-
370  // introduce PhysicalLayer overloads
-
371  using PhysicalLayer::transmit;
-
372  using PhysicalLayer::receive;
-
373  using PhysicalLayer::startTransmit;
-
374  using PhysicalLayer::readData;
-
375 
-
381  SX126x(Module* mod);
-
382 
-
383  Module* getMod();
-
384 
-
385  // basic methods
+
115 #define RADIOLIB_SX126X_REG_LNA_CAP_TUNE_N 0x08E3
+
116 #define RADIOLIB_SX126X_REG_LNA_CAP_TUNE_P 0x08E4
+
117 #define RADIOLIB_SX126X_REG_OCP_CONFIGURATION 0x08E7
+
118 #define RADIOLIB_SX126X_REG_RTC_CTRL 0x0902
+
119 #define RADIOLIB_SX126X_REG_XTA_TRIM 0x0911
+
120 #define RADIOLIB_SX126X_REG_XTB_TRIM 0x0912
+
121 #define RADIOLIB_SX126X_REG_DIO3_OUT_VOLTAGE_CTRL 0x0920
+
122 #define RADIOLIB_SX126X_REG_EVENT_MASK 0x0944
+
123 
+
124 // undocumented registers
+
125 #define RADIOLIB_SX126X_REG_SENSITIVITY_CONFIG 0x0889 // SX1268 datasheet v1.1, section 15.1
+
126 #define RADIOLIB_SX126X_REG_RX_GAIN_RETENTION_0 0x029F // SX1268 datasheet v1.1, section 9.6
+
127 #define RADIOLIB_SX126X_REG_RX_GAIN_RETENTION_1 0x02A0 // SX1268 datasheet v1.1, section 9.6
+
128 #define RADIOLIB_SX126X_REG_RX_GAIN_RETENTION_2 0x02A1 // SX1268 datasheet v1.1, section 9.6
+
129 
+
130 
+
131 // SX126X SPI command variables
+
132 //RADIOLIB_SX126X_CMD_SET_SLEEP MSB LSB DESCRIPTION
+
133 #define RADIOLIB_SX126X_SLEEP_START_COLD 0b00000000 // 2 2 sleep mode: cold start, configuration is lost (default)
+
134 #define RADIOLIB_SX126X_SLEEP_START_WARM 0b00000100 // 2 2 warm start, configuration is retained
+
135 #define RADIOLIB_SX126X_SLEEP_RTC_OFF 0b00000000 // 0 0 wake on RTC timeout: disabled
+
136 #define RADIOLIB_SX126X_SLEEP_RTC_ON 0b00000001 // 0 0 enabled
+
137 
+
138 //RADIOLIB_SX126X_CMD_SET_STANDBY
+
139 #define RADIOLIB_SX126X_STANDBY_RC 0x00 // 7 0 standby mode: 13 MHz RC oscillator
+
140 #define RADIOLIB_SX126X_STANDBY_XOSC 0x01 // 7 0 32 MHz crystal oscillator
+
141 
+
142 //RADIOLIB_SX126X_CMD_SET_RX
+
143 #define RADIOLIB_SX126X_RX_TIMEOUT_NONE 0x000000 // 23 0 Rx timeout duration: no timeout (Rx single mode)
+
144 #define RADIOLIB_SX126X_RX_TIMEOUT_INF 0xFFFFFF // 23 0 infinite (Rx continuous mode)
+
145 
+
146 //RADIOLIB_SX126X_CMD_SET_TX
+
147 #define RADIOLIB_SX126X_TX_TIMEOUT_NONE 0x000000 // 23 0 Tx timeout duration: no timeout (Tx single mode)
+
148 
+
149 //RADIOLIB_SX126X_CMD_STOP_TIMER_ON_PREAMBLE
+
150 #define RADIOLIB_SX126X_STOP_ON_PREAMBLE_OFF 0x00 // 7 0 stop timer on: sync word or header (default)
+
151 #define RADIOLIB_SX126X_STOP_ON_PREAMBLE_ON 0x01 // 7 0 preamble detection
+
152 
+
153 //RADIOLIB_SX126X_CMD_SET_REGULATOR_MODE
+
154 #define RADIOLIB_SX126X_REGULATOR_LDO 0x00 // 7 0 set regulator mode: LDO (default)
+
155 #define RADIOLIB_SX126X_REGULATOR_DC_DC 0x01 // 7 0 DC-DC
+
156 
+
157 //RADIOLIB_SX126X_CMD_CALIBRATE
+
158 #define RADIOLIB_SX126X_CALIBRATE_IMAGE_OFF 0b00000000 // 6 6 image calibration: disabled
+
159 #define RADIOLIB_SX126X_CALIBRATE_IMAGE_ON 0b01000000 // 6 6 enabled
+
160 #define RADIOLIB_SX126X_CALIBRATE_ADC_BULK_P_OFF 0b00000000 // 5 5 ADC bulk P calibration: disabled
+
161 #define RADIOLIB_SX126X_CALIBRATE_ADC_BULK_P_ON 0b00100000 // 5 5 enabled
+
162 #define RADIOLIB_SX126X_CALIBRATE_ADC_BULK_N_OFF 0b00000000 // 4 4 ADC bulk N calibration: disabled
+
163 #define RADIOLIB_SX126X_CALIBRATE_ADC_BULK_N_ON 0b00010000 // 4 4 enabled
+
164 #define RADIOLIB_SX126X_CALIBRATE_ADC_PULSE_OFF 0b00000000 // 3 3 ADC pulse calibration: disabled
+
165 #define RADIOLIB_SX126X_CALIBRATE_ADC_PULSE_ON 0b00001000 // 3 3 enabled
+
166 #define RADIOLIB_SX126X_CALIBRATE_PLL_OFF 0b00000000 // 2 2 PLL calibration: disabled
+
167 #define RADIOLIB_SX126X_CALIBRATE_PLL_ON 0b00000100 // 2 2 enabled
+
168 #define RADIOLIB_SX126X_CALIBRATE_RC13M_OFF 0b00000000 // 1 1 13 MHz RC osc. calibration: disabled
+
169 #define RADIOLIB_SX126X_CALIBRATE_RC13M_ON 0b00000010 // 1 1 enabled
+
170 #define RADIOLIB_SX126X_CALIBRATE_RC64K_OFF 0b00000000 // 0 0 64 kHz RC osc. calibration: disabled
+
171 #define RADIOLIB_SX126X_CALIBRATE_RC64K_ON 0b00000001 // 0 0 enabled
+
172 #define RADIOLIB_SX126X_CALIBRATE_ALL 0b01111111 // 6 0 calibrate all blocks
+
173 
+
174 //RADIOLIB_SX126X_CMD_CALIBRATE_IMAGE
+
175 #define RADIOLIB_SX126X_CAL_IMG_430_MHZ_1 0x6B
+
176 #define RADIOLIB_SX126X_CAL_IMG_430_MHZ_2 0x6F
+
177 #define RADIOLIB_SX126X_CAL_IMG_470_MHZ_1 0x75
+
178 #define RADIOLIB_SX126X_CAL_IMG_470_MHZ_2 0x81
+
179 #define RADIOLIB_SX126X_CAL_IMG_779_MHZ_1 0xC1
+
180 #define RADIOLIB_SX126X_CAL_IMG_779_MHZ_2 0xC5
+
181 #define RADIOLIB_SX126X_CAL_IMG_863_MHZ_1 0xD7
+
182 #define RADIOLIB_SX126X_CAL_IMG_863_MHZ_2 0xDB
+
183 #define RADIOLIB_SX126X_CAL_IMG_902_MHZ_1 0xE1
+
184 #define RADIOLIB_SX126X_CAL_IMG_902_MHZ_2 0xE9
+
185 
+
186 //RADIOLIB_SX126X_CMD_SET_PA_CONFIG
+
187 #define RADIOLIB_SX126X_PA_CONFIG_HP_MAX 0x07
+
188 #define RADIOLIB_SX126X_PA_CONFIG_PA_LUT 0x01
+
189 #define RADIOLIB_SX126X_PA_CONFIG_SX1262_8 0x00
+
190 
+
191 //RADIOLIB_SX126X_CMD_SET_RX_TX_FALLBACK_MODE
+
192 #define RADIOLIB_SX126X_RX_TX_FALLBACK_MODE_FS 0x40 // 7 0 after Rx/Tx go to: FS mode
+
193 #define RADIOLIB_SX126X_RX_TX_FALLBACK_MODE_STDBY_XOSC 0x30 // 7 0 standby with crystal oscillator
+
194 #define RADIOLIB_SX126X_RX_TX_FALLBACK_MODE_STDBY_RC 0x20 // 7 0 standby with RC oscillator (default)
+
195 
+
196 //RADIOLIB_SX126X_CMD_SET_DIO_IRQ_PARAMS
+
197 #define RADIOLIB_SX126X_IRQ_LR_FHSS_HOP 0b0100000000000000 // 14 14 PA ramped up during LR-FHSS hop
+
198 #define RADIOLIB_SX126X_IRQ_TIMEOUT 0b0000001000000000 // 9 9 Rx or Tx timeout
+
199 #define RADIOLIB_SX126X_IRQ_CAD_DETECTED 0b0000000100000000 // 8 8 channel activity detected
+
200 #define RADIOLIB_SX126X_IRQ_CAD_DONE 0b0000000010000000 // 7 7 channel activity detection finished
+
201 #define RADIOLIB_SX126X_IRQ_CRC_ERR 0b0000000001000000 // 6 6 wrong CRC received
+
202 #define RADIOLIB_SX126X_IRQ_HEADER_ERR 0b0000000000100000 // 5 5 LoRa header CRC error
+
203 #define RADIOLIB_SX126X_IRQ_HEADER_VALID 0b0000000000010000 // 4 4 valid LoRa header received
+
204 #define RADIOLIB_SX126X_IRQ_SYNC_WORD_VALID 0b0000000000001000 // 3 3 valid sync word detected
+
205 #define RADIOLIB_SX126X_IRQ_RADIOLIB_PREAMBLE_DETECTED 0b0000000000000100 // 2 2 preamble detected
+
206 #define RADIOLIB_SX126X_IRQ_RX_DONE 0b0000000000000010 // 1 1 packet received
+
207 #define RADIOLIB_SX126X_IRQ_TX_DONE 0b0000000000000001 // 0 0 packet transmission completed
+
208 #define RADIOLIB_SX126X_IRQ_ALL 0b0100001111111111 // 14 0 all interrupts
+
209 #define RADIOLIB_SX126X_IRQ_NONE 0b0000000000000000 // 14 0 no interrupts
+
210 
+
211 //RADIOLIB_SX126X_CMD_SET_DIO2_AS_RF_SWITCH_CTRL
+
212 #define RADIOLIB_SX126X_DIO2_AS_IRQ 0x00 // 7 0 DIO2 configuration: IRQ
+
213 #define RADIOLIB_SX126X_DIO2_AS_RF_SWITCH 0x01 // 7 0 RF switch control
+
214 
+
215 //RADIOLIB_SX126X_CMD_SET_DIO3_AS_TCXO_CTRL
+
216 #define RADIOLIB_SX126X_DIO3_OUTPUT_1_6 0x00 // 7 0 DIO3 voltage output for TCXO: 1.6 V
+
217 #define RADIOLIB_SX126X_DIO3_OUTPUT_1_7 0x01 // 7 0 1.7 V
+
218 #define RADIOLIB_SX126X_DIO3_OUTPUT_1_8 0x02 // 7 0 1.8 V
+
219 #define RADIOLIB_SX126X_DIO3_OUTPUT_2_2 0x03 // 7 0 2.2 V
+
220 #define RADIOLIB_SX126X_DIO3_OUTPUT_2_4 0x04 // 7 0 2.4 V
+
221 #define RADIOLIB_SX126X_DIO3_OUTPUT_2_7 0x05 // 7 0 2.7 V
+
222 #define RADIOLIB_SX126X_DIO3_OUTPUT_3_0 0x06 // 7 0 3.0 V
+
223 #define RADIOLIB_SX126X_DIO3_OUTPUT_3_3 0x07 // 7 0 3.3 V
+
224 
+
225 //RADIOLIB_SX126X_CMD_SET_PACKET_TYPE
+
226 #define RADIOLIB_SX126X_PACKET_TYPE_GFSK 0x00 // 7 0 packet type: GFSK
+
227 #define RADIOLIB_SX126X_PACKET_TYPE_LORA 0x01 // 7 0 LoRa
+
228 #define RADIOLIB_SX126X_PACKET_TYPE_LR_FHSS 0x03 // 7 0 LR-FHSS
+
229 
+
230 //RADIOLIB_SX126X_CMD_SET_TX_PARAMS
+
231 #define RADIOLIB_SX126X_PA_RAMP_10U 0x00 // 7 0 ramp time: 10 us
+
232 #define RADIOLIB_SX126X_PA_RAMP_20U 0x01 // 7 0 20 us
+
233 #define RADIOLIB_SX126X_PA_RAMP_40U 0x02 // 7 0 40 us
+
234 #define RADIOLIB_SX126X_PA_RAMP_80U 0x03 // 7 0 80 us
+
235 #define RADIOLIB_SX126X_PA_RAMP_200U 0x04 // 7 0 200 us
+
236 #define RADIOLIB_SX126X_PA_RAMP_800U 0x05 // 7 0 800 us
+
237 #define RADIOLIB_SX126X_PA_RAMP_1700U 0x06 // 7 0 1700 us
+
238 #define RADIOLIB_SX126X_PA_RAMP_3400U 0x07 // 7 0 3400 us
+
239 
+
240 //RADIOLIB_SX126X_CMD_SET_MODULATION_PARAMS
+
241 #define RADIOLIB_SX126X_GFSK_FILTER_NONE 0x00 // 7 0 GFSK filter: none
+
242 #define RADIOLIB_SX126X_GFSK_FILTER_GAUSS_0_3 0x08 // 7 0 Gaussian, BT = 0.3
+
243 #define RADIOLIB_SX126X_GFSK_FILTER_GAUSS_0_5 0x09 // 7 0 Gaussian, BT = 0.5
+
244 #define RADIOLIB_SX126X_GFSK_FILTER_GAUSS_0_7 0x0A // 7 0 Gaussian, BT = 0.7
+
245 #define RADIOLIB_SX126X_GFSK_FILTER_GAUSS_1 0x0B // 7 0 Gaussian, BT = 1
+
246 #define RADIOLIB_SX126X_GFSK_RX_BW_4_8 0x1F // 7 0 GFSK Rx bandwidth: 4.8 kHz
+
247 #define RADIOLIB_SX126X_GFSK_RX_BW_5_8 0x17 // 7 0 5.8 kHz
+
248 #define RADIOLIB_SX126X_GFSK_RX_BW_7_3 0x0F // 7 0 7.3 kHz
+
249 #define RADIOLIB_SX126X_GFSK_RX_BW_9_7 0x1E // 7 0 9.7 kHz
+
250 #define RADIOLIB_SX126X_GFSK_RX_BW_11_7 0x16 // 7 0 11.7 kHz
+
251 #define RADIOLIB_SX126X_GFSK_RX_BW_14_6 0x0E // 7 0 14.6 kHz
+
252 #define RADIOLIB_SX126X_GFSK_RX_BW_19_5 0x1D // 7 0 19.5 kHz
+
253 #define RADIOLIB_SX126X_GFSK_RX_BW_23_4 0x15 // 7 0 23.4 kHz
+
254 #define RADIOLIB_SX126X_GFSK_RX_BW_29_3 0x0D // 7 0 29.3 kHz
+
255 #define RADIOLIB_SX126X_GFSK_RX_BW_39_0 0x1C // 7 0 39.0 kHz
+
256 #define RADIOLIB_SX126X_GFSK_RX_BW_46_9 0x14 // 7 0 46.9 kHz
+
257 #define RADIOLIB_SX126X_GFSK_RX_BW_58_6 0x0C // 7 0 58.6 kHz
+
258 #define RADIOLIB_SX126X_GFSK_RX_BW_78_2 0x1B // 7 0 78.2 kHz
+
259 #define RADIOLIB_SX126X_GFSK_RX_BW_93_8 0x13 // 7 0 93.8 kHz
+
260 #define RADIOLIB_SX126X_GFSK_RX_BW_117_3 0x0B // 7 0 117.3 kHz
+
261 #define RADIOLIB_SX126X_GFSK_RX_BW_156_2 0x1A // 7 0 156.2 kHz
+
262 #define RADIOLIB_SX126X_GFSK_RX_BW_187_2 0x12 // 7 0 187.2 kHz
+
263 #define RADIOLIB_SX126X_GFSK_RX_BW_234_3 0x0A // 7 0 234.3 kHz
+
264 #define RADIOLIB_SX126X_GFSK_RX_BW_312_0 0x19 // 7 0 312.0 kHz
+
265 #define RADIOLIB_SX126X_GFSK_RX_BW_373_6 0x11 // 7 0 373.6 kHz
+
266 #define RADIOLIB_SX126X_GFSK_RX_BW_467_0 0x09 // 7 0 467.0 kHz
+
267 #define RADIOLIB_SX126X_LORA_BW_7_8 0x00 // 7 0 LoRa bandwidth: 7.8 kHz
+
268 #define RADIOLIB_SX126X_LORA_BW_10_4 0x08 // 7 0 10.4 kHz
+
269 #define RADIOLIB_SX126X_LORA_BW_15_6 0x01 // 7 0 15.6 kHz
+
270 #define RADIOLIB_SX126X_LORA_BW_20_8 0x09 // 7 0 20.8 kHz
+
271 #define RADIOLIB_SX126X_LORA_BW_31_25 0x02 // 7 0 31.25 kHz
+
272 #define RADIOLIB_SX126X_LORA_BW_41_7 0x0A // 7 0 41.7 kHz
+
273 #define RADIOLIB_SX126X_LORA_BW_62_5 0x03 // 7 0 62.5 kHz
+
274 #define RADIOLIB_SX126X_LORA_BW_125_0 0x04 // 7 0 125.0 kHz
+
275 #define RADIOLIB_SX126X_LORA_BW_250_0 0x05 // 7 0 250.0 kHz
+
276 #define RADIOLIB_SX126X_LORA_BW_500_0 0x06 // 7 0 500.0 kHz
+
277 #define RADIOLIB_SX126X_LORA_CR_4_5 0x01 // 7 0 LoRa coding rate: 4/5
+
278 #define RADIOLIB_SX126X_LORA_CR_4_6 0x02 // 7 0 4/6
+
279 #define RADIOLIB_SX126X_LORA_CR_4_7 0x03 // 7 0 4/7
+
280 #define RADIOLIB_SX126X_LORA_CR_4_8 0x04 // 7 0 4/8
+
281 #define RADIOLIB_SX126X_LORA_LOW_DATA_RATE_OPTIMIZE_OFF 0x00 // 7 0 LoRa low data rate optimization: disabled
+
282 #define RADIOLIB_SX126X_LORA_LOW_DATA_RATE_OPTIMIZE_ON 0x01 // 7 0 enabled
+
283 
+
284 //RADIOLIB_SX126X_CMD_SET_PACKET_PARAMS
+
285 #define RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_OFF 0x00 // 7 0 GFSK minimum preamble length before reception starts: detector disabled
+
286 #define RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_8 0x04 // 7 0 8 bits
+
287 #define RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_16 0x05 // 7 0 16 bits
+
288 #define RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_24 0x06 // 7 0 24 bits
+
289 #define RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_32 0x07 // 7 0 32 bits
+
290 #define RADIOLIB_SX126X_GFSK_ADDRESS_FILT_OFF 0x00 // 7 0 GFSK address filtering: disabled
+
291 #define RADIOLIB_SX126X_GFSK_ADDRESS_FILT_NODE 0x01 // 7 0 node only
+
292 #define RADIOLIB_SX126X_GFSK_ADDRESS_FILT_NODE_BROADCAST 0x02 // 7 0 node and broadcast
+
293 #define RADIOLIB_SX126X_GFSK_PACKET_FIXED 0x00 // 7 0 GFSK packet type: fixed (payload length known in advance to both sides)
+
294 #define RADIOLIB_SX126X_GFSK_PACKET_VARIABLE 0x01 // 7 0 variable (payload length added to packet)
+
295 #define RADIOLIB_SX126X_GFSK_CRC_OFF 0x01 // 7 0 GFSK packet CRC: disabled
+
296 #define RADIOLIB_SX126X_GFSK_CRC_1_BYTE 0x00 // 7 0 1 byte
+
297 #define RADIOLIB_SX126X_GFSK_CRC_2_BYTE 0x02 // 7 0 2 byte
+
298 #define RADIOLIB_SX126X_GFSK_CRC_1_BYTE_INV 0x04 // 7 0 1 byte, inverted
+
299 #define RADIOLIB_SX126X_GFSK_CRC_2_BYTE_INV 0x06 // 7 0 2 byte, inverted
+
300 #define RADIOLIB_SX126X_GFSK_WHITENING_OFF 0x00 // 7 0 GFSK data whitening: disabled
+
301 #define RADIOLIB_SX126X_GFSK_WHITENING_ON 0x01 // 7 0 enabled
+
302 #define RADIOLIB_SX126X_LORA_HEADER_EXPLICIT 0x00 // 7 0 LoRa header mode: explicit
+
303 #define RADIOLIB_SX126X_LORA_HEADER_IMPLICIT 0x01 // 7 0 implicit
+
304 #define RADIOLIB_SX126X_LORA_CRC_OFF 0x00 // 7 0 LoRa CRC mode: disabled
+
305 #define RADIOLIB_SX126X_LORA_CRC_ON 0x01 // 7 0 enabled
+
306 #define RADIOLIB_SX126X_LORA_IQ_STANDARD 0x00 // 7 0 LoRa IQ setup: standard
+
307 #define RADIOLIB_SX126X_LORA_IQ_INVERTED 0x01 // 7 0 inverted
+
308 
+
309 //RADIOLIB_SX126X_CMD_SET_CAD_PARAMS
+
310 #define RADIOLIB_SX126X_CAD_ON_1_SYMB 0x00 // 7 0 number of symbols used for CAD: 1
+
311 #define RADIOLIB_SX126X_CAD_ON_2_SYMB 0x01 // 7 0 2
+
312 #define RADIOLIB_SX126X_CAD_ON_4_SYMB 0x02 // 7 0 4
+
313 #define RADIOLIB_SX126X_CAD_ON_8_SYMB 0x03 // 7 0 8
+
314 #define RADIOLIB_SX126X_CAD_ON_16_SYMB 0x04 // 7 0 16
+
315 #define RADIOLIB_SX126X_CAD_GOTO_STDBY 0x00 // 7 0 after CAD is done, always go to STDBY_RC mode
+
316 #define RADIOLIB_SX126X_CAD_GOTO_RX 0x01 // 7 0 after CAD is done, go to Rx mode if activity is detected
+
317 #define RADIOLIB_SX126X_CAD_PARAM_DEFAULT 0xFF // 7 0 used by the CAD methods to specify default parameter value
+
318 #define RADIOLIB_SX126X_CAD_PARAM_DET_MIN 10 // 7 0 default detMin CAD parameter
+
319 
+
320 //RADIOLIB_SX126X_CMD_GET_STATUS
+
321 #define RADIOLIB_SX126X_STATUS_MODE_STDBY_RC 0b00100000 // 6 4 current chip mode: STDBY_RC
+
322 #define RADIOLIB_SX126X_STATUS_MODE_STDBY_XOSC 0b00110000 // 6 4 STDBY_XOSC
+
323 #define RADIOLIB_SX126X_STATUS_MODE_FS 0b01000000 // 6 4 FS
+
324 #define RADIOLIB_SX126X_STATUS_MODE_RX 0b01010000 // 6 4 RX
+
325 #define RADIOLIB_SX126X_STATUS_MODE_TX 0b01100000 // 6 4 TX
+
326 #define RADIOLIB_SX126X_STATUS_DATA_AVAILABLE 0b00000100 // 3 1 command status: packet received and data can be retrieved
+
327 #define RADIOLIB_SX126X_STATUS_CMD_TIMEOUT 0b00000110 // 3 1 SPI command timed out
+
328 #define RADIOLIB_SX126X_STATUS_CMD_INVALID 0b00001000 // 3 1 invalid SPI command
+
329 #define RADIOLIB_SX126X_STATUS_CMD_FAILED 0b00001010 // 3 1 SPI command failed to execute
+
330 #define RADIOLIB_SX126X_STATUS_TX_DONE 0b00001100 // 3 1 packet transmission done
+
331 #define RADIOLIB_SX126X_STATUS_SPI_FAILED 0b11111111 // 7 0 SPI transaction failed
+
332 
+
333 //RADIOLIB_SX126X_CMD_GET_PACKET_STATUS
+
334 #define RADIOLIB_SX126X_GFSK_RX_STATUS_PREAMBLE_ERR 0b10000000 // 7 7 GFSK Rx status: preamble error
+
335 #define RADIOLIB_SX126X_GFSK_RX_STATUS_SYNC_ERR 0b01000000 // 6 6 sync word error
+
336 #define RADIOLIB_SX126X_GFSK_RX_STATUS_ADRS_ERR 0b00100000 // 5 5 address error
+
337 #define RADIOLIB_SX126X_GFSK_RX_STATUS_CRC_ERR 0b00010000 // 4 4 CRC error
+
338 #define RADIOLIB_SX126X_GFSK_RX_STATUS_LENGTH_ERR 0b00001000 // 3 3 length error
+
339 #define RADIOLIB_SX126X_GFSK_RX_STATUS_ABORT_ERR 0b00000100 // 2 2 abort error
+
340 #define RADIOLIB_SX126X_GFSK_RX_STATUS_PACKET_RECEIVED 0b00000010 // 2 2 packet received
+
341 #define RADIOLIB_SX126X_GFSK_RX_STATUS_PACKET_SENT 0b00000001 // 2 2 packet sent
+
342 
+
343 //RADIOLIB_SX126X_CMD_GET_DEVICE_ERRORS
+
344 #define RADIOLIB_SX126X_PA_RAMP_ERR 0b100000000 // 8 8 device errors: PA ramping failed
+
345 #define RADIOLIB_SX126X_PLL_LOCK_ERR 0b001000000 // 6 6 PLL failed to lock
+
346 #define RADIOLIB_SX126X_XOSC_START_ERR 0b000100000 // 5 5 crystal oscillator failed to start
+
347 #define RADIOLIB_SX126X_IMG_CALIB_ERR 0b000010000 // 4 4 image calibration failed
+
348 #define RADIOLIB_SX126X_ADC_CALIB_ERR 0b000001000 // 3 3 ADC calibration failed
+
349 #define RADIOLIB_SX126X_PLL_CALIB_ERR 0b000000100 // 2 2 PLL calibration failed
+
350 #define RADIOLIB_SX126X_RC13M_CALIB_ERR 0b000000010 // 1 1 RC13M calibration failed
+
351 #define RADIOLIB_SX126X_RC64K_CALIB_ERR 0b000000001 // 0 0 RC64K calibration failed
+
352 
+
353 
+
354 // SX126X SPI register variables
+
355 //RADIOLIB_SX126X_REG_HOPPING_ENABLE
+
356 #define RADIOLIB_SX126X_HOPPING_ENABLED 0b00000001 // 0 0 intra-packet hopping for LR-FHSS: enabled
+
357 #define RADIOLIB_SX126X_HOPPING_DISABLED 0b00000000 // 0 0 (disabled)
+
358 
+
359 //RADIOLIB_SX126X_REG_LORA_SYNC_WORD_MSB + LSB
+
360 #define RADIOLIB_SX126X_SYNC_WORD_PUBLIC 0x34 // actually 0x3444 NOTE: The low nibbles in each byte (0x_4_4) are masked out since apparently, they're reserved.
+
361 #define RADIOLIB_SX126X_SYNC_WORD_PRIVATE 0x12 // actually 0x1424 You couldn't make this up if you tried.
+
362 
+
363 // RADIOLIB_SX126X_REG_TX_BITBANG_ENABLE_1
+
364 #define RADIOLIB_SX126X_TX_BITBANG_1_DISABLED 0b00000000 // 6 4 Tx bitbang: disabled (default)
+
365 #define RADIOLIB_SX126X_TX_BITBANG_1_ENABLED 0b00010000 // 6 4 enabled
+
366 
+
367 // RADIOLIB_SX126X_REG_TX_BITBANG_ENABLE_0
+
368 #define RADIOLIB_SX126X_TX_BITBANG_0_DISABLED 0b00000000 // 3 0 Tx bitbang: disabled (default)
+
369 #define RADIOLIB_SX126X_TX_BITBANG_0_ENABLED 0b00001100 // 3 0 enabled
+
370 
+
371 // RADIOLIB_SX126X_REG_DIOX_OUT_ENABLE
+
372 #define RADIOLIB_SX126X_DIO1_OUT_DISABLED 0b00000010 // 1 1 DIO1 output: disabled
+
373 #define RADIOLIB_SX126X_DIO1_OUT_ENABLED 0b00000000 // 1 1 enabled
+
374 #define RADIOLIB_SX126X_DIO2_OUT_DISABLED 0b00000100 // 2 2 DIO2 output: disabled
+
375 #define RADIOLIB_SX126X_DIO2_OUT_ENABLED 0b00000000 // 2 2 enabled
+
376 #define RADIOLIB_SX126X_DIO3_OUT_DISABLED 0b00001000 // 3 3 DIO3 output: disabled
+
377 #define RADIOLIB_SX126X_DIO3_OUT_ENABLED 0b00000000 // 3 3 enabled
+
378 
+
379 // RADIOLIB_SX126X_REG_DIOX_IN_ENABLE
+
380 #define RADIOLIB_SX126X_DIO1_IN_DISABLED 0b00000000 // 1 1 DIO1 input: disabled
+
381 #define RADIOLIB_SX126X_DIO1_IN_ENABLED 0b00000010 // 1 1 enabled
+
382 #define RADIOLIB_SX126X_DIO2_IN_DISABLED 0b00000000 // 2 2 DIO2 input: disabled
+
383 #define RADIOLIB_SX126X_DIO2_IN_ENABLED 0b00000100 // 2 2 enabled
+
384 #define RADIOLIB_SX126X_DIO3_IN_DISABLED 0b00000000 // 3 3 DIO3 input: disabled
+
385 #define RADIOLIB_SX126X_DIO3_IN_ENABLED 0b00001000 // 3 3 enabled
386 
-
402  int16_t begin(uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO = false);
-
403 
-
421  int16_t beginFSK(float br, float freqDev, float rxBw, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO = false);
-
422 
-
431  int16_t reset(bool verify = true);
-
432 
-
445  int16_t transmit(uint8_t* data, size_t len, uint8_t addr = 0) override;
-
446 
-
457  int16_t receive(uint8_t* data, size_t len) override;
-
458 
-
466  int16_t transmitDirect(uint32_t frf = 0) override;
-
467 
-
474  int16_t receiveDirect() override;
-
475 
-
487  int16_t scanChannel(uint8_t symbolNum = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin = RADIOLIB_SX126X_CAD_PARAM_DEFAULT);
-
488 
-
496  int16_t sleep(bool retainConfig = true);
-
497 
-
503  int16_t standby() override;
-
504 
-
512  int16_t standby(uint8_t mode);
+
393 class SX126x: public PhysicalLayer {
+
394  public:
+
395  // introduce PhysicalLayer overloads
+
396  using PhysicalLayer::transmit;
+
397  using PhysicalLayer::receive;
+
398  using PhysicalLayer::startTransmit;
+
399  using PhysicalLayer::readData;
+
400 
+
406  SX126x(Module* mod);
+
407 
+
408  Module* getMod();
+
409 
+
410  // basic methods
+
411 
+
427  int16_t begin(uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO = false);
+
428 
+
446  int16_t beginFSK(float br, float freqDev, float rxBw, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO = false);
+
447 
+
456  int16_t reset(bool verify = true);
+
457 
+
470  int16_t transmit(uint8_t* data, size_t len, uint8_t addr = 0) override;
+
471 
+
482  int16_t receive(uint8_t* data, size_t len) override;
+
483 
+
491  int16_t transmitDirect(uint32_t frf = 0) override;
+
492 
+
499  int16_t receiveDirect() override;
+
500 
+
512  int16_t scanChannel(uint8_t symbolNum = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin = RADIOLIB_SX126X_CAD_PARAM_DEFAULT);
513 
-
514  // interrupt methods
-
515 
-
521  void setDio1Action(void (*func)(void));
+
521  int16_t sleep(bool retainConfig = true);
522 
-
526  void clearDio1Action();
-
527 
-
540  int16_t startTransmit(uint8_t* data, size_t len, uint8_t addr = 0) override;
-
541 
-
547  int16_t finishTransmit() override;
-
548 
-
557  int16_t startReceive(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF);
-
558 
-
569  int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod);
-
570 
-
582  int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength = 0, uint16_t minSymbols = 8);
+
528  int16_t standby() override;
+
529 
+
537  int16_t standby(uint8_t mode);
+
538 
+
539  // interrupt methods
+
540 
+
546  void setDio1Action(void (*func)(void));
+
547 
+
551  void clearDio1Action();
+
552 
+
565  int16_t startTransmit(uint8_t* data, size_t len, uint8_t addr = 0) override;
+
566 
+
572  int16_t finishTransmit() override;
+
573 
+
582  int16_t startReceive(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF);
583 
-
589  uint16_t getIrqStatus();
-
590 
-
601  int16_t readData(uint8_t* data, size_t len) override;
-
602 
-
614  int16_t startChannelScan(uint8_t symbolNum = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin = RADIOLIB_SX126X_CAD_PARAM_DEFAULT);
+
594  int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod);
+
595 
+
607  int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength = 0, uint16_t minSymbols = 8);
+
608 
+
614  uint16_t getIrqStatus();
615 
-
621  int16_t getChannelScanResult();
-
622 
-
623  // configuration methods
-
624 
-
632  int16_t setBandwidth(float bw);
-
633 
-
641  int16_t setSpreadingFactor(uint8_t sf);
-
642 
-
650  int16_t setCodingRate(uint8_t cr);
-
651 
-
661  int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits = 0x44);
-
662 
-
670  int16_t setCurrentLimit(float currentLimit);
-
671 
-
677  float getCurrentLimit();
-
678 
-
686  int16_t setPreambleLength(uint16_t preambleLength);
+
626  int16_t readData(uint8_t* data, size_t len) override;
+
627 
+
639  int16_t startChannelScan(uint8_t symbolNum = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin = RADIOLIB_SX126X_CAD_PARAM_DEFAULT);
+
640 
+
646  int16_t getChannelScanResult();
+
647 
+
648  // configuration methods
+
649 
+
657  int16_t setBandwidth(float bw);
+
658 
+
666  int16_t setSpreadingFactor(uint8_t sf);
+
667 
+
675  int16_t setCodingRate(uint8_t cr);
+
676 
+
686  int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits = 0x44);
687 
-
695  int16_t setFrequencyDeviation(float freqDev) override;
+
695  int16_t setCurrentLimit(float currentLimit);
696 
-
704  int16_t setBitRate(float br);
-
705 
-
713  int16_t setRxBandwidth(float rxBw);
-
714 
-
724  int16_t setRxBoostedGainMode(bool rxbgm, bool persist = true);
-
725 
-
735  int16_t setDataShaping(uint8_t sh) override;
-
736 
-
746  int16_t setSyncWord(uint8_t* syncWord, uint8_t len);
-
747 
-
757  int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen);
-
758 
-
766  int16_t setNodeAddress(uint8_t nodeAddr);
-
767 
-
775  int16_t setBroadcastAddress(uint8_t broadAddr);
-
776 
-
782  int16_t disableAddressFiltering();
+
702  float getCurrentLimit();
+
703 
+
711  int16_t setPreambleLength(uint16_t preambleLength);
+
712 
+
720  int16_t setFrequencyDeviation(float freqDev) override;
+
721 
+
729  int16_t setBitRate(float br);
+
730 
+
738  int16_t setRxBandwidth(float rxBw);
+
739 
+
749  int16_t setRxBoostedGainMode(bool rxbgm, bool persist = true);
+
750 
+
760  int16_t setDataShaping(uint8_t sh) override;
+
761 
+
771  int16_t setSyncWord(uint8_t* syncWord, uint8_t len);
+
772 
+
782  int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen);
783 
-
797  int16_t setCRC(uint8_t len, uint16_t initial = 0x1D0F, uint16_t polynomial = 0x1021, bool inverted = true);
-
798 
-
808  int16_t setWhitening(bool enabled, uint16_t initial = 0x0100);
-
809 
-
820  int16_t setTCXO(float voltage, uint32_t delay = 5000);
-
821 
-
827  int16_t setDio2AsRfSwitch(bool enable = true);
-
828 
-
834  float getDataRate() const;
-
835 
-
841  float getRSSI();
-
842 
-
848  float getSNR();
-
849 
-
857  size_t getPacketLength(bool update = true) override;
-
858 
-
866  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
+
791  int16_t setNodeAddress(uint8_t nodeAddr);
+
792 
+
800  int16_t setBroadcastAddress(uint8_t broadAddr);
+
801 
+
807  int16_t disableAddressFiltering();
+
808 
+
822  int16_t setCRC(uint8_t len, uint16_t initial = 0x1D0F, uint16_t polynomial = 0x1021, bool inverted = true);
+
823 
+
833  int16_t setWhitening(bool enabled, uint16_t initial = 0x0100);
+
834 
+
845  int16_t setTCXO(float voltage, uint32_t delay = 5000);
+
846 
+
852  int16_t setDio2AsRfSwitch(bool enable = true);
+
853 
+
859  float getDataRate() const;
+
860 
+
866  float getRSSI();
867 
-
875  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
-
876 
-
884  uint32_t getTimeOnAir(size_t len);
-
885 
-
891  float getRSSIInst();
+
873  float getSNR();
+
874 
+
882  size_t getPacketLength(bool update = true) override;
+
883 
+
891  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
892 
-
900  int16_t implicitHeader(size_t len);
+
900  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
901 
-
907  int16_t explicitHeader();
-
908 
-
914  int16_t setRegulatorLDO();
-
915 
-
921  int16_t setRegulatorDCDC();
-
922 
-
930  int16_t setEncoding(uint8_t encoding) override;
-
931 
-
933  void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);
-
934 
-
936  void setRfSwitchTable(const RADIOLIB_PIN_TYPE (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
-
937 
-
946  int16_t forceLDRO(bool enable);
+
909  uint32_t getTimeOnAir(size_t len);
+
910 
+
916  float getRSSIInst();
+
917 
+
925  int16_t implicitHeader(size_t len);
+
926 
+
932  int16_t explicitHeader();
+
933 
+
939  int16_t setRegulatorLDO();
+
940 
+
946  int16_t setRegulatorDCDC();
947 
-
954  int16_t autoLDRO();
-
955 
-
961  uint8_t randomByte();
+
955  int16_t setEncoding(uint8_t encoding) override;
+
956 
+
958  void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);
+
959 
+
961  void setRfSwitchTable(const RADIOLIB_PIN_TYPE (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
962 
-
968  int16_t getLastError();
-
969 
-
970  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
976  void setDirectAction(void (*func)(void));
-
977 
-
983  void readBit(RADIOLIB_PIN_TYPE pin);
-
984  #endif
-
985 
-
986 
-
987 #if !defined(RADIOLIB_GODMODE)
-
988  protected:
-
989 #endif
-
990  // SX126x SPI command implementations
-
991  int16_t setTx(uint32_t timeout = 0);
-
992  int16_t setRx(uint32_t timeout);
-
993  int16_t setCad(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
-
994  int16_t setPaConfig(uint8_t paDutyCycle, uint8_t deviceSel, uint8_t hpMax = RADIOLIB_SX126X_PA_CONFIG_HP_MAX, uint8_t paLut = RADIOLIB_SX126X_PA_CONFIG_PA_LUT);
-
995  int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
-
996  int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
-
997  int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
-
998  int16_t readBuffer(uint8_t* data, uint8_t numBytes);
-
999  int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX126X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX126X_IRQ_NONE);
-
1000  virtual int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX126X_IRQ_ALL);
-
1001  int16_t setRfFrequency(uint32_t frf);
-
1002  int16_t calibrateImage(uint8_t* data);
-
1003  uint8_t getPacketType();
-
1004  int16_t setTxParams(uint8_t power, uint8_t rampTime = RADIOLIB_SX126X_PA_RAMP_200U);
-
1005  int16_t setModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
-
1006  int16_t setModulationParamsFSK(uint32_t br, uint8_t pulseShape, uint8_t rxBw, uint32_t freqDev);
-
1007  int16_t setPacketParams(uint16_t preambleLength, uint8_t crcType, uint8_t payloadLength, uint8_t headerType, uint8_t invertIQ = RADIOLIB_SX126X_LORA_IQ_STANDARD);
-
1008  int16_t setPacketParamsFSK(uint16_t preambleLength, uint8_t crcType, uint8_t syncWordLength, uint8_t addrComp, uint8_t whitening, uint8_t packetType = RADIOLIB_SX126X_GFSK_PACKET_VARIABLE, uint8_t payloadLength = 0xFF, uint8_t preambleDetectorLength = RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_16);
-
1009  int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
-
1010  int16_t setRegulatorMode(uint8_t mode);
-
1011  uint8_t getStatus();
-
1012  uint32_t getPacketStatus();
-
1013  uint16_t getDeviceErrors();
-
1014  int16_t clearDeviceErrors();
-
1015 
-
1016  int16_t startReceiveCommon(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF);
-
1017  int16_t setFrequencyRaw(float freq);
-
1018  int16_t setPacketMode(uint8_t mode, uint8_t len);
-
1019  int16_t setHeaderType(uint8_t headerType, size_t len = 0xFF);
-
1020  int16_t directMode();
-
1021 
-
1022  // fixes to errata
-
1023  int16_t fixSensitivity();
-
1024  int16_t fixPaClamping(bool enable = true);
-
1025  int16_t fixImplicitTimeout();
-
1026  int16_t fixInvertedIQ(uint8_t iqConfig);
-
1027 
-
1028 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
1029  protected:
-
1030 #endif
-
1031  Module* _mod;
-
1032 
-
1033  // common low-level SPI interface
-
1034  int16_t SPIwriteCommand(uint8_t cmd, uint8_t* data, uint8_t numBytes, bool waitForBusy = true, bool verify = true);
-
1035  int16_t SPIwriteCommand(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, uint8_t numBytes, bool waitForBusy = true, bool verify = true);
-
1036  int16_t SPIreadCommand(uint8_t cmd, uint8_t* data, uint8_t numBytes, bool waitForBusy = true, bool verify = true);
-
1037  int16_t SPIreadCommand(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, uint8_t numBytes, bool waitForBusy = true, bool verify = true);
-
1038  int16_t SPItransfer(uint8_t* cmd, uint8_t cmdLen, bool write, uint8_t* dataOut, uint8_t* dataIn, uint8_t numBytes, bool waitForBusy, uint32_t timeout = 5000);
-
1039 
-
1040 #if !defined(RADIOLIB_GODMODE)
-
1041  protected:
-
1042 #endif
-
1043 
-
1044  uint8_t _bw = 0, _sf = 0, _cr = 0, _ldro = 0, _crcType = 0, _headerType = 0;
-
1045  uint16_t _preambleLength = 0;
-
1046  float _bwKhz = 0;
-
1047  bool _ldroAuto = true;
-
1048 
-
1049  uint32_t _br = 0, _freqDev = 0;
-
1050  uint8_t _rxBw = 0, _pulseShape = 0, _crcTypeFSK = 0, _syncWordLength = 0, _addrComp = 0, _whitening = 0, _packetType = 0;
-
1051  uint16_t _preambleLengthFSK = 0;
-
1052  float _rxBwKhz = 0;
-
1053 
-
1054  float _dataRate = 0;
-
1055 
-
1056  uint32_t _tcxoDelay = 0;
-
1057 
-
1058  size_t _implicitLen = 0;
-
1059 
-
1060  int16_t _lastError = RADIOLIB_ERR_NONE;
-
1061 
-
1062  // Allow subclasses to define different TX modes
-
1063  uint8_t _tx_mode = Module::MODE_TX;
-
1064 
-
1065  int16_t config(uint8_t modem);
-
1066  int16_t checkCommandResult();
-
1067 };
+
971  int16_t forceLDRO(bool enable);
+
972 
+
979  int16_t autoLDRO();
+
980 
+
986  uint8_t randomByte();
+
987 
+
988  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
994  void setDirectAction(void (*func)(void));
+
995 
+
1001  void readBit(RADIOLIB_PIN_TYPE pin);
+
1002  #endif
+
1003 
+
1004 
+
1005 #if !defined(RADIOLIB_GODMODE)
+
1006  protected:
+
1007 #endif
+
1008  // SX126x SPI command implementations
+
1009  int16_t setTx(uint32_t timeout = 0);
+
1010  int16_t setRx(uint32_t timeout);
+
1011  int16_t setCad(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
+
1012  int16_t setPaConfig(uint8_t paDutyCycle, uint8_t deviceSel, uint8_t hpMax = RADIOLIB_SX126X_PA_CONFIG_HP_MAX, uint8_t paLut = RADIOLIB_SX126X_PA_CONFIG_PA_LUT);
+
1013  int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+
1014  int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+
1015  int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
+
1016  int16_t readBuffer(uint8_t* data, uint8_t numBytes);
+
1017  int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX126X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX126X_IRQ_NONE);
+
1018  virtual int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX126X_IRQ_ALL);
+
1019  int16_t setRfFrequency(uint32_t frf);
+
1020  int16_t calibrateImage(uint8_t* data);
+
1021  uint8_t getPacketType();
+
1022  int16_t setTxParams(uint8_t power, uint8_t rampTime = RADIOLIB_SX126X_PA_RAMP_200U);
+
1023  int16_t setModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
+
1024  int16_t setModulationParamsFSK(uint32_t br, uint8_t pulseShape, uint8_t rxBw, uint32_t freqDev);
+
1025  int16_t setPacketParams(uint16_t preambleLength, uint8_t crcType, uint8_t payloadLength, uint8_t headerType, uint8_t invertIQ = RADIOLIB_SX126X_LORA_IQ_STANDARD);
+
1026  int16_t setPacketParamsFSK(uint16_t preambleLength, uint8_t crcType, uint8_t syncWordLength, uint8_t addrComp, uint8_t whitening, uint8_t packetType = RADIOLIB_SX126X_GFSK_PACKET_VARIABLE, uint8_t payloadLength = 0xFF, uint8_t preambleDetectorLength = RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_16);
+
1027  int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
+
1028  int16_t setRegulatorMode(uint8_t mode);
+
1029  uint8_t getStatus();
+
1030  uint32_t getPacketStatus();
+
1031  uint16_t getDeviceErrors();
+
1032  int16_t clearDeviceErrors();
+
1033 
+
1034  int16_t startReceiveCommon(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF);
+
1035  int16_t setFrequencyRaw(float freq);
+
1036  int16_t setPacketMode(uint8_t mode, uint8_t len);
+
1037  int16_t setHeaderType(uint8_t headerType, size_t len = 0xFF);
+
1038  int16_t directMode();
+
1039  int16_t packetMode();
+
1040 
+
1041  // fixes to errata
+
1042  int16_t fixSensitivity();
+
1043  int16_t fixPaClamping(bool enable = true);
+
1044  int16_t fixImplicitTimeout();
+
1045  int16_t fixInvertedIQ(uint8_t iqConfig);
+
1046 
+
1047 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
1048  protected:
+
1049 #endif
+
1050  Module* _mod;
+
1051 
+
1052  // common low-level SPI interface
+
1053  static int16_t SPIparseStatus(uint8_t in);
+
1054 
+
1055 #if !defined(RADIOLIB_GODMODE)
+
1056  protected:
+
1057 #endif
+
1058 
+
1059  uint8_t _bw = 0, _sf = 0, _cr = 0, _ldro = 0, _crcType = 0, _headerType = 0;
+
1060  uint16_t _preambleLength = 0;
+
1061  float _bwKhz = 0;
+
1062  bool _ldroAuto = true;
+
1063 
+
1064  uint32_t _br = 0, _freqDev = 0;
+
1065  uint8_t _rxBw = 0, _pulseShape = 0, _crcTypeFSK = 0, _syncWordLength = 0, _addrComp = 0, _whitening = 0, _packetType = 0;
+
1066  uint16_t _preambleLengthFSK = 0;
+
1067  float _rxBwKhz = 0;
1068 
-
1069 #endif
+
1069  float _dataRate = 0;
1070 
-
1071 #endif
+
1071  uint32_t _tcxoDelay = 0;
+
1072 
+
1073  size_t _implicitLen = 0;
+
1074 
+
1075  // Allow subclasses to define different TX modes
+
1076  uint8_t _tx_mode = Module::MODE_TX;
+
1077 
+
1078  int16_t config(uint8_t modem);
+
1079 };
+
1080 
+
1081 #endif
+
1082 
+
1083 #endif
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
Module::RFSWITCH_MAX_PINS
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:27
Module::MODE_TX
@ MODE_TX
Definition: Module.h:56
@@ -689,71 +706,69 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
PhysicalLayer::readData
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:140
PhysicalLayer::startTransmit
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:121
PhysicalLayer::receive
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
-
SX126x
Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...
Definition: SX126x.h:368
-
SX126x::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:423
-
SX126x::getRSSI
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: SX126x.cpp:1192
-
SX126x::startChannelScan
int16_t startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)
Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is dete...
Definition: SX126x.cpp:649
-
SX126x::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPI...
Definition: SX126x.cpp:967
-
SX126x::setRegulatorLDO
int16_t setRegulatorLDO()
Set regulator mode to LDO.
Definition: SX126x.cpp:1280
-
SX126x::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX126x.cpp:1292
-
SX126x::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Available in FSK mode only. Serves only as alias for PhysicalLayer compat...
Definition: SX126x.cpp:1288
-
SX126x::beginFSK
int16_t beginFSK(float br, float freqDev, float rxBw, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO=false)
Initialization method for FSK modem.
Definition: SX126x.cpp:78
-
SX126x::setBandwidth
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 7.8, 10.4, 15.6, 20.8, 31.25, 41.7, 62.5, 125....
Definition: SX126x.cpp:696
-
SX126x::explicitHeader
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX126x.cpp:1276
-
SX126x::forceLDRO
int16_t forceLDRO(bool enable)
Forces LoRa low data rate optimization. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1300
-
SX126x::setNodeAddress
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition: SX126x.cpp:1047
-
SX126x::setTCXO
int16_t setTCXO(float voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition: SX126x.cpp:1360
-
SX126x::setRxBandwidth
int16_t setRxBandwidth(float rxBw)
Sets FSK receiver bandwidth. Allowed values are 4.8, 5.8, 7.3, 9.7, 11.7, 14.6, 19....
Definition: SX126x.cpp:867
-
SX126x::setRegulatorDCDC
int16_t setRegulatorDCDC()
Set regulator mode to DC-DC.
Definition: SX126x.cpp:1284
-
SX126x::setWhitening
int16_t setWhitening(bool enabled, uint16_t initial=0x0100)
Sets FSK whitening parameters.
Definition: SX126x.cpp:1151
-
SX126x::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:427
-
SX126x::startReceiveDutyCycleAuto
int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8)
Calls startReceiveDutyCycle with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages...
Definition: SX126x.cpp:540
-
SX126x::scanChannel
int16_t scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.
Definition: SX126x.cpp:381
-
SX126x::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: SX126x.cpp:411
-
SX126x::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz.
Definition: SX126x.cpp:819
-
SX126x::setBitRate
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps.
Definition: SX126x.cpp:846
-
SX126x::getTimeOnAir
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX126x.cpp:1230
-
SX126x::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: SX126x.cpp:1321
-
SX126x::receiveDirect
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does...
Definition: SX126x.cpp:316
-
SX126x::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: SX126x.cpp:492
-
SX126x::setCurrentLimit
int16_t setCurrentLimit(float currentLimit)
Sets current protection limit. Can be set in 2.5 mA steps.
Definition: SX126x.cpp:784
-
SX126x::setRxBoostedGainMode
int16_t setRxBoostedGainMode(bool rxbgm, bool persist=true)
Enables or disables Rx Boosted Gain mode as described in SX126x datasheet section 9....
Definition: SX126x.cpp:930
-
SX126x::transmitDirect
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: SX126x.cpp:300
-
SX126x::variablePacketLengthMode
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)
Set modem in variable packet length mode. Available in FSK mode only.
Definition: SX126x.cpp:1226
+
SX126x
Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...
Definition: SX126x.h:393
+
SX126x::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:444
+
SX126x::getRSSI
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: SX126x.cpp:1207
+
SX126x::startChannelScan
int16_t startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)
Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is dete...
Definition: SX126x.cpp:670
+
SX126x::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPI...
Definition: SX126x.cpp:982
+
SX126x::setRegulatorLDO
int16_t setRegulatorLDO()
Set regulator mode to LDO.
Definition: SX126x.cpp:1295
+
SX126x::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX126x.cpp:1307
+
SX126x::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Available in FSK mode only. Serves only as alias for PhysicalLayer compat...
Definition: SX126x.cpp:1303
+
SX126x::beginFSK
int16_t beginFSK(float br, float freqDev, float rxBw, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO=false)
Initialization method for FSK modem.
Definition: SX126x.cpp:84
+
SX126x::setBandwidth
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 7.8, 10.4, 15.6, 20.8, 31.25, 41.7, 62.5, 125....
Definition: SX126x.cpp:717
+
SX126x::explicitHeader
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX126x.cpp:1291
+
SX126x::forceLDRO
int16_t forceLDRO(bool enable)
Forces LoRa low data rate optimization. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1315
+
SX126x::setNodeAddress
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition: SX126x.cpp:1062
+
SX126x::setTCXO
int16_t setTCXO(float voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition: SX126x.cpp:1367
+
SX126x::setRxBandwidth
int16_t setRxBandwidth(float rxBw)
Sets FSK receiver bandwidth. Allowed values are 4.8, 5.8, 7.3, 9.7, 11.7, 14.6, 19....
Definition: SX126x.cpp:882
+
SX126x::setRegulatorDCDC
int16_t setRegulatorDCDC()
Set regulator mode to DC-DC.
Definition: SX126x.cpp:1299
+
SX126x::setWhitening
int16_t setWhitening(bool enabled, uint16_t initial=0x0100)
Sets FSK whitening parameters.
Definition: SX126x.cpp:1166
+
SX126x::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:448
+
SX126x::startReceiveDutyCycleAuto
int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8)
Calls startReceiveDutyCycle with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages...
Definition: SX126x.cpp:561
+
SX126x::scanChannel
int16_t scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.
Definition: SX126x.cpp:402
+
SX126x::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: SX126x.cpp:432
+
SX126x::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz.
Definition: SX126x.cpp:840
+
SX126x::setBitRate
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps.
Definition: SX126x.cpp:864
+
SX126x::getTimeOnAir
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX126x.cpp:1245
+
SX126x::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: SX126x.cpp:1336
+
SX126x::receiveDirect
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does...
Definition: SX126x.cpp:328
+
SX126x::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: SX126x.cpp:513
+
SX126x::setCurrentLimit
int16_t setCurrentLimit(float currentLimit)
Sets current protection limit. Can be set in 2.5 mA steps.
Definition: SX126x.cpp:805
+
SX126x::setRxBoostedGainMode
int16_t setRxBoostedGainMode(bool rxbgm, bool persist=true)
Enables or disables Rx Boosted Gain mode as described in SX126x datasheet section 9....
Definition: SX126x.cpp:945
+
SX126x::transmitDirect
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: SX126x.cpp:312
+
SX126x::variablePacketLengthMode
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)
Set modem in variable packet length mode. Available in FSK mode only.
Definition: SX126x.cpp:1241
SX126x::begin
int16_t begin(uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO=false)
Initialization method for LoRa modem.
Definition: SX126x.cpp:12
-
SX126x::setCRC
int16_t setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)
Sets CRC configuration.
Definition: SX126x.cpp:1092
-
SX126x::getIrqStatus
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX126x.cpp:1509
-
SX126x::reset
int16_t reset(bool verify=true)
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX126x.cpp:159
-
SX126x::setSyncWord
int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)
Sets LoRa sync word.
Definition: SX126x.cpp:773
-
SX126x::getCurrentLimit
float getCurrentLimit()
Reads current protection limit.
Definition: SX126x.cpp:797
+
SX126x::setCRC
int16_t setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)
Sets CRC configuration.
Definition: SX126x.cpp:1107
+
SX126x::getIrqStatus
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX126x.cpp:1514
+
SX126x::reset
int16_t reset(bool verify=true)
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX126x.cpp:171
+
SX126x::setSyncWord
int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)
Sets LoRa sync word.
Definition: SX126x.cpp:794
+
SX126x::getCurrentLimit
float getCurrentLimit()
Reads current protection limit.
Definition: SX126x.cpp:818
SX126x::SX126x
SX126x(Module *mod)
Default constructor.
Definition: SX126x.cpp:4
-
SX126x::setPreambleLength
int16_t setPreambleLength(uint16_t preambleLength)
Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535.
Definition: SX126x.cpp:806
+
SX126x::setPreambleLength
int16_t setPreambleLength(uint16_t preambleLength)
Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535.
Definition: SX126x.cpp:827
SX126x::transmit
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
-
SX126x::autoLDRO
int16_t autoLDRO()
Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1312
-
SX126x::setDirectAction
void setDirectAction(void(*func)(void))
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX126x.cpp:1347
-
SX126x::fixedPacketLengthMode
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_SX126X_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode. Available in FSK mode only.
Definition: SX126x.cpp:1222
-
SX126x::setBroadcastAddress
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition: SX126x.cpp:1064
-
SX126x::getChannelScanResult
int16_t getChannelScanResult()
Read the channel scan result.
Definition: SX126x.cpp:675
-
SX126x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX126x.cpp:1215
-
SX126x::setSyncBits
int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen)
Sets FSK sync word in the form of array of up to 8 bytes.
Definition: SX126x.cpp:1020
-
SX126x::getLastError
int16_t getLastError()
Get the last recorded transaction error.
Definition: SX126x.cpp:1342
-
SX126x::getDataRate
float getDataRate() const
Gets effective data rate for the last transmitted packet. The value is calculated only for payload by...
Definition: SX126x.cpp:1188
-
SX126x::setRfSwitchTable
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX126x.cpp:1296
-
SX126x::startReceiveDutyCycle
int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)
Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen....
Definition: SX126x.cpp:513
-
SX126x::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX126x.cpp:1272
-
SX126x::getRSSIInst
float getRSSIInst()
Get instantaneous RSSI value during recption of the packet. Should switch to FSK receive mode for LBT...
Definition: SX126x.cpp:1265
-
SX126x::getSNR
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: SX126x.cpp:1199
-
SX126x::setDio2AsRfSwitch
int16_t setDio2AsRfSwitch(bool enable=true)
Set DIO2 to function as RF switch (default in Semtech example designs).
Definition: SX126x.cpp:1408
-
SX126x::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX126x.cpp:747
+
SX126x::autoLDRO
int16_t autoLDRO()
Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1327
+
SX126x::setDirectAction
void setDirectAction(void(*func)(void))
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX126x.cpp:1358
+
SX126x::fixedPacketLengthMode
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_SX126X_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode. Available in FSK mode only.
Definition: SX126x.cpp:1237
+
SX126x::setBroadcastAddress
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition: SX126x.cpp:1079
+
SX126x::getChannelScanResult
int16_t getChannelScanResult()
Read the channel scan result.
Definition: SX126x.cpp:696
+
SX126x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX126x.cpp:1230
+
SX126x::setSyncBits
int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen)
Sets FSK sync word in the form of array of up to 8 bytes.
Definition: SX126x.cpp:1035
+
SX126x::getDataRate
float getDataRate() const
Gets effective data rate for the last transmitted packet. The value is calculated only for payload by...
Definition: SX126x.cpp:1203
+
SX126x::setRfSwitchTable
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX126x.cpp:1311
+
SX126x::startReceiveDutyCycle
int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)
Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen....
Definition: SX126x.cpp:534
+
SX126x::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX126x.cpp:1287
+
SX126x::getRSSIInst
float getRSSIInst()
Get instantaneous RSSI value during recption of the packet. Should switch to FSK receive mode for LBT...
Definition: SX126x.cpp:1280
+
SX126x::getSNR
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: SX126x.cpp:1214
+
SX126x::setDio2AsRfSwitch
int16_t setDio2AsRfSwitch(bool enable=true)
Set DIO2 to function as RF switch (default in Semtech example designs).
Definition: SX126x.cpp:1415
+
SX126x::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX126x.cpp:768
SX126x::readData
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:140
-
SX126x::startReceive
int16_t startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)
Interrupt-driven receive method. DIO1 will be activated when full packet is received.
Definition: SX126x.cpp:500
+
SX126x::startReceive
int16_t startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)
Interrupt-driven receive method. DIO1 will be activated when full packet is received.
Definition: SX126x.cpp:521
SX126x::startTransmit
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:121
SX126x::receive
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
-
SX126x::sleep
int16_t sleep(bool retainConfig=true)
Sets the module to sleep mode.
Definition: SX126x.cpp:395
-
SX126x::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: SX126x.cpp:1081
-
SX126x::setCodingRate
int16_t setCodingRate(uint8_t cr)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX126x.cpp:760
-
SX126x::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX126x.cpp:1353
-
RADIOLIB_ERR_NONE
#define RADIOLIB_ERR_NONE
No error, method executed successfully.
Definition: TypeDef.h:102
+
SX126x::sleep
int16_t sleep(bool retainConfig=true)
Sets the module to sleep mode.
Definition: SX126x.cpp:416
+
SX126x::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: SX126x.cpp:1096
+
SX126x::setCodingRate
int16_t setCodingRate(uint8_t cr)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX126x.cpp:781
+
SX126x::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX126x.cpp:1362
Module::RfSwitchMode_t
Definition: Module.h:34
diff --git a/_s_x128x_8h_source.html b/_s_x128x_8h_source.html index b5da630a..0936e98b 100644 --- a/_s_x128x_8h_source.html +++ b/_s_x128x_8h_source.html @@ -541,90 +541,81 @@ $(document).ready(function(){initNavTree('_s_x128x_8h_source.html',''); initResi
817 
823  uint8_t randomByte();
824 
-
830  int16_t getLastError();
-
831 
-
832  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
838  void setDirectAction(void (*func)(void));
-
839 
-
845  void readBit(RADIOLIB_PIN_TYPE pin);
-
846  #endif
-
847 
-
848 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
849  protected:
-
850 #endif
-
851  Module* _mod;
-
852 
-
853 #if !defined(RADIOLIB_GODMODE)
-
854  protected:
-
855 #endif
-
856 
-
857  // cached LoRa parameters
-
858  float _bwKhz = 0;
-
859  uint8_t _bw = 0, _sf = 0, _cr = 0;
-
860  uint8_t _preambleLengthLoRa = 0, _headerType = 0, _payloadLen = 0, _crcLoRa = 0;
-
861 
-
862  // SX128x SPI command implementations
-
863  uint8_t getStatus();
-
864  int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
-
865  int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
-
866  int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
-
867  int16_t readBuffer(uint8_t* data, uint8_t numBytes);
-
868  int16_t setTx(uint16_t periodBaseCount = RADIOLIB_SX128X_TX_TIMEOUT_NONE, uint8_t periodBase = RADIOLIB_SX128X_PERIOD_BASE_15_625_US);
-
869  int16_t setRx(uint16_t periodBaseCount, uint8_t periodBase = RADIOLIB_SX128X_PERIOD_BASE_15_625_US);
-
870  int16_t setCad();
-
871  uint8_t getPacketType();
-
872  int16_t setRfFrequency(uint32_t frf);
-
873  int16_t setTxParams(uint8_t power, uint8_t rampTime = RADIOLIB_SX128X_PA_RAMP_10_US);
-
874  int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
-
875  int16_t setModulationParams(uint8_t modParam1, uint8_t modParam2, uint8_t modParam3);
-
876  int16_t setPacketParamsGFSK(uint8_t preambleLen, uint8_t syncWordLen, uint8_t syncWordMatch, uint8_t crcLen, uint8_t whitening, uint8_t payloadLen = 0xFF, uint8_t headerType = RADIOLIB_SX128X_GFSK_FLRC_PACKET_VARIABLE);
-
877  int16_t setPacketParamsBLE(uint8_t connState, uint8_t crcLen, uint8_t bleTestPayload, uint8_t whitening);
-
878  int16_t setPacketParamsLoRa(uint8_t preambleLen, uint8_t headerType, uint8_t payloadLen, uint8_t crc, uint8_t invertIQ = RADIOLIB_SX128X_LORA_IQ_STANDARD);
-
879  int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX128X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX128X_IRQ_NONE);
-
880  int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX128X_IRQ_ALL);
-
881  int16_t setRangingRole(uint8_t role);
-
882  int16_t setPacketType(uint8_t type);
-
883 
-
884  int16_t setHeaderType(uint8_t headerType, size_t len = 0xFF);
+
825  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
831  void setDirectAction(void (*func)(void));
+
832 
+
838  void readBit(RADIOLIB_PIN_TYPE pin);
+
839  #endif
+
840 
+
841 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
842  protected:
+
843 #endif
+
844  Module* _mod;
+
845 
+
846 #if !defined(RADIOLIB_GODMODE)
+
847  protected:
+
848 #endif
+
849 
+
850  // cached LoRa parameters
+
851  float _bwKhz = 0;
+
852  uint8_t _bw = 0, _sf = 0, _cr = 0;
+
853  uint8_t _preambleLengthLoRa = 0, _headerType = 0, _payloadLen = 0, _crcLoRa = 0;
+
854 
+
855  // SX128x SPI command implementations
+
856  uint8_t getStatus();
+
857  int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+
858  int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+
859  int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
+
860  int16_t readBuffer(uint8_t* data, uint8_t numBytes);
+
861  int16_t setTx(uint16_t periodBaseCount = RADIOLIB_SX128X_TX_TIMEOUT_NONE, uint8_t periodBase = RADIOLIB_SX128X_PERIOD_BASE_15_625_US);
+
862  int16_t setRx(uint16_t periodBaseCount, uint8_t periodBase = RADIOLIB_SX128X_PERIOD_BASE_15_625_US);
+
863  int16_t setCad();
+
864  uint8_t getPacketType();
+
865  int16_t setRfFrequency(uint32_t frf);
+
866  int16_t setTxParams(uint8_t power, uint8_t rampTime = RADIOLIB_SX128X_PA_RAMP_10_US);
+
867  int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
+
868  int16_t setModulationParams(uint8_t modParam1, uint8_t modParam2, uint8_t modParam3);
+
869  int16_t setPacketParamsGFSK(uint8_t preambleLen, uint8_t syncWordLen, uint8_t syncWordMatch, uint8_t crcLen, uint8_t whitening, uint8_t payloadLen = 0xFF, uint8_t headerType = RADIOLIB_SX128X_GFSK_FLRC_PACKET_VARIABLE);
+
870  int16_t setPacketParamsBLE(uint8_t connState, uint8_t crcLen, uint8_t bleTestPayload, uint8_t whitening);
+
871  int16_t setPacketParamsLoRa(uint8_t preambleLen, uint8_t headerType, uint8_t payloadLen, uint8_t crc, uint8_t invertIQ = RADIOLIB_SX128X_LORA_IQ_STANDARD);
+
872  int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX128X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX128X_IRQ_NONE);
+
873  int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX128X_IRQ_ALL);
+
874  int16_t setRangingRole(uint8_t role);
+
875  int16_t setPacketType(uint8_t type);
+
876 
+
877  int16_t setHeaderType(uint8_t headerType, size_t len = 0xFF);
+
878 
+
879 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
880  private:
+
881 #endif
+
882 
+
883  // common low-level SPI interface
+
884  static int16_t SPIparseStatus(uint8_t in);
885 
-
886 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
886 #if !defined(RADIOLIB_GODMODE)
887  private:
888 #endif
-
889 
-
890  // common low-level SPI interface
-
891  int16_t SPIwriteCommand(uint8_t cmd, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);
-
892  int16_t SPIwriteCommand(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);
-
893  int16_t SPIreadCommand(uint8_t cmd, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);
-
894  int16_t SPIreadCommand(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);
-
895  int16_t SPItransfer(uint8_t* cmd, uint8_t cmdLen, bool write, uint8_t* dataOut, uint8_t* dataIn, uint8_t numBytes, bool waitForBusy, uint32_t timeout = 5000);
-
896 
-
897 #if !defined(RADIOLIB_GODMODE)
-
898  private:
-
899 #endif
-
900  // common parameters
-
901  uint8_t _pwr = 0;
-
902 
-
903  // cached GFSK parameters
-
904  float _modIndexReal = 0;
-
905  uint16_t _brKbps = 0;
-
906  uint8_t _br = 0, _modIndex = 0, _shaping = 0;
-
907  uint8_t _preambleLengthGFSK = 0, _syncWordLen = 0, _syncWordMatch = 0, _crcGFSK = 0, _whitening = 0;
+
889  // common parameters
+
890  uint8_t _pwr = 0;
+
891 
+
892  // cached GFSK parameters
+
893  float _modIndexReal = 0;
+
894  uint16_t _brKbps = 0;
+
895  uint8_t _br = 0, _modIndex = 0, _shaping = 0;
+
896  uint8_t _preambleLengthGFSK = 0, _syncWordLen = 0, _syncWordMatch = 0, _crcGFSK = 0, _whitening = 0;
+
897 
+
898  // cached FLRC parameters
+
899  uint8_t _crFLRC = 0;
+
900 
+
901  // cached BLE parameters
+
902  uint8_t _connectionState = 0, _crcBLE = 0, _bleTestPayload = 0;
+
903 
+
904  int16_t config(uint8_t modem);
+
905 };
+
906 
+
907 #endif
908 
-
909  // cached FLRC parameters
-
910  uint8_t _crFLRC = 0;
-
911 
-
912  // cached BLE parameters
-
913  uint8_t _connectionState = 0, _crcBLE = 0, _bleTestPayload = 0;
-
914 
-
915  int16_t _lastError = RADIOLIB_ERR_NONE;
-
916 
-
917  int16_t config(uint8_t modem);
-
918  int16_t checkCommandResult();
-
919 };
-
920 
-
921 #endif
-
922 
-
923 #endif
+
909 #endif
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
Module::RFSWITCH_MAX_PINS
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:27
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
@@ -633,57 +624,55 @@ $(document).ready(function(){initNavTree('_s_x128x_8h_source.html',''); initResi
PhysicalLayer::startTransmit
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:121
PhysicalLayer::receive
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
SX128x
Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281) inherit from thi...
Definition: SX128x.h:350
-
SX128x::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: SX128x.cpp:445
-
SX128x::setSyncWord
int16_t setSyncWord(uint8_t *syncWord, uint8_t len)
Sets FSK/FLRC sync word in the form of array of up to 5 bytes (FSK). For FLRC modem,...
Definition: SX128x.cpp:875
-
SX128x::setPreambleLength
int16_t setPreambleLength(uint32_t preambleLength)
Sets preamble length for currently active modem. Allowed values range from 1 to 65535.
Definition: SX128x.cpp:707
-
SX128x::sleep
int16_t sleep(bool retainConfig=true)
Sets the module to sleep mode.
Definition: SX128x.cpp:417
-
SX128x::setFrequency
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values are in range from 2400.0 to 2500.0 MHz.
Definition: SX128x.cpp:601
-
SX128x::getTimeOnAir
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX128x.cpp:1166
-
SX128x::reset
int16_t reset(bool verify=true)
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX128x.cpp:238
-
SX128x::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 3200.0 kHz.
Definition: SX128x.cpp:812
-
SX128x::getFrequencyError
float getFrequencyError()
Gets frequency error of the latest received packet.
Definition: SX128x.cpp:1126
-
SX128x::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: SX128x.cpp:433
-
SX128x::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1267
-
SX128x::beginBLE
int16_t beginBLE(float freq=2400.0, uint16_t br=800, float freqDev=400.0, int8_t power=10, uint8_t dataShaping=RADIOLIB_SHAPING_0_5)
Initialization method for BLE modem.
Definition: SX128x.cpp:130
-
SX128x::setGainControl
int16_t setGainControl(uint8_t gain=0)
Enables or disables receiver manual gain control.
Definition: SX128x.cpp:1046
-
SX128x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX128x.cpp:1159
-
SX128x::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: SX128x.cpp:517
-
SX128x::setBitRate
int16_t setBitRate(float br)
Sets FSK or FLRC bit rate. Allowed values are 125, 250, 400, 500, 800, 1000, 1600 and 2000 kbps (for ...
Definition: SX128x.cpp:755
-
SX128x::transmitDirect
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: SX128x.cpp:349
-
SX128x::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX128x.cpp:1242
-
SX128x::setHighSensitivityMode
int16_t setHighSensitivityMode(bool hsm=false)
Enables or disables receiver high sensitivity mode.
Definition: SX128x.cpp:1029
-
SX128x::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Serves only as alias for PhysicalLayer compatibility.
Definition: SX128x.cpp:1238
-
SX128x::scanChannel
int16_t scanChannel()
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.
Definition: SX128x.cpp:372
-
SX128x::getSNR
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa or ranging mode...
Definition: SX128x.cpp:1106
-
SX128x::setWhitening
int16_t setWhitening(bool enabled)
Sets whitening parameters, not available for LoRa or FLRC modem.
Definition: SX128x.cpp:998
-
SX128x::beginGFSK
int16_t beginGFSK(float freq=2400.0, uint16_t br=800, float freqDev=400.0, int8_t power=10, uint16_t preambleLength=16)
Initialization method for GFSK modem.
Definition: SX128x.cpp:67
-
SX128x::setAccessAddress
int16_t setAccessAddress(uint32_t addr)
Sets BLE access address.
Definition: SX128x.cpp:1018
-
SX128x::explicitHeader
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX128x.cpp:1234
-
SX128x::getRSSI
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: SX128x.cpp:1082
-
SX128x::randomByte
uint8_t randomByte()
Dummy random method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1250
-
SX128x::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPI...
Definition: SX128x.cpp:845
+
SX128x::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: SX128x.cpp:469
+
SX128x::setSyncWord
int16_t setSyncWord(uint8_t *syncWord, uint8_t len)
Sets FSK/FLRC sync word in the form of array of up to 5 bytes (FSK). For FLRC modem,...
Definition: SX128x.cpp:899
+
SX128x::setPreambleLength
int16_t setPreambleLength(uint32_t preambleLength)
Sets preamble length for currently active modem. Allowed values range from 1 to 65535.
Definition: SX128x.cpp:731
+
SX128x::sleep
int16_t sleep(bool retainConfig=true)
Sets the module to sleep mode.
Definition: SX128x.cpp:441
+
SX128x::setFrequency
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values are in range from 2400.0 to 2500.0 MHz.
Definition: SX128x.cpp:625
+
SX128x::getTimeOnAir
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX128x.cpp:1190
+
SX128x::reset
int16_t reset(bool verify=true)
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX128x.cpp:262
+
SX128x::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 3200.0 kHz.
Definition: SX128x.cpp:836
+
SX128x::getFrequencyError
float getFrequencyError()
Gets frequency error of the latest received packet.
Definition: SX128x.cpp:1150
+
SX128x::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: SX128x.cpp:457
+
SX128x::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1287
+
SX128x::beginBLE
int16_t beginBLE(float freq=2400.0, uint16_t br=800, float freqDev=400.0, int8_t power=10, uint8_t dataShaping=RADIOLIB_SHAPING_0_5)
Initialization method for BLE modem.
Definition: SX128x.cpp:142
+
SX128x::setGainControl
int16_t setGainControl(uint8_t gain=0)
Enables or disables receiver manual gain control.
Definition: SX128x.cpp:1070
+
SX128x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX128x.cpp:1183
+
SX128x::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: SX128x.cpp:541
+
SX128x::setBitRate
int16_t setBitRate(float br)
Sets FSK or FLRC bit rate. Allowed values are 125, 250, 400, 500, 800, 1000, 1600 and 2000 kbps (for ...
Definition: SX128x.cpp:779
+
SX128x::transmitDirect
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: SX128x.cpp:373
+
SX128x::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX128x.cpp:1266
+
SX128x::setHighSensitivityMode
int16_t setHighSensitivityMode(bool hsm=false)
Enables or disables receiver high sensitivity mode.
Definition: SX128x.cpp:1053
+
SX128x::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Serves only as alias for PhysicalLayer compatibility.
Definition: SX128x.cpp:1262
+
SX128x::scanChannel
int16_t scanChannel()
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.
Definition: SX128x.cpp:396
+
SX128x::getSNR
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa or ranging mode...
Definition: SX128x.cpp:1130
+
SX128x::setWhitening
int16_t setWhitening(bool enabled)
Sets whitening parameters, not available for LoRa or FLRC modem.
Definition: SX128x.cpp:1022
+
SX128x::beginGFSK
int16_t beginGFSK(float freq=2400.0, uint16_t br=800, float freqDev=400.0, int8_t power=10, uint16_t preambleLength=16)
Initialization method for GFSK modem.
Definition: SX128x.cpp:73
+
SX128x::setAccessAddress
int16_t setAccessAddress(uint32_t addr)
Sets BLE access address.
Definition: SX128x.cpp:1042
+
SX128x::explicitHeader
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX128x.cpp:1258
+
SX128x::getRSSI
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: SX128x.cpp:1106
+
SX128x::randomByte
uint8_t randomByte()
Dummy random method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1274
+
SX128x::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPI...
Definition: SX128x.cpp:869
SX128x::SX128x
SX128x(Module *mod)
Default constructor.
Definition: SX128x.cpp:4
-
SX128x::setCodingRate
int16_t setCodingRate(uint8_t cr, bool longInterleaving=false)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX128x.cpp:673
-
SX128x::setCRC
int16_t setCRC(uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)
Sets CRC configuration.
Definition: SX128x.cpp:934
+
SX128x::setCodingRate
int16_t setCodingRate(uint8_t cr, bool longInterleaving=false)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX128x.cpp:697
+
SX128x::setCRC
int16_t setCRC(uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)
Sets CRC configuration.
Definition: SX128x.cpp:958
SX128x::transmit
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
-
SX128x::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX128x.cpp:449
-
SX128x::getLastError
int16_t getLastError()
Get the last recorded transaction error.
Definition: SX128x.cpp:1256
-
SX128x::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX128x.cpp:1230
-
SX128x::beginFLRC
int16_t beginFLRC(float freq=2400.0, uint16_t br=650, uint8_t cr=3, int8_t power=10, uint16_t preambleLength=16, uint8_t dataShaping=RADIOLIB_SHAPING_0_5)
Initialization method for FLRC modem.
Definition: SX128x.cpp:179
+
SX128x::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX128x.cpp:473
+
SX128x::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX128x.cpp:1254
+
SX128x::beginFLRC
int16_t beginFLRC(float freq=2400.0, uint16_t br=650, uint8_t cr=3, int8_t power=10, uint16_t preambleLength=16, uint8_t dataShaping=RADIOLIB_SHAPING_0_5)
Initialization method for FLRC modem.
Definition: SX128x.cpp:197
SX128x::begin
int16_t begin(float freq=2400.0, float bw=812.5, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX128X_SYNC_WORD_PRIVATE, int8_t power=10, uint16_t preambleLength=12)
Initialization method for LoRa modem.
Definition: SX128x.cpp:12
-
SX128x::startReceive
int16_t startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF)
Interrupt-driven receive method. DIO1 will be activated when full packet is received.
Definition: SX128x.cpp:525
-
SX128x::setOutputPower
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are in range from -18 to 13 dBm.
Definition: SX128x.cpp:701
-
SX128x::setRfSwitchTable
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX128x.cpp:1246
-
SX128x::getIrqStatus
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX128x.cpp:1368
-
SX128x::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX128x.cpp:639
+
SX128x::startReceive
int16_t startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF)
Interrupt-driven receive method. DIO1 will be activated when full packet is received.
Definition: SX128x.cpp:549
+
SX128x::setOutputPower
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are in range from -18 to 13 dBm.
Definition: SX128x.cpp:725
+
SX128x::setRfSwitchTable
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX128x.cpp:1270
+
SX128x::getIrqStatus
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX128x.cpp:1387
+
SX128x::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX128x.cpp:663
SX128x::readData
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:140
-
SX128x::setBandwidth
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 203.125, 406.25, 812.5 and 1625.0 kHz.
Definition: SX128x.cpp:609
+
SX128x::setBandwidth
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 203.125, 406.25, 812.5 and 1625.0 kHz.
Definition: SX128x.cpp:633
SX128x::startTransmit
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:121
SX128x::receive
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
-
SX128x::setDirectAction
void setDirectAction(void(*func)(void))
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1261
-
SX128x::receiveDirect
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX128x series does...
Definition: SX128x.cpp:364
+
SX128x::setDirectAction
void setDirectAction(void(*func)(void))
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1281
+
SX128x::receiveDirect
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX128x series does...
Definition: SX128x.cpp:388
RADIOLIB_SHAPING_0_5
#define RADIOLIB_SHAPING_0_5
Gaussin shaping filter, BT = 0.5.
Definition: TypeDef.h:25
-
RADIOLIB_ERR_NONE
#define RADIOLIB_ERR_NONE
No error, method executed successfully.
Definition: TypeDef.h:102
Module::RfSwitchMode_t
Definition: Module.h:34
diff --git a/class_l_l_c_c68-members.html b/class_l_l_c_c68-members.html index 8e8abc22..6ba2d810 100644 --- a/class_l_l_c_c68-members.html +++ b/class_l_l_c_c68-members.html @@ -107,89 +107,88 @@ $(document).ready(function(){initNavTree('class_l_l_c_c68.html',''); initResizab getDataRate() constSX126x getFreqStep() constPhysicalLayer getIrqStatus()SX126x - getLastError()SX126x - getMod() (defined in SX126x)SX126xvirtual - getPacketLength(bool update=true) overrideSX126xvirtual - getRSSI()SX126x - getRSSIInst()SX126x - getSNR()SX126x - getTimeOnAir(size_t len)SX126x - implicitHeader(size_t len)SX126x - LLCC68(Module *mod)LLCC68 - PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer - random(int32_t max)PhysicalLayer - random(int32_t min, int32_t max)PhysicalLayer - randomByte()SX126xvirtual - read(bool drop=true)PhysicalLayer - readBit(RADIOLIB_PIN_TYPE pin)SX126xvirtual - readData(uint8_t *data, size_t len) overrideSX126xvirtual - readData(String &str, size_t len=0)SX126x - readData(uint8_t *data, size_t len)SX126x - PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer - receive(uint8_t *data, size_t len) overrideSX126xvirtual - receive(String &str, size_t len=0)SX126x - receive(uint8_t *data, size_t len)SX126x - PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer - receiveDirect() overrideSX126xvirtual - reset(bool verify=true)SX126x - scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x - setBandwidth(float bw)LLCC68 - setBitRate(float br)SX126xvirtual - setBroadcastAddress(uint8_t broadAddr)SX126x - setCodingRate(uint8_t cr)SX126x - setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)SX126x - setCurrentLimit(float currentLimit)SX126x - setDataShaping(uint8_t sh) overrideSX126xvirtual - setDio1Action(void(*func)(void))SX126x - setDio2AsRfSwitch(bool enable=true)SX126x - setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual - setDirectAction(void(*func)(void))SX126xvirtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding) overrideSX126xvirtual - setFrequency(float freq)SX1262virtual - setFrequency(float freq, bool calibrate)SX1262 - setFrequencyDeviation(float freqDev) overrideSX126xvirtual - setNodeAddress(uint8_t nodeAddr)SX126x - setOutputPower(int8_t power)SX1262virtual - setPreambleLength(uint16_t preambleLength)SX126x - setRegulatorDCDC()SX126x - setRegulatorLDO()SX126x - setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX126x - setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX126x - setRxBandwidth(float rxBw)SX126x - setRxBoostedGainMode(bool rxbgm, bool persist=true)SX126x - setSpreadingFactor(uint8_t sf)LLCC68 - setSyncBits(uint8_t *syncWord, uint8_t bitsLen)SX126x - setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX126x - setSyncWord(uint8_t *syncWord, uint8_t len)SX126x - setTCXO(float voltage, uint32_t delay=5000)SX126x - setWhitening(bool enabled, uint16_t initial=0x0100)SX126x - sleep(bool retainConfig=true)SX126x - standby() overrideSX126xvirtual - standby(uint8_t mode)SX126xvirtual - startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x - startDirect()PhysicalLayer - startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)SX126x - startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)SX126x - startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - startTransmit(String &str, uint8_t addr=0)SX126x - startTransmit(const char *str, uint8_t addr=0)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - SX1262(Module *mod)SX1262 - SX126x(Module *mod)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX126x - transmit(String &str, uint8_t addr=0)SX126x - transmit(const char *str, uint8_t addr=0)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideSX126xvirtual - variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x + getMod() (defined in SX126x)SX126xvirtual + getPacketLength(bool update=true) overrideSX126xvirtual + getRSSI()SX126x + getRSSIInst()SX126x + getSNR()SX126x + getTimeOnAir(size_t len)SX126x + implicitHeader(size_t len)SX126x + LLCC68(Module *mod)LLCC68 + PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer + random(int32_t max)PhysicalLayer + random(int32_t min, int32_t max)PhysicalLayer + randomByte()SX126xvirtual + read(bool drop=true)PhysicalLayer + readBit(RADIOLIB_PIN_TYPE pin)SX126xvirtual + readData(uint8_t *data, size_t len) overrideSX126xvirtual + readData(String &str, size_t len=0)SX126x + readData(uint8_t *data, size_t len)SX126x + PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer + receive(uint8_t *data, size_t len) overrideSX126xvirtual + receive(String &str, size_t len=0)SX126x + receive(uint8_t *data, size_t len)SX126x + PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer + receiveDirect() overrideSX126xvirtual + reset(bool verify=true)SX126x + scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x + setBandwidth(float bw)LLCC68 + setBitRate(float br)SX126xvirtual + setBroadcastAddress(uint8_t broadAddr)SX126x + setCodingRate(uint8_t cr)SX126x + setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)SX126x + setCurrentLimit(float currentLimit)SX126x + setDataShaping(uint8_t sh) overrideSX126xvirtual + setDio1Action(void(*func)(void))SX126x + setDio2AsRfSwitch(bool enable=true)SX126x + setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual + setDirectAction(void(*func)(void))SX126xvirtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overrideSX126xvirtual + setFrequency(float freq)SX1262virtual + setFrequency(float freq, bool calibrate)SX1262 + setFrequencyDeviation(float freqDev) overrideSX126xvirtual + setNodeAddress(uint8_t nodeAddr)SX126x + setOutputPower(int8_t power)SX1262virtual + setPreambleLength(uint16_t preambleLength)SX126x + setRegulatorDCDC()SX126x + setRegulatorLDO()SX126x + setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX126x + setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX126x + setRxBandwidth(float rxBw)SX126x + setRxBoostedGainMode(bool rxbgm, bool persist=true)SX126x + setSpreadingFactor(uint8_t sf)LLCC68 + setSyncBits(uint8_t *syncWord, uint8_t bitsLen)SX126x + setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX126x + setSyncWord(uint8_t *syncWord, uint8_t len)SX126x + setTCXO(float voltage, uint32_t delay=5000)SX126x + setWhitening(bool enabled, uint16_t initial=0x0100)SX126x + sleep(bool retainConfig=true)SX126x + standby() overrideSX126xvirtual + standby(uint8_t mode)SX126xvirtual + startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x + startDirect()PhysicalLayer + startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)SX126x + startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)SX126x + startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + startTransmit(String &str, uint8_t addr=0)SX126x + startTransmit(const char *str, uint8_t addr=0)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + SX1262(Module *mod)SX1262 + SX126x(Module *mod)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX126x + transmit(String &str, uint8_t addr=0)SX126x + transmit(const char *str, uint8_t addr=0)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideSX126xvirtual + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x diff --git a/class_l_l_c_c68.html b/class_l_l_c_c68.html index a1d02ad0..c71c1c37 100644 --- a/class_l_l_c_c68.html +++ b/class_l_l_c_c68.html @@ -330,9 +330,6 @@ void uint8_t randomByte ()  Get one truly random byte from RSSI noise. More...
  -int16_t getLastError () - Get the last recorded transaction error. More...
-  void setDirectAction (void(*func)(void))  Dummy method, to ensure PhysicalLayer compatibility. More...
  diff --git a/class_module-members.html b/class_module-members.html index 61b5879e..312dc2c5 100644 --- a/class_module-members.html +++ b/class_module-members.html @@ -127,27 +127,36 @@ $(document).ready(function(){initNavTree('class_module.html',''); initResizable( setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)Module setRfSwitchState(uint8_t mode)Module setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[])Module - SPIbeginTransaction() (defined in Module)Modulevirtual + SPIaddrWidthModule + SPIbeginTransaction() (defined in Module)Modulevirtual + SPIcheckStream()Module SPIendTransaction() (defined in Module)Modulevirtual - SPIgetRegValue(uint8_t reg, uint8_t msb=7, uint8_t lsb=0)Module - SPIparseStatusCbModule - SPIparseStatusCb_t typedefModule - SPIreadCommandModule - SPIreadRegister(uint8_t reg)Module - SPIreadRegisterBurst(uint8_t reg, uint8_t numBytes, uint8_t *inBytes)Module - SPIsetRegValue(uint8_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF)Module - SPIstreamTypeModule - SPItransfer(uint8_t cmd, uint8_t reg, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes)Module - SPItransfer(uint8_t b) (defined in Module)Modulevirtual - SPItransferStream(uint8_t *cmd, uint8_t cmdLen, bool write, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes, bool waitForGpio, uint32_t timeout)Module - SPIwriteCommandModule - SPIwriteRegister(uint8_t reg, uint8_t data)Module - SPIwriteRegisterBurst(uint8_t reg, uint8_t *data, uint8_t numBytes)Module - term()Module - tone(RADIOLIB_PIN_TYPE pin, uint16_t value, uint32_t duration=0)Module - transfer(uint8_t b)Module - waitForMicroseconds(uint32_t start, uint32_t len)Module - yield()Module + SPIgetRegValue(uint16_t reg, uint8_t msb=7, uint8_t lsb=0)Module + SPInopCommandModule + SPIparseStatusCbModule + SPIparseStatusCb_t typedefModule + SPIreadCommandModule + SPIreadRegister(uint16_t reg)Module + SPIreadRegisterBurst(uint16_t reg, uint8_t numBytes, uint8_t *inBytes)Module + SPIreadStream(uint8_t cmd, uint8_t *data, uint8_t numBytes, bool waitForGpio=true, bool verify=true)Module + SPIreadStream(uint8_t *cmd, uint8_t cmdLen, uint8_t *data, uint8_t numBytes, bool waitForGpio=true, bool verify=true)Module + SPIsetRegValue(uint16_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF)Module + SPIstatusCommandModule + SPIstreamErrorModule + SPIstreamTypeModule + SPItransfer(uint8_t cmd, uint16_t reg, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes)Module + SPItransfer(uint8_t b) (defined in Module)Modulevirtual + SPItransferStream(uint8_t *cmd, uint8_t cmdLen, bool write, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes, bool waitForGpio, uint32_t timeout)Module + SPIwriteCommandModule + SPIwriteRegister(uint16_t reg, uint8_t data)Module + SPIwriteRegisterBurst(uint16_t reg, uint8_t *data, uint8_t numBytes)Module + SPIwriteStream(uint8_t cmd, uint8_t *data, uint8_t numBytes, bool waitForGpio=true, bool verify=true)Module + SPIwriteStream(uint8_t *cmd, uint8_t cmdLen, uint8_t *data, uint8_t numBytes, bool waitForGpio=true, bool verify=true)Module + term()Module + tone(RADIOLIB_PIN_TYPE pin, uint16_t value, uint32_t duration=0)Module + transfer(uint8_t b)Module + waitForMicroseconds(uint32_t start, uint32_t len)Module + yield()Module diff --git a/class_module.html b/class_module.html index bbc0bb79..db06bf07 100644 --- a/class_module.html +++ b/class_module.html @@ -146,27 +146,42 @@ void term ()  Terminate low-level module control.
  -int16_t SPIgetRegValue (uint8_t reg, uint8_t msb=7, uint8_t lsb=0) - SPI read method that automatically masks unused bits. This method is the preferred SPI read mechanism. More...
-  -int16_t SPIsetRegValue (uint8_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF) - Overwrite-safe SPI write method with verification. This method is the preferred SPI write mechanism. More...
-  -void SPIreadRegisterBurst (uint8_t reg, uint8_t numBytes, uint8_t *inBytes) - SPI burst read method. More...
-  -uint8_t SPIreadRegister (uint8_t reg) - SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be used instead. More...
-  -void SPIwriteRegisterBurst (uint8_t reg, uint8_t *data, uint8_t numBytes) - SPI burst write method. More...
-  -void SPIwriteRegister (uint8_t reg, uint8_t data) - SPI basic write method. Use of this method is reserved for special cases, SPIsetRegValue should be used instead. More...
-  -void SPItransfer (uint8_t cmd, uint8_t reg, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes) - SPI single transfer method. More...
-  +int16_t SPIgetRegValue (uint16_t reg, uint8_t msb=7, uint8_t lsb=0) + SPI read method that automatically masks unused bits. This method is the preferred SPI read mechanism. More...
+  +int16_t SPIsetRegValue (uint16_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF) + Overwrite-safe SPI write method with verification. This method is the preferred SPI write mechanism. More...
+  +void SPIreadRegisterBurst (uint16_t reg, uint8_t numBytes, uint8_t *inBytes) + SPI burst read method. More...
+  +uint8_t SPIreadRegister (uint16_t reg) + SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be used instead. More...
+  +void SPIwriteRegisterBurst (uint16_t reg, uint8_t *data, uint8_t numBytes) + SPI burst write method. More...
+  +void SPIwriteRegister (uint16_t reg, uint8_t data) + SPI basic write method. Use of this method is reserved for special cases, SPIsetRegValue should be used instead. More...
+  +void SPItransfer (uint8_t cmd, uint16_t reg, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes) + SPI single transfer method. More...
+  +int16_t SPIcheckStream () + Method to check the result of last SPI stream transfer. More...
+  +int16_t SPIreadStream (uint8_t cmd, uint8_t *data, uint8_t numBytes, bool waitForGpio=true, bool verify=true) + Method to perform a read transaction with SPI stream. More...
+  +int16_t SPIreadStream (uint8_t *cmd, uint8_t cmdLen, uint8_t *data, uint8_t numBytes, bool waitForGpio=true, bool verify=true) + Method to perform a read transaction with SPI stream. More...
+  +int16_t SPIwriteStream (uint8_t cmd, uint8_t *data, uint8_t numBytes, bool waitForGpio=true, bool verify=true) + Method to perform a write transaction with SPI stream. More...
+  +int16_t SPIwriteStream (uint8_t *cmd, uint8_t cmdLen, uint8_t *data, uint8_t numBytes, bool waitForGpio=true, bool verify=true) + Method to perform a write transaction with SPI stream. More...
+  int16_t SPItransferStream (uint8_t *cmd, uint8_t cmdLen, bool write, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes, bool waitForGpio, uint32_t timeout)  SPI single transfer method for modules with stream-type SPI interface (SX126x, SX128x etc.). More...
  @@ -297,10 +312,26 @@ uint8_t SPIwriteCommand = 0b10000000  Basic SPI write command. Defaults to 0x80.
  + +uint8_t SPInopCommand = 0x00 + Basic SPI no-operation command. Defaults to 0x00.
+  + +uint8_t SPIstatusCommand = 0x00 + Basic SPI status read command. Defaults to 0x00.
+  + +uint8_t SPIaddrWidth = 8 + SPI address width. Defaults to 8, currently only supports 8 and 16-bit addresses.
+  bool SPIstreamType = false  Whether the SPI interface is stream-type (e.g. SX126x) or register-type (e.g. SX127x). Defaults to register-type SPI interfaces.
  + +int16_t SPIstreamError = RADIOLIB_ERR_UNKNOWN + The last recorded SPI stream error.
+  SPIparseStatusCb_t SPIparseStatusCb = nullptr  Callback to function that will parse the module-specific status codes to RadioLib status codes. Typically used for modules with SPI stream-type interface (e.g. SX126x/SX128x).
@@ -1048,8 +1079,28 @@ Static Public Attributes - -

◆ SPIgetRegValue()

+ +

◆ SPIcheckStream()

+ +
+
+ + + + + + + +
int16_t Module::SPIcheckStream ()
+
+ +

Method to check the result of last SPI stream transfer.

+
Returns
Status Codes
+ +
+
+ +

◆ SPIgetRegValue()

@@ -1057,7 +1108,7 @@ Static Public Attributes int16_t Module::SPIgetRegValue ( - uint8_t  + uint16_t  reg, @@ -1093,8 +1144,8 @@ Static Public Attributes
- -

◆ SPIreadRegister()

+ +

◆ SPIreadRegister()

@@ -1102,7 +1153,7 @@ Static Public Attributes uint8_t Module::SPIreadRegister ( - uint8_t  + uint16_t  reg) @@ -1120,8 +1171,8 @@ Static Public Attributes
- -

◆ SPIreadRegisterBurst()

+ +

◆ SPIreadRegisterBurst()

@@ -1129,7 +1180,7 @@ Static Public Attributes void Module::SPIreadRegisterBurst ( - uint8_t  + uint16_t  reg, @@ -1164,8 +1215,133 @@ Static Public Attributes
- -

◆ SPIsetRegValue()

+ +

◆ SPIreadStream() [1/2]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int16_t Module::SPIreadStream (uint8_t * cmd,
uint8_t cmdLen,
uint8_t * data,
uint8_t numBytes,
bool waitForGpio = true,
bool verify = true 
)
+
+ +

Method to perform a read transaction with SPI stream.

+
Parameters
+ + + + + + + +
cmdSPI operation command.
cmdLenSPI command length in bytes.
dataData that will be transferred from slave to master.
numBytesNumber of bytes to transfer.
waitForGpioWhether to wait for some GPIO at the end of transfer (e.g. BUSY line on SX126x/SX128x).
verifyWhether to verify the result of the transaction after it is finished.
+
+
+
Returns
Status Codes
+ +
+
+ +

◆ SPIreadStream() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int16_t Module::SPIreadStream (uint8_t cmd,
uint8_t * data,
uint8_t numBytes,
bool waitForGpio = true,
bool verify = true 
)
+
+ +

Method to perform a read transaction with SPI stream.

+
Parameters
+ + + + + + +
cmdSPI operation command.
dataData that will be transferred from slave to master.
numBytesNumber of bytes to transfer.
waitForGpioWhether to wait for some GPIO at the end of transfer (e.g. BUSY line on SX126x/SX128x).
verifyWhether to verify the result of the transaction after it is finished.
+
+
+
Returns
Status Codes
+ +
+
+ +

◆ SPIsetRegValue()

@@ -1173,7 +1349,7 @@ Static Public Attributes int16_t Module::SPIsetRegValue ( - uint8_t  + uint16_t  reg, @@ -1230,8 +1406,8 @@ Static Public Attributes
- -

◆ SPItransfer()

+ +

◆ SPItransfer()

@@ -1245,7 +1421,7 @@ Static Public Attributes - uint8_t  + uint16_t  reg, @@ -1354,7 +1530,7 @@ Static Public Attributes
Parameters
- + @@ -1368,8 +1544,8 @@ Static Public Attributes - -

◆ SPIwriteRegister()

+ +

◆ SPIwriteRegister()

@@ -1377,7 +1553,7 @@ Static Public Attributes
- + @@ -1405,8 +1581,8 @@ Static Public Attributes - -

◆ SPIwriteRegisterBurst()

+ +

◆ SPIwriteRegisterBurst()

@@ -1414,7 +1590,7 @@ Static Public Attributes
- + @@ -1447,6 +1623,131 @@ Static Public Attributes + + + +

◆ SPIwriteStream() [1/2]

+ +
+
+
cmdSPI operation command.
cmdSPI command length in bytes.
cmdLenSPI command length in bytes.
writeSet to true for write commands, false for read commands.
dataOutData that will be transfered from master to slave.
dataInData that was transfered from slave to master.
void Module::SPIwriteRegister (uint8_t uint16_t  reg,
void Module::SPIwriteRegisterBurst (uint8_t uint16_t  reg,
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int16_t Module::SPIwriteStream (uint8_t * cmd,
uint8_t cmdLen,
uint8_t * data,
uint8_t numBytes,
bool waitForGpio = true,
bool verify = true 
)
+
+ +

Method to perform a write transaction with SPI stream.

+
Parameters
+ + + + + + + +
cmdSPI operation command.
cmdLenSPI command length in bytes.
dataData that will be transferred from master to slave.
numBytesNumber of bytes to transfer.
waitForGpioWhether to wait for some GPIO at the end of transfer (e.g. BUSY line on SX126x/SX128x).
verifyWhether to verify the result of the transaction after it is finished.
+
+
+
Returns
Status Codes
+ +
+
+ +

◆ SPIwriteStream() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int16_t Module::SPIwriteStream (uint8_t cmd,
uint8_t * data,
uint8_t numBytes,
bool waitForGpio = true,
bool verify = true 
)
+
+ +

Method to perform a write transaction with SPI stream.

+
Parameters
+ + + + + + +
cmdSPI operation command.
dataData that will be transferred from master to slave.
numBytesNumber of bytes to transfer.
waitForGpioWhether to wait for some GPIO at the end of transfer (e.g. BUSY line on SX126x/SX128x).
verifyWhether to verify the result of the transaction after it is finished.
+
+
+
Returns
Status Codes
+
diff --git a/class_module.js b/class_module.js index 74f02033..b407758a 100644 --- a/class_module.js +++ b/class_module.js @@ -37,23 +37,32 @@ var class_module = [ "setRfSwitchState", "class_module.html#afbed643f082286012bf44bba22381ae6", null ], [ "setRfSwitchTable", "class_module.html#a870c63233146d03380f753498c975050", null ], [ "SPIbeginTransaction", "class_module.html#a5ecd52243289112f35a9644cdafbe49f", null ], + [ "SPIcheckStream", "class_module.html#a5efa7ae78cab1d7f43005e965923f769", null ], [ "SPIendTransaction", "class_module.html#acabb23f1cded0a43ffc38cfcc649dcb2", null ], - [ "SPIgetRegValue", "class_module.html#ad7ca9ae5a22cdacdf9437ca9cd37c9b4", null ], - [ "SPIreadRegister", "class_module.html#a1d1a279cc7e1ab92e30c29c4dcca26a3", null ], - [ "SPIreadRegisterBurst", "class_module.html#a6fa5239d73379e4140f5c4f513b1b8d2", null ], - [ "SPIsetRegValue", "class_module.html#a1286d7fd9673cbfab945c26b2585a129", null ], + [ "SPIgetRegValue", "class_module.html#a01e15988ec448c76142ee5709929be2c", null ], + [ "SPIreadRegister", "class_module.html#a9a545e4a001da0d9f6358279ac40d4f0", null ], + [ "SPIreadRegisterBurst", "class_module.html#a40948ebf20bf154332d0c7b37a80865d", null ], + [ "SPIreadStream", "class_module.html#aaeeb0f2933e7d3d8fd822df4521959df", null ], + [ "SPIreadStream", "class_module.html#ab29965c0c58db4c967b98a91aae722dd", null ], + [ "SPIsetRegValue", "class_module.html#a081191402ad5c49e6c21982fc4587b77", null ], [ "SPItransfer", "class_module.html#abb9e88a881632cb2c72931c5b8c2ae90", null ], - [ "SPItransfer", "class_module.html#aefd955f1cd6d588b2cc229db87cb2121", null ], + [ "SPItransfer", "class_module.html#a48d526086ceefd38029ecf106b055225", null ], [ "SPItransferStream", "class_module.html#a7295c6b22ac09146d538b90e2dc6ae92", null ], - [ "SPIwriteRegister", "class_module.html#ab814614ddd34b57f5a612a20f5fe4c57", null ], - [ "SPIwriteRegisterBurst", "class_module.html#a9d77a08070cbd48fd4ece62a739333e9", null ], + [ "SPIwriteRegister", "class_module.html#a4437af6552e258e95ed8ed452afa6dd4", null ], + [ "SPIwriteRegisterBurst", "class_module.html#a9547d4753fc648878d294aec14a14754", null ], + [ "SPIwriteStream", "class_module.html#a46b612b35eeed08754f530d442454756", null ], + [ "SPIwriteStream", "class_module.html#adc910405811bc9ae262a51f217ab0975", null ], [ "term", "class_module.html#a45bd514a1f2859d9a867c8f9b13eb332", null ], [ "tone", "class_module.html#a33e33df69d58660b8cd0e2dafe5e9189", null ], [ "transfer", "class_module.html#a45e7823c44ac0aa8a10bd4f365890c98", null ], [ "waitForMicroseconds", "class_module.html#a47978200f7e2e408fb64f506c81cee9f", null ], [ "yield", "class_module.html#a227d2d38e4747d0f49bb4df1c80b45d7", null ], + [ "SPIaddrWidth", "class_module.html#ac19a495026aae62f5c2f089aa1b2b57a", null ], + [ "SPInopCommand", "class_module.html#a466112286d19675ca2dbe481358e4365", null ], [ "SPIparseStatusCb", "class_module.html#af6e89e2bc4976e8c5dc42dedda9fa6a2", null ], [ "SPIreadCommand", "class_module.html#a849ad85fc1bc3a7130e660c13973ab26", null ], + [ "SPIstatusCommand", "class_module.html#a06d8d4257c584b57a529fcc405d87c79", null ], + [ "SPIstreamError", "class_module.html#a66b06e69d57b97116bed1c6f185381f1", null ], [ "SPIstreamType", "class_module.html#a34927454be3a34df8a5a586c46c428af", null ], [ "SPIwriteCommand", "class_module.html#ae89764d15e8df5694a6aec0e18f72d3f", null ] ]; \ No newline at end of file diff --git a/class_s_t_m32_w_lx-members.html b/class_s_t_m32_w_lx-members.html index 6814dd62..fece7405 100644 --- a/class_s_t_m32_w_lx-members.html +++ b/class_s_t_m32_w_lx-members.html @@ -108,96 +108,95 @@ $(document).ready(function(){initNavTree('class_s_t_m32_w_lx.html',''); initResi getDataRate() constSX126x getFreqStep() constPhysicalLayer getIrqStatus()SX126x - getLastError()SX126x - getMod() (defined in SX126x)SX126xvirtual - getPacketLength(bool update=true) overrideSX126xvirtual - getRSSI()SX126x - getRSSIInst()SX126x - getSNR()SX126x - getTimeOnAir(size_t len)SX126x - implicitHeader(size_t len)SX126x - MODE_END_OF_TABLE enum valueSTM32WLx - MODE_IDLE enum valueSTM32WLx - MODE_RX enum valueSTM32WLx - MODE_TX_HP enum valueSTM32WLx - MODE_TX_LP enum valueSTM32WLx - OpMode_t enum nameSTM32WLx - PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer - random(int32_t max)PhysicalLayer - random(int32_t min, int32_t max)PhysicalLayer - randomByte()SX126xvirtual - read(bool drop=true)PhysicalLayer - readBit(RADIOLIB_PIN_TYPE pin)SX126xvirtual - readData(uint8_t *data, size_t len) overrideSX126xvirtual - readData(String &str, size_t len=0)SX126x - readData(uint8_t *data, size_t len)SX126x - PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer - receive(uint8_t *data, size_t len) overrideSX126xvirtual - receive(String &str, size_t len=0)SX126x - receive(uint8_t *data, size_t len)SX126x - PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer - receiveDirect() overrideSX126xvirtual - reset(bool verify=true)SX126x - scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x - setBandwidth(float bw)SX126x - setBitRate(float br)SX126xvirtual - setBroadcastAddress(uint8_t broadAddr)SX126x - setCodingRate(uint8_t cr)SX126x - setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)SX126x - setCurrentLimit(float currentLimit)SX126x - setDataShaping(uint8_t sh) overrideSX126xvirtual - setDio1Action(void(*func)(void))STM32WLx - setDio2AsRfSwitch(bool enable=true)SX126x - setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual - setDirectAction(void(*func)(void))SX126xvirtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding) overrideSX126xvirtual - setFrequency(float freq)SX1262virtual - setFrequency(float freq, bool calibrate)SX1262 - setFrequencyDeviation(float freqDev) overrideSX126xvirtual - setNodeAddress(uint8_t nodeAddr)SX126x - setOutputPower(int8_t power) overrideSTM32WLxvirtual - setPreambleLength(uint16_t preambleLength)SX126x - setRegulatorDCDC()SX126x - setRegulatorLDO()SX126x - setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX126x - setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])STM32WLx - SX1262::setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX126x - setRxBandwidth(float rxBw)SX126x - setRxBoostedGainMode(bool rxbgm, bool persist=true)SX126x - setSpreadingFactor(uint8_t sf)SX126x - setSyncBits(uint8_t *syncWord, uint8_t bitsLen)SX126x - setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX126x - setSyncWord(uint8_t *syncWord, uint8_t len)SX126x - setTCXO(float voltage, uint32_t delay=5000)SX126x - setWhitening(bool enabled, uint16_t initial=0x0100)SX126x - sleep(bool retainConfig=true)SX126x - standby() overrideSX126xvirtual - standby(uint8_t mode)SX126xvirtual - startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x - startDirect()PhysicalLayer - startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)SX126x - startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)SX126x - startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - startTransmit(String &str, uint8_t addr=0)SX126x - startTransmit(const char *str, uint8_t addr=0)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - STM32WLx(STM32WLx_Module *mod)STM32WLx - SX1262(Module *mod)SX1262 - SX126x(Module *mod)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX126x - transmit(String &str, uint8_t addr=0)SX126x - transmit(const char *str, uint8_t addr=0)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideSX126xvirtual - variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x + getMod() (defined in SX126x)SX126xvirtual + getPacketLength(bool update=true) overrideSX126xvirtual + getRSSI()SX126x + getRSSIInst()SX126x + getSNR()SX126x + getTimeOnAir(size_t len)SX126x + implicitHeader(size_t len)SX126x + MODE_END_OF_TABLE enum valueSTM32WLx + MODE_IDLE enum valueSTM32WLx + MODE_RX enum valueSTM32WLx + MODE_TX_HP enum valueSTM32WLx + MODE_TX_LP enum valueSTM32WLx + OpMode_t enum nameSTM32WLx + PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer + random(int32_t max)PhysicalLayer + random(int32_t min, int32_t max)PhysicalLayer + randomByte()SX126xvirtual + read(bool drop=true)PhysicalLayer + readBit(RADIOLIB_PIN_TYPE pin)SX126xvirtual + readData(uint8_t *data, size_t len) overrideSX126xvirtual + readData(String &str, size_t len=0)SX126x + readData(uint8_t *data, size_t len)SX126x + PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer + receive(uint8_t *data, size_t len) overrideSX126xvirtual + receive(String &str, size_t len=0)SX126x + receive(uint8_t *data, size_t len)SX126x + PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer + receiveDirect() overrideSX126xvirtual + reset(bool verify=true)SX126x + scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x + setBandwidth(float bw)SX126x + setBitRate(float br)SX126xvirtual + setBroadcastAddress(uint8_t broadAddr)SX126x + setCodingRate(uint8_t cr)SX126x + setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)SX126x + setCurrentLimit(float currentLimit)SX126x + setDataShaping(uint8_t sh) overrideSX126xvirtual + setDio1Action(void(*func)(void))STM32WLx + setDio2AsRfSwitch(bool enable=true)SX126x + setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual + setDirectAction(void(*func)(void))SX126xvirtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overrideSX126xvirtual + setFrequency(float freq)SX1262virtual + setFrequency(float freq, bool calibrate)SX1262 + setFrequencyDeviation(float freqDev) overrideSX126xvirtual + setNodeAddress(uint8_t nodeAddr)SX126x + setOutputPower(int8_t power) overrideSTM32WLxvirtual + setPreambleLength(uint16_t preambleLength)SX126x + setRegulatorDCDC()SX126x + setRegulatorLDO()SX126x + setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX126x + setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])STM32WLx + SX1262::setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX126x + setRxBandwidth(float rxBw)SX126x + setRxBoostedGainMode(bool rxbgm, bool persist=true)SX126x + setSpreadingFactor(uint8_t sf)SX126x + setSyncBits(uint8_t *syncWord, uint8_t bitsLen)SX126x + setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX126x + setSyncWord(uint8_t *syncWord, uint8_t len)SX126x + setTCXO(float voltage, uint32_t delay=5000)SX126x + setWhitening(bool enabled, uint16_t initial=0x0100)SX126x + sleep(bool retainConfig=true)SX126x + standby() overrideSX126xvirtual + standby(uint8_t mode)SX126xvirtual + startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x + startDirect()PhysicalLayer + startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)SX126x + startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)SX126x + startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + startTransmit(String &str, uint8_t addr=0)SX126x + startTransmit(const char *str, uint8_t addr=0)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + STM32WLx(STM32WLx_Module *mod)STM32WLx + SX1262(Module *mod)SX1262 + SX126x(Module *mod)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX126x + transmit(String &str, uint8_t addr=0)SX126x + transmit(const char *str, uint8_t addr=0)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideSX126xvirtual + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x diff --git a/class_s_t_m32_w_lx.html b/class_s_t_m32_w_lx.html index e7d9b194..49c5b70f 100644 --- a/class_s_t_m32_w_lx.html +++ b/class_s_t_m32_w_lx.html @@ -353,9 +353,6 @@ void uint8_t randomByte ()  Get one truly random byte from RSSI noise. More...
  -int16_t getLastError () - Get the last recorded transaction error. More...
-  void setDirectAction (void(*func)(void))  Dummy method, to ensure PhysicalLayer compatibility. More...
  diff --git a/class_s_t_m32_w_lx___module-members.html b/class_s_t_m32_w_lx___module-members.html index 4abb718a..50296828 100644 --- a/class_s_t_m32_w_lx___module-members.html +++ b/class_s_t_m32_w_lx___module-members.html @@ -127,28 +127,37 @@ $(document).ready(function(){initNavTree('class_s_t_m32_w_lx___module.html',''); setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)Module setRfSwitchState(uint8_t mode)Module setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[])Module - SPIbeginTransaction() (defined in Module)Modulevirtual + SPIaddrWidthModule + SPIbeginTransaction() (defined in Module)Modulevirtual + SPIcheckStream()Module SPIendTransaction() (defined in Module)Modulevirtual - SPIgetRegValue(uint8_t reg, uint8_t msb=7, uint8_t lsb=0)Module - SPIparseStatusCbModule - SPIparseStatusCb_t typedefModule - SPIreadCommandModule - SPIreadRegister(uint8_t reg)Module - SPIreadRegisterBurst(uint8_t reg, uint8_t numBytes, uint8_t *inBytes)Module - SPIsetRegValue(uint8_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF)Module - SPIstreamTypeModule - SPItransfer(uint8_t cmd, uint8_t reg, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes)Module - SPItransfer(uint8_t b) (defined in Module)Modulevirtual - SPItransferStream(uint8_t *cmd, uint8_t cmdLen, bool write, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes, bool waitForGpio, uint32_t timeout)Module - SPIwriteCommandModule - SPIwriteRegister(uint8_t reg, uint8_t data)Module - SPIwriteRegisterBurst(uint8_t reg, uint8_t *data, uint8_t numBytes)Module - STM32WLx_Module() (defined in STM32WLx_Module)STM32WLx_Module - term()Module - tone(RADIOLIB_PIN_TYPE pin, uint16_t value, uint32_t duration=0)Module - transfer(uint8_t b)Module - waitForMicroseconds(uint32_t start, uint32_t len)Module - yield()Module + SPIgetRegValue(uint16_t reg, uint8_t msb=7, uint8_t lsb=0)Module + SPInopCommandModule + SPIparseStatusCbModule + SPIparseStatusCb_t typedefModule + SPIreadCommandModule + SPIreadRegister(uint16_t reg)Module + SPIreadRegisterBurst(uint16_t reg, uint8_t numBytes, uint8_t *inBytes)Module + SPIreadStream(uint8_t cmd, uint8_t *data, uint8_t numBytes, bool waitForGpio=true, bool verify=true)Module + SPIreadStream(uint8_t *cmd, uint8_t cmdLen, uint8_t *data, uint8_t numBytes, bool waitForGpio=true, bool verify=true)Module + SPIsetRegValue(uint16_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF)Module + SPIstatusCommandModule + SPIstreamErrorModule + SPIstreamTypeModule + SPItransfer(uint8_t cmd, uint16_t reg, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes)Module + SPItransfer(uint8_t b) (defined in Module)Modulevirtual + SPItransferStream(uint8_t *cmd, uint8_t cmdLen, bool write, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes, bool waitForGpio, uint32_t timeout)Module + SPIwriteCommandModule + SPIwriteRegister(uint16_t reg, uint8_t data)Module + SPIwriteRegisterBurst(uint16_t reg, uint8_t *data, uint8_t numBytes)Module + SPIwriteStream(uint8_t cmd, uint8_t *data, uint8_t numBytes, bool waitForGpio=true, bool verify=true)Module + SPIwriteStream(uint8_t *cmd, uint8_t cmdLen, uint8_t *data, uint8_t numBytes, bool waitForGpio=true, bool verify=true)Module + STM32WLx_Module() (defined in STM32WLx_Module)STM32WLx_Module + term()Module + tone(RADIOLIB_PIN_TYPE pin, uint16_t value, uint32_t duration=0)Module + transfer(uint8_t b)Module + waitForMicroseconds(uint32_t start, uint32_t len)Module + yield()Module diff --git a/class_s_t_m32_w_lx___module.html b/class_s_t_m32_w_lx___module.html index 28179ea2..c51a9e2d 100644 --- a/class_s_t_m32_w_lx___module.html +++ b/class_s_t_m32_w_lx___module.html @@ -131,27 +131,42 @@ void term ()  Terminate low-level module control.
  -int16_t SPIgetRegValue (uint8_t reg, uint8_t msb=7, uint8_t lsb=0) - SPI read method that automatically masks unused bits. This method is the preferred SPI read mechanism. More...
-  -int16_t SPIsetRegValue (uint8_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF) - Overwrite-safe SPI write method with verification. This method is the preferred SPI write mechanism. More...
-  -void SPIreadRegisterBurst (uint8_t reg, uint8_t numBytes, uint8_t *inBytes) - SPI burst read method. More...
-  -uint8_t SPIreadRegister (uint8_t reg) - SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be used instead. More...
-  -void SPIwriteRegisterBurst (uint8_t reg, uint8_t *data, uint8_t numBytes) - SPI burst write method. More...
-  -void SPIwriteRegister (uint8_t reg, uint8_t data) - SPI basic write method. Use of this method is reserved for special cases, SPIsetRegValue should be used instead. More...
-  -void SPItransfer (uint8_t cmd, uint8_t reg, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes) - SPI single transfer method. More...
-  +int16_t SPIgetRegValue (uint16_t reg, uint8_t msb=7, uint8_t lsb=0) + SPI read method that automatically masks unused bits. This method is the preferred SPI read mechanism. More...
+  +int16_t SPIsetRegValue (uint16_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF) + Overwrite-safe SPI write method with verification. This method is the preferred SPI write mechanism. More...
+  +void SPIreadRegisterBurst (uint16_t reg, uint8_t numBytes, uint8_t *inBytes) + SPI burst read method. More...
+  +uint8_t SPIreadRegister (uint16_t reg) + SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be used instead. More...
+  +void SPIwriteRegisterBurst (uint16_t reg, uint8_t *data, uint8_t numBytes) + SPI burst write method. More...
+  +void SPIwriteRegister (uint16_t reg, uint8_t data) + SPI basic write method. Use of this method is reserved for special cases, SPIsetRegValue should be used instead. More...
+  +void SPItransfer (uint8_t cmd, uint16_t reg, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes) + SPI single transfer method. More...
+  +int16_t SPIcheckStream () + Method to check the result of last SPI stream transfer. More...
+  +int16_t SPIreadStream (uint8_t cmd, uint8_t *data, uint8_t numBytes, bool waitForGpio=true, bool verify=true) + Method to perform a read transaction with SPI stream. More...
+  +int16_t SPIreadStream (uint8_t *cmd, uint8_t cmdLen, uint8_t *data, uint8_t numBytes, bool waitForGpio=true, bool verify=true) + Method to perform a read transaction with SPI stream. More...
+  +int16_t SPIwriteStream (uint8_t cmd, uint8_t *data, uint8_t numBytes, bool waitForGpio=true, bool verify=true) + Method to perform a write transaction with SPI stream. More...
+  +int16_t SPIwriteStream (uint8_t *cmd, uint8_t cmdLen, uint8_t *data, uint8_t numBytes, bool waitForGpio=true, bool verify=true) + Method to perform a write transaction with SPI stream. More...
+  int16_t SPItransferStream (uint8_t *cmd, uint8_t cmdLen, bool write, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes, bool waitForGpio, uint32_t timeout)  SPI single transfer method for modules with stream-type SPI interface (SX126x, SX128x etc.). More...
  @@ -278,10 +293,26 @@ uint8_t SPIwriteCommand = 0b10000000  Basic SPI write command. Defaults to 0x80.
  + +uint8_t SPInopCommand = 0x00 + Basic SPI no-operation command. Defaults to 0x00.
+  + +uint8_t SPIstatusCommand = 0x00 + Basic SPI status read command. Defaults to 0x00.
+  + +uint8_t SPIaddrWidth = 8 + SPI address width. Defaults to 8, currently only supports 8 and 16-bit addresses.
+  bool SPIstreamType = false  Whether the SPI interface is stream-type (e.g. SX126x) or register-type (e.g. SX127x). Defaults to register-type SPI interfaces.
  + +int16_t SPIstreamError = RADIOLIB_ERR_UNKNOWN + The last recorded SPI stream error.
+  SPIparseStatusCb_t SPIparseStatusCb = nullptr  Callback to function that will parse the module-specific status codes to RadioLib status codes. Typically used for modules with SPI stream-type interface (e.g. SX126x/SX128x).
diff --git a/class_s_x1261-members.html b/class_s_x1261-members.html index b67ed5b3..7943e003 100644 --- a/class_s_x1261-members.html +++ b/class_s_x1261-members.html @@ -107,89 +107,88 @@ $(document).ready(function(){initNavTree('class_s_x1261.html',''); initResizable getDataRate() constSX126x getFreqStep() constPhysicalLayer getIrqStatus()SX126x - getLastError()SX126x - getMod() (defined in SX126x)SX126xvirtual - getPacketLength(bool update=true) overrideSX126xvirtual - getRSSI()SX126x - getRSSIInst()SX126x - getSNR()SX126x - getTimeOnAir(size_t len)SX126x - implicitHeader(size_t len)SX126x - PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer - random(int32_t max)PhysicalLayer - random(int32_t min, int32_t max)PhysicalLayer - randomByte()SX126xvirtual - read(bool drop=true)PhysicalLayer - readBit(RADIOLIB_PIN_TYPE pin)SX126xvirtual - readData(uint8_t *data, size_t len) overrideSX126xvirtual - readData(String &str, size_t len=0)SX126x - readData(uint8_t *data, size_t len)SX126x - PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer - receive(uint8_t *data, size_t len) overrideSX126xvirtual - receive(String &str, size_t len=0)SX126x - receive(uint8_t *data, size_t len)SX126x - PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer - receiveDirect() overrideSX126xvirtual - reset(bool verify=true)SX126x - scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x - setBandwidth(float bw)SX126x - setBitRate(float br)SX126xvirtual - setBroadcastAddress(uint8_t broadAddr)SX126x - setCodingRate(uint8_t cr)SX126x - setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)SX126x - setCurrentLimit(float currentLimit)SX126x - setDataShaping(uint8_t sh) overrideSX126xvirtual - setDio1Action(void(*func)(void))SX126x - setDio2AsRfSwitch(bool enable=true)SX126x - setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual - setDirectAction(void(*func)(void))SX126xvirtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding) overrideSX126xvirtual - setFrequency(float freq)SX1262virtual - setFrequency(float freq, bool calibrate)SX1262 - setFrequencyDeviation(float freqDev) overrideSX126xvirtual - setNodeAddress(uint8_t nodeAddr)SX126x - setOutputPower(int8_t power)SX1261virtual - setPreambleLength(uint16_t preambleLength)SX126x - setRegulatorDCDC()SX126x - setRegulatorLDO()SX126x - setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX126x - setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX126x - setRxBandwidth(float rxBw)SX126x - setRxBoostedGainMode(bool rxbgm, bool persist=true)SX126x - setSpreadingFactor(uint8_t sf)SX126x - setSyncBits(uint8_t *syncWord, uint8_t bitsLen)SX126x - setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX126x - setSyncWord(uint8_t *syncWord, uint8_t len)SX126x - setTCXO(float voltage, uint32_t delay=5000)SX126x - setWhitening(bool enabled, uint16_t initial=0x0100)SX126x - sleep(bool retainConfig=true)SX126x - standby() overrideSX126xvirtual - standby(uint8_t mode)SX126xvirtual - startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x - startDirect()PhysicalLayer - startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)SX126x - startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)SX126x - startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - startTransmit(String &str, uint8_t addr=0)SX126x - startTransmit(const char *str, uint8_t addr=0)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - SX1261(Module *mod)SX1261 - SX1262(Module *mod)SX1262 - SX126x(Module *mod)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX126x - transmit(String &str, uint8_t addr=0)SX126x - transmit(const char *str, uint8_t addr=0)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideSX126xvirtual - variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x + getMod() (defined in SX126x)SX126xvirtual + getPacketLength(bool update=true) overrideSX126xvirtual + getRSSI()SX126x + getRSSIInst()SX126x + getSNR()SX126x + getTimeOnAir(size_t len)SX126x + implicitHeader(size_t len)SX126x + PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer + random(int32_t max)PhysicalLayer + random(int32_t min, int32_t max)PhysicalLayer + randomByte()SX126xvirtual + read(bool drop=true)PhysicalLayer + readBit(RADIOLIB_PIN_TYPE pin)SX126xvirtual + readData(uint8_t *data, size_t len) overrideSX126xvirtual + readData(String &str, size_t len=0)SX126x + readData(uint8_t *data, size_t len)SX126x + PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer + receive(uint8_t *data, size_t len) overrideSX126xvirtual + receive(String &str, size_t len=0)SX126x + receive(uint8_t *data, size_t len)SX126x + PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer + receiveDirect() overrideSX126xvirtual + reset(bool verify=true)SX126x + scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x + setBandwidth(float bw)SX126x + setBitRate(float br)SX126xvirtual + setBroadcastAddress(uint8_t broadAddr)SX126x + setCodingRate(uint8_t cr)SX126x + setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)SX126x + setCurrentLimit(float currentLimit)SX126x + setDataShaping(uint8_t sh) overrideSX126xvirtual + setDio1Action(void(*func)(void))SX126x + setDio2AsRfSwitch(bool enable=true)SX126x + setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual + setDirectAction(void(*func)(void))SX126xvirtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overrideSX126xvirtual + setFrequency(float freq)SX1262virtual + setFrequency(float freq, bool calibrate)SX1262 + setFrequencyDeviation(float freqDev) overrideSX126xvirtual + setNodeAddress(uint8_t nodeAddr)SX126x + setOutputPower(int8_t power)SX1261virtual + setPreambleLength(uint16_t preambleLength)SX126x + setRegulatorDCDC()SX126x + setRegulatorLDO()SX126x + setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX126x + setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX126x + setRxBandwidth(float rxBw)SX126x + setRxBoostedGainMode(bool rxbgm, bool persist=true)SX126x + setSpreadingFactor(uint8_t sf)SX126x + setSyncBits(uint8_t *syncWord, uint8_t bitsLen)SX126x + setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX126x + setSyncWord(uint8_t *syncWord, uint8_t len)SX126x + setTCXO(float voltage, uint32_t delay=5000)SX126x + setWhitening(bool enabled, uint16_t initial=0x0100)SX126x + sleep(bool retainConfig=true)SX126x + standby() overrideSX126xvirtual + standby(uint8_t mode)SX126xvirtual + startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x + startDirect()PhysicalLayer + startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)SX126x + startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)SX126x + startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + startTransmit(String &str, uint8_t addr=0)SX126x + startTransmit(const char *str, uint8_t addr=0)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + SX1261(Module *mod)SX1261 + SX1262(Module *mod)SX1262 + SX126x(Module *mod)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX126x + transmit(String &str, uint8_t addr=0)SX126x + transmit(const char *str, uint8_t addr=0)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideSX126xvirtual + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x diff --git a/class_s_x1261.html b/class_s_x1261.html index 41d74df6..de2fe079 100644 --- a/class_s_x1261.html +++ b/class_s_x1261.html @@ -321,9 +321,6 @@ void uint8_t randomByte ()  Get one truly random byte from RSSI noise. More...
  -int16_t getLastError () - Get the last recorded transaction error. More...
-  void setDirectAction (void(*func)(void))  Dummy method, to ensure PhysicalLayer compatibility. More...
  diff --git a/class_s_x1262-members.html b/class_s_x1262-members.html index f5300c13..c99aca2a 100644 --- a/class_s_x1262-members.html +++ b/class_s_x1262-members.html @@ -107,88 +107,87 @@ $(document).ready(function(){initNavTree('class_s_x1262.html',''); initResizable getDataRate() constSX126x getFreqStep() constPhysicalLayer getIrqStatus()SX126x - getLastError()SX126x - getMod() (defined in SX126x)SX126xvirtual - getPacketLength(bool update=true) overrideSX126xvirtual - getRSSI()SX126x - getRSSIInst()SX126x - getSNR()SX126x - getTimeOnAir(size_t len)SX126x - implicitHeader(size_t len)SX126x - PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer - random(int32_t max)PhysicalLayer - random(int32_t min, int32_t max)PhysicalLayer - randomByte()SX126xvirtual - read(bool drop=true)PhysicalLayer - readBit(RADIOLIB_PIN_TYPE pin)SX126xvirtual - readData(uint8_t *data, size_t len) overrideSX126xvirtual - readData(String &str, size_t len=0)SX126x - readData(uint8_t *data, size_t len)SX126x - PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer - receive(uint8_t *data, size_t len) overrideSX126xvirtual - receive(String &str, size_t len=0)SX126x - receive(uint8_t *data, size_t len)SX126x - PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer - receiveDirect() overrideSX126xvirtual - reset(bool verify=true)SX126x - scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x - setBandwidth(float bw)SX126x - setBitRate(float br)SX126xvirtual - setBroadcastAddress(uint8_t broadAddr)SX126x - setCodingRate(uint8_t cr)SX126x - setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)SX126x - setCurrentLimit(float currentLimit)SX126x - setDataShaping(uint8_t sh) overrideSX126xvirtual - setDio1Action(void(*func)(void))SX126x - setDio2AsRfSwitch(bool enable=true)SX126x - setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual - setDirectAction(void(*func)(void))SX126xvirtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding) overrideSX126xvirtual - setFrequency(float freq)SX1262virtual - setFrequency(float freq, bool calibrate)SX1262 - setFrequencyDeviation(float freqDev) overrideSX126xvirtual - setNodeAddress(uint8_t nodeAddr)SX126x - setOutputPower(int8_t power)SX1262virtual - setPreambleLength(uint16_t preambleLength)SX126x - setRegulatorDCDC()SX126x - setRegulatorLDO()SX126x - setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX126x - setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX126x - setRxBandwidth(float rxBw)SX126x - setRxBoostedGainMode(bool rxbgm, bool persist=true)SX126x - setSpreadingFactor(uint8_t sf)SX126x - setSyncBits(uint8_t *syncWord, uint8_t bitsLen)SX126x - setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX126x - setSyncWord(uint8_t *syncWord, uint8_t len)SX126x - setTCXO(float voltage, uint32_t delay=5000)SX126x - setWhitening(bool enabled, uint16_t initial=0x0100)SX126x - sleep(bool retainConfig=true)SX126x - standby() overrideSX126xvirtual - standby(uint8_t mode)SX126xvirtual - startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x - startDirect()PhysicalLayer - startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)SX126x - startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)SX126x - startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - startTransmit(String &str, uint8_t addr=0)SX126x - startTransmit(const char *str, uint8_t addr=0)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - SX1262(Module *mod)SX1262 - SX126x(Module *mod)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX126x - transmit(String &str, uint8_t addr=0)SX126x - transmit(const char *str, uint8_t addr=0)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideSX126xvirtual - variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x + getMod() (defined in SX126x)SX126xvirtual + getPacketLength(bool update=true) overrideSX126xvirtual + getRSSI()SX126x + getRSSIInst()SX126x + getSNR()SX126x + getTimeOnAir(size_t len)SX126x + implicitHeader(size_t len)SX126x + PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer + random(int32_t max)PhysicalLayer + random(int32_t min, int32_t max)PhysicalLayer + randomByte()SX126xvirtual + read(bool drop=true)PhysicalLayer + readBit(RADIOLIB_PIN_TYPE pin)SX126xvirtual + readData(uint8_t *data, size_t len) overrideSX126xvirtual + readData(String &str, size_t len=0)SX126x + readData(uint8_t *data, size_t len)SX126x + PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer + receive(uint8_t *data, size_t len) overrideSX126xvirtual + receive(String &str, size_t len=0)SX126x + receive(uint8_t *data, size_t len)SX126x + PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer + receiveDirect() overrideSX126xvirtual + reset(bool verify=true)SX126x + scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x + setBandwidth(float bw)SX126x + setBitRate(float br)SX126xvirtual + setBroadcastAddress(uint8_t broadAddr)SX126x + setCodingRate(uint8_t cr)SX126x + setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)SX126x + setCurrentLimit(float currentLimit)SX126x + setDataShaping(uint8_t sh) overrideSX126xvirtual + setDio1Action(void(*func)(void))SX126x + setDio2AsRfSwitch(bool enable=true)SX126x + setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual + setDirectAction(void(*func)(void))SX126xvirtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overrideSX126xvirtual + setFrequency(float freq)SX1262virtual + setFrequency(float freq, bool calibrate)SX1262 + setFrequencyDeviation(float freqDev) overrideSX126xvirtual + setNodeAddress(uint8_t nodeAddr)SX126x + setOutputPower(int8_t power)SX1262virtual + setPreambleLength(uint16_t preambleLength)SX126x + setRegulatorDCDC()SX126x + setRegulatorLDO()SX126x + setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX126x + setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX126x + setRxBandwidth(float rxBw)SX126x + setRxBoostedGainMode(bool rxbgm, bool persist=true)SX126x + setSpreadingFactor(uint8_t sf)SX126x + setSyncBits(uint8_t *syncWord, uint8_t bitsLen)SX126x + setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX126x + setSyncWord(uint8_t *syncWord, uint8_t len)SX126x + setTCXO(float voltage, uint32_t delay=5000)SX126x + setWhitening(bool enabled, uint16_t initial=0x0100)SX126x + sleep(bool retainConfig=true)SX126x + standby() overrideSX126xvirtual + standby(uint8_t mode)SX126xvirtual + startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x + startDirect()PhysicalLayer + startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)SX126x + startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)SX126x + startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + startTransmit(String &str, uint8_t addr=0)SX126x + startTransmit(const char *str, uint8_t addr=0)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + SX1262(Module *mod)SX1262 + SX126x(Module *mod)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX126x + transmit(String &str, uint8_t addr=0)SX126x + transmit(const char *str, uint8_t addr=0)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideSX126xvirtual + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x diff --git a/class_s_x1262.html b/class_s_x1262.html index 7cbf8d11..ffd4c625 100644 --- a/class_s_x1262.html +++ b/class_s_x1262.html @@ -319,9 +319,6 @@ void uint8_t randomByte ()  Get one truly random byte from RSSI noise. More...
  -int16_t getLastError () - Get the last recorded transaction error. More...
-  void setDirectAction (void(*func)(void))  Dummy method, to ensure PhysicalLayer compatibility. More...
  diff --git a/class_s_x1268-members.html b/class_s_x1268-members.html index f23a9325..8e587301 100644 --- a/class_s_x1268-members.html +++ b/class_s_x1268-members.html @@ -107,88 +107,87 @@ $(document).ready(function(){initNavTree('class_s_x1268.html',''); initResizable getDataRate() constSX126x getFreqStep() constPhysicalLayer getIrqStatus()SX126x - getLastError()SX126x - getMod() (defined in SX126x)SX126xvirtual - getPacketLength(bool update=true) overrideSX126xvirtual - getRSSI()SX126x - getRSSIInst()SX126x - getSNR()SX126x - getTimeOnAir(size_t len)SX126x - implicitHeader(size_t len)SX126x - PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer - random(int32_t max)PhysicalLayer - random(int32_t min, int32_t max)PhysicalLayer - randomByte()SX126xvirtual - read(bool drop=true)PhysicalLayer - readBit(RADIOLIB_PIN_TYPE pin)SX126xvirtual - readData(uint8_t *data, size_t len) overrideSX126xvirtual - readData(String &str, size_t len=0)SX126x - readData(uint8_t *data, size_t len)SX126x - PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer - receive(uint8_t *data, size_t len) overrideSX126xvirtual - receive(String &str, size_t len=0)SX126x - receive(uint8_t *data, size_t len)SX126x - PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer - receiveDirect() overrideSX126xvirtual - reset(bool verify=true)SX126x - scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x - setBandwidth(float bw)SX126x - setBitRate(float br)SX126xvirtual - setBroadcastAddress(uint8_t broadAddr)SX126x - setCodingRate(uint8_t cr)SX126x - setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)SX126x - setCurrentLimit(float currentLimit)SX126x - setDataShaping(uint8_t sh) overrideSX126xvirtual - setDio1Action(void(*func)(void))SX126x - setDio2AsRfSwitch(bool enable=true)SX126x - setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual - setDirectAction(void(*func)(void))SX126xvirtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding) overrideSX126xvirtual - setFrequency(float freq)SX1268virtual - setFrequency(float freq, bool calibrate)SX1268 - setFrequencyDeviation(float freqDev) overrideSX126xvirtual - setNodeAddress(uint8_t nodeAddr)SX126x - setOutputPower(int8_t power)SX1268 - setPreambleLength(uint16_t preambleLength)SX126x - setRegulatorDCDC()SX126x - setRegulatorLDO()SX126x - setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX126x - setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX126x - setRxBandwidth(float rxBw)SX126x - setRxBoostedGainMode(bool rxbgm, bool persist=true)SX126x - setSpreadingFactor(uint8_t sf)SX126x - setSyncBits(uint8_t *syncWord, uint8_t bitsLen)SX126x - setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX126x - setSyncWord(uint8_t *syncWord, uint8_t len)SX126x - setTCXO(float voltage, uint32_t delay=5000)SX126x - setWhitening(bool enabled, uint16_t initial=0x0100)SX126x - sleep(bool retainConfig=true)SX126x - standby() overrideSX126xvirtual - standby(uint8_t mode)SX126xvirtual - startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x - startDirect()PhysicalLayer - startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)SX126x - startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)SX126x - startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - startTransmit(String &str, uint8_t addr=0)SX126x - startTransmit(const char *str, uint8_t addr=0)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - SX1268(Module *mod)SX1268 - SX126x(Module *mod)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX126x - transmit(String &str, uint8_t addr=0)SX126x - transmit(const char *str, uint8_t addr=0)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideSX126xvirtual - variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x + getMod() (defined in SX126x)SX126xvirtual + getPacketLength(bool update=true) overrideSX126xvirtual + getRSSI()SX126x + getRSSIInst()SX126x + getSNR()SX126x + getTimeOnAir(size_t len)SX126x + implicitHeader(size_t len)SX126x + PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer + random(int32_t max)PhysicalLayer + random(int32_t min, int32_t max)PhysicalLayer + randomByte()SX126xvirtual + read(bool drop=true)PhysicalLayer + readBit(RADIOLIB_PIN_TYPE pin)SX126xvirtual + readData(uint8_t *data, size_t len) overrideSX126xvirtual + readData(String &str, size_t len=0)SX126x + readData(uint8_t *data, size_t len)SX126x + PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer + receive(uint8_t *data, size_t len) overrideSX126xvirtual + receive(String &str, size_t len=0)SX126x + receive(uint8_t *data, size_t len)SX126x + PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer + receiveDirect() overrideSX126xvirtual + reset(bool verify=true)SX126x + scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x + setBandwidth(float bw)SX126x + setBitRate(float br)SX126xvirtual + setBroadcastAddress(uint8_t broadAddr)SX126x + setCodingRate(uint8_t cr)SX126x + setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)SX126x + setCurrentLimit(float currentLimit)SX126x + setDataShaping(uint8_t sh) overrideSX126xvirtual + setDio1Action(void(*func)(void))SX126x + setDio2AsRfSwitch(bool enable=true)SX126x + setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual + setDirectAction(void(*func)(void))SX126xvirtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overrideSX126xvirtual + setFrequency(float freq)SX1268virtual + setFrequency(float freq, bool calibrate)SX1268 + setFrequencyDeviation(float freqDev) overrideSX126xvirtual + setNodeAddress(uint8_t nodeAddr)SX126x + setOutputPower(int8_t power)SX1268 + setPreambleLength(uint16_t preambleLength)SX126x + setRegulatorDCDC()SX126x + setRegulatorLDO()SX126x + setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX126x + setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX126x + setRxBandwidth(float rxBw)SX126x + setRxBoostedGainMode(bool rxbgm, bool persist=true)SX126x + setSpreadingFactor(uint8_t sf)SX126x + setSyncBits(uint8_t *syncWord, uint8_t bitsLen)SX126x + setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX126x + setSyncWord(uint8_t *syncWord, uint8_t len)SX126x + setTCXO(float voltage, uint32_t delay=5000)SX126x + setWhitening(bool enabled, uint16_t initial=0x0100)SX126x + sleep(bool retainConfig=true)SX126x + standby() overrideSX126xvirtual + standby(uint8_t mode)SX126xvirtual + startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x + startDirect()PhysicalLayer + startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)SX126x + startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)SX126x + startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + startTransmit(String &str, uint8_t addr=0)SX126x + startTransmit(const char *str, uint8_t addr=0)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + SX1268(Module *mod)SX1268 + SX126x(Module *mod)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX126x + transmit(String &str, uint8_t addr=0)SX126x + transmit(const char *str, uint8_t addr=0)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideSX126xvirtual + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x diff --git a/class_s_x1268.html b/class_s_x1268.html index aaec39bf..46dd3931 100644 --- a/class_s_x1268.html +++ b/class_s_x1268.html @@ -316,9 +316,6 @@ void uint8_t randomByte ()  Get one truly random byte from RSSI noise. More...
  -int16_t getLastError () - Get the last recorded transaction error. More...
-  void setDirectAction (void(*func)(void))  Dummy method, to ensure PhysicalLayer compatibility. More...
  diff --git a/class_s_x126x-members.html b/class_s_x126x-members.html index 9e407da1..41091d8a 100644 --- a/class_s_x126x-members.html +++ b/class_s_x126x-members.html @@ -105,85 +105,84 @@ $(document).ready(function(){initNavTree('class_s_x126x.html',''); initResizable getDataRate() constSX126x getFreqStep() constPhysicalLayer getIrqStatus()SX126x - getLastError()SX126x - getMod() (defined in SX126x)SX126xvirtual - getPacketLength(bool update=true) overrideSX126xvirtual - getRSSI()SX126x - getRSSIInst()SX126x - getSNR()SX126x - getTimeOnAir(size_t len)SX126x - implicitHeader(size_t len)SX126x - PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer - random(int32_t max)PhysicalLayer - random(int32_t min, int32_t max)PhysicalLayer - randomByte()SX126xvirtual - read(bool drop=true)PhysicalLayer - readBit(RADIOLIB_PIN_TYPE pin)SX126xvirtual - readData(uint8_t *data, size_t len) overrideSX126xvirtual - readData(String &str, size_t len=0)SX126x - readData(uint8_t *data, size_t len)SX126x - PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer - receive(uint8_t *data, size_t len) overrideSX126xvirtual - receive(String &str, size_t len=0)SX126x - receive(uint8_t *data, size_t len)SX126x - PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer - receiveDirect() overrideSX126xvirtual - reset(bool verify=true)SX126x - scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x - setBandwidth(float bw)SX126x - setBitRate(float br)SX126xvirtual - setBroadcastAddress(uint8_t broadAddr)SX126x - setCodingRate(uint8_t cr)SX126x - setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)SX126x - setCurrentLimit(float currentLimit)SX126x - setDataShaping(uint8_t sh) overrideSX126xvirtual - setDio1Action(void(*func)(void))SX126x - setDio2AsRfSwitch(bool enable=true)SX126x - setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual - setDirectAction(void(*func)(void))SX126xvirtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding) overrideSX126xvirtual - setFrequency(float freq)PhysicalLayervirtual - setFrequencyDeviation(float freqDev) overrideSX126xvirtual - setNodeAddress(uint8_t nodeAddr)SX126x - setPreambleLength(uint16_t preambleLength)SX126x - setRegulatorDCDC()SX126x - setRegulatorLDO()SX126x - setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX126x - setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX126x - setRxBandwidth(float rxBw)SX126x - setRxBoostedGainMode(bool rxbgm, bool persist=true)SX126x - setSpreadingFactor(uint8_t sf)SX126x - setSyncBits(uint8_t *syncWord, uint8_t bitsLen)SX126x - setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX126x - setSyncWord(uint8_t *syncWord, uint8_t len)SX126x - setTCXO(float voltage, uint32_t delay=5000)SX126x - setWhitening(bool enabled, uint16_t initial=0x0100)SX126x - sleep(bool retainConfig=true)SX126x - standby() overrideSX126xvirtual - standby(uint8_t mode)SX126xvirtual - startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x - startDirect()PhysicalLayer - startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)SX126x - startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)SX126x - startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - startTransmit(String &str, uint8_t addr=0)SX126x - startTransmit(const char *str, uint8_t addr=0)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - SX126x(Module *mod)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX126x - transmit(String &str, uint8_t addr=0)SX126x - transmit(const char *str, uint8_t addr=0)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideSX126xvirtual - variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x + getMod() (defined in SX126x)SX126xvirtual + getPacketLength(bool update=true) overrideSX126xvirtual + getRSSI()SX126x + getRSSIInst()SX126x + getSNR()SX126x + getTimeOnAir(size_t len)SX126x + implicitHeader(size_t len)SX126x + PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer + random(int32_t max)PhysicalLayer + random(int32_t min, int32_t max)PhysicalLayer + randomByte()SX126xvirtual + read(bool drop=true)PhysicalLayer + readBit(RADIOLIB_PIN_TYPE pin)SX126xvirtual + readData(uint8_t *data, size_t len) overrideSX126xvirtual + readData(String &str, size_t len=0)SX126x + readData(uint8_t *data, size_t len)SX126x + PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer + receive(uint8_t *data, size_t len) overrideSX126xvirtual + receive(String &str, size_t len=0)SX126x + receive(uint8_t *data, size_t len)SX126x + PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer + receiveDirect() overrideSX126xvirtual + reset(bool verify=true)SX126x + scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x + setBandwidth(float bw)SX126x + setBitRate(float br)SX126xvirtual + setBroadcastAddress(uint8_t broadAddr)SX126x + setCodingRate(uint8_t cr)SX126x + setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)SX126x + setCurrentLimit(float currentLimit)SX126x + setDataShaping(uint8_t sh) overrideSX126xvirtual + setDio1Action(void(*func)(void))SX126x + setDio2AsRfSwitch(bool enable=true)SX126x + setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual + setDirectAction(void(*func)(void))SX126xvirtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overrideSX126xvirtual + setFrequency(float freq)PhysicalLayervirtual + setFrequencyDeviation(float freqDev) overrideSX126xvirtual + setNodeAddress(uint8_t nodeAddr)SX126x + setPreambleLength(uint16_t preambleLength)SX126x + setRegulatorDCDC()SX126x + setRegulatorLDO()SX126x + setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX126x + setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX126x + setRxBandwidth(float rxBw)SX126x + setRxBoostedGainMode(bool rxbgm, bool persist=true)SX126x + setSpreadingFactor(uint8_t sf)SX126x + setSyncBits(uint8_t *syncWord, uint8_t bitsLen)SX126x + setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX126x + setSyncWord(uint8_t *syncWord, uint8_t len)SX126x + setTCXO(float voltage, uint32_t delay=5000)SX126x + setWhitening(bool enabled, uint16_t initial=0x0100)SX126x + sleep(bool retainConfig=true)SX126x + standby() overrideSX126xvirtual + standby(uint8_t mode)SX126xvirtual + startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x + startDirect()PhysicalLayer + startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)SX126x + startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)SX126x + startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + startTransmit(String &str, uint8_t addr=0)SX126x + startTransmit(const char *str, uint8_t addr=0)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + SX126x(Module *mod)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX126x + transmit(String &str, uint8_t addr=0)SX126x + transmit(const char *str, uint8_t addr=0)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideSX126xvirtual + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x diff --git a/class_s_x126x.html b/class_s_x126x.html index 27bfd1af..9470f7bb 100644 --- a/class_s_x126x.html +++ b/class_s_x126x.html @@ -301,9 +301,6 @@ void uint8_t randomByte ()  Get one truly random byte from RSSI noise. More...
  -int16_t getLastError () - Get the last recorded transaction error. More...
-  void setDirectAction (void(*func)(void))  Dummy method, to ensure PhysicalLayer compatibility. More...
  @@ -777,26 +774,6 @@ void 
Returns
IRQ status bits
- - - -

◆ getLastError()

- -
-
- - - - - - - -
int16_t SX126x::getLastError ()
-
- -

Get the last recorded transaction error.

-
Returns
Status Codes
-
diff --git a/class_s_x126x.js b/class_s_x126x.js index f77fc533..4f8e563b 100644 --- a/class_s_x126x.js +++ b/class_s_x126x.js @@ -14,7 +14,6 @@ var class_s_x126x = [ "getCurrentLimit", "class_s_x126x.html#aa668babb0bd129b2facee9fd280525ab", null ], [ "getDataRate", "class_s_x126x.html#acbe2d75b1e2df8bcc58c4fd9d8e6e4f9", null ], [ "getIrqStatus", "class_s_x126x.html#a9a9b090eddcb811ee19b595debfab1df", null ], - [ "getLastError", "class_s_x126x.html#ac71eb1209354837ced2e21e66534bff3", null ], [ "getMod", "class_s_x126x.html#aae1af90432c457e5bf8f8f362295399b", null ], [ "getPacketLength", "class_s_x126x.html#ac4ef8c8751a3c09d64e431684840c987", null ], [ "getRSSI", "class_s_x126x.html#a0e5f0032a91686b9673a48c908eb1925", null ], diff --git a/class_s_x1280-members.html b/class_s_x1280-members.html index 2258b9d3..fc4a1f30 100644 --- a/class_s_x1280-members.html +++ b/class_s_x1280-members.html @@ -101,79 +101,78 @@ $(document).ready(function(){initNavTree('class_s_x1280.html',''); initResizable getFreqStep() constPhysicalLayer getFrequencyError()SX128x getIrqStatus()SX128x - getLastError()SX128x - getMod() (defined in SX128x)SX128xvirtual - getPacketLength(bool update=true) overrideSX128xvirtual - getRangingResult()SX1280 - getRSSI()SX128x - getSNR()SX128x - getTimeOnAir(size_t len)SX128x - implicitHeader(size_t len)SX128x - PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer - random(int32_t max)PhysicalLayer - random(int32_t min, int32_t max)PhysicalLayer - randomByte()SX128xvirtual - range(bool master, uint32_t addr, uint16_t calTable[3][6]=NULL)SX1280 - read(bool drop=true)PhysicalLayer - readBit(RADIOLIB_PIN_TYPE pin)SX128xvirtual - readData(uint8_t *data, size_t len) overrideSX128xvirtual - readData(String &str, size_t len=0)SX128x - readData(uint8_t *data, size_t len)SX128x - PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer - receive(uint8_t *data, size_t len) overrideSX128xvirtual - receive(String &str, size_t len=0)SX128x - receive(uint8_t *data, size_t len)SX128x - PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer - receiveDirect() overrideSX128xvirtual - reset(bool verify=true)SX128x - scanChannel()SX128x - setAccessAddress(uint32_t addr)SX128x - setBandwidth(float bw)SX128x - setBitRate(float br)SX128xvirtual - setCodingRate(uint8_t cr, bool longInterleaving=false)SX128x - setCRC(uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)SX128x - setDataShaping(uint8_t sh) overrideSX128xvirtual - setDio1Action(void(*func)(void))SX128x - setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual - setDirectAction(void(*func)(void))SX128xvirtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding) overrideSX128xvirtual - setFrequency(float freq)SX128xvirtual - setFrequencyDeviation(float freqDev) overrideSX128xvirtual - setGainControl(uint8_t gain=0)SX128x - setHighSensitivityMode(bool hsm=false)SX128x - setOutputPower(int8_t power)SX128x - setPreambleLength(uint32_t preambleLength)SX128x - setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX128x - setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX128x - setSpreadingFactor(uint8_t sf)SX128x - setSyncWord(uint8_t *syncWord, uint8_t len)SX128x - setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX128x - setWhitening(bool enabled)SX128x - sleep(bool retainConfig=true)SX128x - standby() overrideSX128xvirtual - standby(uint8_t mode)SX128xvirtual - startDirect()PhysicalLayer - startRanging(bool master, uint32_t addr, uint16_t calTable[3][6]=NULL)SX1280 - startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF)SX128x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX128xvirtual - startTransmit(String &str, uint8_t addr=0)SX128x - startTransmit(const char *str, uint8_t addr=0)SX128x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX128x - PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - SX1280(Module *mod)SX1280 - SX1281(Module *mod)SX1281 - SX128x(Module *mod)SX128x - transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX128xvirtual - transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX128x - transmit(String &str, uint8_t addr=0)SX128x - transmit(const char *str, uint8_t addr=0)SX128x - transmit(uint8_t *data, size_t len, uint8_t addr=0)SX128x - PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideSX128xvirtual + getMod() (defined in SX128x)SX128xvirtual + getPacketLength(bool update=true) overrideSX128xvirtual + getRangingResult()SX1280 + getRSSI()SX128x + getSNR()SX128x + getTimeOnAir(size_t len)SX128x + implicitHeader(size_t len)SX128x + PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer + random(int32_t max)PhysicalLayer + random(int32_t min, int32_t max)PhysicalLayer + randomByte()SX128xvirtual + range(bool master, uint32_t addr, uint16_t calTable[3][6]=NULL)SX1280 + read(bool drop=true)PhysicalLayer + readBit(RADIOLIB_PIN_TYPE pin)SX128xvirtual + readData(uint8_t *data, size_t len) overrideSX128xvirtual + readData(String &str, size_t len=0)SX128x + readData(uint8_t *data, size_t len)SX128x + PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer + receive(uint8_t *data, size_t len) overrideSX128xvirtual + receive(String &str, size_t len=0)SX128x + receive(uint8_t *data, size_t len)SX128x + PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer + receiveDirect() overrideSX128xvirtual + reset(bool verify=true)SX128x + scanChannel()SX128x + setAccessAddress(uint32_t addr)SX128x + setBandwidth(float bw)SX128x + setBitRate(float br)SX128xvirtual + setCodingRate(uint8_t cr, bool longInterleaving=false)SX128x + setCRC(uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)SX128x + setDataShaping(uint8_t sh) overrideSX128xvirtual + setDio1Action(void(*func)(void))SX128x + setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual + setDirectAction(void(*func)(void))SX128xvirtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overrideSX128xvirtual + setFrequency(float freq)SX128xvirtual + setFrequencyDeviation(float freqDev) overrideSX128xvirtual + setGainControl(uint8_t gain=0)SX128x + setHighSensitivityMode(bool hsm=false)SX128x + setOutputPower(int8_t power)SX128x + setPreambleLength(uint32_t preambleLength)SX128x + setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX128x + setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX128x + setSpreadingFactor(uint8_t sf)SX128x + setSyncWord(uint8_t *syncWord, uint8_t len)SX128x + setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX128x + setWhitening(bool enabled)SX128x + sleep(bool retainConfig=true)SX128x + standby() overrideSX128xvirtual + standby(uint8_t mode)SX128xvirtual + startDirect()PhysicalLayer + startRanging(bool master, uint32_t addr, uint16_t calTable[3][6]=NULL)SX1280 + startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF)SX128x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX128xvirtual + startTransmit(String &str, uint8_t addr=0)SX128x + startTransmit(const char *str, uint8_t addr=0)SX128x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX128x + PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + SX1280(Module *mod)SX1280 + SX1281(Module *mod)SX1281 + SX128x(Module *mod)SX128x + transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX128xvirtual + transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX128x + transmit(String &str, uint8_t addr=0)SX128x + transmit(const char *str, uint8_t addr=0)SX128x + transmit(uint8_t *data, size_t len, uint8_t addr=0)SX128x + PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideSX128xvirtual diff --git a/class_s_x1280.html b/class_s_x1280.html index 7996bf9e..35a5fe77 100644 --- a/class_s_x1280.html +++ b/class_s_x1280.html @@ -274,9 +274,6 @@ void uint8_t randomByte ()  Dummy random method, to ensure PhysicalLayer compatibility. More...
  -int16_t getLastError () - Get the last recorded transaction error. More...
-  void setDirectAction (void(*func)(void))  Dummy method, to ensure PhysicalLayer compatibility. More...
  diff --git a/class_s_x1281-members.html b/class_s_x1281-members.html index 2ed02d21..75de8cc3 100644 --- a/class_s_x1281-members.html +++ b/class_s_x1281-members.html @@ -101,75 +101,74 @@ $(document).ready(function(){initNavTree('class_s_x1281.html',''); initResizable getFreqStep() constPhysicalLayer getFrequencyError()SX128x getIrqStatus()SX128x - getLastError()SX128x - getMod() (defined in SX128x)SX128xvirtual - getPacketLength(bool update=true) overrideSX128xvirtual - getRSSI()SX128x - getSNR()SX128x - getTimeOnAir(size_t len)SX128x - implicitHeader(size_t len)SX128x - PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer - random(int32_t max)PhysicalLayer - random(int32_t min, int32_t max)PhysicalLayer - randomByte()SX128xvirtual - read(bool drop=true)PhysicalLayer - readBit(RADIOLIB_PIN_TYPE pin)SX128xvirtual - readData(uint8_t *data, size_t len) overrideSX128xvirtual - readData(String &str, size_t len=0)SX128x - readData(uint8_t *data, size_t len)SX128x - PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer - receive(uint8_t *data, size_t len) overrideSX128xvirtual - receive(String &str, size_t len=0)SX128x - receive(uint8_t *data, size_t len)SX128x - PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer - receiveDirect() overrideSX128xvirtual - reset(bool verify=true)SX128x - scanChannel()SX128x - setAccessAddress(uint32_t addr)SX128x - setBandwidth(float bw)SX128x - setBitRate(float br)SX128xvirtual - setCodingRate(uint8_t cr, bool longInterleaving=false)SX128x - setCRC(uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)SX128x - setDataShaping(uint8_t sh) overrideSX128xvirtual - setDio1Action(void(*func)(void))SX128x - setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual - setDirectAction(void(*func)(void))SX128xvirtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding) overrideSX128xvirtual - setFrequency(float freq)SX128xvirtual - setFrequencyDeviation(float freqDev) overrideSX128xvirtual - setGainControl(uint8_t gain=0)SX128x - setHighSensitivityMode(bool hsm=false)SX128x - setOutputPower(int8_t power)SX128x - setPreambleLength(uint32_t preambleLength)SX128x - setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX128x - setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX128x - setSpreadingFactor(uint8_t sf)SX128x - setSyncWord(uint8_t *syncWord, uint8_t len)SX128x - setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX128x - setWhitening(bool enabled)SX128x - sleep(bool retainConfig=true)SX128x - standby() overrideSX128xvirtual - standby(uint8_t mode)SX128xvirtual - startDirect()PhysicalLayer - startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF)SX128x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX128xvirtual - startTransmit(String &str, uint8_t addr=0)SX128x - startTransmit(const char *str, uint8_t addr=0)SX128x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX128x - PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - SX1281(Module *mod)SX1281 - SX128x(Module *mod)SX128x - transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX128xvirtual - transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX128x - transmit(String &str, uint8_t addr=0)SX128x - transmit(const char *str, uint8_t addr=0)SX128x - transmit(uint8_t *data, size_t len, uint8_t addr=0)SX128x - PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideSX128xvirtual + getMod() (defined in SX128x)SX128xvirtual + getPacketLength(bool update=true) overrideSX128xvirtual + getRSSI()SX128x + getSNR()SX128x + getTimeOnAir(size_t len)SX128x + implicitHeader(size_t len)SX128x + PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer + random(int32_t max)PhysicalLayer + random(int32_t min, int32_t max)PhysicalLayer + randomByte()SX128xvirtual + read(bool drop=true)PhysicalLayer + readBit(RADIOLIB_PIN_TYPE pin)SX128xvirtual + readData(uint8_t *data, size_t len) overrideSX128xvirtual + readData(String &str, size_t len=0)SX128x + readData(uint8_t *data, size_t len)SX128x + PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer + receive(uint8_t *data, size_t len) overrideSX128xvirtual + receive(String &str, size_t len=0)SX128x + receive(uint8_t *data, size_t len)SX128x + PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer + receiveDirect() overrideSX128xvirtual + reset(bool verify=true)SX128x + scanChannel()SX128x + setAccessAddress(uint32_t addr)SX128x + setBandwidth(float bw)SX128x + setBitRate(float br)SX128xvirtual + setCodingRate(uint8_t cr, bool longInterleaving=false)SX128x + setCRC(uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)SX128x + setDataShaping(uint8_t sh) overrideSX128xvirtual + setDio1Action(void(*func)(void))SX128x + setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual + setDirectAction(void(*func)(void))SX128xvirtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overrideSX128xvirtual + setFrequency(float freq)SX128xvirtual + setFrequencyDeviation(float freqDev) overrideSX128xvirtual + setGainControl(uint8_t gain=0)SX128x + setHighSensitivityMode(bool hsm=false)SX128x + setOutputPower(int8_t power)SX128x + setPreambleLength(uint32_t preambleLength)SX128x + setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX128x + setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX128x + setSpreadingFactor(uint8_t sf)SX128x + setSyncWord(uint8_t *syncWord, uint8_t len)SX128x + setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX128x + setWhitening(bool enabled)SX128x + sleep(bool retainConfig=true)SX128x + standby() overrideSX128xvirtual + standby(uint8_t mode)SX128xvirtual + startDirect()PhysicalLayer + startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF)SX128x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX128xvirtual + startTransmit(String &str, uint8_t addr=0)SX128x + startTransmit(const char *str, uint8_t addr=0)SX128x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX128x + PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + SX1281(Module *mod)SX1281 + SX128x(Module *mod)SX128x + transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX128xvirtual + transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX128x + transmit(String &str, uint8_t addr=0)SX128x + transmit(const char *str, uint8_t addr=0)SX128x + transmit(uint8_t *data, size_t len, uint8_t addr=0)SX128x + PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideSX128xvirtual diff --git a/class_s_x1281.html b/class_s_x1281.html index f353a8c0..c8370918 100644 --- a/class_s_x1281.html +++ b/class_s_x1281.html @@ -261,9 +261,6 @@ void uint8_t randomByte ()  Dummy random method, to ensure PhysicalLayer compatibility. More...
  -int16_t getLastError () - Get the last recorded transaction error. More...
-  void setDirectAction (void(*func)(void))  Dummy method, to ensure PhysicalLayer compatibility. More...
  diff --git a/class_s_x1282-members.html b/class_s_x1282-members.html index 68ed92b8..453f7ac3 100644 --- a/class_s_x1282-members.html +++ b/class_s_x1282-members.html @@ -101,80 +101,79 @@ $(document).ready(function(){initNavTree('class_s_x1282.html',''); initResizable getFreqStep() constPhysicalLayer getFrequencyError()SX128x getIrqStatus()SX128x - getLastError()SX128x - getMod() (defined in SX128x)SX128xvirtual - getPacketLength(bool update=true) overrideSX128xvirtual - getRangingResult()SX1280 - getRSSI()SX128x - getSNR()SX128x - getTimeOnAir(size_t len)SX128x - implicitHeader(size_t len)SX128x - PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer - random(int32_t max)PhysicalLayer - random(int32_t min, int32_t max)PhysicalLayer - randomByte()SX128xvirtual - range(bool master, uint32_t addr, uint16_t calTable[3][6]=NULL)SX1280 - read(bool drop=true)PhysicalLayer - readBit(RADIOLIB_PIN_TYPE pin)SX128xvirtual - readData(uint8_t *data, size_t len) overrideSX128xvirtual - readData(String &str, size_t len=0)SX128x - readData(uint8_t *data, size_t len)SX128x - PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer - receive(uint8_t *data, size_t len) overrideSX128xvirtual - receive(String &str, size_t len=0)SX128x - receive(uint8_t *data, size_t len)SX128x - PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer - receiveDirect() overrideSX128xvirtual - reset(bool verify=true)SX128x - scanChannel()SX128x - setAccessAddress(uint32_t addr)SX128x - setBandwidth(float bw)SX128x - setBitRate(float br)SX128xvirtual - setCodingRate(uint8_t cr, bool longInterleaving=false)SX128x - setCRC(uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)SX128x - setDataShaping(uint8_t sh) overrideSX128xvirtual - setDio1Action(void(*func)(void))SX128x - setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual - setDirectAction(void(*func)(void))SX128xvirtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding) overrideSX128xvirtual - setFrequency(float freq)SX128xvirtual - setFrequencyDeviation(float freqDev) overrideSX128xvirtual - setGainControl(uint8_t gain=0)SX128x - setHighSensitivityMode(bool hsm=false)SX128x - setOutputPower(int8_t power)SX128x - setPreambleLength(uint32_t preambleLength)SX128x - setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX128x - setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX128x - setSpreadingFactor(uint8_t sf)SX128x - setSyncWord(uint8_t *syncWord, uint8_t len)SX128x - setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX128x - setWhitening(bool enabled)SX128x - sleep(bool retainConfig=true)SX128x - standby() overrideSX128xvirtual - standby(uint8_t mode)SX128xvirtual - startDirect()PhysicalLayer - startRanging(bool master, uint32_t addr, uint16_t calTable[3][6]=NULL)SX1280 - startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF)SX128x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX128xvirtual - startTransmit(String &str, uint8_t addr=0)SX128x - startTransmit(const char *str, uint8_t addr=0)SX128x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX128x - PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - SX1280(Module *mod)SX1280 - SX1281(Module *mod)SX1281 - SX1282(Module *mod)SX1282 - SX128x(Module *mod)SX128x - transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX128xvirtual - transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX128x - transmit(String &str, uint8_t addr=0)SX128x - transmit(const char *str, uint8_t addr=0)SX128x - transmit(uint8_t *data, size_t len, uint8_t addr=0)SX128x - PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideSX128xvirtual + getMod() (defined in SX128x)SX128xvirtual + getPacketLength(bool update=true) overrideSX128xvirtual + getRangingResult()SX1280 + getRSSI()SX128x + getSNR()SX128x + getTimeOnAir(size_t len)SX128x + implicitHeader(size_t len)SX128x + PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer + random(int32_t max)PhysicalLayer + random(int32_t min, int32_t max)PhysicalLayer + randomByte()SX128xvirtual + range(bool master, uint32_t addr, uint16_t calTable[3][6]=NULL)SX1280 + read(bool drop=true)PhysicalLayer + readBit(RADIOLIB_PIN_TYPE pin)SX128xvirtual + readData(uint8_t *data, size_t len) overrideSX128xvirtual + readData(String &str, size_t len=0)SX128x + readData(uint8_t *data, size_t len)SX128x + PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer + receive(uint8_t *data, size_t len) overrideSX128xvirtual + receive(String &str, size_t len=0)SX128x + receive(uint8_t *data, size_t len)SX128x + PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer + receiveDirect() overrideSX128xvirtual + reset(bool verify=true)SX128x + scanChannel()SX128x + setAccessAddress(uint32_t addr)SX128x + setBandwidth(float bw)SX128x + setBitRate(float br)SX128xvirtual + setCodingRate(uint8_t cr, bool longInterleaving=false)SX128x + setCRC(uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)SX128x + setDataShaping(uint8_t sh) overrideSX128xvirtual + setDio1Action(void(*func)(void))SX128x + setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual + setDirectAction(void(*func)(void))SX128xvirtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overrideSX128xvirtual + setFrequency(float freq)SX128xvirtual + setFrequencyDeviation(float freqDev) overrideSX128xvirtual + setGainControl(uint8_t gain=0)SX128x + setHighSensitivityMode(bool hsm=false)SX128x + setOutputPower(int8_t power)SX128x + setPreambleLength(uint32_t preambleLength)SX128x + setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX128x + setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX128x + setSpreadingFactor(uint8_t sf)SX128x + setSyncWord(uint8_t *syncWord, uint8_t len)SX128x + setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX128x + setWhitening(bool enabled)SX128x + sleep(bool retainConfig=true)SX128x + standby() overrideSX128xvirtual + standby(uint8_t mode)SX128xvirtual + startDirect()PhysicalLayer + startRanging(bool master, uint32_t addr, uint16_t calTable[3][6]=NULL)SX1280 + startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF)SX128x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX128xvirtual + startTransmit(String &str, uint8_t addr=0)SX128x + startTransmit(const char *str, uint8_t addr=0)SX128x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX128x + PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + SX1280(Module *mod)SX1280 + SX1281(Module *mod)SX1281 + SX1282(Module *mod)SX1282 + SX128x(Module *mod)SX128x + transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX128xvirtual + transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX128x + transmit(String &str, uint8_t addr=0)SX128x + transmit(const char *str, uint8_t addr=0)SX128x + transmit(uint8_t *data, size_t len, uint8_t addr=0)SX128x + PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideSX128xvirtual diff --git a/class_s_x1282.html b/class_s_x1282.html index 6d9e912d..7e2a40f9 100644 --- a/class_s_x1282.html +++ b/class_s_x1282.html @@ -278,9 +278,6 @@ void uint8_t randomByte ()  Dummy random method, to ensure PhysicalLayer compatibility. More...
  -int16_t getLastError () - Get the last recorded transaction error. More...
-  void setDirectAction (void(*func)(void))  Dummy method, to ensure PhysicalLayer compatibility. More...
  diff --git a/class_s_x128x-members.html b/class_s_x128x-members.html index 995456fe..5e713b9d 100644 --- a/class_s_x128x-members.html +++ b/class_s_x128x-members.html @@ -101,74 +101,73 @@ $(document).ready(function(){initNavTree('class_s_x128x.html',''); initResizable getFreqStep() constPhysicalLayer getFrequencyError()SX128x getIrqStatus()SX128x - getLastError()SX128x - getMod() (defined in SX128x)SX128xvirtual - getPacketLength(bool update=true) overrideSX128xvirtual - getRSSI()SX128x - getSNR()SX128x - getTimeOnAir(size_t len)SX128x - implicitHeader(size_t len)SX128x - PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer - random(int32_t max)PhysicalLayer - random(int32_t min, int32_t max)PhysicalLayer - randomByte()SX128xvirtual - read(bool drop=true)PhysicalLayer - readBit(RADIOLIB_PIN_TYPE pin)SX128xvirtual - readData(uint8_t *data, size_t len) overrideSX128xvirtual - readData(String &str, size_t len=0)SX128x - readData(uint8_t *data, size_t len)SX128x - PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer - receive(uint8_t *data, size_t len) overrideSX128xvirtual - receive(String &str, size_t len=0)SX128x - receive(uint8_t *data, size_t len)SX128x - PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer - receiveDirect() overrideSX128xvirtual - reset(bool verify=true)SX128x - scanChannel()SX128x - setAccessAddress(uint32_t addr)SX128x - setBandwidth(float bw)SX128x - setBitRate(float br)SX128xvirtual - setCodingRate(uint8_t cr, bool longInterleaving=false)SX128x - setCRC(uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)SX128x - setDataShaping(uint8_t sh) overrideSX128xvirtual - setDio1Action(void(*func)(void))SX128x - setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual - setDirectAction(void(*func)(void))SX128xvirtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding) overrideSX128xvirtual - setFrequency(float freq)SX128xvirtual - setFrequencyDeviation(float freqDev) overrideSX128xvirtual - setGainControl(uint8_t gain=0)SX128x - setHighSensitivityMode(bool hsm=false)SX128x - setOutputPower(int8_t power)SX128x - setPreambleLength(uint32_t preambleLength)SX128x - setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX128x - setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX128x - setSpreadingFactor(uint8_t sf)SX128x - setSyncWord(uint8_t *syncWord, uint8_t len)SX128x - setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX128x - setWhitening(bool enabled)SX128x - sleep(bool retainConfig=true)SX128x - standby() overrideSX128xvirtual - standby(uint8_t mode)SX128xvirtual - startDirect()PhysicalLayer - startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF)SX128x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX128xvirtual - startTransmit(String &str, uint8_t addr=0)SX128x - startTransmit(const char *str, uint8_t addr=0)SX128x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX128x - PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - SX128x(Module *mod)SX128x - transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX128xvirtual - transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX128x - transmit(String &str, uint8_t addr=0)SX128x - transmit(const char *str, uint8_t addr=0)SX128x - transmit(uint8_t *data, size_t len, uint8_t addr=0)SX128x - PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideSX128xvirtual + getMod() (defined in SX128x)SX128xvirtual + getPacketLength(bool update=true) overrideSX128xvirtual + getRSSI()SX128x + getSNR()SX128x + getTimeOnAir(size_t len)SX128x + implicitHeader(size_t len)SX128x + PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer + random(int32_t max)PhysicalLayer + random(int32_t min, int32_t max)PhysicalLayer + randomByte()SX128xvirtual + read(bool drop=true)PhysicalLayer + readBit(RADIOLIB_PIN_TYPE pin)SX128xvirtual + readData(uint8_t *data, size_t len) overrideSX128xvirtual + readData(String &str, size_t len=0)SX128x + readData(uint8_t *data, size_t len)SX128x + PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer + receive(uint8_t *data, size_t len) overrideSX128xvirtual + receive(String &str, size_t len=0)SX128x + receive(uint8_t *data, size_t len)SX128x + PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer + receiveDirect() overrideSX128xvirtual + reset(bool verify=true)SX128x + scanChannel()SX128x + setAccessAddress(uint32_t addr)SX128x + setBandwidth(float bw)SX128x + setBitRate(float br)SX128xvirtual + setCodingRate(uint8_t cr, bool longInterleaving=false)SX128x + setCRC(uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)SX128x + setDataShaping(uint8_t sh) overrideSX128xvirtual + setDio1Action(void(*func)(void))SX128x + setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual + setDirectAction(void(*func)(void))SX128xvirtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overrideSX128xvirtual + setFrequency(float freq)SX128xvirtual + setFrequencyDeviation(float freqDev) overrideSX128xvirtual + setGainControl(uint8_t gain=0)SX128x + setHighSensitivityMode(bool hsm=false)SX128x + setOutputPower(int8_t power)SX128x + setPreambleLength(uint32_t preambleLength)SX128x + setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX128x + setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX128x + setSpreadingFactor(uint8_t sf)SX128x + setSyncWord(uint8_t *syncWord, uint8_t len)SX128x + setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX128x + setWhitening(bool enabled)SX128x + sleep(bool retainConfig=true)SX128x + standby() overrideSX128xvirtual + standby(uint8_t mode)SX128xvirtual + startDirect()PhysicalLayer + startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF)SX128x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX128xvirtual + startTransmit(String &str, uint8_t addr=0)SX128x + startTransmit(const char *str, uint8_t addr=0)SX128x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX128x + PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + SX128x(Module *mod)SX128x + transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX128xvirtual + transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX128x + transmit(String &str, uint8_t addr=0)SX128x + transmit(const char *str, uint8_t addr=0)SX128x + transmit(uint8_t *data, size_t len, uint8_t addr=0)SX128x + PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideSX128xvirtual diff --git a/class_s_x128x.html b/class_s_x128x.html index c05b9030..ea5025bd 100644 --- a/class_s_x128x.html +++ b/class_s_x128x.html @@ -257,9 +257,6 @@ void uint8_t randomByte ()  Dummy random method, to ensure PhysicalLayer compatibility. More...
  -int16_t getLastError () - Get the last recorded transaction error. More...
-  void setDirectAction (void(*func)(void))  Dummy method, to ensure PhysicalLayer compatibility. More...
  @@ -734,26 +731,6 @@ void 
Returns
IRQ status bits
- - - -

◆ getLastError()

- -
-
- - - - - - - -
int16_t SX128x::getLastError ()
-
- -

Get the last recorded transaction error.

-
Returns
Status Codes
-
diff --git a/class_s_x128x.js b/class_s_x128x.js index 95dd2f71..e9f2d453 100644 --- a/class_s_x128x.js +++ b/class_s_x128x.js @@ -10,7 +10,6 @@ var class_s_x128x = [ "finishTransmit", "class_s_x128x.html#a4587409a9b96a0c496cf12b3acac20c4", null ], [ "getFrequencyError", "class_s_x128x.html#a2b424000856a9dc212f571d0e8890635", null ], [ "getIrqStatus", "class_s_x128x.html#ae1f933f767161cc59fdaca816ab93e22", null ], - [ "getLastError", "class_s_x128x.html#abefabeb0ecd6c441fbd388340bb7b2b2", null ], [ "getMod", "class_s_x128x.html#a69ee7379f4b79abf626df186b2db6441", null ], [ "getPacketLength", "class_s_x128x.html#a390fd0749b316eed67da7b54f4f24735", null ], [ "getRSSI", "class_s_x128x.html#a94d3003277925e2dc3372548b3311008", null ], diff --git a/functions_func_g.html b/functions_func_g.html index 4cf58c76..a1b0c8c0 100644 --- a/functions_func_g.html +++ b/functions_func_g.html @@ -140,10 +140,6 @@ $(document).ready(function(){initNavTree('functions_func_g.html',''); initResiza : SX126x , SX128x -
  • getLastError() -: SX126x -, SX128x -
  • getLQI() : CC1101
    • diff --git a/functions_func_s.html b/functions_func_s.html index 2613226d..a846f2c0 100644 --- a/functions_func_s.html +++ b/functions_func_s.html @@ -260,7 +260,7 @@ $(document).ready(function(){initNavTree('functions_func_s.html',''); initResiza , RFM96 , Si4430 , Si4432 -, SX1262 +, SX1262 , SX1268 , SX1272 , SX1276 @@ -435,7 +435,7 @@ $(document).ready(function(){initNavTree('functions_func_s.html',''); initResiza , RF69 , Si443x , SX126x -, SX127x +, SX127x , SX128x
  • setTCXO() @@ -468,42 +468,51 @@ $(document).ready(function(){initNavTree('functions_func_s.html',''); initResiza , SX127x , SX128x
    • +
  • SPIcheckStream() +: Module +
  • SPIgetRegValue() -: Module +: Module
  • SPIreadRegister() -: Module +: Module
  • SPIreadRegisterBurst() -: Module +: Module +
    • +
  • SPIreadStream() +: Module
  • SPIsetRegValue() -: Module +: Module
  • SPItransfer() -: Module +: Module
  • SPItransferStream() : Module
  • SPIwriteRegister() -: Module +: Module
  • SPIwriteRegisterBurst() -: Module +: Module +
    • +
  • SPIwriteStream() +: Module
  • SSTVClient() -: SSTVClient +: SSTVClient
  • standby() : CC1101 , FSK4Client , nRF24 -, PhysicalLayer +, PhysicalLayer , RF69 , RTTYClient , Si443x -, SX126x +, SX126x , SX127x , SX128x
    • @@ -538,7 +547,7 @@ $(document).ready(function(){initNavTree('functions_func_s.html',''); initResiza
  • startTransmit() : CC1101 -, nRF24 +, nRF24 , PhysicalLayer , RF69 , Si443x diff --git a/functions_g.html b/functions_g.html index 599e5daf..b82282da 100644 --- a/functions_g.html +++ b/functions_g.html @@ -140,10 +140,6 @@ $(document).ready(function(){initNavTree('functions_g.html',''); initResizable() : SX126x , SX128x
    • -
  • getLastError() -: SX126x -, SX128x -
  • getLQI() : CC1101
    • diff --git a/functions_s.html b/functions_s.html index 8e8454ee..b5763c63 100644 --- a/functions_s.html +++ b/functions_s.html @@ -267,7 +267,7 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable() , Si4430 , Si4432 , SX1262 -, SX1268 +, SX1268 , SX1272 , SX1276 , SX1277 @@ -437,7 +437,7 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable() : SX126x
  • setSyncWord() -: CC1101 +: CC1101 , RF69 , Si443x , SX126x @@ -474,8 +474,17 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable() , SX127x , SX128x
    • +
  • SPIaddrWidth +: Module +
    • +
  • SPIcheckStream() +: Module +
  • SPIgetRegValue() -: Module +: Module +
    • +
  • SPInopCommand +: Module
  • SPIparseStatusCb : Module @@ -487,19 +496,28 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable() : Module
  • SPIreadRegister() -: Module +: Module
  • SPIreadRegisterBurst() -: Module +: Module +
    • +
  • SPIreadStream() +: Module
  • SPIsetRegValue() -: Module +: Module +
    • +
  • SPIstatusCommand +: Module +
    • +
  • SPIstreamError +: Module
  • SPIstreamType : Module
  • SPItransfer() -: Module +: Module
  • SPItransferStream() : Module @@ -508,10 +526,13 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable() : Module
  • SPIwriteRegister() -: Module +: Module
  • SPIwriteRegisterBurst() -: Module +: Module +
    • +
  • SPIwriteStream() +: Module
  • srcCallsign : AX25Frame @@ -565,13 +586,13 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable()
  • startTransmit() : CC1101 -, nRF24 -, PhysicalLayer -, RF69 +, nRF24 +, PhysicalLayer +, RF69 , Si443x , SX126x , SX127x -, SX128x +, SX128x
  • STM32WLx() : STM32WLx diff --git a/functions_vars.html b/functions_vars.html index b2006303..bb139bf2 100644 --- a/functions_vars.html +++ b/functions_vars.html @@ -82,44 +82,82 @@ $(document).ready(function(){initNavTree('functions_vars.html',''); initResizabl
    -