diff --git a/_physical_layer_8h_source.html b/_physical_layer_8h_source.html index b21f440a..7665ffff 100644 --- a/_physical_layer_8h_source.html +++ b/_physical_layer_8h_source.html @@ -195,86 +195,88 @@ $(document).ready(function(){initNavTree('_physical_layer_8h_source.html',''); i
298 
303  virtual float getSNR();
304 
-
310  int32_t random(int32_t max);
-
311 
-
318  int32_t random(int32_t min, int32_t max);
+
311  virtual int16_t scanChannel();
+
312 
+
318  int32_t random(int32_t max);
319 
-
324  virtual uint8_t randomByte();
-
325 
-
331  int16_t startDirect();
-
332 
-
333  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
340  int16_t setDirectSyncWord(uint32_t syncWord, uint8_t len);
-
341 
-
347  virtual void setDirectAction(void (*func)(void));
-
348 
-
353  virtual void readBit(uint32_t pin);
-
354 
-
359  int16_t available();
-
360 
-
364  void dropSync();
-
365 
-
372  uint8_t read(bool drop = true);
-
373  #endif
-
374 
-
381  virtual int16_t setDIOMapping(uint32_t pin, uint32_t value);
+
326  int32_t random(int32_t min, int32_t max);
+
327 
+
332  virtual uint8_t randomByte();
+
333 
+
339  int16_t startDirect();
+
340 
+
341  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
348  int16_t setDirectSyncWord(uint32_t syncWord, uint8_t len);
+
349 
+
355  virtual void setDirectAction(void (*func)(void));
+
356 
+
361  virtual void readBit(uint32_t pin);
+
362 
+
367  int16_t available();
+
368 
+
372  void dropSync();
+
373 
+
380  uint8_t read(bool drop = true);
+
381  #endif
382 
-
387  virtual void setPacketReceivedAction(void (*func)(void));
-
388 
-
392  virtual void clearPacketReceivedAction();
-
393 
-
398  virtual void setPacketSentAction(void (*func)(void));
-
399 
-
403  virtual void clearPacketSentAction();
-
404 
-
405  #if defined(RADIOLIB_INTERRUPT_TIMING)
-
406 
-
412  void setInterruptSetup(void (*func)(uint32_t));
-
413 
-
418  void setTimerFlag();
-
419 
-
420  #endif
+
389  virtual int16_t setDIOMapping(uint32_t pin, uint32_t value);
+
390 
+
395  virtual void setPacketReceivedAction(void (*func)(void));
+
396 
+
400  virtual void clearPacketReceivedAction();
+
401 
+
406  virtual void setPacketSentAction(void (*func)(void));
+
407 
+
411  virtual void clearPacketSentAction();
+
412 
+
413  #if defined(RADIOLIB_INTERRUPT_TIMING)
+
414 
+
420  void setInterruptSetup(void (*func)(uint32_t));
421 
-
422 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
423  protected:
-
424  void updateDirectBuffer(uint8_t bit);
-
425 #endif
-
426 
-
427 #if !defined(RADIOLIB_GODMODE)
-
428  private:
-
429 #endif
-
430  float freqStep;
-
431  size_t maxPacketLength;
-
432 
-
433  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
434  uint8_t bufferBitPos;
-
435  uint8_t bufferWritePos;
-
436  uint8_t bufferReadPos;
-
437  uint8_t buffer[RADIOLIB_STATIC_ARRAY_SIZE];
-
438  uint32_t syncBuffer;
-
439  uint32_t directSyncWord;
-
440  uint8_t directSyncWordLen;
-
441  uint32_t directSyncWordMask;
-
442  bool gotSync;
-
443  #endif
-
444 
-
445  virtual Module* getMod() = 0;
-
446 
-
447  // allow specific classes access the private getMod method
-
448  friend class AFSKClient;
-
449  friend class RTTYClient;
-
450  friend class MorseClient;
-
451  friend class HellClient;
-
452  friend class SSTVClient;
-
453  friend class AX25Client;
-
454  friend class FSK4Client;
-
455  friend class PagerClient;
-
456  friend class BellClient;
-
457  friend class FT8Client;
-
458  friend class LoRaWANNode;
-
459 };
-
460 
-
461 #endif
+
426  void setTimerFlag();
+
427 
+
428  #endif
+
429 
+
430 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
431  protected:
+
432  void updateDirectBuffer(uint8_t bit);
+
433 #endif
+
434 
+
435 #if !defined(RADIOLIB_GODMODE)
+
436  private:
+
437 #endif
+
438  float freqStep;
+
439  size_t maxPacketLength;
+
440 
+
441  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
442  uint8_t bufferBitPos;
+
443  uint8_t bufferWritePos;
+
444  uint8_t bufferReadPos;
+
445  uint8_t buffer[RADIOLIB_STATIC_ARRAY_SIZE];
+
446  uint32_t syncBuffer;
+
447  uint32_t directSyncWord;
+
448  uint8_t directSyncWordLen;
+
449  uint32_t directSyncWordMask;
+
450  bool gotSync;
+
451  #endif
+
452 
+
453  virtual Module* getMod() = 0;
+
454 
+
455  // allow specific classes access the private getMod method
+
456  friend class AFSKClient;
+
457  friend class RTTYClient;
+
458  friend class MorseClient;
+
459  friend class HellClient;
+
460  friend class SSTVClient;
+
461  friend class AX25Client;
+
462  friend class FSK4Client;
+
463  friend class PagerClient;
+
464  friend class BellClient;
+
465  friend class FT8Client;
+
466  friend class LoRaWANNode;
+
467 };
+
468 
+
469 #endif
AFSKClient
Client for audio-based transmissions. Requires Arduino tone() function, and a module capable of direc...
Definition: AFSK.h:16
AX25Client
Client for AX25 communication.
Definition: AX25.h:238
BellClient
Client for Bell modem communication. The public interface is the same as Arduino Serial.
Definition: BellModem.h:57
@@ -287,40 +289,41 @@ $(document).ready(function(){initNavTree('_physical_layer_8h_source.html',''); i
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:33
PhysicalLayer::invertIQ
virtual int16_t invertIQ(bool enable)
Set IQ inversion. Must be implemented in module class if the module supports it.
Definition: PhysicalLayer.cpp:249
PhysicalLayer::startReceive
virtual int16_t startReceive()
Sets module to received mode using its default configuration.
Definition: PhysicalLayer.cpp:131
-
PhysicalLayer::randomByte
virtual uint8_t randomByte()
Get one truly random byte from RSSI noise. Must be implemented in module class.
Definition: PhysicalLayer.cpp:319
+
PhysicalLayer::randomByte
virtual uint8_t randomByte()
Get one truly random byte from RSSI noise. Must be implemented in module class.
Definition: PhysicalLayer.cpp:323
PhysicalLayer::finishTransmit
virtual int16_t finishTransmit()
Clean up after transmission is done.
Definition: PhysicalLayer.cpp:160
PhysicalLayer::setFrequencyDeviation
virtual int16_t setFrequencyDeviation(float freqDev)
Sets FSK frequency deviation from carrier frequency. Only available in FSK mode. Must be implemented ...
Definition: PhysicalLayer.cpp:234
PhysicalLayer::getPacketLength
virtual size_t getPacketLength(bool update=true)
Query modem for the packet length of received payload. Must be implemented in module class.
Definition: PhysicalLayer.cpp:279
-
PhysicalLayer::setPacketSentAction
virtual void setPacketSentAction(void(*func)(void))
Sets interrupt service routine to call when a packet is sent.
Definition: PhysicalLayer.cpp:432
-
PhysicalLayer::setDIOMapping
virtual int16_t setDIOMapping(uint32_t pin, uint32_t value)
Configure DIO pin mapping to get a given signal on a DIO pin (if available).
Definition: PhysicalLayer.cpp:418
+
PhysicalLayer::setPacketSentAction
virtual void setPacketSentAction(void(*func)(void))
Sets interrupt service routine to call when a packet is sent.
Definition: PhysicalLayer.cpp:436
+
PhysicalLayer::setDIOMapping
virtual int16_t setDIOMapping(uint32_t pin, uint32_t value)
Configure DIO pin mapping to get a given signal on a DIO pin (if available).
Definition: PhysicalLayer.cpp:422
PhysicalLayer::readData
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:209
-
PhysicalLayer::dropSync
void dropSync()
Forcefully drop synchronization.
Definition: PhysicalLayer.cpp:342
+
PhysicalLayer::dropSync
void dropSync()
Forcefully drop synchronization.
Definition: PhysicalLayer.cpp:346
PhysicalLayer::transmit
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52
-
PhysicalLayer::read
uint8_t read(bool drop=true)
Get data from direct mode buffer.
Definition: PhysicalLayer.cpp:349
-
PhysicalLayer::clearPacketSentAction
virtual void clearPacketSentAction()
Clears interrupt service routine to call when a packet is sent.
Definition: PhysicalLayer.cpp:436
+
PhysicalLayer::read
uint8_t read(bool drop=true)
Get data from direct mode buffer.
Definition: PhysicalLayer.cpp:353
+
PhysicalLayer::clearPacketSentAction
virtual void clearPacketSentAction()
Clears interrupt service routine to call when a packet is sent.
Definition: PhysicalLayer.cpp:440
PhysicalLayer::setSyncWord
virtual int16_t setSyncWord(uint8_t *sync, size_t len)
Set sync word. Must be implemented in module class if the module supports it.
Definition: PhysicalLayer.cpp:259
PhysicalLayer::setDataRate
virtual int16_t setDataRate(DataRate_t dr)
Set data. Must be implemented in module class if the module supports it.
Definition: PhysicalLayer.cpp:270
-
PhysicalLayer::clearPacketReceivedAction
virtual void clearPacketReceivedAction()
Clears interrupt service routine to call when a packet is received.
Definition: PhysicalLayer.cpp:428
+
PhysicalLayer::clearPacketReceivedAction
virtual void clearPacketReceivedAction()
Clears interrupt service routine to call when a packet is received.
Definition: PhysicalLayer.cpp:432
PhysicalLayer::setPreambleLength
virtual int16_t setPreambleLength(size_t len)
Set preamble length. Must be implemented in module class if the module supports it.
Definition: PhysicalLayer.cpp:265
-
PhysicalLayer::startDirect
int16_t startDirect()
Configure module parameters for direct modes. Must be called prior to "ham" modes like RTTY or AX....
Definition: PhysicalLayer.cpp:323
+
PhysicalLayer::startDirect
int16_t startDirect()
Configure module parameters for direct modes. Must be called prior to "ham" modes like RTTY or AX....
Definition: PhysicalLayer.cpp:327
PhysicalLayer::setFrequency
virtual int16_t setFrequency(float freq)
Sets carrier frequency. Must be implemented in module class.
Definition: PhysicalLayer.cpp:224
-
PhysicalLayer::setDirectSyncWord
int16_t setDirectSyncWord(uint32_t syncWord, uint8_t len)
Set sync word to be used to determine start of packet in direct reception mode.
Definition: PhysicalLayer.cpp:357
+
PhysicalLayer::setDirectSyncWord
int16_t setDirectSyncWord(uint32_t syncWord, uint8_t len)
Set sync word to be used to determine start of packet in direct reception mode.
Definition: PhysicalLayer.cpp:361
PhysicalLayer::startTransmit
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:149
PhysicalLayer::getFreqStep
float getFreqStep() const
Gets the module frequency step size that was set in constructor.
Definition: PhysicalLayer.cpp:275
PhysicalLayer::transmitDirect
virtual int16_t transmitDirect(uint32_t frf=0)
Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module ...
Definition: PhysicalLayer.cpp:215
PhysicalLayer::getRSSI
virtual float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: PhysicalLayer.cpp:284
-
PhysicalLayer::available
int16_t available()
Get the number of direct mode bytes currently available in buffer.
Definition: PhysicalLayer.cpp:338
+
PhysicalLayer::available
int16_t available()
Get the number of direct mode bytes currently available in buffer.
Definition: PhysicalLayer.cpp:342
PhysicalLayer::receive
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition: PhysicalLayer.cpp:112
-
PhysicalLayer::setDirectAction
virtual void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is received in direct mode....
Definition: PhysicalLayer.cpp:408
+
PhysicalLayer::scanChannel
virtual int16_t scanChannel()
Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules,...
Definition: PhysicalLayer.cpp:292
+
PhysicalLayer::setDirectAction
virtual void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is received in direct mode....
Definition: PhysicalLayer.cpp:412
PhysicalLayer::setEncoding
virtual int16_t setEncoding(uint8_t encoding)
Sets FSK data encoding. Only available in FSK mode. Must be implemented in module class.
Definition: PhysicalLayer.cpp:244
PhysicalLayer::standby
virtual int16_t standby()
Sets module to standby.
Definition: PhysicalLayer.cpp:122
-
PhysicalLayer::random
int32_t random(int32_t max)
Get truly random number in range 0 - max.
Definition: PhysicalLayer.cpp:292
-
PhysicalLayer::readBit
virtual void readBit(uint32_t pin)
Function to read and process data bit in direct reception mode. Must be implemented in module class.
Definition: PhysicalLayer.cpp:412
+
PhysicalLayer::random
int32_t random(int32_t max)
Get truly random number in range 0 - max.
Definition: PhysicalLayer.cpp:296
+
PhysicalLayer::readBit
virtual void readBit(uint32_t pin)
Function to read and process data bit in direct reception mode. Must be implemented in module class.
Definition: PhysicalLayer.cpp:416
PhysicalLayer::setOutputPower
virtual int16_t setOutputPower(int8_t power)
Set output power. Must be implemented in module class if the module supports it.
Definition: PhysicalLayer.cpp:254
PhysicalLayer::receiveDirect
virtual int16_t receiveDirect()
Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module cla...
Definition: PhysicalLayer.cpp:220
PhysicalLayer::PhysicalLayer
PhysicalLayer(float step, size_t maxLen)
Default constructor.
Definition: PhysicalLayer.cpp:4
PhysicalLayer::setDataShaping
virtual int16_t setDataShaping(uint8_t sh)
Sets GFSK data shaping. Only available in FSK mode. Must be implemented in module class.
Definition: PhysicalLayer.cpp:239
-
PhysicalLayer::setPacketReceivedAction
virtual void setPacketReceivedAction(void(*func)(void))
Sets interrupt service routine to call when a packet is received.
Definition: PhysicalLayer.cpp:424
+
PhysicalLayer::setPacketReceivedAction
virtual void setPacketReceivedAction(void(*func)(void))
Sets interrupt service routine to call when a packet is received.
Definition: PhysicalLayer.cpp:428
PhysicalLayer::setBitRate
virtual int16_t setBitRate(float br)
Sets FSK bit rate. Only available in FSK mode. Must be implemented in module class.
Definition: PhysicalLayer.cpp:229
PhysicalLayer::getSNR
virtual float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: PhysicalLayer.cpp:288
PhysicalLayer::sleep
virtual int16_t sleep()
Sets module to sleep.
Definition: PhysicalLayer.cpp:118
diff --git a/_s_t_m32_w_lx_8h_source.html b/_s_t_m32_w_lx_8h_source.html index 573d077d..feda2fde 100644 --- a/_s_t_m32_w_lx_8h_source.html +++ b/_s_t_m32_w_lx_8h_source.html @@ -168,7 +168,7 @@ $(document).ready(function(){initNavTree('_s_t_m32_w_lx_8h_source.html',''); ini
STM32WLx::MODE_IDLE
@ MODE_IDLE
Definition: STM32WLx.h:55
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:27
SX1262
Derived class for SX1262 modules.
Definition: SX1262.h:22
-
SX126x::setRfSwitchTable
void setRfSwitchTable(const uint32_t(&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:1441
+
SX126x::setRfSwitchTable
void setRfSwitchTable(const uint32_t(&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:1445
diff --git a/_s_x126x_8h_source.html b/_s_x126x_8h_source.html index 8d3f1604..4178076a 100644 --- a/_s_x126x_8h_source.html +++ b/_s_x126x_8h_source.html @@ -553,231 +553,233 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
523 
529  int16_t receiveDirect() override;
530 
-
538  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);
-
539 
-
546  int16_t sleep(bool retainConfig = true);
-
547 
-
552  int16_t standby() override;
+
535  int16_t scanChannel() override;
+
536 
+
544  int16_t scanChannel(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
+
545 
+
552  int16_t sleep(bool retainConfig = true);
553 
-
561  int16_t standby(uint8_t mode, bool wakeup = true);
-
562 
-
563  // interrupt methods
-
564 
-
569  void setDio1Action(void (*func)(void));
+
558  int16_t standby() override;
+
559 
+
567  int16_t standby(uint8_t mode, bool wakeup = true);
+
568 
+
569  // interrupt methods
570 
-
574  void clearDio1Action();
-
575 
-
580  void setPacketReceivedAction(void (*func)(void));
+
575  void setDio1Action(void (*func)(void));
+
576 
+
580  void clearDio1Action();
581 
-
585  void clearPacketReceivedAction();
-
586 
-
591  void setPacketSentAction(void (*func)(void));
+
586  void setPacketReceivedAction(void (*func)(void));
+
587 
+
591  void clearPacketReceivedAction();
592 
-
596  void clearPacketSentAction();
-
597 
-
606  int16_t startTransmit(uint8_t* data, size_t len, uint8_t addr = 0) override;
-
607 
-
612  int16_t finishTransmit() override;
-
613 
-
620  int16_t startReceive();
-
621 
-
637  int16_t startReceive(uint32_t timeout, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE, size_t len = 0);
-
638 
-
649  int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);
-
650 
-
665  int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength = 0, uint16_t minSymbols = 8, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);
-
666 
-
671  uint16_t getIrqStatus();
+
597  void setPacketSentAction(void (*func)(void));
+
598 
+
602  void clearPacketSentAction();
+
603 
+
612  int16_t startTransmit(uint8_t* data, size_t len, uint8_t addr = 0) override;
+
613 
+
618  int16_t finishTransmit() override;
+
619 
+
626  int16_t startReceive();
+
627 
+
643  int16_t startReceive(uint32_t timeout, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE, size_t len = 0);
+
644 
+
655  int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);
+
656 
+
671  int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength = 0, uint16_t minSymbols = 8, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);
672 
-
681  int16_t readData(uint8_t* data, size_t len) override;
-
682 
-
691  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);
-
692 
-
697  int16_t getChannelScanResult();
+
677  uint16_t getIrqStatus();
+
678 
+
687  int16_t readData(uint8_t* data, size_t len) override;
+
688 
+
697  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);
698 
-
699  // configuration methods
-
700 
-
706  int16_t setBandwidth(float bw);
-
707 
-
713  int16_t setSpreadingFactor(uint8_t sf);
-
714 
-
720  int16_t setCodingRate(uint8_t cr);
-
721 
-
728  int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits = 0x44);
-
729 
-
735  int16_t setCurrentLimit(float currentLimit);
-
736 
-
741  float getCurrentLimit();
+
703  int16_t getChannelScanResult();
+
704 
+
705  // configuration methods
+
706 
+
712  int16_t setBandwidth(float bw);
+
713 
+
719  int16_t setSpreadingFactor(uint8_t sf);
+
720 
+
726  int16_t setCodingRate(uint8_t cr);
+
727 
+
734  int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits = 0x44);
+
735 
+
741  int16_t setCurrentLimit(float currentLimit);
742 
-
748  int16_t setPreambleLength(size_t preambleLength) override;
-
749 
-
755  int16_t setFrequencyDeviation(float freqDev) override;
-
756 
-
762  int16_t setBitRate(float br);
-
763 
-
769  int16_t setDataRate(DataRate_t dr) override;
-
770 
-
777  int16_t setRxBandwidth(float rxBw);
-
778 
-
787  int16_t setRxBoostedGainMode(bool rxbgm, bool persist = true);
-
788 
-
796  int16_t setDataShaping(uint8_t sh) override;
-
797 
-
804  int16_t setSyncWord(uint8_t* syncWord, size_t len) override;
-
805 
-
813  int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen);
-
814 
-
820  int16_t setNodeAddress(uint8_t nodeAddr);
-
821 
-
828  int16_t setBroadcastAddress(uint8_t broadAddr);
-
829 
-
834  int16_t disableAddressFiltering();
+
747  float getCurrentLimit();
+
748 
+
754  int16_t setPreambleLength(size_t preambleLength) override;
+
755 
+
761  int16_t setFrequencyDeviation(float freqDev) override;
+
762 
+
768  int16_t setBitRate(float br);
+
769 
+
775  int16_t setDataRate(DataRate_t dr) override;
+
776 
+
783  int16_t setRxBandwidth(float rxBw);
+
784 
+
793  int16_t setRxBoostedGainMode(bool rxbgm, bool persist = true);
+
794 
+
802  int16_t setDataShaping(uint8_t sh) override;
+
803 
+
810  int16_t setSyncWord(uint8_t* syncWord, size_t len) override;
+
811 
+
819  int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen);
+
820 
+
826  int16_t setNodeAddress(uint8_t nodeAddr);
+
827 
+
834  int16_t setBroadcastAddress(uint8_t broadAddr);
835 
-
844  int16_t setCRC(uint8_t len, uint16_t initial = 0x1D0F, uint16_t polynomial = 0x1021, bool inverted = true);
-
845 
-
853  int16_t setWhitening(bool enabled, uint16_t initial = 0x0100);
-
854 
-
864  int16_t setTCXO(float voltage, uint32_t delay = 5000);
-
865 
-
870  int16_t setDio2AsRfSwitch(bool enable = true);
+
840  int16_t disableAddressFiltering();
+
841 
+
850  int16_t setCRC(uint8_t len, uint16_t initial = 0x1D0F, uint16_t polynomial = 0x1021, bool inverted = true);
+
851 
+
859  int16_t setWhitening(bool enabled, uint16_t initial = 0x0100);
+
860 
+
870  int16_t setTCXO(float voltage, uint32_t delay = 5000);
871 
-
876  float getDataRate() const;
+
876  int16_t setDio2AsRfSwitch(bool enable = true);
877 
-
883  float getRSSI(bool packet = true);
-
884 
-
889  float getSNR();
+
882  float getDataRate() const;
+
883 
+
889  float getRSSI(bool packet = true);
890 
-
898  float getFrequencyError();
-
899 
-
905  size_t getPacketLength(bool update = true) override;
-
906 
-
912  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
-
913 
-
919  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
-
920 
-
926  uint32_t getTimeOnAir(size_t len);
-
927 
-
933  int16_t implicitHeader(size_t len);
-
934 
-
939  int16_t explicitHeader();
+
895  float getSNR();
+
896 
+
904  float getFrequencyError();
+
905 
+
911  size_t getPacketLength(bool update = true) override;
+
912 
+
918  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
+
919 
+
925  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
+
926 
+
932  uint32_t getTimeOnAir(size_t len);
+
933 
+
939  int16_t implicitHeader(size_t len);
940 
-
945  int16_t setRegulatorLDO();
+
945  int16_t explicitHeader();
946 
-
951  int16_t setRegulatorDCDC();
+
951  int16_t setRegulatorLDO();
952 
-
958  int16_t setEncoding(uint8_t encoding) override;
-
959 
-
961  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
-
962 
-
964  void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
+
957  int16_t setRegulatorDCDC();
+
958 
+
964  int16_t setEncoding(uint8_t encoding) override;
965 
-
974  int16_t forceLDRO(bool enable);
-
975 
-
982  int16_t autoLDRO();
-
983 
-
988  uint8_t randomByte();
+
967  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
+
968 
+
970  void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
+
971 
+
980  int16_t forceLDRO(bool enable);
+
981 
+
988  int16_t autoLDRO();
989 
-
995  int16_t invertIQ(bool enable) override;
-
996 
-
997  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
1002  void setDirectAction(void (*func)(void));
-
1003 
-
1008  void readBit(uint32_t pin);
-
1009  #endif
-
1010 
-
1020  int16_t uploadPatch(const uint32_t* patch, size_t len, bool nonvolatile = true);
-
1021 
-
1029  int16_t spectralScanStart(uint16_t numSamples, uint8_t window = RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval = RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US);
-
1030 
-
1034  void spectralScanAbort();
-
1035 
-
1040  int16_t spectralScanGetStatus();
+
994  uint8_t randomByte();
+
995 
+
1001  int16_t invertIQ(bool enable) override;
+
1002 
+
1003  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
1008  void setDirectAction(void (*func)(void));
+
1009 
+
1014  void readBit(uint32_t pin);
+
1015  #endif
+
1016 
+
1026  int16_t uploadPatch(const uint32_t* patch, size_t len, bool nonvolatile = true);
+
1027 
+
1035  int16_t spectralScanStart(uint16_t numSamples, uint8_t window = RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval = RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US);
+
1036 
+
1040  void spectralScanAbort();
1041 
-
1047  int16_t spectralScanGetResult(uint16_t* results);
-
1048 
-
1049 #if !defined(RADIOLIB_GODMODE)
-
1050  protected:
-
1051 #endif
-
1052  // SX126x SPI command implementations
-
1053  int16_t setFs();
-
1054  int16_t setTx(uint32_t timeout = 0);
-
1055  int16_t setRx(uint32_t timeout);
-
1056  int16_t setCad(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
-
1057  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);
-
1058  int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
-
1059  int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
-
1060  int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
-
1061  int16_t readBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
-
1062  int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX126X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX126X_IRQ_NONE);
-
1063  virtual int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX126X_IRQ_ALL);
-
1064  int16_t setRfFrequency(uint32_t frf);
-
1065  int16_t calibrateImage(uint8_t* data);
-
1066  uint8_t getPacketType();
-
1067  int16_t setTxParams(uint8_t power, uint8_t rampTime = RADIOLIB_SX126X_PA_RAMP_200U);
-
1068  int16_t setModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
-
1069  int16_t setModulationParamsFSK(uint32_t br, uint8_t sh, uint8_t rxBw, uint32_t freqDev);
-
1070  int16_t setPacketParams(uint16_t preambleLen, uint8_t crcType, uint8_t payloadLen, uint8_t hdrType, uint8_t invertIQ);
-
1071  int16_t setPacketParamsFSK(uint16_t preambleLen, uint8_t crcType, uint8_t syncWordLen, uint8_t addrCmp, uint8_t whiten, uint8_t packType = RADIOLIB_SX126X_GFSK_PACKET_VARIABLE, uint8_t payloadLen = 0xFF, uint8_t preambleDetectorLen = RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_16);
-
1072  int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
-
1073  int16_t setRegulatorMode(uint8_t mode);
-
1074  uint8_t getStatus();
-
1075  uint32_t getPacketStatus();
-
1076  uint16_t getDeviceErrors();
-
1077  int16_t clearDeviceErrors();
-
1078 
-
1079  int16_t startReceiveCommon(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);
-
1080  int16_t setFrequencyRaw(float freq);
-
1081  int16_t setPacketMode(uint8_t mode, uint8_t len);
-
1082  int16_t setHeaderType(uint8_t hdrType, size_t len = 0xFF);
-
1083  int16_t directMode();
-
1084  int16_t packetMode();
-
1085 
-
1086  // fixes to errata
-
1087  int16_t fixSensitivity();
-
1088  int16_t fixPaClamping(bool enable = true);
-
1089  int16_t fixImplicitTimeout();
-
1090  int16_t fixInvertedIQ(uint8_t iqConfig);
+
1046  int16_t spectralScanGetStatus();
+
1047 
+
1053  int16_t spectralScanGetResult(uint16_t* results);
+
1054 
+
1055 #if !defined(RADIOLIB_GODMODE)
+
1056  protected:
+
1057 #endif
+
1058  // SX126x SPI command implementations
+
1059  int16_t setFs();
+
1060  int16_t setTx(uint32_t timeout = 0);
+
1061  int16_t setRx(uint32_t timeout);
+
1062  int16_t setCad(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
+
1063  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);
+
1064  int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+
1065  int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+
1066  int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
+
1067  int16_t readBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
+
1068  int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX126X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX126X_IRQ_NONE);
+
1069  virtual int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX126X_IRQ_ALL);
+
1070  int16_t setRfFrequency(uint32_t frf);
+
1071  int16_t calibrateImage(uint8_t* data);
+
1072  uint8_t getPacketType();
+
1073  int16_t setTxParams(uint8_t power, uint8_t rampTime = RADIOLIB_SX126X_PA_RAMP_200U);
+
1074  int16_t setModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
+
1075  int16_t setModulationParamsFSK(uint32_t br, uint8_t sh, uint8_t rxBw, uint32_t freqDev);
+
1076  int16_t setPacketParams(uint16_t preambleLen, uint8_t crcType, uint8_t payloadLen, uint8_t hdrType, uint8_t invertIQ);
+
1077  int16_t setPacketParamsFSK(uint16_t preambleLen, uint8_t crcType, uint8_t syncWordLen, uint8_t addrCmp, uint8_t whiten, uint8_t packType = RADIOLIB_SX126X_GFSK_PACKET_VARIABLE, uint8_t payloadLen = 0xFF, uint8_t preambleDetectorLen = RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_16);
+
1078  int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
+
1079  int16_t setRegulatorMode(uint8_t mode);
+
1080  uint8_t getStatus();
+
1081  uint32_t getPacketStatus();
+
1082  uint16_t getDeviceErrors();
+
1083  int16_t clearDeviceErrors();
+
1084 
+
1085  int16_t startReceiveCommon(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);
+
1086  int16_t setFrequencyRaw(float freq);
+
1087  int16_t setPacketMode(uint8_t mode, uint8_t len);
+
1088  int16_t setHeaderType(uint8_t hdrType, size_t len = 0xFF);
+
1089  int16_t directMode();
+
1090  int16_t packetMode();
1091 
-
1092 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
1093  protected:
-
1094 #endif
-
1095  Module* mod;
-
1096 
-
1097  // common low-level SPI interface
-
1098  static int16_t SPIparseStatus(uint8_t in);
-
1099 
-
1100 #if !defined(RADIOLIB_GODMODE)
-
1101  protected:
-
1102 #endif
-
1103 
-
1104  uint8_t bandwidth = 0, spreadingFactor = 0, codingRate = 0, ldrOptimize = 0, crcTypeLoRa = 0, headerType = 0;
-
1105  uint16_t preambleLengthLoRa = 0;
-
1106  float bandwidthKhz = 0;
-
1107  bool ldroAuto = true;
-
1108 
-
1109  uint32_t bitRate = 0, frequencyDev = 0;
-
1110  uint8_t rxBandwidth = 0, pulseShape = 0, crcTypeFSK = 0, syncWordLength = 0, addrComp = 0, whitening = 0, packetType = 0;
-
1111  uint16_t preambleLengthFSK = 0;
-
1112  float rxBandwidthKhz = 0;
-
1113 
-
1114  float dataRateMeasured = 0;
-
1115 
-
1116  uint32_t tcxoDelay = 0;
-
1117 
-
1118  size_t implicitLen = 0;
-
1119  uint8_t invertIQEnabled = RADIOLIB_SX126X_LORA_IQ_STANDARD;
-
1120  const char* chipType;
+
1092  // fixes to errata
+
1093  int16_t fixSensitivity();
+
1094  int16_t fixPaClamping(bool enable = true);
+
1095  int16_t fixImplicitTimeout();
+
1096  int16_t fixInvertedIQ(uint8_t iqConfig);
+
1097 
+
1098 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
1099  protected:
+
1100 #endif
+
1101  Module* mod;
+
1102 
+
1103  // common low-level SPI interface
+
1104  static int16_t SPIparseStatus(uint8_t in);
+
1105 
+
1106 #if !defined(RADIOLIB_GODMODE)
+
1107  protected:
+
1108 #endif
+
1109 
+
1110  uint8_t bandwidth = 0, spreadingFactor = 0, codingRate = 0, ldrOptimize = 0, crcTypeLoRa = 0, headerType = 0;
+
1111  uint16_t preambleLengthLoRa = 0;
+
1112  float bandwidthKhz = 0;
+
1113  bool ldroAuto = true;
+
1114 
+
1115  uint32_t bitRate = 0, frequencyDev = 0;
+
1116  uint8_t rxBandwidth = 0, pulseShape = 0, crcTypeFSK = 0, syncWordLength = 0, addrComp = 0, whitening = 0, packetType = 0;
+
1117  uint16_t preambleLengthFSK = 0;
+
1118  float rxBandwidthKhz = 0;
+
1119 
+
1120  float dataRateMeasured = 0;
1121 
-
1122  // Allow subclasses to define different TX modes
-
1123  uint8_t txMode = Module::MODE_TX;
-
1124 
-
1125  int16_t config(uint8_t modem);
-
1126  bool findChip(const char* verStr);
-
1127 };
-
1128 
-
1129 #endif
+
1122  uint32_t tcxoDelay = 0;
+
1123 
+
1124  size_t implicitLen = 0;
+
1125  uint8_t invertIQEnabled = RADIOLIB_SX126X_LORA_IQ_STANDARD;
+
1126  const char* chipType;
+
1127 
+
1128  // Allow subclasses to define different TX modes
+
1129  uint8_t txMode = Module::MODE_TX;
1130 
-
1131 #endif
+
1131  int16_t config(uint8_t modem);
+
1132  bool findChip(const char* verStr);
+
1133 };
+
1134 
+
1135 #endif
+
1136 
+
1137 #endif
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
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:42
Module::MODE_TX
@ MODE_TX
Definition: Module.h:71
@@ -789,78 +791,78 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
PhysicalLayer::receive
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition: PhysicalLayer.cpp:112
PhysicalLayer::sleep
virtual int16_t sleep()
Sets module to sleep.
Definition: PhysicalLayer.cpp:118
SX126x
Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...
Definition: SX126x.h:443
-
SX126x::setPacketSentAction
void setPacketSentAction(void(*func)(void))
Sets interrupt service routine to call when a packet is sent.
Definition: SX126x.cpp:495
-
SX126x::getFrequencyError
float getFrequencyError()
Gets frequency error of the latest received packet. WARNING: This functionality is based on SX128x im...
Definition: SX126x.cpp:1328
-
SX126x::startReceiveDutyCycleAuto
int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)
Calls startReceiveDutyCycle with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages...
Definition: SX126x.cpp:617
-
SX126x::setRfSwitchPins
void setRfSwitchPins(uint32_t rxEn, uint32_t txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX126x.cpp:1437
-
SX126x::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:479
-
SX126x::clearPacketSentAction
void clearPacketSentAction()
Clears interrupt service routine to call when a packet is sent.
Definition: SX126x.cpp:499
-
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:725
-
SX126x::startReceive
int16_t startReceive()
Interrupt-driven receive method with default parameters. Implemented for compatibility with PhysicalL...
Definition: SX126x.cpp:572
-
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:1065
-
SX126x::setRegulatorLDO
int16_t setRegulatorLDO()
Set regulator mode to LDO.
Definition: SX126x.cpp:1425
-
SX126x::invertIQ
int16_t invertIQ(bool enable) override
Enable/disable inversion of the I and Q signals.
Definition: SX126x.cpp:1495
-
SX126x::uploadPatch
int16_t uploadPatch(const uint32_t *patch, size_t len, bool nonvolatile=true)
Upload binary patch into the SX126x device RAM. Patch is needed to e.g., enable spectral scan and mus...
Definition: SX126x.cpp:1519
-
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:1433
-
SX126x::setRfSwitchTable
void setRfSwitchTable(const uint32_t(&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:1441
+
SX126x::setPacketSentAction
void setPacketSentAction(void(*func)(void))
Sets interrupt service routine to call when a packet is sent.
Definition: SX126x.cpp:499
+
SX126x::getFrequencyError
float getFrequencyError()
Gets frequency error of the latest received packet. WARNING: This functionality is based on SX128x im...
Definition: SX126x.cpp:1332
+
SX126x::startReceiveDutyCycleAuto
int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)
Calls startReceiveDutyCycle with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages...
Definition: SX126x.cpp:621
+
SX126x::setRfSwitchPins
void setRfSwitchPins(uint32_t rxEn, uint32_t txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX126x.cpp:1441
+
SX126x::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:483
+
SX126x::clearPacketSentAction
void clearPacketSentAction()
Clears interrupt service routine to call when a packet is sent.
Definition: SX126x.cpp:503
+
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:729
+
SX126x::startReceive
int16_t startReceive()
Interrupt-driven receive method with default parameters. Implemented for compatibility with PhysicalL...
Definition: SX126x.cpp:576
+
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:1069
+
SX126x::setRegulatorLDO
int16_t setRegulatorLDO()
Set regulator mode to LDO.
Definition: SX126x.cpp:1429
+
SX126x::invertIQ
int16_t invertIQ(bool enable) override
Enable/disable inversion of the I and Q signals.
Definition: SX126x.cpp:1499
+
SX126x::uploadPatch
int16_t uploadPatch(const uint32_t *patch, size_t len, bool nonvolatile=true)
Upload binary patch into the SX126x device RAM. Patch is needed to e.g., enable spectral scan and mus...
Definition: SX126x.cpp:1523
+
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:1437
+
SX126x::setRfSwitchTable
void setRfSwitchTable(const uint32_t(&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:1445
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:97
-
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:772
+
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:776
SX126x::readData
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:209
-
SX126x::explicitHeader
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX126x.cpp:1421
-
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:1445
+
SX126x::explicitHeader
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX126x.cpp:1425
+
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:1449
SX126x::transmit
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52
-
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:1153
-
SX126x::spectralScanGetStatus
int16_t spectralScanGetStatus()
Read the status of spectral scan.
Definition: SX126x.cpp:1586
-
SX126x::setTCXO
int16_t setTCXO(float voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition: SX126x.cpp:1606
-
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:965
-
SX126x::setRegulatorDCDC
int16_t setRegulatorDCDC()
Set regulator mode to DC-DC.
Definition: SX126x.cpp:1429
-
SX126x::startReceiveDutyCycle
int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)
Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen....
Definition: SX126x.cpp:590
-
SX126x::setWhitening
int16_t setWhitening(bool enabled, uint16_t initial=0x0100)
Sets FSK whitening parameters.
Definition: SX126x.cpp:1257
-
SX126x::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:483
-
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:432
-
SX126x::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: SX126x.cpp:462
-
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:895
-
SX126x::setBitRate
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps.
Definition: SX126x.cpp:919
-
SX126x::getTimeOnAir
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX126x.cpp:1382
-
SX126x::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: SX126x.cpp:1466
-
SX126x::spectralScanAbort
void spectralScanAbort()
Abort an ongoing spectral scan.
Definition: SX126x.cpp:1582
+
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:1157
+
SX126x::spectralScanGetStatus
int16_t spectralScanGetStatus()
Read the status of spectral scan.
Definition: SX126x.cpp:1590
+
SX126x::setTCXO
int16_t setTCXO(float voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition: SX126x.cpp:1610
+
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:969
+
SX126x::setRegulatorDCDC
int16_t setRegulatorDCDC()
Set regulator mode to DC-DC.
Definition: SX126x.cpp:1433
+
SX126x::startReceiveDutyCycle
int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)
Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen....
Definition: SX126x.cpp:594
+
SX126x::setWhitening
int16_t setWhitening(bool enabled, uint16_t initial=0x0100)
Sets FSK whitening parameters.
Definition: SX126x.cpp:1261
+
SX126x::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:487
+
SX126x::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: SX126x.cpp:466
+
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:899
+
SX126x::setBitRate
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps.
Definition: SX126x.cpp:923
+
SX126x::getTimeOnAir
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX126x.cpp:1386
+
SX126x::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: SX126x.cpp:1470
+
SX126x::spectralScanAbort
void spectralScanAbort()
Abort an ongoing spectral scan.
Definition: SX126x.cpp:1586
SX126x::receiveDirect
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does...
Definition: SX126x.cpp:358
-
SX126x::spectralScanStart
int16_t spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)
Start spectral scan. Requires binary path to be uploaded.
Definition: SX126x.cpp:1566
-
SX126x::readBit
void readBit(uint32_t pin)
Function to read and process data bit in direct reception mode.
Definition: SX126x.cpp:1514
-
SX126x::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: SX126x.cpp:564
-
SX126x::setCurrentLimit
int16_t setCurrentLimit(float currentLimit)
Sets current protection limit. Can be set in 2.5 mA steps.
Definition: SX126x.cpp:860
-
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:1028
+
SX126x::spectralScanStart
int16_t spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)
Start spectral scan. Requires binary path to be uploaded.
Definition: SX126x.cpp:1570
+
SX126x::readBit
void readBit(uint32_t pin)
Function to read and process data bit in direct reception mode.
Definition: SX126x.cpp:1518
+
SX126x::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: SX126x.cpp:568
+
SX126x::setCurrentLimit
int16_t setCurrentLimit(float currentLimit)
Sets current protection limit. Can be set in 2.5 mA steps.
Definition: SX126x.cpp:864
+
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:1032
SX126x::transmitDirect
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: SX126x.cpp:342
SX126x::startTransmit
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:149
-
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:1378
+
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:1382
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:15
-
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:1198
-
SX126x::getIrqStatus
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX126x.cpp:1762
+
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:1202
+
SX126x::getIrqStatus
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX126x.cpp:1766
SX126x::reset
int16_t reset(bool verify=true)
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX126x.cpp:191
-
SX126x::setSyncWord
int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)
Sets LoRa sync word.
Definition: SX126x.cpp:849
-
SX126x::getCurrentLimit
float getCurrentLimit()
Reads current protection limit.
Definition: SX126x.cpp:873
+
SX126x::setSyncWord
int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)
Sets LoRa sync word.
Definition: SX126x.cpp:853
+
SX126x::getCurrentLimit
float getCurrentLimit()
Reads current protection limit.
Definition: SX126x.cpp:877
SX126x::SX126x
SX126x(Module *mod)
Default constructor.
Definition: SX126x.cpp:6
SX126x::receive
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition: PhysicalLayer.cpp:112
-
SX126x::autoLDRO
int16_t autoLDRO()
Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1457
-
SX126x::setDirectAction
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: SX126x.cpp:1510
-
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:1374
-
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:1170
-
SX126x::getChannelScanResult
int16_t getChannelScanResult()
Read the channel scan result.
Definition: SX126x.cpp:751
-
SX126x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX126x.cpp:1361
-
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:1126
-
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:1294
-
SX126x::clearPacketReceivedAction
void clearPacketReceivedAction()
Clears interrupt service routine to call when a packet is received.
Definition: SX126x.cpp:491
-
SX126x::setPacketReceivedAction
void setPacketReceivedAction(void(*func)(void))
Sets interrupt service routine to call when a packet is received.
Definition: SX126x.cpp:487
-
SX126x::setPreambleLength
int16_t setPreambleLength(size_t preambleLength) override
Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535.
Definition: SX126x.cpp:882
+
SX126x::autoLDRO
int16_t autoLDRO()
Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1461
+
SX126x::setDirectAction
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: SX126x.cpp:1514
+
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:1378
+
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:1174
+
SX126x::getChannelScanResult
int16_t getChannelScanResult()
Read the channel scan result.
Definition: SX126x.cpp:755
+
SX126x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX126x.cpp:1365
+
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:1130
+
SX126x::scanChannel
int16_t scanChannel() override
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.
Definition: SX126x.cpp:432
+
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:1298
+
SX126x::clearPacketReceivedAction
void clearPacketReceivedAction()
Clears interrupt service routine to call when a packet is received.
Definition: SX126x.cpp:495
+
SX126x::setPacketReceivedAction
void setPacketReceivedAction(void(*func)(void))
Sets interrupt service routine to call when a packet is received.
Definition: SX126x.cpp:491
+
SX126x::setPreambleLength
int16_t setPreambleLength(size_t preambleLength) override
Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535.
Definition: SX126x.cpp:886
SX126x::XTAL
bool XTAL
Whether the module has an XTAL (true) or TCXO (false). Defaults to false.
Definition: SX126x.h:462
-
SX126x::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX126x.cpp:1417
-
SX126x::getSNR
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: SX126x.cpp:1312
-
SX126x::setDio2AsRfSwitch
int16_t setDio2AsRfSwitch(bool enable=true)
Set DIO2 to function as RF switch (default in Semtech example designs).
Definition: SX126x.cpp:1659
-
SX126x::spectralScanGetResult
int16_t spectralScanGetResult(uint16_t *results)
Read the result of spectral scan.
Definition: SX126x.cpp:1594
-
SX126x::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX126x.cpp:823
-
SX126x::setDataRate
int16_t setDataRate(DataRate_t dr) override
Set data.
Definition: SX126x.cpp:940
-
SX126x::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: SX126x.cpp:1187
-
SX126x::setCodingRate
int16_t setCodingRate(uint8_t cr)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX126x.cpp:836
+
SX126x::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX126x.cpp:1421
+
SX126x::getSNR
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: SX126x.cpp:1316
+
SX126x::setDio2AsRfSwitch
int16_t setDio2AsRfSwitch(bool enable=true)
Set DIO2 to function as RF switch (default in Semtech example designs).
Definition: SX126x.cpp:1663
+
SX126x::spectralScanGetResult
int16_t spectralScanGetResult(uint16_t *results)
Read the result of spectral scan.
Definition: SX126x.cpp:1598
+
SX126x::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX126x.cpp:827
+
SX126x::setDataRate
int16_t setDataRate(DataRate_t dr) override
Set data.
Definition: SX126x.cpp:944
+
SX126x::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: SX126x.cpp:1191
+
SX126x::setCodingRate
int16_t setCodingRate(uint8_t cr)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX126x.cpp:840
Module::RfSwitchMode_t
Definition: Module.h:49
DataRate_t
Definition: PhysicalLayer.h:20
diff --git a/_s_x127x_8h_source.html b/_s_x127x_8h_source.html index fb44b790..25ab12bd 100644 --- a/_s_x127x_8h_source.html +++ b/_s_x127x_8h_source.html @@ -688,7 +688,7 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
636 
644  int16_t receive(uint8_t* data, size_t len) override;
645 
-
650  int16_t scanChannel();
+
650  int16_t scanChannel() override;
651 
657  int16_t sleep();
658 
@@ -907,6 +907,7 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
SX127x::packetMode
int16_t packetMode()
Disables direct mode and enables packet mode, allowing the module to receive packets....
Definition: SX127x.cpp:360
SX127x::clearFifoFullAction
void clearFifoFullAction()
Clears interrupt service routine to call when FIFO is full.
Definition: SX127x.cpp:489
SX127x::setDIOMapping
int16_t setDIOMapping(uint32_t pin, uint32_t value)
Configure DIO pin mapping to get a given signal on a DIO pin (if available).
Definition: SX127x.cpp:1573
+
SX127x::scanChannel
int16_t scanChannel() override
Performs scan for valid LoRa preamble in the current channel.
Definition: SX127x.cpp:257
SX127x::setOokFixedOrFloorThreshold
int16_t setOokFixedOrFloorThreshold(uint8_t value)
Fixed threshold for the Data Slicer in OOK mode or floor threshold for the Data Slicer in OOK when Pe...
Definition: SX127x.cpp:1067
SX127x::enableBitSync
int16_t enableBitSync()
Enable Bit synchronizer.
Definition: SX127x.cpp:1091
SX127x::readBit
void readBit(uint32_t pin)
Function to read and process data bit in direct reception mode.
Definition: SX127x.cpp:1547
@@ -972,7 +973,6 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
SX127x::getTimeOnAir
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX127x.cpp:1175
SX127x::setPacketReceivedAction
void setPacketReceivedAction(void(*func)(void))
Sets interrupt service routine to call when a packet is received.
Definition: SX127x.cpp:455
SX127x::getFHSSHoppingPeriod
uint8_t getFHSSHoppingPeriod(void)
Gets FHSS hopping period.
Definition: SX127x.cpp:1556
-
SX127x::scanChannel
int16_t scanChannel()
Performs scan for valid LoRa preamble in the current channel.
Definition: SX127x.cpp:257
SX127x::getDataRate
float getDataRate() const
Get data rate of the latest transmitted packet.
Definition: SX127x.cpp:846
SX127x::setDio0Action
void setDio0Action(void(*func)(void), uint32_t dir)
Set interrupt service routine function to call when DIO0 activates.
Definition: SX127x.cpp:433
SX127x::startReceive
int16_t startReceive()
Interrupt-driven receive method with default parameters. Implemented for compatibility with PhysicalL...
Definition: SX127x.cpp:369
diff --git a/class_c_c1101-members.html b/class_c_c1101-members.html index 5b04e349..11524cc7 100644 --- a/class_c_c1101-members.html +++ b/class_c_c1101-members.html @@ -126,49 +126,50 @@ $(document).ready(function(){initNavTree('class_c_c1101.html',''); initResizable receiveDirect() overrideCC1101virtual receiveDirectAsync()CC1101 reset()CC1101 - setBitRate(float br)CC1101virtual - setCrcFiltering(bool enable=true)CC1101 - setDataRate(DataRate_t dr)PhysicalLayervirtual - setDataShaping(uint8_t sh) overrideCC1101virtual - setDIOMapping(uint32_t pin, uint32_t value)CC1101virtual - setDirectAction(void(*func)(void))CC1101virtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding) overrideCC1101virtual - setFrequency(float freq)CC1101virtual - setFrequencyDeviation(float freqDev) overrideCC1101virtual - setGdo0Action(void(*func)(void), uint32_t dir)CC1101 - setGdo2Action(void(*func)(void), uint32_t dir)CC1101 - setNodeAddress(uint8_t nodeAddr, uint8_t numBroadcastAddrs=0)CC1101 - setOOK(bool enableOOK)CC1101 - setOutputPower(int8_t pwr)CC1101virtual - setPacketReceivedAction(void(*func)(void))CC1101virtual - setPacketSentAction(void(*func)(void))CC1101virtual - setPreambleLength(uint8_t preambleLength, uint8_t qualityThreshold)CC1101 - PhysicalLayer::setPreambleLength(size_t len)PhysicalLayervirtual - setPromiscuousMode(bool enable=true)CC1101 - setRfSwitchPins(uint32_t rxEn, uint32_t txEn)CC1101 - setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])CC1101 - setRxBandwidth(float rxBw)CC1101 - setSyncWord(uint8_t syncH, uint8_t syncL, uint8_t maxErrBits=0, bool requireCarrierSense=false)CC1101 - setSyncWord(uint8_t *syncWord, uint8_t len, uint8_t maxErrBits=0, bool requireCarrierSense=false)CC1101 - PhysicalLayer::setSyncWord(uint8_t *sync, size_t len)PhysicalLayervirtual - sleep()PhysicalLayervirtual - standby() overrideCC1101virtual - standby(uint8_t mode) overrideCC1101virtual - startDirect()PhysicalLayer - startReceive()CC1101virtual - startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)CC1101virtual - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideCC1101virtual - startTransmit(const char *str, uint8_t addr=0)CC1101 - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)CC1101 - PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideCC1101virtual - transmit(const char *str, uint8_t addr=0)CC1101 - transmit(uint8_t *data, size_t len, uint8_t addr=0)CC1101 - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideCC1101virtual - transmitDirectAsync(uint32_t frf=0)CC1101 - variablePacketLengthMode(uint8_t maxLen=RADIOLIB_CC1101_MAX_PACKET_LENGTH)CC1101 + scanChannel()PhysicalLayervirtual + setBitRate(float br)CC1101virtual + setCrcFiltering(bool enable=true)CC1101 + setDataRate(DataRate_t dr)PhysicalLayervirtual + setDataShaping(uint8_t sh) overrideCC1101virtual + setDIOMapping(uint32_t pin, uint32_t value)CC1101virtual + setDirectAction(void(*func)(void))CC1101virtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overrideCC1101virtual + setFrequency(float freq)CC1101virtual + setFrequencyDeviation(float freqDev) overrideCC1101virtual + setGdo0Action(void(*func)(void), uint32_t dir)CC1101 + setGdo2Action(void(*func)(void), uint32_t dir)CC1101 + setNodeAddress(uint8_t nodeAddr, uint8_t numBroadcastAddrs=0)CC1101 + setOOK(bool enableOOK)CC1101 + setOutputPower(int8_t pwr)CC1101virtual + setPacketReceivedAction(void(*func)(void))CC1101virtual + setPacketSentAction(void(*func)(void))CC1101virtual + setPreambleLength(uint8_t preambleLength, uint8_t qualityThreshold)CC1101 + PhysicalLayer::setPreambleLength(size_t len)PhysicalLayervirtual + setPromiscuousMode(bool enable=true)CC1101 + setRfSwitchPins(uint32_t rxEn, uint32_t txEn)CC1101 + setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])CC1101 + setRxBandwidth(float rxBw)CC1101 + setSyncWord(uint8_t syncH, uint8_t syncL, uint8_t maxErrBits=0, bool requireCarrierSense=false)CC1101 + setSyncWord(uint8_t *syncWord, uint8_t len, uint8_t maxErrBits=0, bool requireCarrierSense=false)CC1101 + PhysicalLayer::setSyncWord(uint8_t *sync, size_t len)PhysicalLayervirtual + sleep()PhysicalLayervirtual + standby() overrideCC1101virtual + standby(uint8_t mode) overrideCC1101virtual + startDirect()PhysicalLayer + startReceive()CC1101virtual + startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)CC1101virtual + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideCC1101virtual + startTransmit(const char *str, uint8_t addr=0)CC1101 + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)CC1101 + PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideCC1101virtual + transmit(const char *str, uint8_t addr=0)CC1101 + transmit(uint8_t *data, size_t len, uint8_t addr=0)CC1101 + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideCC1101virtual + transmitDirectAsync(uint32_t frf=0)CC1101 + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_CC1101_MAX_PACKET_LENGTH)CC1101 diff --git a/class_c_c1101.html b/class_c_c1101.html index b20131b8..aaa80491 100644 --- a/class_c_c1101.html +++ b/class_c_c1101.html @@ -332,6 +332,9 @@ void virtual float getSNR ()  Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. More...
  +virtual int16_t scanChannel () + Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules, or RSSI measurement for FSK modules. More...
