From 2b0a6ec30289aed79100aaa4d8907499bd305395 Mon Sep 17 00:00:00 2001 From: jgromes Date: Wed, 21 Dec 2022 09:38:36 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=20674f2?= =?UTF-8?q?5faa4f99983d606880a814f8afa12d378b9=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _l_l_c_c68_8h_source.html | 26 +++++++++++++------------- _s_x1262_8h_source.html | 34 +++++++++++++++++----------------- _s_x1268_8h_source.html | 34 +++++++++++++++++----------------- class_l_l_c_c68.html | 3 ++- class_s_x1262.html | 10 +++------- class_s_x1268.html | 10 +++------- class_s_x126x.html | 4 ++-- class_s_x128x.html | 9 ++------- 8 files changed, 59 insertions(+), 71 deletions(-) diff --git a/_l_l_c_c68_8h_source.html b/_l_l_c_c68_8h_source.html index 200afcb6..32d4f77d 100644 --- a/_l_l_c_c68_8h_source.html +++ b/_l_l_c_c68_8h_source.html @@ -100,23 +100,23 @@ $(document).ready(function(){initNavTree('_l_l_c_c68_8h_source.html',''); initRe
17  public:
23  LLCC68(Module* mod);
24 
-
46  int16_t begin(float freq = 434.0, float bw = 125.0, uint8_t sf = 9, uint8_t cr = 7, uint8_t syncWord = RADIOLIB_SX126X_SYNC_WORD_PRIVATE, int8_t power = 10, uint16_t preambleLength = 8, float tcxoVoltage = 1.6, bool useRegulatorLDO = false);
-
47 
-
48  // configuration methods
+
48  int16_t begin(float freq = 434.0, float bw = 125.0, uint8_t sf = 9, uint8_t cr = 7, uint8_t syncWord = RADIOLIB_SX126X_SYNC_WORD_PRIVATE, int8_t power = 10, uint16_t preambleLength = 8, float tcxoVoltage = 1.6, bool useRegulatorLDO = false);
49 
-
57  int16_t setBandwidth(float bw);
-
58 
-
66  int16_t setSpreadingFactor(uint8_t sf);
-
67 
-
68 #if !defined(RADIOLIB_GODMODE)
-
69  private:
-
70 #endif
-
71 
-
72 };
+
50  // configuration methods
+
51 
+
59  int16_t setBandwidth(float bw);
+
60 
+
68  int16_t setSpreadingFactor(uint8_t sf);
+
69 
+
70 #if !defined(RADIOLIB_GODMODE)
+
71  private:
+
72 #endif
73 
-
74 #endif
+
74 };
75 
76 #endif
+
77 
+
78 #endif
LLCC68
Derived class for LLCC68 modules.
Definition: LLCC68.h:16
LLCC68::begin
int16_t begin(float freq=434.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX126X_SYNC_WORD_PRIVATE, int8_t power=10, uint16_t preambleLength=8, float tcxoVoltage=1.6, bool useRegulatorLDO=false)
Initialization method for LoRa modem.
Definition: LLCC68.cpp:8
LLCC68::setBandwidth
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 125.0, 250.0 and 500.0 kHz.
Definition: LLCC68.cpp:32
diff --git a/_s_x1262_8h_source.html b/_s_x1262_8h_source.html index 616dd678..5513b7f4 100644 --- a/_s_x1262_8h_source.html +++ b/_s_x1262_8h_source.html @@ -105,27 +105,27 @@ $(document).ready(function(){initNavTree('_s_x1262_8h_source.html',''); initResi
27 
28  // basic methods
29 
-
51  int16_t begin(float freq = 434.0, float bw = 125.0, uint8_t sf = 9, uint8_t cr = 7, uint8_t syncWord = RADIOLIB_SX126X_SYNC_WORD_PRIVATE, int8_t power = 10, uint16_t preambleLength = 8, float tcxoVoltage = 1.6, bool useRegulatorLDO = false);
-
52 
-
74  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);
-
75 
-
76  // configuration methods
+
53  int16_t begin(float freq = 434.0, float bw = 125.0, uint8_t sf = 9, uint8_t cr = 7, uint8_t syncWord = RADIOLIB_SX126X_SYNC_WORD_PRIVATE, int8_t power = 10, uint16_t preambleLength = 8, float tcxoVoltage = 1.6, bool useRegulatorLDO = false);
+
54 
+
76  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);
77 
-
85  int16_t setFrequency(float freq);
-
86 
-
96  int16_t setFrequency(float freq, bool calibrate);
-
97 
-
106  virtual int16_t setOutputPower(int8_t power);
-
107 
-
108 #if !defined(RADIOLIB_GODMODE)
-
109  private:
-
110 #endif
-
111 
-
112 };
+
78  // configuration methods
+
79 
+
87  int16_t setFrequency(float freq);
+
88 
+
98  int16_t setFrequency(float freq, bool calibrate);
+
99 
+
108  virtual int16_t setOutputPower(int8_t power);
+
109 
+
110 #if !defined(RADIOLIB_GODMODE)
+
111  private:
+
112 #endif
113 
-
114 #endif
+
114 };
115 
116 #endif
+
117 
+
118 #endif
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
SX1262
Derived class for SX1262 modules.
Definition: SX1262.h:19
SX1262::SX1262
SX1262(Module *mod)
Default constructor.
Definition: SX1262.cpp:4
diff --git a/_s_x1268_8h_source.html b/_s_x1268_8h_source.html index d81b564e..ed0a89a2 100644 --- a/_s_x1268_8h_source.html +++ b/_s_x1268_8h_source.html @@ -105,27 +105,27 @@ $(document).ready(function(){initNavTree('_s_x1268_8h_source.html',''); initResi
27 
28  // basic methods
29 
-
51  int16_t begin(float freq = 434.0, float bw = 125.0, uint8_t sf = 9, uint8_t cr = 7, uint8_t syncWord = RADIOLIB_SX126X_SYNC_WORD_PRIVATE, int8_t power = 10, uint16_t preambleLength = 8, float tcxoVoltage = 1.6, bool useRegulatorLDO = false);
-
52 
-
74  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);
-
75 
-
76  // configuration methods
+
53  int16_t begin(float freq = 434.0, float bw = 125.0, uint8_t sf = 9, uint8_t cr = 7, uint8_t syncWord = RADIOLIB_SX126X_SYNC_WORD_PRIVATE, int8_t power = 10, uint16_t preambleLength = 8, float tcxoVoltage = 1.6, bool useRegulatorLDO = false);
+
54 
+
76  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);
77 
-
85  int16_t setFrequency(float freq);
-
86 
-
96  int16_t setFrequency(float freq, bool calibrate);
-
97 
-
105  int16_t setOutputPower(int8_t power);
-
106 
-
107 #if !defined(RADIOLIB_GODMODE)
-
108  private:
-
109 #endif
-
110 
-
111 };
+
78  // configuration methods
+
79 
+
87  int16_t setFrequency(float freq);
+
88 
+
98  int16_t setFrequency(float freq, bool calibrate);
+
99 
+
107  int16_t setOutputPower(int8_t power);
+
108 
+
109 #if !defined(RADIOLIB_GODMODE)
+
110  private:
+
111 #endif
112 
-
113 #endif
+
113 };
114 
115 #endif
+
116 
+
117 #endif
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
SX1268
Derived class for SX1268 modules.
Definition: SX1268.h:19
SX1268::setOutputPower
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are in range from -9 to 22 dBm.
Definition: SX1268.cpp:79
diff --git a/class_l_l_c_c68.html b/class_l_l_c_c68.html index 3ac192f4..6404a533 100644 --- a/class_l_l_c_c68.html +++ b/class_l_l_c_c68.html @@ -525,10 +525,11 @@ void bwLoRa bandwidth in kHz. Defaults to 125.0 kHz. sfLoRa spreading factor. Defaults to 9. crLoRa coding rate denominator. Defaults to 7 (coding rate 4/7). - syncWord2-byte LoRa sync word. Defaults to RADIOLIB_SX126X_SYNC_WORD_PRIVATE (0x12). + syncWord1-byte LoRa sync word. Defaults to RADIOLIB_SX126X_SYNC_WORD_PRIVATE (0x12). powerOutput power in dBm. Defaults to 10 dBm. preambleLengthLoRa preamble length in symbols. Defaults to 8 symbols. tcxoVoltageTCXO reference voltage to be set on DIO3. Defaults to 1.6 V, set to 0 to skip. + useRegulatorLDOWhether to use only LDO regulator (true) or DC-DC regulator (false). Defaults to false. diff --git a/class_s_x1262.html b/class_s_x1262.html index 0170ea9b..64da4a73 100644 --- a/class_s_x1262.html +++ b/class_s_x1262.html @@ -513,10 +513,11 @@ void bwLoRa bandwidth in kHz. Defaults to 125.0 kHz. sfLoRa spreading factor. Defaults to 9. crLoRa coding rate denominator. Defaults to 7 (coding rate 4/7). - syncWord2-byte LoRa sync word. Defaults to RADIOLIB_SX126X_SYNC_WORD_PRIVATE (0x12). + syncWord1-byte LoRa sync word. Defaults to RADIOLIB_SX126X_SYNC_WORD_PRIVATE (0x12). powerOutput power in dBm. Defaults to 10 dBm. preambleLengthLoRa preamble length in symbols. Defaults to 8 symbols. tcxoVoltageTCXO reference voltage to be set on DIO3. Defaults to 1.6 V, set to 0 to skip. + useRegulatorLDOWhether to use only LDO regulator (true) or DC-DC regulator (false). Defaults to false. @@ -594,12 +595,7 @@ void freqDevFrequency deviation from carrier frequency in kHz. Defaults to 5.0 kHz. rxBwReceiver bandwidth in kHz. Defaults to 156.2 kHz. powerOutput power in dBm. Defaults to 10 dBm. - - - -