+  int32_t random (int32_t max)  Get truly random number in range 0 - max. More...
  diff --git a/class_external_radio-members.html b/class_external_radio-members.html index 91bfd1f4..4361a9bc 100644 --- a/class_external_radio-members.html +++ b/class_external_radio-members.html @@ -110,31 +110,32 @@ $(document).ready(function(){initNavTree('class_external_radio.html',''); initRe readData(uint8_t *data, size_t len)PhysicalLayervirtual receive(uint8_t *data, size_t len)PhysicalLayervirtual receiveDirect()PhysicalLayervirtual - setBitRate(float br)PhysicalLayervirtual - setDataRate(DataRate_t dr)PhysicalLayervirtual - setDataShaping(uint8_t sh) overrideExternalRadiovirtual - setDIOMapping(uint32_t pin, uint32_t value)PhysicalLayervirtual - setDirectAction(void(*func)(void))PhysicalLayervirtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding) overrideExternalRadiovirtual - setFrequency(float freq)PhysicalLayervirtual - setFrequencyDeviation(float freqDev) overrideExternalRadiovirtual - setOutputPower(int8_t power)PhysicalLayervirtual - setPacketReceivedAction(void(*func)(void))PhysicalLayervirtual - setPacketSentAction(void(*func)(void))PhysicalLayervirtual - setPreambleLength(size_t len)PhysicalLayervirtual - setSyncWord(uint8_t *sync, size_t len)PhysicalLayervirtual - sleep()PhysicalLayervirtual - standby()PhysicalLayervirtual - standby(uint8_t mode)PhysicalLayervirtual - startDirect()PhysicalLayer - startReceive()PhysicalLayervirtual - startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)PhysicalLayervirtual - startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)PhysicalLayervirtual - transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmit(uint8_t *data, size_t len, uint8_t addr=0)PhysicalLayervirtual - transmitDirect(uint32_t frf=0)ExternalRadiovirtual + scanChannel()PhysicalLayervirtual + setBitRate(float br)PhysicalLayervirtual + setDataRate(DataRate_t dr)PhysicalLayervirtual + setDataShaping(uint8_t sh) overrideExternalRadiovirtual + setDIOMapping(uint32_t pin, uint32_t value)PhysicalLayervirtual + setDirectAction(void(*func)(void))PhysicalLayervirtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overrideExternalRadiovirtual + setFrequency(float freq)PhysicalLayervirtual + setFrequencyDeviation(float freqDev) overrideExternalRadiovirtual + setOutputPower(int8_t power)PhysicalLayervirtual + setPacketReceivedAction(void(*func)(void))PhysicalLayervirtual + setPacketSentAction(void(*func)(void))PhysicalLayervirtual + setPreambleLength(size_t len)PhysicalLayervirtual + setSyncWord(uint8_t *sync, size_t len)PhysicalLayervirtual + sleep()PhysicalLayervirtual + standby()PhysicalLayervirtual + standby(uint8_t mode)PhysicalLayervirtual + startDirect()PhysicalLayer + startReceive()PhysicalLayervirtual + startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)PhysicalLayervirtual + startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)PhysicalLayervirtual + transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmit(uint8_t *data, size_t len, uint8_t addr=0)PhysicalLayervirtual + transmitDirect(uint32_t frf=0)ExternalRadiovirtual diff --git a/class_external_radio.html b/class_external_radio.html index 93cff01b..ed28b54b 100644 --- a/class_external_radio.html +++ b/class_external_radio.html @@ -195,6 +195,9 @@ Public Member Functions virtual float getSNR ()  Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. More...
  +virtual int16_t scanChannel () + Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules, or RSSI measurement for FSK modules. More...
+  int32_t random (int32_t max)  Get truly random number in range 0 - max. More...
  diff --git a/class_l_l_c_c68-members.html b/class_l_l_c_c68-members.html index 30f95bec..23f9ce73 100644 --- a/class_l_l_c_c68-members.html +++ b/class_l_l_c_c68-members.html @@ -131,70 +131,71 @@ $(document).ready(function(){initNavTree('class_l_l_c_c68.html',''); initResizab receive(uint8_t *data, size_t len)SX126x 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 - setDataRate(DataRate_t dr) overrideSX126xvirtual - setDataShaping(uint8_t sh) overrideSX126xvirtual - setDio1Action(void(*func)(void))SX126x - setDio2AsRfSwitch(bool enable=true)SX126x - setDIOMapping(uint32_t pin, uint32_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 - setPacketReceivedAction(void(*func)(void))SX126xvirtual - setPacketSentAction(void(*func)(void))SX126xvirtual - setPreambleLength(size_t preambleLength) overrideSX126xvirtual - setRegulatorDCDC()SX126x - setRegulatorLDO()SX126x - setRfSwitchPins(uint32_t rxEn, uint32_t txEn)SX126x - setRfSwitchTable(const uint32_t(&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, size_t len) overrideSX126xvirtual - setTCXO(float voltage, uint32_t delay=5000)SX126x - setWhitening(bool enabled, uint16_t initial=0x0100)SX126x - sleep(bool retainConfig=true)SX126x - PhysicalLayer::sleep()PhysicalLayervirtual - spectralScanAbort()SX126x - spectralScanGetResult(uint16_t *results)SX126x - spectralScanGetStatus()SX126x - spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x - standby() overrideSX126xvirtual - standby(uint8_t mode, bool wakeup=true)SX126x - PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual - 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()SX126xvirtual - startReceive(uint32_t timeout, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0)SX126xvirtual - startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x - startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - startTransmit(const char *str, uint8_t addr=0)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - 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(const char *str, uint8_t addr=0)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideSX126xvirtual - uploadPatch(const uint32_t *patch, size_t len, bool nonvolatile=true)SX126x - variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x - XTALSX126x + scanChannel() overrideSX126xvirtual + scanChannel(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin)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 + setDataRate(DataRate_t dr) overrideSX126xvirtual + setDataShaping(uint8_t sh) overrideSX126xvirtual + setDio1Action(void(*func)(void))SX126x + setDio2AsRfSwitch(bool enable=true)SX126x + setDIOMapping(uint32_t pin, uint32_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 + setPacketReceivedAction(void(*func)(void))SX126xvirtual + setPacketSentAction(void(*func)(void))SX126xvirtual + setPreambleLength(size_t preambleLength) overrideSX126xvirtual + setRegulatorDCDC()SX126x + setRegulatorLDO()SX126x + setRfSwitchPins(uint32_t rxEn, uint32_t txEn)SX126x + setRfSwitchTable(const uint32_t(&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, size_t len) overrideSX126xvirtual + setTCXO(float voltage, uint32_t delay=5000)SX126x + setWhitening(bool enabled, uint16_t initial=0x0100)SX126x + sleep(bool retainConfig=true)SX126x + PhysicalLayer::sleep()PhysicalLayervirtual + spectralScanAbort()SX126x + spectralScanGetResult(uint16_t *results)SX126x + spectralScanGetStatus()SX126x + spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x + standby() overrideSX126xvirtual + standby(uint8_t mode, bool wakeup=true)SX126x + PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual + 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()SX126xvirtual + startReceive(uint32_t timeout, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0)SX126xvirtual + startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x + startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + startTransmit(const char *str, uint8_t addr=0)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + 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(const char *str, uint8_t addr=0)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideSX126xvirtual + uploadPatch(const uint32_t *patch, size_t len, bool nonvolatile=true)SX126x + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x + XTALSX126x diff --git a/class_l_l_c_c68.html b/class_l_l_c_c68.html index c105c1bb..e2720525 100644 --- a/class_l_l_c_c68.html +++ b/class_l_l_c_c68.html @@ -167,9 +167,12 @@ Public Member Functions int16_t receiveDirect () override  Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does not support direct mode reception. Will always return RADIOLIB_ERR_UNKNOWN. More...
  -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. More...
-  +int16_t scanChannel () override + Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
+  +int16_t scanChannel (uint8_t symbolNum, uint8_t detPeak, uint8_t detMin) + Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
+  int16_t sleep (bool retainConfig=true)  Sets the module to sleep mode. To wake the device up, call standby(). More...
  diff --git a/class_physical_layer-members.html b/class_physical_layer-members.html index 0b51869d..b2f0f8db 100644 --- a/class_physical_layer-members.html +++ b/class_physical_layer-members.html @@ -118,32 +118,33 @@ $(document).ready(function(){initNavTree('class_physical_layer.html',''); initRe receive(uint8_t *data, size_t len)PhysicalLayervirtual receiveDirect()PhysicalLayervirtual RTTYClient (defined in PhysicalLayer)PhysicalLayerfriend - setBitRate(float br)PhysicalLayervirtual - setDataRate(DataRate_t dr)PhysicalLayervirtual - setDataShaping(uint8_t sh)PhysicalLayervirtual - setDIOMapping(uint32_t pin, uint32_t value)PhysicalLayervirtual - setDirectAction(void(*func)(void))PhysicalLayervirtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding)PhysicalLayervirtual - setFrequency(float freq)PhysicalLayervirtual - setFrequencyDeviation(float freqDev)PhysicalLayervirtual - setOutputPower(int8_t power)PhysicalLayervirtual - setPacketReceivedAction(void(*func)(void))PhysicalLayervirtual - setPacketSentAction(void(*func)(void))PhysicalLayervirtual - setPreambleLength(size_t len)PhysicalLayervirtual - setSyncWord(uint8_t *sync, size_t len)PhysicalLayervirtual - sleep()PhysicalLayervirtual - SSTVClient (defined in PhysicalLayer)PhysicalLayerfriend - standby()PhysicalLayervirtual - standby(uint8_t mode)PhysicalLayervirtual - startDirect()PhysicalLayer - startReceive()PhysicalLayervirtual - startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)PhysicalLayervirtual - startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)PhysicalLayervirtual - transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmit(uint8_t *data, size_t len, uint8_t addr=0)PhysicalLayervirtual - transmitDirect(uint32_t frf=0)PhysicalLayervirtual + scanChannel()PhysicalLayervirtual + setBitRate(float br)PhysicalLayervirtual + setDataRate(DataRate_t dr)PhysicalLayervirtual + setDataShaping(uint8_t sh)PhysicalLayervirtual + setDIOMapping(uint32_t pin, uint32_t value)PhysicalLayervirtual + setDirectAction(void(*func)(void))PhysicalLayervirtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding)PhysicalLayervirtual + setFrequency(float freq)PhysicalLayervirtual + setFrequencyDeviation(float freqDev)PhysicalLayervirtual + setOutputPower(int8_t power)PhysicalLayervirtual + setPacketReceivedAction(void(*func)(void))PhysicalLayervirtual + setPacketSentAction(void(*func)(void))PhysicalLayervirtual + setPreambleLength(size_t len)PhysicalLayervirtual + setSyncWord(uint8_t *sync, size_t len)PhysicalLayervirtual + sleep()PhysicalLayervirtual + SSTVClient (defined in PhysicalLayer)PhysicalLayerfriend + standby()PhysicalLayervirtual + standby(uint8_t mode)PhysicalLayervirtual + startDirect()PhysicalLayer + startReceive()PhysicalLayervirtual + startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)PhysicalLayervirtual + startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)PhysicalLayervirtual + transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmit(uint8_t *data, size_t len, uint8_t addr=0)PhysicalLayervirtual + transmitDirect(uint32_t frf=0)PhysicalLayervirtual diff --git a/class_physical_layer.html b/class_physical_layer.html index 3f6f19fb..d4732061 100644 --- a/class_physical_layer.html +++ b/class_physical_layer.html @@ -201,6 +201,9 @@ Public Member Functions virtual float getSNR ()  Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. More...
  +virtual int16_t scanChannel () + Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules, or RSSI measurement for FSK modules. More...
+  int32_t random (int32_t max)  Get truly random number in range 0 - max. More...
  @@ -813,6 +816,36 @@ class LoRaWANNode

Reimplemented in SX128x, SX127x, SX126x, Si443x, RF69, nRF24, and CC1101.

+ + + +

◆ scanChannel()

+ +
+
+ + + + + +
+ + + + + + + +
int16_t PhysicalLayer::scanChannel ()
+ 		+virtual
+
+ +

Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules, or RSSI measurement for FSK modules.

+
Returns
RADIOLIB_CHANNEL_FREE when channel is free, RADIOLIB_PREAMBLE_DETECTEDwhen occupied or other Status Codes.
+ +

Reimplemented in SX127x, SX126x, and SX128x.

+
diff --git a/class_physical_layer.js b/class_physical_layer.js index 4055f2ba..215b01b4 100644 --- a/class_physical_layer.js +++ b/class_physical_layer.js @@ -19,6 +19,7 @@ var class_physical_layer = [ "readData", "class_physical_layer.html#a3563453988a83d22dd07d4691543a300", null ], [ "receive", "class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8", null ], [ "receiveDirect", "class_physical_layer.html#ad9d1dbb2041e87af5a80e12f125a60e6", null ], + [ "scanChannel", "class_physical_layer.html#abd9e39cc745acbf084cfa0d3f4d10718", null ], [ "setBitRate", "class_physical_layer.html#aedd39ad84b45c6392087b12d59192d8c", null ], [ "setDataRate", "class_physical_layer.html#a6ee1fed6bbb8d3571974153ac6f26751", null ], [ "setDataShaping", "class_physical_layer.html#aeba04366a0cf05ff3d8227c4f7c8e1e9", null ], diff --git a/class_r_f69-members.html b/class_r_f69-members.html index 473d80a4..85382bfd 100644 --- a/class_r_f69-members.html +++ b/class_r_f69-members.html @@ -133,58 +133,59 @@ $(document).ready(function(){initNavTree('class_r_f69.html',''); initResizable() receiveDirect() overrideRF69virtual reset()RF69 RF69(Module *module)RF69 - setAESKey(uint8_t *key)RF69 - setAmbientTemperature(int16_t tempAmbient)RF69 - setBitRate(float br)RF69virtual - setBroadcastAddress(uint8_t broadAddr)RF69 - setCrcFiltering(bool crcOn=true)RF69 - setDataRate(DataRate_t dr)PhysicalLayervirtual - setDataShaping(uint8_t sh) overrideRF69virtual - setDio0Action(void(*func)(void))RF69 - setDio1Action(void(*func)(void))RF69 - setDIOMapping(uint32_t pin, uint32_t value)RF69virtual - setDirectAction(void(*func)(void))RF69virtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding) overrideRF69virtual - setFifoEmptyAction(void(*func)(void))RF69 - setFifoFullAction(void(*func)(void))RF69 - setFrequency(float freq)RF69virtual - setFrequencyDeviation(float freqDev) overrideRF69virtual - setLnaTestBoost(bool value)RF69 - setNodeAddress(uint8_t nodeAddr)RF69 - setOOK(bool enable)RF69 - setOokFixedThreshold(uint8_t value)RF69 - setOokPeakThresholdDecrement(uint8_t value)RF69 - setOokThresholdType(uint8_t type)RF69 - setOutputPower(int8_t pwr, bool highPower=false)RF69 - PhysicalLayer::setOutputPower(int8_t power)PhysicalLayervirtual - setPacketReceivedAction(void(*func)(void))RF69virtual - setPacketSentAction(void(*func)(void))RF69virtual - setPreambleLength(uint8_t preambleLen)RF69 - PhysicalLayer::setPreambleLength(size_t len)PhysicalLayervirtual - setPromiscuousMode(bool enable=true)RF69 - setRfSwitchPins(uint32_t rxEn, uint32_t txEn)RF69 - setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])RF69 - setRSSIThreshold(float dbm)RF69 - setRxBandwidth(float rxBw)RF69 - setSyncWord(uint8_t *syncWord, size_t len, uint8_t maxErrBits=0)RF69 - PhysicalLayer::setSyncWord(uint8_t *sync, size_t len)PhysicalLayervirtual - sleep()RF69virtual - standby() overrideRF69virtual - standby(uint8_t mode) overrideRF69virtual - startDirect()PhysicalLayer - startReceive()RF69virtual - startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)RF69virtual - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideRF69virtual - startTransmit(const char *str, uint8_t addr=0)RF69 - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)RF69 - PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideRF69virtual - transmit(const char *str, uint8_t addr=0)RF69 - transmit(uint8_t *data, size_t len, uint8_t addr=0)RF69 - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideRF69virtual - variablePacketLengthMode(uint8_t maxLen=RADIOLIB_RF69_MAX_PACKET_LENGTH)RF69 + scanChannel()PhysicalLayervirtual + setAESKey(uint8_t *key)RF69 + setAmbientTemperature(int16_t tempAmbient)RF69 + setBitRate(float br)RF69virtual + setBroadcastAddress(uint8_t broadAddr)RF69 + setCrcFiltering(bool crcOn=true)RF69 + setDataRate(DataRate_t dr)PhysicalLayervirtual + setDataShaping(uint8_t sh) overrideRF69virtual + setDio0Action(void(*func)(void))RF69 + setDio1Action(void(*func)(void))RF69 + setDIOMapping(uint32_t pin, uint32_t value)RF69virtual + setDirectAction(void(*func)(void))RF69virtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overrideRF69virtual + setFifoEmptyAction(void(*func)(void))RF69 + setFifoFullAction(void(*func)(void))RF69 + setFrequency(float freq)RF69virtual + setFrequencyDeviation(float freqDev) overrideRF69virtual + setLnaTestBoost(bool value)RF69 + setNodeAddress(uint8_t nodeAddr)RF69 + setOOK(bool enable)RF69 + setOokFixedThreshold(uint8_t value)RF69 + setOokPeakThresholdDecrement(uint8_t value)RF69 + setOokThresholdType(uint8_t type)RF69 + setOutputPower(int8_t pwr, bool highPower=false)RF69 + PhysicalLayer::setOutputPower(int8_t power)PhysicalLayervirtual + setPacketReceivedAction(void(*func)(void))RF69virtual + setPacketSentAction(void(*func)(void))RF69virtual + setPreambleLength(uint8_t preambleLen)RF69 + PhysicalLayer::setPreambleLength(size_t len)PhysicalLayervirtual + setPromiscuousMode(bool enable=true)RF69 + setRfSwitchPins(uint32_t rxEn, uint32_t txEn)RF69 + setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])RF69 + setRSSIThreshold(float dbm)RF69 + setRxBandwidth(float rxBw)RF69 + setSyncWord(uint8_t *syncWord, size_t len, uint8_t maxErrBits=0)RF69 + PhysicalLayer::setSyncWord(uint8_t *sync, size_t len)PhysicalLayervirtual + sleep()RF69virtual + standby() overrideRF69virtual + standby(uint8_t mode) overrideRF69virtual + startDirect()PhysicalLayer + startReceive()RF69virtual + startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)RF69virtual + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideRF69virtual + startTransmit(const char *str, uint8_t addr=0)RF69 + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)RF69 + PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideRF69virtual + transmit(const char *str, uint8_t addr=0)RF69 + transmit(uint8_t *data, size_t len, uint8_t addr=0)RF69 + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideRF69virtual + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_RF69_MAX_PACKET_LENGTH)RF69 diff --git a/class_r_f69.html b/class_r_f69.html index 10c1a2bd..fc888b3a 100644 --- a/class_r_f69.html +++ b/class_r_f69.html @@ -383,6 +383,9 @@ void virtual float getSNR ()  Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. More...
  +virtual int16_t scanChannel () + Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules, or RSSI measurement for FSK modules. More...