\parma preambleLength FSK preamble length in bits. Defaults to 16 bits.

-
Parameters
- +
preambleLengthFSK preamble length in bits. Defaults to 16 bits.
tcxoVoltageTCXO reference voltage to be set on DIO3. Defaults to 1.6 V, set to 0 to skip.
useRegulatorLDOWhether to use only LDO regulator (true) or DC-DC regulator (false). Defaults to false.
diff --git a/class_s_x1268.html b/class_s_x1268.html index 3fca203e..5f3be791 100644 --- a/class_s_x1268.html +++ b/class_s_x1268.html @@ -511,10 +511,11 @@ void bwLoRa bandwidth in kHz. Defaults to 125.0 kHz. sfLoRa spreading factor. Defaults to 9. crLoRa coding rate denominator. Defaults to 7 (coding rate 4/7). - syncWord2-byte LoRa sync word. Defaults to RADIOLIB_SX126X_SYNC_WORD_PRIVATE (0x12). + syncWord1-byte LoRa sync word. Defaults to RADIOLIB_SX126X_SYNC_WORD_PRIVATE (0x12). powerOutput power in dBm. Defaults to 10 dBm. preambleLengthLoRa preamble length in symbols. Defaults to 8 symbols. tcxoVoltageTCXO reference voltage to be set on DIO3. Defaults to 1.6 V, set to 0 to skip. + useRegulatorLDOWhether to use only LDO regulator (true) or DC-DC regulator (false). Defaults to false.
@@ -592,12 +593,7 @@ void freqDevFrequency deviation from carrier frequency in kHz. Defaults to 5.0 kHz. rxBwReceiver bandwidth in kHz. Defaults to 156.2 kHz. powerOutput power in dBm. Defaults to 10 dBm. - - - -

\parma preambleLength FSK preamble length in bits. Defaults to 16 bits.

-
Parameters
- +
preambleLengthFSK preamble length in bits. Defaults to 16 bits.
tcxoVoltageTCXO reference voltage to be set on DIO3. Defaults to 1.6 V, set to 0 to skip.
useRegulatorLDOWhether to use only LDO regulator (true) or DC-DC regulator (false). Defaults to false.
diff --git a/class_s_x126x.html b/class_s_x126x.html index bacb845b..13be4ceb 100644 --- a/class_s_x126x.html +++ b/class_s_x126x.html @@ -494,7 +494,7 @@ void syncWord1-byte LoRa sync word. preambleLengthLoRa preamble length in symbols. Allowed values range from 1 to 65535. tcxoVoltageTCXO reference voltage to be set on DIO3. Defaults to 1.6 V, set to 0 to skip. - useRegulatorLDOuse the LDO instead of DC-DC converter (default false). This is necessary for some modules such as the LAMBDA from RF solutions. + useRegulatorLDOWhether to use only LDO regulator (true) or DC-DC regulator (false). Defaults to false.
@@ -560,7 +560,7 @@ void rxBwReceiver bandwidth in kHz. Allowed values are 4.8, 5.8, 7.3, 9.7, 11.7, 14.6, 19.5, 23.4, 29.3, 39.0, 46.9, 58.6, 78.2, 93.8, 117.3, 156.2, 187.2, 234.3, 312.0, 373.6 and 467.0 kHz. preambleLengthFSK preamble length in bits. Allowed values range from 0 to 65535. tcxoVoltageTCXO reference voltage to be set on DIO3. Defaults to 1.6 V, set to 0 to skip. - useRegulatorLDOuse the LDO instead of DC-DC converter (default false). This is necessary for some modules such as the LAMBDA from RF solutions. + useRegulatorLDOWhether to use only LDO regulator (true) or DC-DC regulator (false). Defaults to false. diff --git a/class_s_x128x.html b/class_s_x128x.html index f20cd435..fde91de7 100644 --- a/class_s_x128x.html +++ b/class_s_x128x.html @@ -569,12 +569,7 @@ void brFLRC bit rate in kbps. Defaults to 650 kbps. crFLRC coding rate. Defaults to 3 (coding rate 3/4). powerOutput power in dBm. Defaults to 10 dBm. - - - -

\parma preambleLength FLRC preamble length in bits. Defaults to 16 bits.

-
Parameters
- +
preambleLengthFLRC preamble length in bits. Defaults to 16 bits.
dataShapingTime-bandwidth product of the Gaussian filter to be used for shaping. Defaults to 0.5.
@@ -634,10 +629,10 @@ void brFSK bit rate in kbps. Defaults to 800 kbps. freqDevFrequency deviation from carrier frequency in kHz. Defaults to 400.0 kHz. powerOutput power in dBm. Defaults to 10 dBm. + preambleLengthFSK preamble length in bits. Defaults to 16 bits.
-

\parma preambleLength FSK preamble length in bits. Defaults to 16 bits.

Returns
Status Codes