+  int32_t random (int32_t max)  Get truly random number in range 0 - max. More...
  diff --git a/class_r_f_m95-members.html b/class_r_f_m95-members.html index 7f397438..3e942c29 100644 --- a/class_r_f_m95-members.html +++ b/class_r_f_m95-members.html @@ -145,7 +145,7 @@ $(document).ready(function(){initNavTree('class_r_f_m95.html',''); initResizable receiveDirect() overrideSX127xvirtual reset() overrideSX1278virtual RFM95(Module *mod)RFM95 - scanChannel()SX127x + scanChannel() overrideSX127xvirtual setAFC(bool isEnabled)SX127x setAFCAGCTrigger(uint8_t trigger)SX127x setAFCBandwidth(float afcBw)SX127x diff --git a/class_r_f_m95.html b/class_r_f_m95.html index 5592005a..5eda85de 100644 --- a/class_r_f_m95.html +++ b/class_r_f_m95.html @@ -205,9 +205,9 @@ void int16_t receive (uint8_t *data, size_t len) override  Binary receive method. Will attempt to receive arbitrary binary data up to 255 bytes long using LoRa or up to 63 bytes using FSK modem. For overloads to receive Arduino String, see PhysicalLayer::receive. More...
  -int16_t scanChannel () - Performs scan for valid LoRa preamble in the current channel. More...
-  +int16_t scanChannel () override + Performs scan for valid LoRa preamble in the current channel. More...
+  int16_t sleep ()  Sets the LoRa module to sleep to save power. Module will not be able to transmit or receive any data while in sleep mode. Module will wake up automatically when methods like transmit or receive are called. More...
  diff --git a/class_r_f_m96-members.html b/class_r_f_m96-members.html index d3153125..a0837c04 100644 --- a/class_r_f_m96-members.html +++ b/class_r_f_m96-members.html @@ -145,7 +145,7 @@ $(document).ready(function(){initNavTree('class_r_f_m96.html',''); initResizable receiveDirect() overrideSX127xvirtual reset() overrideSX1278virtual RFM96(Module *mod)RFM96 - scanChannel()SX127x + scanChannel() overrideSX127xvirtual setAFC(bool isEnabled)SX127x setAFCAGCTrigger(uint8_t trigger)SX127x setAFCBandwidth(float afcBw)SX127x diff --git a/class_r_f_m96.html b/class_r_f_m96.html index 5b590d14..f8698f31 100644 --- a/class_r_f_m96.html +++ b/class_r_f_m96.html @@ -204,9 +204,9 @@ void int16_t receive (uint8_t *data, size_t len) override  Binary receive method. Will attempt to receive arbitrary binary data up to 255 bytes long using LoRa or up to 63 bytes using FSK modem. For overloads to receive Arduino String, see PhysicalLayer::receive. More...
  -int16_t scanChannel () - Performs scan for valid LoRa preamble in the current channel. More...
-  +int16_t scanChannel () override + Performs scan for valid LoRa preamble in the current channel. More...
+  int16_t sleep ()  Sets the LoRa module to sleep to save power. Module will not be able to transmit or receive any data while in sleep mode. Module will wake up automatically when methods like transmit or receive are called. More...
  diff --git a/class_r_f_m97-members.html b/class_r_f_m97-members.html index 9b83e4d4..2edab341 100644 --- a/class_r_f_m97-members.html +++ b/class_r_f_m97-members.html @@ -146,7 +146,7 @@ $(document).ready(function(){initNavTree('class_r_f_m97.html',''); initResizable reset() overrideSX1278virtual RFM95(Module *mod)RFM95 RFM97(Module *mod)RFM97 - scanChannel()SX127x + scanChannel() overrideSX127xvirtual setAFC(bool isEnabled)SX127x setAFCAGCTrigger(uint8_t trigger)SX127x setAFCBandwidth(float afcBw)SX127x diff --git a/class_r_f_m97.html b/class_r_f_m97.html index 1a324e0d..7315674c 100644 --- a/class_r_f_m97.html +++ b/class_r_f_m97.html @@ -212,9 +212,9 @@ void int16_t receive (uint8_t *data, size_t len) override  Binary receive method. Will attempt to receive arbitrary binary data up to 255 bytes long using LoRa or up to 63 bytes using FSK modem. For overloads to receive Arduino String, see PhysicalLayer::receive. More...
  -int16_t scanChannel () - Performs scan for valid LoRa preamble in the current channel. More...
-  +int16_t scanChannel () override + Performs scan for valid LoRa preamble in the current channel. More...
+  int16_t sleep ()  Sets the LoRa module to sleep to save power. Module will not be able to transmit or receive any data while in sleep mode. Module will wake up automatically when methods like transmit or receive are called. More...
  diff --git a/class_s_t_m32_w_lx-members.html b/class_s_t_m32_w_lx-members.html index 91f12caf..fdea5407 100644 --- a/class_s_t_m32_w_lx-members.html +++ b/class_s_t_m32_w_lx-members.html @@ -136,72 +136,73 @@ $(document).ready(function(){initNavTree('class_s_t_m32_w_lx.html',''); initResi receive(uint8_t *data, size_t len)SX126x 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 - setDataRate(DataRate_t dr) overrideSX126xvirtual - setDataShaping(uint8_t sh) overrideSX126xvirtual - setDio1Action(void(*func)(void))STM32WLx - setDio2AsRfSwitch(bool enable=true)SX126x - setDIOMapping(uint32_t pin, uint32_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 - setPacketReceivedAction(void(*func)(void))SX126xvirtual - setPacketSentAction(void(*func)(void))SX126xvirtual - setPreambleLength(size_t preambleLength) overrideSX126xvirtual - setRegulatorDCDC()SX126x - setRegulatorLDO()SX126x - setRfSwitchPins(uint32_t rxEn, uint32_t txEn)SX126x - setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])STM32WLx - SX1262::setRfSwitchTable(const uint32_t(&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, size_t len) overrideSX126xvirtual - setTCXO(float voltage, uint32_t delay=5000)SX126x - setWhitening(bool enabled, uint16_t initial=0x0100)SX126x - sleep(bool retainConfig=true)SX126x - PhysicalLayer::sleep()PhysicalLayervirtual - spectralScanAbort()SX126x - spectralScanGetResult(uint16_t *results)SX126x - spectralScanGetStatus()SX126x - spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x - standby() overrideSX126xvirtual - standby(uint8_t mode, bool wakeup=true)SX126x - PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual - 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()SX126xvirtual - startReceive(uint32_t timeout, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0)SX126xvirtual - startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x - startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - startTransmit(const char *str, uint8_t addr=0)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - 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(const char *str, uint8_t addr=0)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideSX126xvirtual - uploadPatch(const uint32_t *patch, size_t len, bool nonvolatile=true)SX126x - variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x - XTALSX126x + scanChannel() overrideSX126xvirtual + scanChannel(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin)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 + setDataRate(DataRate_t dr) overrideSX126xvirtual + setDataShaping(uint8_t sh) overrideSX126xvirtual + setDio1Action(void(*func)(void))STM32WLx + setDio2AsRfSwitch(bool enable=true)SX126x + setDIOMapping(uint32_t pin, uint32_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 + setPacketReceivedAction(void(*func)(void))SX126xvirtual + setPacketSentAction(void(*func)(void))SX126xvirtual + setPreambleLength(size_t preambleLength) overrideSX126xvirtual + setRegulatorDCDC()SX126x + setRegulatorLDO()SX126x + setRfSwitchPins(uint32_t rxEn, uint32_t txEn)SX126x + setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])STM32WLx + SX1262::setRfSwitchTable(const uint32_t(&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, size_t len) overrideSX126xvirtual + setTCXO(float voltage, uint32_t delay=5000)SX126x + setWhitening(bool enabled, uint16_t initial=0x0100)SX126x + sleep(bool retainConfig=true)SX126x + PhysicalLayer::sleep()PhysicalLayervirtual + spectralScanAbort()SX126x + spectralScanGetResult(uint16_t *results)SX126x + spectralScanGetStatus()SX126x + spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x + standby() overrideSX126xvirtual + standby(uint8_t mode, bool wakeup=true)SX126x + PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual + 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()SX126xvirtual + startReceive(uint32_t timeout, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0)SX126xvirtual + startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x + startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + startTransmit(const char *str, uint8_t addr=0)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + 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(const char *str, uint8_t addr=0)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideSX126xvirtual + uploadPatch(const uint32_t *patch, size_t len, bool nonvolatile=true)SX126x + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x + XTALSX126x diff --git a/class_s_t_m32_w_lx.html b/class_s_t_m32_w_lx.html index 935507a7..7ef98a1b 100644 --- a/class_s_t_m32_w_lx.html +++ b/class_s_t_m32_w_lx.html @@ -189,9 +189,12 @@ void int16_t receiveDirect () override  Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does not support direct mode reception. Will always return RADIOLIB_ERR_UNKNOWN. More...
  -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. More...
-  +int16_t scanChannel () override + Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
+  +int16_t scanChannel (uint8_t symbolNum, uint8_t detPeak, uint8_t detMin) + Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
+  int16_t sleep (bool retainConfig=true)  Sets the module to sleep mode. To wake the device up, call standby(). More...
  diff --git a/class_s_x1231-members.html b/class_s_x1231-members.html index b8d19cd0..b3355ff8 100644 --- a/class_s_x1231-members.html +++ b/class_s_x1231-members.html @@ -133,59 +133,60 @@ $(document).ready(function(){initNavTree('class_s_x1231.html',''); initResizable receiveDirect() overrideRF69virtual reset()RF69 RF69(Module *module)RF69 - setAESKey(uint8_t *key)RF69 - setAmbientTemperature(int16_t tempAmbient)RF69 - setBitRate(float br)RF69virtual - setBroadcastAddress(uint8_t broadAddr)RF69 - setCrcFiltering(bool crcOn=true)RF69 - setDataRate(DataRate_t dr)PhysicalLayervirtual - setDataShaping(uint8_t sh) overrideRF69virtual - setDio0Action(void(*func)(void))RF69 - setDio1Action(void(*func)(void))RF69 - setDIOMapping(uint32_t pin, uint32_t value)RF69virtual - setDirectAction(void(*func)(void))RF69virtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding) overrideRF69virtual - setFifoEmptyAction(void(*func)(void))RF69 - setFifoFullAction(void(*func)(void))RF69 - setFrequency(float freq)RF69virtual - setFrequencyDeviation(float freqDev) overrideRF69virtual - setLnaTestBoost(bool value)RF69 - setNodeAddress(uint8_t nodeAddr)RF69 - setOOK(bool enable)RF69 - setOokFixedThreshold(uint8_t value)RF69 - setOokPeakThresholdDecrement(uint8_t value)RF69 - setOokThresholdType(uint8_t type)RF69 - setOutputPower(int8_t pwr, bool highPower=false)RF69 - PhysicalLayer::setOutputPower(int8_t power)PhysicalLayervirtual - setPacketReceivedAction(void(*func)(void))RF69virtual - setPacketSentAction(void(*func)(void))RF69virtual - setPreambleLength(uint8_t preambleLen)RF69 - PhysicalLayer::setPreambleLength(size_t len)PhysicalLayervirtual - setPromiscuousMode(bool enable=true)RF69 - setRfSwitchPins(uint32_t rxEn, uint32_t txEn)RF69 - setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])RF69 - setRSSIThreshold(float dbm)RF69 - setRxBandwidth(float rxBw)RF69 - setSyncWord(uint8_t *syncWord, size_t len, uint8_t maxErrBits=0)RF69 - PhysicalLayer::setSyncWord(uint8_t *sync, size_t len)PhysicalLayervirtual - sleep()RF69virtual - standby() overrideRF69virtual - standby(uint8_t mode) overrideRF69virtual - startDirect()PhysicalLayer - startReceive()RF69virtual - startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)RF69virtual - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideRF69virtual - startTransmit(const char *str, uint8_t addr=0)RF69 - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)RF69 - PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - SX1231(Module *mod)SX1231 - transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideRF69virtual - transmit(const char *str, uint8_t addr=0)RF69 - transmit(uint8_t *data, size_t len, uint8_t addr=0)RF69 - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideRF69virtual - variablePacketLengthMode(uint8_t maxLen=RADIOLIB_RF69_MAX_PACKET_LENGTH)RF69 + scanChannel()PhysicalLayervirtual + setAESKey(uint8_t *key)RF69 + setAmbientTemperature(int16_t tempAmbient)RF69 + setBitRate(float br)RF69virtual + setBroadcastAddress(uint8_t broadAddr)RF69 + setCrcFiltering(bool crcOn=true)RF69 + setDataRate(DataRate_t dr)PhysicalLayervirtual + setDataShaping(uint8_t sh) overrideRF69virtual + setDio0Action(void(*func)(void))RF69 + setDio1Action(void(*func)(void))RF69 + setDIOMapping(uint32_t pin, uint32_t value)RF69virtual + setDirectAction(void(*func)(void))RF69virtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overrideRF69virtual + setFifoEmptyAction(void(*func)(void))RF69 + setFifoFullAction(void(*func)(void))RF69 + setFrequency(float freq)RF69virtual + setFrequencyDeviation(float freqDev) overrideRF69virtual + setLnaTestBoost(bool value)RF69 + setNodeAddress(uint8_t nodeAddr)RF69 + setOOK(bool enable)RF69 + setOokFixedThreshold(uint8_t value)RF69 + setOokPeakThresholdDecrement(uint8_t value)RF69 + setOokThresholdType(uint8_t type)RF69 + setOutputPower(int8_t pwr, bool highPower=false)RF69 + PhysicalLayer::setOutputPower(int8_t power)PhysicalLayervirtual + setPacketReceivedAction(void(*func)(void))RF69virtual + setPacketSentAction(void(*func)(void))RF69virtual + setPreambleLength(uint8_t preambleLen)RF69 + PhysicalLayer::setPreambleLength(size_t len)PhysicalLayervirtual + setPromiscuousMode(bool enable=true)RF69 + setRfSwitchPins(uint32_t rxEn, uint32_t txEn)RF69 + setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])RF69 + setRSSIThreshold(float dbm)RF69 + setRxBandwidth(float rxBw)RF69 + setSyncWord(uint8_t *syncWord, size_t len, uint8_t maxErrBits=0)RF69 + PhysicalLayer::setSyncWord(uint8_t *sync, size_t len)PhysicalLayervirtual + sleep()RF69virtual + standby() overrideRF69virtual + standby(uint8_t mode) overrideRF69virtual + startDirect()PhysicalLayer + startReceive()RF69virtual + startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)RF69virtual + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideRF69virtual + startTransmit(const char *str, uint8_t addr=0)RF69 + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)RF69 + PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + SX1231(Module *mod)SX1231 + transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideRF69virtual + transmit(const char *str, uint8_t addr=0)RF69 + transmit(uint8_t *data, size_t len, uint8_t addr=0)RF69 + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideRF69virtual + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_RF69_MAX_PACKET_LENGTH)RF69 diff --git a/class_s_x1231.html b/class_s_x1231.html index ec6704f9..f71830d1 100644 --- a/class_s_x1231.html +++ b/class_s_x1231.html @@ -390,6 +390,9 @@ void virtual float getSNR ()  Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. More...
  +virtual int16_t scanChannel () + Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules, or RSSI measurement for FSK modules. More...
+  int32_t random (int32_t max)  Get truly random number in range 0 - max. More...
  diff --git a/class_s_x1261-members.html b/class_s_x1261-members.html index 39998d5a..f1ed8b67 100644 --- a/class_s_x1261-members.html +++ b/class_s_x1261-members.html @@ -130,71 +130,72 @@ $(document).ready(function(){initNavTree('class_s_x1261.html',''); initResizable receive(uint8_t *data, size_t len)SX126x 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 - setDataRate(DataRate_t dr) overrideSX126xvirtual - setDataShaping(uint8_t sh) overrideSX126xvirtual - setDio1Action(void(*func)(void))SX126x - setDio2AsRfSwitch(bool enable=true)SX126x - setDIOMapping(uint32_t pin, uint32_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 - setPacketReceivedAction(void(*func)(void))SX126xvirtual - setPacketSentAction(void(*func)(void))SX126xvirtual - setPreambleLength(size_t preambleLength) overrideSX126xvirtual - setRegulatorDCDC()SX126x - setRegulatorLDO()SX126x - setRfSwitchPins(uint32_t rxEn, uint32_t txEn)SX126x - setRfSwitchTable(const uint32_t(&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, size_t len) overrideSX126xvirtual - setTCXO(float voltage, uint32_t delay=5000)SX126x - setWhitening(bool enabled, uint16_t initial=0x0100)SX126x - sleep(bool retainConfig=true)SX126x - PhysicalLayer::sleep()PhysicalLayervirtual - spectralScanAbort()SX126x - spectralScanGetResult(uint16_t *results)SX126x - spectralScanGetStatus()SX126x - spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x - standby() overrideSX126xvirtual - standby(uint8_t mode, bool wakeup=true)SX126x - PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual - 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()SX126xvirtual - startReceive(uint32_t timeout, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0)SX126xvirtual - startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x - startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - startTransmit(const char *str, uint8_t addr=0)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - 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(const char *str, uint8_t addr=0)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideSX126xvirtual - uploadPatch(const uint32_t *patch, size_t len, bool nonvolatile=true)SX126x - variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x - XTALSX126x + scanChannel() overrideSX126xvirtual + scanChannel(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin)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 + setDataRate(DataRate_t dr) overrideSX126xvirtual + setDataShaping(uint8_t sh) overrideSX126xvirtual + setDio1Action(void(*func)(void))SX126x + setDio2AsRfSwitch(bool enable=true)SX126x + setDIOMapping(uint32_t pin, uint32_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 + setPacketReceivedAction(void(*func)(void))SX126xvirtual + setPacketSentAction(void(*func)(void))SX126xvirtual + setPreambleLength(size_t preambleLength) overrideSX126xvirtual + setRegulatorDCDC()SX126x + setRegulatorLDO()SX126x + setRfSwitchPins(uint32_t rxEn, uint32_t txEn)SX126x + setRfSwitchTable(const uint32_t(&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, size_t len) overrideSX126xvirtual + setTCXO(float voltage, uint32_t delay=5000)SX126x + setWhitening(bool enabled, uint16_t initial=0x0100)SX126x + sleep(bool retainConfig=true)SX126x + PhysicalLayer::sleep()PhysicalLayervirtual + spectralScanAbort()SX126x + spectralScanGetResult(uint16_t *results)SX126x + spectralScanGetStatus()SX126x + spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x + standby() overrideSX126xvirtual + standby(uint8_t mode, bool wakeup=true)SX126x + PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual + 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()SX126xvirtual + startReceive(uint32_t timeout, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0)SX126xvirtual + startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x + startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + startTransmit(const char *str, uint8_t addr=0)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + 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(const char *str, uint8_t addr=0)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideSX126xvirtual + uploadPatch(const uint32_t *patch, size_t len, bool nonvolatile=true)SX126x + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x + XTALSX126x diff --git a/class_s_x1261.html b/class_s_x1261.html index 40f25626..113b26f8 100644 --- a/class_s_x1261.html +++ b/class_s_x1261.html @@ -158,9 +158,12 @@ Public Member Functions int16_t receiveDirect () override  Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does not support direct mode reception. Will always return RADIOLIB_ERR_UNKNOWN. More...
  -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. More...
-  +int16_t scanChannel () override + Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
+  +int16_t scanChannel (uint8_t symbolNum, uint8_t detPeak, uint8_t detMin) + Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
+  int16_t sleep (bool retainConfig=true)  Sets the module to sleep mode. To wake the device up, call standby(). More...
  diff --git a/class_s_x1262-members.html b/class_s_x1262-members.html index 72c6c926..763dfc2f 100644 --- a/class_s_x1262-members.html +++ b/class_s_x1262-members.html @@ -130,70 +130,71 @@ $(document).ready(function(){initNavTree('class_s_x1262.html',''); initResizable receive(uint8_t *data, size_t len)SX126x 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 - setDataRate(DataRate_t dr) overrideSX126xvirtual - setDataShaping(uint8_t sh) overrideSX126xvirtual - setDio1Action(void(*func)(void))SX126x - setDio2AsRfSwitch(bool enable=true)SX126x - setDIOMapping(uint32_t pin, uint32_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 - setPacketReceivedAction(void(*func)(void))SX126xvirtual - setPacketSentAction(void(*func)(void))SX126xvirtual - setPreambleLength(size_t preambleLength) overrideSX126xvirtual - setRegulatorDCDC()SX126x - setRegulatorLDO()SX126x - setRfSwitchPins(uint32_t rxEn, uint32_t txEn)SX126x - setRfSwitchTable(const uint32_t(&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, size_t len) overrideSX126xvirtual - setTCXO(float voltage, uint32_t delay=5000)SX126x - setWhitening(bool enabled, uint16_t initial=0x0100)SX126x - sleep(bool retainConfig=true)SX126x - PhysicalLayer::sleep()PhysicalLayervirtual - spectralScanAbort()SX126x - spectralScanGetResult(uint16_t *results)SX126x - spectralScanGetStatus()SX126x - spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x - standby() overrideSX126xvirtual - standby(uint8_t mode, bool wakeup=true)SX126x - PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual - 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()SX126xvirtual - startReceive(uint32_t timeout, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0)SX126xvirtual - startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x - startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - startTransmit(const char *str, uint8_t addr=0)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - 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(const char *str, uint8_t addr=0)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideSX126xvirtual - uploadPatch(const uint32_t *patch, size_t len, bool nonvolatile=true)SX126x - variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x - XTALSX126x + scanChannel() overrideSX126xvirtual + scanChannel(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin)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 + setDataRate(DataRate_t dr) overrideSX126xvirtual + setDataShaping(uint8_t sh) overrideSX126xvirtual + setDio1Action(void(*func)(void))SX126x + setDio2AsRfSwitch(bool enable=true)SX126x + setDIOMapping(uint32_t pin, uint32_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 + setPacketReceivedAction(void(*func)(void))SX126xvirtual + setPacketSentAction(void(*func)(void))SX126xvirtual + setPreambleLength(size_t preambleLength) overrideSX126xvirtual + setRegulatorDCDC()SX126x + setRegulatorLDO()SX126x + setRfSwitchPins(uint32_t rxEn, uint32_t txEn)SX126x + setRfSwitchTable(const uint32_t(&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, size_t len) overrideSX126xvirtual + setTCXO(float voltage, uint32_t delay=5000)SX126x + setWhitening(bool enabled, uint16_t initial=0x0100)SX126x + sleep(bool retainConfig=true)SX126x + PhysicalLayer::sleep()PhysicalLayervirtual + spectralScanAbort()SX126x + spectralScanGetResult(uint16_t *results)SX126x + spectralScanGetStatus()SX126x + spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x + standby() overrideSX126xvirtual + standby(uint8_t mode, bool wakeup=true)SX126x + PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual + 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()SX126xvirtual + startReceive(uint32_t timeout, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0)SX126xvirtual + startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x + startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + startTransmit(const char *str, uint8_t addr=0)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + 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(const char *str, uint8_t addr=0)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideSX126xvirtual + uploadPatch(const uint32_t *patch, size_t len, bool nonvolatile=true)SX126x + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x + XTALSX126x diff --git a/class_s_x1262.html b/class_s_x1262.html index 0bb835eb..91dc6c3a 100644 --- a/class_s_x1262.html +++ b/class_s_x1262.html @@ -156,9 +156,12 @@ Public Member Functions int16_t receiveDirect () override  Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does not support direct mode reception. Will always return RADIOLIB_ERR_UNKNOWN. More...
  -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. More...
-  +int16_t scanChannel () override + Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
+  +int16_t scanChannel (uint8_t symbolNum, uint8_t detPeak, uint8_t detMin) + Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
+  int16_t sleep (bool retainConfig=true)  Sets the module to sleep mode. To wake the device up, call standby(). More...
  diff --git a/class_s_x1268-members.html b/class_s_x1268-members.html index 37da483d..192a91d0 100644 --- a/class_s_x1268-members.html +++ b/class_s_x1268-members.html @@ -130,70 +130,71 @@ $(document).ready(function(){initNavTree('class_s_x1268.html',''); initResizable receive(uint8_t *data, size_t len)SX126x 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 - setDataRate(DataRate_t dr) overrideSX126xvirtual - setDataShaping(uint8_t sh) overrideSX126xvirtual - setDio1Action(void(*func)(void))SX126x - setDio2AsRfSwitch(bool enable=true)SX126x - setDIOMapping(uint32_t pin, uint32_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)SX1268virtual - setPacketReceivedAction(void(*func)(void))SX126xvirtual - setPacketSentAction(void(*func)(void))SX126xvirtual - setPreambleLength(size_t preambleLength) overrideSX126xvirtual - setRegulatorDCDC()SX126x - setRegulatorLDO()SX126x - setRfSwitchPins(uint32_t rxEn, uint32_t txEn)SX126x - setRfSwitchTable(const uint32_t(&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, size_t len) overrideSX126xvirtual - setTCXO(float voltage, uint32_t delay=5000)SX126x - setWhitening(bool enabled, uint16_t initial=0x0100)SX126x - sleep(bool retainConfig=true)SX126x - PhysicalLayer::sleep()PhysicalLayervirtual - spectralScanAbort()SX126x - spectralScanGetResult(uint16_t *results)SX126x - spectralScanGetStatus()SX126x - spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x - standby() overrideSX126xvirtual - standby(uint8_t mode, bool wakeup=true)SX126x - PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual - 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()SX126xvirtual - startReceive(uint32_t timeout, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0)SX126xvirtual - startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x - startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - startTransmit(const char *str, uint8_t addr=0)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - 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(const char *str, uint8_t addr=0)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideSX126xvirtual - uploadPatch(const uint32_t *patch, size_t len, bool nonvolatile=true)SX126x - variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x - XTALSX126x + scanChannel() overrideSX126xvirtual + scanChannel(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin)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 + setDataRate(DataRate_t dr) overrideSX126xvirtual + setDataShaping(uint8_t sh) overrideSX126xvirtual + setDio1Action(void(*func)(void))SX126x + setDio2AsRfSwitch(bool enable=true)SX126x + setDIOMapping(uint32_t pin, uint32_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)SX1268virtual + setPacketReceivedAction(void(*func)(void))SX126xvirtual + setPacketSentAction(void(*func)(void))SX126xvirtual + setPreambleLength(size_t preambleLength) overrideSX126xvirtual + setRegulatorDCDC()SX126x + setRegulatorLDO()SX126x + setRfSwitchPins(uint32_t rxEn, uint32_t txEn)SX126x + setRfSwitchTable(const uint32_t(&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, size_t len) overrideSX126xvirtual + setTCXO(float voltage, uint32_t delay=5000)SX126x + setWhitening(bool enabled, uint16_t initial=0x0100)SX126x + sleep(bool retainConfig=true)SX126x + PhysicalLayer::sleep()PhysicalLayervirtual + spectralScanAbort()SX126x + spectralScanGetResult(uint16_t *results)SX126x + spectralScanGetStatus()SX126x + spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x + standby() overrideSX126xvirtual + standby(uint8_t mode, bool wakeup=true)SX126x + PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual + 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()SX126xvirtual + startReceive(uint32_t timeout, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0)SX126xvirtual + startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x + startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + startTransmit(const char *str, uint8_t addr=0)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + 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(const char *str, uint8_t addr=0)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideSX126xvirtual + uploadPatch(const uint32_t *patch, size_t len, bool nonvolatile=true)SX126x + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x + XTALSX126x diff --git a/class_s_x1268.html b/class_s_x1268.html index 575d0e21..caa6ba1a 100644 --- a/class_s_x1268.html +++ b/class_s_x1268.html @@ -153,9 +153,12 @@ Public Member Functions int16_t receiveDirect () override  Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does not support direct mode reception. Will always return RADIOLIB_ERR_UNKNOWN. More...
  -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. More...
-  +int16_t scanChannel () override + Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
+  +int16_t scanChannel (uint8_t symbolNum, uint8_t detPeak, uint8_t detMin) + Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
+  int16_t sleep (bool retainConfig=true)  Sets the module to sleep mode. To wake the device up, call standby(). More...
  diff --git a/class_s_x126x-members.html b/class_s_x126x-members.html index 506eb352..ead29a64 100644 --- a/class_s_x126x-members.html +++ b/class_s_x126x-members.html @@ -128,68 +128,69 @@ $(document).ready(function(){initNavTree('class_s_x126x.html',''); initResizable receive(uint8_t *data, size_t len)SX126x 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 - setDataRate(DataRate_t dr) overrideSX126xvirtual - setDataShaping(uint8_t sh) overrideSX126xvirtual - setDio1Action(void(*func)(void))SX126x - setDio2AsRfSwitch(bool enable=true)SX126x - setDIOMapping(uint32_t pin, uint32_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 - setOutputPower(int8_t power)PhysicalLayervirtual - setPacketReceivedAction(void(*func)(void))SX126xvirtual - setPacketSentAction(void(*func)(void))SX126xvirtual - setPreambleLength(size_t preambleLength) overrideSX126xvirtual - setRegulatorDCDC()SX126x - setRegulatorLDO()SX126x - setRfSwitchPins(uint32_t rxEn, uint32_t txEn)SX126x - setRfSwitchTable(const uint32_t(&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, size_t len) overrideSX126xvirtual - setTCXO(float voltage, uint32_t delay=5000)SX126x - setWhitening(bool enabled, uint16_t initial=0x0100)SX126x - sleep(bool retainConfig=true)SX126x - PhysicalLayer::sleep()PhysicalLayervirtual - spectralScanAbort()SX126x - spectralScanGetResult(uint16_t *results)SX126x - spectralScanGetStatus()SX126x - spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x - standby() overrideSX126xvirtual - standby(uint8_t mode, bool wakeup=true)SX126x - PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual - 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()SX126xvirtual - startReceive(uint32_t timeout, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0)SX126xvirtual - startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x - startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - startTransmit(const char *str, uint8_t addr=0)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - 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(const char *str, uint8_t addr=0)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideSX126xvirtual - uploadPatch(const uint32_t *patch, size_t len, bool nonvolatile=true)SX126x - variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x - XTALSX126x + scanChannel() overrideSX126xvirtual + scanChannel(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin)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 + setDataRate(DataRate_t dr) overrideSX126xvirtual + setDataShaping(uint8_t sh) overrideSX126xvirtual + setDio1Action(void(*func)(void))SX126x + setDio2AsRfSwitch(bool enable=true)SX126x + setDIOMapping(uint32_t pin, uint32_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 + setOutputPower(int8_t power)PhysicalLayervirtual + setPacketReceivedAction(void(*func)(void))SX126xvirtual + setPacketSentAction(void(*func)(void))SX126xvirtual + setPreambleLength(size_t preambleLength) overrideSX126xvirtual + setRegulatorDCDC()SX126x + setRegulatorLDO()SX126x + setRfSwitchPins(uint32_t rxEn, uint32_t txEn)SX126x + setRfSwitchTable(const uint32_t(&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, size_t len) overrideSX126xvirtual + setTCXO(float voltage, uint32_t delay=5000)SX126x + setWhitening(bool enabled, uint16_t initial=0x0100)SX126x + sleep(bool retainConfig=true)SX126x + PhysicalLayer::sleep()PhysicalLayervirtual + spectralScanAbort()SX126x + spectralScanGetResult(uint16_t *results)SX126x + spectralScanGetStatus()SX126x + spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x + standby() overrideSX126xvirtual + standby(uint8_t mode, bool wakeup=true)SX126x + PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual + 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()SX126xvirtual + startReceive(uint32_t timeout, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0)SX126xvirtual + startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x + startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + startTransmit(const char *str, uint8_t addr=0)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + 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(const char *str, uint8_t addr=0)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideSX126xvirtual + uploadPatch(const uint32_t *patch, size_t len, bool nonvolatile=true)SX126x + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x + XTALSX126x diff --git a/class_s_x126x.html b/class_s_x126x.html index d2782ac9..7a688320 100644 --- a/class_s_x126x.html +++ b/class_s_x126x.html @@ -139,9 +139,12 @@ Public Member Functions int16_t receiveDirect () override  Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does not support direct mode reception. Will always return RADIOLIB_ERR_UNKNOWN. More...
  -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. More...
-  +int16_t scanChannel () override + Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
+  +int16_t scanChannel (uint8_t symbolNum, uint8_t detPeak, uint8_t detMin) + Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
+  int16_t sleep (bool retainConfig=true)  Sets the module to sleep mode. To wake the device up, call standby(). More...
  @@ -1277,8 +1280,38 @@ bool  -

◆ scanChannel()

+ +

◆ scanChannel() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
int16_t SX126x::scanChannel ()
+ 		+overridevirtual
+
+ +

Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.

+
Returns
Status Codes
+ +

Reimplemented from PhysicalLayer.

+ +
+
+ +

◆ scanChannel() [2/2]

@@ -1287,19 +1320,19 @@ bool int16_t SX126x::scanChannel ( uint8_t  - symbolNum = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, + symbolNum, uint8_t  - detPeak = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, + detPeak, uint8_t  - detMin = RADIOLIB_SX126X_CAD_PARAM_DEFAULT  + detMin  diff --git a/class_s_x126x.js b/class_s_x126x.js index 7eb1595f..16a94b06 100644 --- a/class_s_x126x.js +++ b/class_s_x126x.js @@ -32,7 +32,8 @@ var class_s_x126x = [ "receive", "class_s_x126x.html#ae3db6b29c482d94eef8a43cd8b5751c0", null ], [ "receiveDirect", "class_s_x126x.html#a8a18aee2bf05793aa29b5cf6b47bb435", null ], [ "reset", "class_s_x126x.html#a9aa6dd05dd32ef717a06cc8ba28ff71f", null ], - [ "scanChannel", "class_s_x126x.html#a755e7df4b0958f7c793d0c058408831a", null ], + [ "scanChannel", "class_s_x126x.html#acb8611a9c3862dd1bfa73ef47b8f9b20", null ], + [ "scanChannel", "class_s_x126x.html#a4bbc29f5dc7253b7743599c68137df48", null ], [ "setBandwidth", "class_s_x126x.html#a2f60df59c80241d98ce078c0417a7f08", null ], [ "setBitRate", "class_s_x126x.html#a7deeef45d7f64a4018a3e56aaea4eb0e", null ], [ "setBroadcastAddress", "class_s_x126x.html#abd8eea7e468db3d6064c19d4934d5034", null ], diff --git a/class_s_x1272-members.html b/class_s_x1272-members.html index b75c1803..552c21a2 100644 --- a/class_s_x1272-members.html +++ b/class_s_x1272-members.html @@ -144,7 +144,7 @@ $(document).ready(function(){initNavTree('class_s_x1272.html',''); initResizable receive(uint8_t *data, size_t len)SX127x receiveDirect() overrideSX127xvirtual reset() overrideSX1272virtual - scanChannel()SX127x + scanChannel() overrideSX127xvirtual setAFC(bool isEnabled)SX127x setAFCAGCTrigger(uint8_t trigger)SX127x setAFCBandwidth(float afcBw)SX127x diff --git a/class_s_x1272.html b/class_s_x1272.html index eff773c9..bf66fee8 100644 --- a/class_s_x1272.html +++ b/class_s_x1272.html @@ -191,9 +191,9 @@ void int16_t receive (uint8_t *data, size_t len) override  Binary receive method. Will attempt to receive arbitrary binary data up to 255 bytes long using LoRa or up to 63 bytes using FSK modem. For overloads to receive Arduino String, see PhysicalLayer::receive. More...
  -int16_t scanChannel () - Performs scan for valid LoRa preamble in the current channel. More...
-  +int16_t scanChannel () override + Performs scan for valid LoRa preamble in the current channel. More...
+  int16_t sleep ()  Sets the LoRa module to sleep to save power. Module will not be able to transmit or receive any data while in sleep mode. Module will wake up automatically when methods like transmit or receive are called. More...
  diff --git a/class_s_x1273-members.html b/class_s_x1273-members.html index d2c7fffe..8a8ab2ab 100644 --- a/class_s_x1273-members.html +++ b/class_s_x1273-members.html @@ -144,7 +144,7 @@ $(document).ready(function(){initNavTree('class_s_x1273.html',''); initResizable receive(uint8_t *data, size_t len)SX127x receiveDirect() overrideSX127xvirtual reset() overrideSX1272virtual - scanChannel()SX127x + scanChannel() overrideSX127xvirtual setAFC(bool isEnabled)SX127x setAFCAGCTrigger(uint8_t trigger)SX127x setAFCBandwidth(float afcBw)SX127x diff --git a/class_s_x1273.html b/class_s_x1273.html index b51739e4..f89bf77b 100644 --- a/class_s_x1273.html +++ b/class_s_x1273.html @@ -201,9 +201,9 @@ void int16_t receive (uint8_t *data, size_t len) override  Binary receive method. Will attempt to receive arbitrary binary data up to 255 bytes long using LoRa or up to 63 bytes using FSK modem. For overloads to receive Arduino String, see PhysicalLayer::receive. More...
  -int16_t scanChannel () - Performs scan for valid LoRa preamble in the current channel. More...
-  +int16_t scanChannel () override + Performs scan for valid LoRa preamble in the current channel. More...
+  int16_t sleep ()  Sets the LoRa module to sleep to save power. Module will not be able to transmit or receive any data while in sleep mode. Module will wake up automatically when methods like transmit or receive are called. More...
  diff --git a/class_s_x1276-members.html b/class_s_x1276-members.html index 8113a429..7732ab84 100644 --- a/class_s_x1276-members.html +++ b/class_s_x1276-members.html @@ -144,7 +144,7 @@ $(document).ready(function(){initNavTree('class_s_x1276.html',''); initResizable receive(uint8_t *data, size_t len)SX127x receiveDirect() overrideSX127xvirtual reset() overrideSX1278virtual - scanChannel()SX127x + scanChannel() overrideSX127xvirtual setAFC(bool isEnabled)SX127x setAFCAGCTrigger(uint8_t trigger)SX127x setAFCBandwidth(float afcBw)SX127x diff --git a/class_s_x1276.html b/class_s_x1276.html index d6b8bc97..97badc54 100644 --- a/class_s_x1276.html +++ b/class_s_x1276.html @@ -204,9 +204,9 @@ void int16_t receive (uint8_t *data, size_t len) override  Binary receive method. Will attempt to receive arbitrary binary data up to 255 bytes long using LoRa or up to 63 bytes using FSK modem. For overloads to receive Arduino String, see PhysicalLayer::receive. More...
  -int16_t scanChannel () - Performs scan for valid LoRa preamble in the current channel. More...
-  +int16_t scanChannel () override + Performs scan for valid LoRa preamble in the current channel. More...
+  int16_t sleep ()  Sets the LoRa module to sleep to save power. Module will not be able to transmit or receive any data while in sleep mode. Module will wake up automatically when methods like transmit or receive are called. More...
  diff --git a/class_s_x1277-members.html b/class_s_x1277-members.html index 740c5696..a292cf7c 100644 --- a/class_s_x1277-members.html +++ b/class_s_x1277-members.html @@ -144,7 +144,7 @@ $(document).ready(function(){initNavTree('class_s_x1277.html',''); initResizable receive(uint8_t *data, size_t len)SX127x receiveDirect() overrideSX127xvirtual reset() overrideSX1278virtual - scanChannel()SX127x + scanChannel() overrideSX127xvirtual setAFC(bool isEnabled)SX127x setAFCAGCTrigger(uint8_t trigger)SX127x setAFCBandwidth(float afcBw)SX127x diff --git a/class_s_x1277.html b/class_s_x1277.html index 2bb08796..804dd2d4 100644 --- a/class_s_x1277.html +++ b/class_s_x1277.html @@ -210,9 +210,9 @@ void int16_t receive (uint8_t *data, size_t len) override  Binary receive method. Will attempt to receive arbitrary binary data up to 255 bytes long using LoRa or up to 63 bytes using FSK modem. For overloads to receive Arduino String, see PhysicalLayer::receive. More...
  -int16_t scanChannel () - Performs scan for valid LoRa preamble in the current channel. More...
-  +int16_t scanChannel () override + Performs scan for valid LoRa preamble in the current channel. More...
+  int16_t sleep ()  Sets the LoRa module to sleep to save power. Module will not be able to transmit or receive any data while in sleep mode. Module will wake up automatically when methods like transmit or receive are called. More...
  diff --git a/class_s_x1278-members.html b/class_s_x1278-members.html index 479e3dd2..31a34488 100644 --- a/class_s_x1278-members.html +++ b/class_s_x1278-members.html @@ -144,7 +144,7 @@ $(document).ready(function(){initNavTree('class_s_x1278.html',''); initResizable receive(uint8_t *data, size_t len)SX127x receiveDirect() overrideSX127xvirtual reset() overrideSX1278virtual - scanChannel()SX127x + scanChannel() overrideSX127xvirtual setAFC(bool isEnabled)SX127x setAFCAGCTrigger(uint8_t trigger)SX127x setAFCBandwidth(float afcBw)SX127x diff --git a/class_s_x1278.html b/class_s_x1278.html index 06896696..cedc7869 100644 --- a/class_s_x1278.html +++ b/class_s_x1278.html @@ -196,9 +196,9 @@ void int16_t receive (uint8_t *data, size_t len) override  Binary receive method. Will attempt to receive arbitrary binary data up to 255 bytes long using LoRa or up to 63 bytes using FSK modem. For overloads to receive Arduino String, see PhysicalLayer::receive. More...
  -int16_t scanChannel () - Performs scan for valid LoRa preamble in the current channel. More...
-  +int16_t scanChannel () override + Performs scan for valid LoRa preamble in the current channel. More...
+  int16_t sleep ()  Sets the LoRa module to sleep to save power. Module will not be able to transmit or receive any data while in sleep mode. Module will wake up automatically when methods like transmit or receive are called. More...
  diff --git a/class_s_x1279-members.html b/class_s_x1279-members.html index a1d2555f..2528b4a5 100644 --- a/class_s_x1279-members.html +++ b/class_s_x1279-members.html @@ -144,7 +144,7 @@ $(document).ready(function(){initNavTree('class_s_x1279.html',''); initResizable receive(uint8_t *data, size_t len)SX127x receiveDirect() overrideSX127xvirtual reset() overrideSX1278virtual - scanChannel()SX127x + scanChannel() overrideSX127xvirtual setAFC(bool isEnabled)SX127x setAFCAGCTrigger(uint8_t trigger)SX127x setAFCBandwidth(float afcBw)SX127x diff --git a/class_s_x1279.html b/class_s_x1279.html index 63d5aa1c..bd955487 100644 --- a/class_s_x1279.html +++ b/class_s_x1279.html @@ -201,9 +201,9 @@ void int16_t receive (uint8_t *data, size_t len) override  Binary receive method. Will attempt to receive arbitrary binary data up to 255 bytes long using LoRa or up to 63 bytes using FSK modem. For overloads to receive Arduino String, see PhysicalLayer::receive. More...
  -int16_t scanChannel () - Performs scan for valid LoRa preamble in the current channel. More...
-  +int16_t scanChannel () override + Performs scan for valid LoRa preamble in the current channel. More...
+  int16_t sleep ()  Sets the LoRa module to sleep to save power. Module will not be able to transmit or receive any data while in sleep mode. Module will wake up automatically when methods like transmit or receive are called. More...
  diff --git a/class_s_x127x-members.html b/class_s_x127x-members.html index 97bd483a..5ec2e5d6 100644 --- a/class_s_x127x-members.html +++ b/class_s_x127x-members.html @@ -137,7 +137,7 @@ $(document).ready(function(){initNavTree('class_s_x127x.html',''); initResizable receive(uint8_t *data, size_t len)SX127x receiveDirect() overrideSX127xvirtual reset()=0SX127xpure virtual - scanChannel()SX127x + scanChannel() overrideSX127xvirtual setAFC(bool isEnabled)SX127x setAFCAGCTrigger(uint8_t trigger)SX127x setAFCBandwidth(float afcBw)SX127x diff --git a/class_s_x127x.html b/class_s_x127x.html index 6506fae1..80aab822 100644 --- a/class_s_x127x.html +++ b/class_s_x127x.html @@ -137,9 +137,9 @@ virtual void int16_t receive (uint8_t *data, size_t len) override  Binary receive method. Will attempt to receive arbitrary binary data up to 255 bytes long using LoRa or up to 63 bytes using FSK modem. For overloads to receive Arduino String, see PhysicalLayer::receive. More...
  -int16_t scanChannel () - Performs scan for valid LoRa preamble in the current channel. More...
-  +int16_t scanChannel () override + Performs scan for valid LoRa preamble in the current channel. More...
+  int16_t sleep ()  Sets the LoRa module to sleep to save power. Module will not be able to transmit or receive any data while in sleep mode. Module will wake up automatically when methods like transmit or receive are called. More...
  @@ -1409,11 +1409,14 @@ void  -

◆ scanChannel()

+ +

◆ scanChannel()

+ + + - + diff --git a/class_s_x1281-members.html b/class_s_x1281-members.html index f128cab2..fcc86eb0 100644 --- a/class_s_x1281-members.html +++ b/class_s_x1281-members.html @@ -122,7 +122,7 @@ $(document).ready(function(){initNavTree('class_s_x1281.html',''); initResizable - + diff --git a/class_s_x1282-members.html b/class_s_x1282-members.html index d06cf40e..0606fd6f 100644 --- a/class_s_x1282-members.html +++ b/class_s_x1282-members.html @@ -124,7 +124,7 @@ $(document).ready(function(){initNavTree('class_s_x1282.html',''); initResizable - + diff --git a/class_s_x128x-members.html b/class_s_x128x-members.html index a041be96..7586c3d1 100644 --- a/class_s_x128x-members.html +++ b/class_s_x128x-members.html @@ -122,7 +122,7 @@ $(document).ready(function(){initNavTree('class_s_x128x.html',''); initResizable - + diff --git a/class_s_x128x.html b/class_s_x128x.html index 280325b0..b499c714 100644 --- a/class_s_x128x.html +++ b/class_s_x128x.html @@ -1196,6 +1196,9 @@ void  + + + diff --git a/class_si4431-members.html b/class_si4431-members.html index 255d801c..86c6d333 100644 --- a/class_si4431-members.html +++ b/class_si4431-members.html @@ -118,44 +118,45 @@ $(document).ready(function(){initNavTree('class_si4431.html',''); initResizable( - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
@@ -1422,11 +1425,18 @@ void  + +
int16_t SX127x::scanChannel +overridevirtual

Performs scan for valid LoRa preamble in the current channel.

Returns
Status Codes
+

Reimplemented from PhysicalLayer.

+
diff --git a/class_s_x127x.js b/class_s_x127x.js index 27b5f66b..ba550ccd 100644 --- a/class_s_x127x.js +++ b/class_s_x127x.js @@ -41,7 +41,7 @@ var class_s_x127x = [ "receive", "class_s_x127x.html#adfe0d3f033a23ec2f3c2a407285d357c", null ], [ "receiveDirect", "class_s_x127x.html#aa7ac558d537c6364c4bc82c8f33e398f", null ], [ "reset", "class_s_x127x.html#a3321ac4a7f65e73004202486db9b1d68", null ], - [ "scanChannel", "class_s_x127x.html#ada007b90821258fe8c6ca7f8ae3efed5", null ], + [ "scanChannel", "class_s_x127x.html#a13ae97e18744dc617bc9326cfbaad3a3", null ], [ "setAFC", "class_s_x127x.html#a41f8cfcc2cdeb25a8e5a03f1ba4edd1e", null ], [ "setAFCAGCTrigger", "class_s_x127x.html#ab0f67330124cefc07a462e77922453d0", null ], [ "setAFCBandwidth", "class_s_x127x.html#a63e00b1ecf1b0dcb6d8a91fc9b8ea5ef", null ], diff --git a/class_s_x1280-members.html b/class_s_x1280-members.html index a912c1fe..b364c0ee 100644 --- a/class_s_x1280-members.html +++ b/class_s_x1280-members.html @@ -124,7 +124,7 @@ $(document).ready(function(){initNavTree('class_s_x1280.html',''); initResizable
receive(uint8_t *data, size_t len)SX128x
receiveDirect() overrideSX128xvirtual
reset(bool verify=true)SX128x
scanChannel()SX128x
scanChannel()SX128xvirtual
setAccessAddress(uint32_t addr)SX128x
setBandwidth(float bw)SX128x
setBitRate(float br)SX128xvirtual
receive(uint8_t *data, size_t len)SX128x
receiveDirect() overrideSX128xvirtual
reset(bool verify=true)SX128x
scanChannel()SX128x
scanChannel()SX128xvirtual
setAccessAddress(uint32_t addr)SX128x
setBandwidth(float bw)SX128x
setBitRate(float br)SX128xvirtual
receive(uint8_t *data, size_t len)SX128x
receiveDirect() overrideSX128xvirtual
reset(bool verify=true)SX128x
scanChannel()SX128x
scanChannel()SX128xvirtual
setAccessAddress(uint32_t addr)SX128x
setBandwidth(float bw)SX128x
setBitRate(float br)SX128xvirtual
receive(uint8_t *data, size_t len)SX128x
receiveDirect() overrideSX128xvirtual
reset(bool verify=true)SX128x
scanChannel()SX128x
scanChannel()SX128xvirtual
setAccessAddress(uint32_t addr)SX128x
setBandwidth(float bw)SX128x
setBitRate(float br)SX128xvirtual
+ + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
@@ -1204,11 +1207,18 @@ void  + +
int16_t SX128x::scanChannel +virtual

Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.

Returns
Status Codes
+

Reimplemented from PhysicalLayer.

+
diff --git a/class_si4430-members.html b/class_si4430-members.html index a15f147d..694b8757 100644 --- a/class_si4430-members.html +++ b/class_si4430-members.html @@ -118,44 +118,45 @@ $(document).ready(function(){initNavTree('class_si4430.html',''); initResizable(
receive(uint8_t *data, size_t len)Si443x
receiveDirect() overrideSi443xvirtual
reset()Si443x
setBitRate(float br)Si443xvirtual
setDataRate(DataRate_t dr)PhysicalLayervirtual
setDataShaping(uint8_t sh) overrideSi443xvirtual
setDIOMapping(uint32_t pin, uint32_t value)PhysicalLayervirtual
setDirectAction(void(*func)(void))Si443xvirtual
setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer
setEncoding(uint8_t encoding) overrideSi443xvirtual
setFrequency(float freq)Si4430virtual
setFrequencyDeviation(float freqDev) overrideSi443xvirtual
setIrqAction(void(*func)(void))Si443x
setOutputPower(int8_t power)Si4430virtual
setPacketReceivedAction(void(*func)(void))Si443xvirtual
setPacketSentAction(void(*func)(void))Si443xvirtual
setPreambleLength(uint8_t preambleLen)Si443x
PhysicalLayer::setPreambleLength(size_t len)PhysicalLayervirtual
setRfSwitchPins(uint32_t rxEn, uint32_t txEn)Si443x
setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])Si443x
setRxBandwidth(float rxBw)Si443x
setSyncWord(uint8_t *syncWord, size_t len)Si443xvirtual
Si4430(Module *mod)Si4430
Si4432(Module *mod)Si4432
Si443x(Module *mod)Si443x
sleep()Si443xvirtual
standby() overrideSi443xvirtual
standby(uint8_t mode) overrideSi443xvirtual
startDirect()PhysicalLayer
startReceive()Si443xvirtual
startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)Si443xvirtual
startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSi443xvirtual
startTransmit(const char *str, uint8_t addr=0)Si443x
startTransmit(uint8_t *data, size_t len, uint8_t addr=0)Si443x
PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer
transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSi443xvirtual
transmit(const char *str, uint8_t addr=0)Si443x
transmit(uint8_t *data, size_t len, uint8_t addr=0)Si443x
PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer
transmitDirect(uint32_t frf=0) overrideSi443xvirtual
variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SI443X_MAX_PACKET_LENGTH)Si443x
scanChannel()PhysicalLayervirtual
setBitRate(float br)Si443xvirtual
setDataRate(DataRate_t dr)PhysicalLayervirtual
setDataShaping(uint8_t sh) overrideSi443xvirtual
setDIOMapping(uint32_t pin, uint32_t value)PhysicalLayervirtual
setDirectAction(void(*func)(void))Si443xvirtual
setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer
setEncoding(uint8_t encoding) overrideSi443xvirtual
setFrequency(float freq)Si4430virtual
setFrequencyDeviation(float freqDev) overrideSi443xvirtual
setIrqAction(void(*func)(void))Si443x
setOutputPower(int8_t power)Si4430virtual
setPacketReceivedAction(void(*func)(void))Si443xvirtual
setPacketSentAction(void(*func)(void))Si443xvirtual
setPreambleLength(uint8_t preambleLen)Si443x
PhysicalLayer::setPreambleLength(size_t len)PhysicalLayervirtual
setRfSwitchPins(uint32_t rxEn, uint32_t txEn)Si443x
setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])Si443x
setRxBandwidth(float rxBw)Si443x
setSyncWord(uint8_t *syncWord, size_t len)Si443xvirtual
Si4430(Module *mod)Si4430
Si4432(Module *mod)Si4432
Si443x(Module *mod)Si443x
sleep()Si443xvirtual
standby() overrideSi443xvirtual
standby(uint8_t mode) overrideSi443xvirtual
startDirect()PhysicalLayer
startReceive()Si443xvirtual
startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)Si443xvirtual
startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSi443xvirtual
startTransmit(const char *str, uint8_t addr=0)Si443x
startTransmit(uint8_t *data, size_t len, uint8_t addr=0)Si443x
PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer
transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSi443xvirtual
transmit(const char *str, uint8_t addr=0)Si443x
transmit(uint8_t *data, size_t len, uint8_t addr=0)Si443x
PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer
transmitDirect(uint32_t frf=0) overrideSi443xvirtual
variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SI443X_MAX_PACKET_LENGTH)Si443x
diff --git a/class_si4430.html b/class_si4430.html index ccc0b9d2..380fdeb0 100644 --- a/class_si4430.html +++ b/class_si4430.html @@ -301,6 +301,9 @@ void 		virtual float getSNR ()
 Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. More...
 
virtual int16_t scanChannel ()
 Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules, or RSSI measurement for FSK modules. More...
 
int32_t random (int32_t max)
 Get truly random number in range 0 - max. More...
 
receive(uint8_t *data, size_t len)Si443x
receiveDirect() overrideSi443xvirtual
reset()Si443x
setBitRate(float br)Si443xvirtual
setDataRate(DataRate_t dr)PhysicalLayervirtual
setDataShaping(uint8_t sh) overrideSi443xvirtual
setDIOMapping(uint32_t pin, uint32_t value)PhysicalLayervirtual
setDirectAction(void(*func)(void))Si443xvirtual
setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer
setEncoding(uint8_t encoding) overrideSi443xvirtual
setFrequency(float freq)Si4432virtual
setFrequencyDeviation(float freqDev) overrideSi443xvirtual
setIrqAction(void(*func)(void))Si443x
setOutputPower(int8_t power)Si4431virtual
setPacketReceivedAction(void(*func)(void))Si443xvirtual
setPacketSentAction(void(*func)(void))Si443xvirtual
setPreambleLength(uint8_t preambleLen)Si443x
PhysicalLayer::setPreambleLength(size_t len)PhysicalLayervirtual
setRfSwitchPins(uint32_t rxEn, uint32_t txEn)Si443x
setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])Si443x
setRxBandwidth(float rxBw)Si443x
setSyncWord(uint8_t *syncWord, size_t len)Si443xvirtual
Si4431(Module *mod)Si4431
Si4432(Module *mod)Si4432
Si443x(Module *mod)Si443x
sleep()Si443xvirtual
standby() overrideSi443xvirtual
standby(uint8_t mode) overrideSi443xvirtual
startDirect()PhysicalLayer
startReceive()Si443xvirtual
startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)Si443xvirtual
startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSi443xvirtual
startTransmit(const char *str, uint8_t addr=0)Si443x
startTransmit(uint8_t *data, size_t len, uint8_t addr=0)Si443x
PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer
transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSi443xvirtual
transmit(const char *str, uint8_t addr=0)Si443x
transmit(uint8_t *data, size_t len, uint8_t addr=0)Si443x
PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer
transmitDirect(uint32_t frf=0) overrideSi443xvirtual
variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SI443X_MAX_PACKET_LENGTH)Si443x
scanChannel()PhysicalLayervirtual
setBitRate(float br)Si443xvirtual
setDataRate(DataRate_t dr)PhysicalLayervirtual
setDataShaping(uint8_t sh) overrideSi443xvirtual
setDIOMapping(uint32_t pin, uint32_t value)PhysicalLayervirtual
setDirectAction(void(*func)(void))Si443xvirtual
setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer
setEncoding(uint8_t encoding) overrideSi443xvirtual
setFrequency(float freq)Si4432virtual
setFrequencyDeviation(float freqDev) overrideSi443xvirtual
setIrqAction(void(*func)(void))Si443x
setOutputPower(int8_t power)Si4431virtual
setPacketReceivedAction(void(*func)(void))Si443xvirtual
setPacketSentAction(void(*func)(void))Si443xvirtual
setPreambleLength(uint8_t preambleLen)Si443x
PhysicalLayer::setPreambleLength(size_t len)PhysicalLayervirtual
setRfSwitchPins(uint32_t rxEn, uint32_t txEn)Si443x
setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])Si443x
setRxBandwidth(float rxBw)Si443x
setSyncWord(uint8_t *syncWord, size_t len)Si443xvirtual
Si4431(Module *mod)Si4431
Si4432(Module *mod)Si4432
Si443x(Module *mod)Si443x
sleep()Si443xvirtual
standby() overrideSi443xvirtual
standby(uint8_t mode) overrideSi443xvirtual
startDirect()PhysicalLayer
startReceive()Si443xvirtual
startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)Si443xvirtual
startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSi443xvirtual
startTransmit(const char *str, uint8_t addr=0)Si443x
startTransmit(uint8_t *data, size_t len, uint8_t addr=0)Si443x
PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer
transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSi443xvirtual
transmit(const char *str, uint8_t addr=0)Si443x
transmit(uint8_t *data, size_t len, uint8_t addr=0)Si443x
PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer
transmitDirect(uint32_t frf=0) overrideSi443xvirtual
variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SI443X_MAX_PACKET_LENGTH)Si443x
diff --git a/class_si4431.html b/class_si4431.html index 72a18c81..78ff6694 100644 --- a/class_si4431.html +++ b/class_si4431.html @@ -298,6 +298,9 @@ void virtual float getSNR ()  Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. More...
  +virtual int16_t scanChannel () + Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules, or RSSI measurement for FSK modules. More...
+  int32_t random (int32_t max)  Get truly random number in range 0 - max. More...
  diff --git a/class_si4432-members.html b/class_si4432-members.html index 79664a45..294a4952 100644 --- a/class_si4432-members.html +++ b/class_si4432-members.html @@ -118,43 +118,44 @@ $(document).ready(function(){initNavTree('class_si4432.html',''); initResizable( receive(uint8_t *data, size_t len)Si443x receiveDirect() overrideSi443xvirtual reset()Si443x - setBitRate(float br)Si443xvirtual - setDataRate(DataRate_t dr)PhysicalLayervirtual - setDataShaping(uint8_t sh) overrideSi443xvirtual - setDIOMapping(uint32_t pin, uint32_t value)PhysicalLayervirtual - setDirectAction(void(*func)(void))Si443xvirtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding) overrideSi443xvirtual - setFrequency(float freq)Si4432virtual - setFrequencyDeviation(float freqDev) overrideSi443xvirtual - setIrqAction(void(*func)(void))Si443x - setOutputPower(int8_t power)Si4432virtual - setPacketReceivedAction(void(*func)(void))Si443xvirtual - setPacketSentAction(void(*func)(void))Si443xvirtual - setPreambleLength(uint8_t preambleLen)Si443x - PhysicalLayer::setPreambleLength(size_t len)PhysicalLayervirtual - setRfSwitchPins(uint32_t rxEn, uint32_t txEn)Si443x - setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])Si443x - setRxBandwidth(float rxBw)Si443x - setSyncWord(uint8_t *syncWord, size_t len)Si443xvirtual - Si4432(Module *mod)Si4432 - Si443x(Module *mod)Si443x - sleep()Si443xvirtual - standby() overrideSi443xvirtual - standby(uint8_t mode) overrideSi443xvirtual - startDirect()PhysicalLayer - startReceive()Si443xvirtual - startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)Si443xvirtual - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSi443xvirtual - startTransmit(const char *str, uint8_t addr=0)Si443x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)Si443x - PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSi443xvirtual - transmit(const char *str, uint8_t addr=0)Si443x - transmit(uint8_t *data, size_t len, uint8_t addr=0)Si443x - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideSi443xvirtual - variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SI443X_MAX_PACKET_LENGTH)Si443x + scanChannel()PhysicalLayervirtual + setBitRate(float br)Si443xvirtual + setDataRate(DataRate_t dr)PhysicalLayervirtual + setDataShaping(uint8_t sh) overrideSi443xvirtual + setDIOMapping(uint32_t pin, uint32_t value)PhysicalLayervirtual + setDirectAction(void(*func)(void))Si443xvirtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overrideSi443xvirtual + setFrequency(float freq)Si4432virtual + setFrequencyDeviation(float freqDev) overrideSi443xvirtual + setIrqAction(void(*func)(void))Si443x + setOutputPower(int8_t power)Si4432virtual + setPacketReceivedAction(void(*func)(void))Si443xvirtual + setPacketSentAction(void(*func)(void))Si443xvirtual + setPreambleLength(uint8_t preambleLen)Si443x + PhysicalLayer::setPreambleLength(size_t len)PhysicalLayervirtual + setRfSwitchPins(uint32_t rxEn, uint32_t txEn)Si443x + setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])Si443x + setRxBandwidth(float rxBw)Si443x + setSyncWord(uint8_t *syncWord, size_t len)Si443xvirtual + Si4432(Module *mod)Si4432 + Si443x(Module *mod)Si443x + sleep()Si443xvirtual + standby() overrideSi443xvirtual + standby(uint8_t mode) overrideSi443xvirtual + startDirect()PhysicalLayer + startReceive()Si443xvirtual + startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)Si443xvirtual + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSi443xvirtual + startTransmit(const char *str, uint8_t addr=0)Si443x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)Si443x + PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSi443xvirtual + transmit(const char *str, uint8_t addr=0)Si443x + transmit(uint8_t *data, size_t len, uint8_t addr=0)Si443x + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideSi443xvirtual + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SI443X_MAX_PACKET_LENGTH)Si443x
diff --git a/class_si4432.html b/class_si4432.html index 91fc0b2f..8a476e0b 100644 --- a/class_si4432.html +++ b/class_si4432.html @@ -289,6 +289,9 @@ void virtual float getSNR ()  Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. More...
  +virtual int16_t scanChannel () + Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules, or RSSI measurement for FSK modules. More...
+  int32_t random (int32_t max)  Get truly random number in range 0 - max. More...
  diff --git a/class_si443x-members.html b/class_si443x-members.html index 9bf19aa2..13f9d505 100644 --- a/class_si443x-members.html +++ b/class_si443x-members.html @@ -117,42 +117,43 @@ $(document).ready(function(){initNavTree('class_si443x.html',''); initResizable( receive(uint8_t *data, size_t len)Si443x receiveDirect() overrideSi443xvirtual reset()Si443x - setBitRate(float br)Si443xvirtual - setDataRate(DataRate_t dr)PhysicalLayervirtual - setDataShaping(uint8_t sh) overrideSi443xvirtual - setDIOMapping(uint32_t pin, uint32_t value)PhysicalLayervirtual - setDirectAction(void(*func)(void))Si443xvirtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding) overrideSi443xvirtual - setFrequency(float freq)PhysicalLayervirtual - setFrequencyDeviation(float freqDev) overrideSi443xvirtual - setIrqAction(void(*func)(void))Si443x - setOutputPower(int8_t power)PhysicalLayervirtual - setPacketReceivedAction(void(*func)(void))Si443xvirtual - setPacketSentAction(void(*func)(void))Si443xvirtual - setPreambleLength(uint8_t preambleLen)Si443x - PhysicalLayer::setPreambleLength(size_t len)PhysicalLayervirtual - setRfSwitchPins(uint32_t rxEn, uint32_t txEn)Si443x - setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])Si443x - setRxBandwidth(float rxBw)Si443x - setSyncWord(uint8_t *syncWord, size_t len)Si443xvirtual - Si443x(Module *mod)Si443x - sleep()Si443xvirtual - standby() overrideSi443xvirtual - standby(uint8_t mode) overrideSi443xvirtual - startDirect()PhysicalLayer - startReceive()Si443xvirtual - startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)Si443xvirtual - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSi443xvirtual - startTransmit(const char *str, uint8_t addr=0)Si443x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)Si443x - PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSi443xvirtual - transmit(const char *str, uint8_t addr=0)Si443x - transmit(uint8_t *data, size_t len, uint8_t addr=0)Si443x - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideSi443xvirtual - variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SI443X_MAX_PACKET_LENGTH)Si443x + scanChannel()PhysicalLayervirtual + setBitRate(float br)Si443xvirtual + setDataRate(DataRate_t dr)PhysicalLayervirtual + setDataShaping(uint8_t sh) overrideSi443xvirtual + setDIOMapping(uint32_t pin, uint32_t value)PhysicalLayervirtual + setDirectAction(void(*func)(void))Si443xvirtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overrideSi443xvirtual + setFrequency(float freq)PhysicalLayervirtual + setFrequencyDeviation(float freqDev) overrideSi443xvirtual + setIrqAction(void(*func)(void))Si443x + setOutputPower(int8_t power)PhysicalLayervirtual + setPacketReceivedAction(void(*func)(void))Si443xvirtual + setPacketSentAction(void(*func)(void))Si443xvirtual + setPreambleLength(uint8_t preambleLen)Si443x + PhysicalLayer::setPreambleLength(size_t len)PhysicalLayervirtual + setRfSwitchPins(uint32_t rxEn, uint32_t txEn)Si443x + setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])Si443x + setRxBandwidth(float rxBw)Si443x + setSyncWord(uint8_t *syncWord, size_t len)Si443xvirtual + Si443x(Module *mod)Si443x + sleep()Si443xvirtual + standby() overrideSi443xvirtual + standby(uint8_t mode) overrideSi443xvirtual + startDirect()PhysicalLayer + startReceive()Si443xvirtual + startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)Si443xvirtual + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSi443xvirtual + startTransmit(const char *str, uint8_t addr=0)Si443x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)Si443x + PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSi443xvirtual + transmit(const char *str, uint8_t addr=0)Si443x + transmit(uint8_t *data, size_t len, uint8_t addr=0)Si443x + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideSi443xvirtual + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SI443X_MAX_PACKET_LENGTH)Si443x diff --git a/class_si443x.html b/class_si443x.html index 920dff2d..5732f2b9 100644 --- a/class_si443x.html +++ b/class_si443x.html @@ -282,6 +282,9 @@ void virtual float getSNR ()  Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. More...
  +virtual int16_t scanChannel () + Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules, or RSSI measurement for FSK modules. More...
+  int32_t random (int32_t max)  Get truly random number in range 0 - max. More...
  diff --git a/classn_r_f24-members.html b/classn_r_f24-members.html index 1f3aa0a8..164ef5dc 100644 --- a/classn_r_f24-members.html +++ b/classn_r_f24-members.html @@ -117,43 +117,44 @@ $(document).ready(function(){initNavTree('classn_r_f24.html',''); initResizable( receive(uint8_t *data, size_t len) overridenRF24virtual receive(uint8_t *data, size_t len)nRF24 receiveDirect() overridenRF24virtual - setAddressWidth(uint8_t addrWidth)nRF24 - setAutoAck(bool autoAckOn=true)nRF24 - setAutoAck(uint8_t pipeNum, bool autoAckOn)nRF24 - setBitRate(float br)nRF24virtual - setCrcFiltering(bool crcOn=true)nRF24 - setDataRate(DataRate_t dr)PhysicalLayervirtual - setDataShaping(uint8_t sh) overridenRF24virtual - setDIOMapping(uint32_t pin, uint32_t value)PhysicalLayervirtual - setDirectAction(void(*func)(void))PhysicalLayervirtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding) overridenRF24virtual - setFrequency(float freq)nRF24virtual - setFrequencyDeviation(float freqDev) overridenRF24virtual - setIrqAction(void(*func)(void))nRF24 - setOutputPower(int8_t pwr)nRF24virtual - setPacketReceivedAction(void(*func)(void))nRF24virtual - setPacketSentAction(void(*func)(void))nRF24virtual - setPreambleLength(size_t len)PhysicalLayervirtual - setReceivePipe(uint8_t pipeNum, uint8_t *addr)nRF24 - setReceivePipe(uint8_t pipeNum, uint8_t addrByte)nRF24 - setSyncWord(uint8_t *sync, size_t len)PhysicalLayervirtual - setTransmitPipe(uint8_t *addr)nRF24 - sleep()nRF24virtual - standby() overridenRF24virtual - standby(uint8_t mode) overridenRF24virtual - startDirect()PhysicalLayer - startReceive()nRF24virtual - startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)nRF24virtual - startTransmit(uint8_t *data, size_t len, uint8_t addr) overridenRF24virtual - startTransmit(const char *str, uint8_t addr=0)nRF24 - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)nRF24 - PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - transmit(uint8_t *data, size_t len, uint8_t addr) overridenRF24virtual - transmit(const char *str, uint8_t addr=0)nRF24 - transmit(uint8_t *data, size_t len, uint8_t addr=0)nRF24 - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overridenRF24virtual + scanChannel()PhysicalLayervirtual + setAddressWidth(uint8_t addrWidth)nRF24 + setAutoAck(bool autoAckOn=true)nRF24 + setAutoAck(uint8_t pipeNum, bool autoAckOn)nRF24 + setBitRate(float br)nRF24virtual + setCrcFiltering(bool crcOn=true)nRF24 + setDataRate(DataRate_t dr)PhysicalLayervirtual + setDataShaping(uint8_t sh) overridenRF24virtual + setDIOMapping(uint32_t pin, uint32_t value)PhysicalLayervirtual + setDirectAction(void(*func)(void))PhysicalLayervirtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overridenRF24virtual + setFrequency(float freq)nRF24virtual + setFrequencyDeviation(float freqDev) overridenRF24virtual + setIrqAction(void(*func)(void))nRF24 + setOutputPower(int8_t pwr)nRF24virtual + setPacketReceivedAction(void(*func)(void))nRF24virtual + setPacketSentAction(void(*func)(void))nRF24virtual + setPreambleLength(size_t len)PhysicalLayervirtual + setReceivePipe(uint8_t pipeNum, uint8_t *addr)nRF24 + setReceivePipe(uint8_t pipeNum, uint8_t addrByte)nRF24 + setSyncWord(uint8_t *sync, size_t len)PhysicalLayervirtual + setTransmitPipe(uint8_t *addr)nRF24 + sleep()nRF24virtual + standby() overridenRF24virtual + standby(uint8_t mode) overridenRF24virtual + startDirect()PhysicalLayer + startReceive()nRF24virtual + startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)nRF24virtual + startTransmit(uint8_t *data, size_t len, uint8_t addr) overridenRF24virtual + startTransmit(const char *str, uint8_t addr=0)nRF24 + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)nRF24 + PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + transmit(uint8_t *data, size_t len, uint8_t addr) overridenRF24virtual + transmit(const char *str, uint8_t addr=0)nRF24 + transmit(uint8_t *data, size_t len, uint8_t addr=0)nRF24 + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overridenRF24virtual diff --git a/classn_r_f24.html b/classn_r_f24.html index 24f9e796..44c8d859 100644 --- a/classn_r_f24.html +++ b/classn_r_f24.html @@ -272,6 +272,9 @@ void virtual float getSNR ()  Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. More...
  +virtual int16_t scanChannel () + Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules, or RSSI measurement for FSK modules. More...
+  int32_t random (int32_t max)  Get truly random number in range 0 - max. More...
  diff --git a/functions_func_s.html b/functions_func_s.html index 8a78f725..2e2206df 100644 --- a/functions_func_s.html +++ b/functions_func_s.html @@ -86,8 +86,9 @@ $(document).ready(function(){initNavTree('functions_func_s.html',''); initResiza

- s -