diff --git a/_s_x126x_8h_source.html b/_s_x126x_8h_source.html
index c2ef8d3a..54d377d1 100644
--- a/_s_x126x_8h_source.html
+++ b/_s_x126x_8h_source.html
@@ -653,231 +653,231 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- 892 int16_t
setSyncWord(uint8_t* syncWord,
size_t len)
override;
-
- 901 int16_t
setSyncBits(uint8_t *syncWord, uint8_t bitsLen);
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 900 int16_t
setSyncWord(uint8_t* syncWord,
size_t len)
override;
+
+ 909 int16_t
setSyncBits(uint8_t *syncWord, uint8_t bitsLen);
+
+
-
-
- 932 int16_t
setCRC(uint8_t len, uint16_t initial = 0x1D0F, uint16_t polynomial = 0x1021,
bool inverted =
true);
-
- 941 int16_t
setWhitening(
bool enabled, uint16_t initial = 0x01FF);
-
- 952 int16_t
setTCXO(
float voltage, uint32_t delay = 5000);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+ 940 int16_t
setCRC(uint8_t len, uint16_t initial = 0x1D0F, uint16_t polynomial = 0x1021,
bool inverted =
true);
+
+ 949 int16_t
setWhitening(
bool enabled, uint16_t initial = 0x01FF);
+
+ 960 int16_t
setTCXO(
float voltage, uint32_t delay = 5000);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
- 1125 int16_t
invertIQ(
bool enable)
override;
-
- 1132 int16_t
getModem(ModemType_t* modem)
override;
-
- 1134 #if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE
-
-
- 1145 void readBit(uint32_t pin)
override;
-
-
- 1157 int16_t
uploadPatch(
const uint32_t* patch,
size_t len,
bool nonvolatile =
true);
-
- 1166 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);
-
-
-
-
-
-
-
- 1197 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);
-
-
-
-
-
-
-
- 1223 #if !RADIOLIB_GODMODE && !RADIOLIB_LOW_LEVEL
-
-
- 1226 Module* getMod()
override;
-
-
-
- 1230 int16_t setTx(uint32_t timeout = 0);
- 1231 int16_t setRx(uint32_t timeout);
- 1232 int16_t setCad(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin, uint8_t exitMode,
RadioLibTime_t timeout);
- 1233 int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
- 1234 int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
- 1235 int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
- 1236 int16_t readBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
- 1237 int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX126X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX126X_IRQ_NONE);
- 1238 virtual int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX126X_IRQ_ALL);
- 1239 int16_t setRfFrequency(uint32_t frf);
-
- 1241 uint8_t getPacketType();
- 1242 int16_t setTxParams(uint8_t power, uint8_t rampTime);
- 1243 int16_t setModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
- 1244 int16_t setModulationParamsFSK(uint32_t br, uint8_t sh, uint8_t rxBw, uint32_t freqDev);
- 1245 int16_t setPacketParams(uint16_t preambleLen, uint8_t crcType, uint8_t payloadLen, uint8_t hdrType, uint8_t
invertIQ);
- 1246 int16_t setPacketParamsFSK(uint16_t preambleLen, uint8_t preambleDetectorLen, uint8_t crcType, uint8_t syncWordLen, uint8_t addrCmp, uint8_t whiten, uint8_t packType = RADIOLIB_SX126X_GFSK_PACKET_VARIABLE, uint8_t payloadLen = 0xFF);
- 1247 int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
- 1248 int16_t setRegulatorMode(uint8_t mode);
- 1249 uint8_t getStatus();
- 1250 uint32_t getPacketStatus();
- 1251 uint16_t getDeviceErrors();
- 1252 int16_t clearDeviceErrors();
-
- 1254 #if !RADIOLIB_GODMODE
-
-
- 1257 const char* chipType = NULL;
- 1258 uint8_t bandwidth = 0;
-
-
-
-
-
- 1264 int16_t setFrequencyRaw(
float freq);
- 1265 int16_t fixPaClamping(
bool enable =
true);
-
-
- 1268 static int16_t SPIparseStatus(uint8_t in);
-
- 1270 #if !RADIOLIB_GODMODE
-
-
-
+
+
+
+
+ 1133 int16_t
invertIQ(
bool enable)
override;
+
+ 1140 int16_t
getModem(ModemType_t* modem)
override;
+
+ 1142 #if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE
+
+
+ 1153 void readBit(uint32_t pin)
override;
+
+
+ 1165 int16_t
uploadPatch(
const uint32_t* patch,
size_t len,
bool nonvolatile =
true);
+
+ 1174 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);
+
+
+
+
+
+
+
+ 1205 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);
+
+
+
+
+
+
+
+ 1231 #if !RADIOLIB_GODMODE && !RADIOLIB_LOW_LEVEL
+
+
+ 1234 Module* getMod()
override;
+
+
+
+ 1238 int16_t setTx(uint32_t timeout = 0);
+ 1239 int16_t setRx(uint32_t timeout);
+ 1240 int16_t setCad(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin, uint8_t exitMode,
RadioLibTime_t timeout);
+ 1241 int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+ 1242 int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+ 1243 int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
+ 1244 int16_t readBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
+ 1245 int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX126X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX126X_IRQ_NONE);
+ 1246 virtual int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX126X_IRQ_ALL);
+ 1247 int16_t setRfFrequency(uint32_t frf);
+
+ 1249 uint8_t getPacketType();
+ 1250 int16_t setTxParams(uint8_t power, uint8_t rampTime);
+ 1251 int16_t setModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
+ 1252 int16_t setModulationParamsFSK(uint32_t br, uint8_t sh, uint8_t rxBw, uint32_t freqDev);
+ 1253 int16_t setPacketParams(uint16_t preambleLen, uint8_t crcType, uint8_t payloadLen, uint8_t hdrType, uint8_t
invertIQ);
+ 1254 int16_t setPacketParamsFSK(uint16_t preambleLen, uint8_t preambleDetectorLen, uint8_t crcType, uint8_t syncWordLen, uint8_t addrCmp, uint8_t whiten, uint8_t packType = RADIOLIB_SX126X_GFSK_PACKET_VARIABLE, uint8_t payloadLen = 0xFF);
+ 1255 int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
+ 1256 int16_t setRegulatorMode(uint8_t mode);
+ 1257 uint8_t getStatus();
+ 1258 uint32_t getPacketStatus();
+ 1259 uint16_t getDeviceErrors();
+ 1260 int16_t clearDeviceErrors();
+
+ 1262 #if !RADIOLIB_GODMODE
+
+
+ 1265 const char* chipType = NULL;
+ 1266 uint8_t bandwidth = 0;
+
+
+
+
+
+ 1272 int16_t setFrequencyRaw(
float freq);
+ 1273 int16_t fixPaClamping(
bool enable =
true);
- 1275 uint8_t spreadingFactor = 0, codingRate = 0, ldrOptimize = 0, crcTypeLoRa = 0, headerType = 0;
- 1276 uint16_t preambleLengthLoRa = 0;
- 1277 float bandwidthKhz = 0;
- 1278 bool ldroAuto =
true;
-
- 1280 uint32_t bitRate = 0, frequencyDev = 0;
- 1281 uint8_t preambleDetLength = 0, rxBandwidth = 0, pulseShape = 0, crcTypeFSK = 0, syncWordLength = 0, addrComp = 0, whitening = 0, packetType = 0;
- 1282 uint16_t preambleLengthFSK = 0;
- 1283 float rxBandwidthKhz = 0;
- 1284 uint8_t nodeAddr = 0;
-
- 1286 float dataRateMeasured = 0;
+
+ 1276 static int16_t SPIparseStatus(uint8_t in);
+
+ 1278 #if !RADIOLIB_GODMODE
+
+
+
+
+ 1283 uint8_t spreadingFactor = 0, codingRate = 0, ldrOptimize = 0, crcTypeLoRa = 0, headerType = 0;
+ 1284 uint16_t preambleLengthLoRa = 0;
+ 1285 float bandwidthKhz = 0;
+ 1286 bool ldroAuto =
true;
- 1288 uint32_t tcxoDelay = 0;
-
-
- 1291 size_t implicitLen = 0;
- 1292 uint8_t invertIQEnabled = RADIOLIB_SX126X_LORA_IQ_STANDARD;
+ 1288 uint32_t bitRate = 0, frequencyDev = 0;
+ 1289 uint8_t preambleDetLength = 0, rxBandwidth = 0, pulseShape = 0, crcTypeFSK = 0, syncWordLength = 0, addrComp = 0, whitening = 0, packetType = 0;
+ 1290 uint16_t preambleLengthFSK = 0;
+ 1291 float rxBandwidthKhz = 0;
+ 1292 uint8_t nodeAddr = 0;
-
- 1295 uint8_t lrFhssCr = RADIOLIB_SX126X_LR_FHSS_CR_2_3;
- 1296 uint8_t lrFhssBw = RADIOLIB_SX126X_LR_FHSS_BW_722_66;
- 1297 uint8_t lrFhssHdrCount = 3;
- 1298 uint8_t lrFhssSyncWord[RADIOLIB_SX126X_LR_FHSS_SYNC_WORD_BYTES] = { 0x12, 0xAD, 0x10, 0x1B };
- 1299 bool lrFhssGridNonFcc =
false;
- 1300 uint16_t lrFhssNgrid = 0;
- 1301 uint16_t lrFhssLfsrState = 0;
- 1302 uint16_t lrFhssPoly = 0;
- 1303 uint16_t lrFhssSeed = 0;
- 1304 uint16_t lrFhssHopSeqId = 0;
- 1305 size_t lrFhssFrameBitsRem = 0;
- 1306 size_t lrFhssFrameHopsRem = 0;
- 1307 size_t lrFhssHopNum = 0;
-
- 1309 int16_t modSetup(
float tcxoVoltage,
bool useRegulatorLDO, uint8_t modem);
- 1310 int16_t config(uint8_t modem);
- 1311 bool findChip(
const char* verStr);
- 1312 int16_t startReceiveCommon(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF,
RadioLibIrqFlags_t irqFlags = RADIOLIB_IRQ_RX_DEFAULT_FLAGS,
RadioLibIrqFlags_t irqMask = RADIOLIB_IRQ_RX_DEFAULT_MASK);
- 1313 int16_t setPacketMode(uint8_t mode, uint8_t len);
- 1314 int16_t setHeaderType(uint8_t hdrType,
size_t len = 0xFF);
- 1315 int16_t directMode();
- 1316 int16_t packetMode();
-
-
- 1319 int16_t fixSensitivity();
- 1320 int16_t fixImplicitTimeout();
- 1321 int16_t fixInvertedIQ(uint8_t iqConfig);
-
-
- 1324 int16_t buildLRFHSSPacket(
const uint8_t* in,
size_t in_len, uint8_t* out,
size_t* out_len,
size_t* out_bits,
size_t* out_hops);
- 1325 int16_t resetLRFHSS();
- 1326 uint16_t stepLRFHSS();
- 1327 int16_t setLRFHSSHop(uint8_t index);
-
-
- 1330 void effectEvalPre(uint8_t* buff, uint32_t start);
- 1331 void effectEvalPost(uint8_t* buff, uint32_t start);
-
-
-
-
+ 1294 float dataRateMeasured = 0;
+
+ 1296 uint32_t tcxoDelay = 0;
+
+
+ 1299 size_t implicitLen = 0;
+ 1300 uint8_t invertIQEnabled = RADIOLIB_SX126X_LORA_IQ_STANDARD;
+
+
+ 1303 uint8_t lrFhssCr = RADIOLIB_SX126X_LR_FHSS_CR_2_3;
+ 1304 uint8_t lrFhssBw = RADIOLIB_SX126X_LR_FHSS_BW_722_66;
+ 1305 uint8_t lrFhssHdrCount = 3;
+ 1306 uint8_t lrFhssSyncWord[RADIOLIB_SX126X_LR_FHSS_SYNC_WORD_BYTES] = { 0x12, 0xAD, 0x10, 0x1B };
+ 1307 bool lrFhssGridNonFcc =
false;
+ 1308 uint16_t lrFhssNgrid = 0;
+ 1309 uint16_t lrFhssLfsrState = 0;
+ 1310 uint16_t lrFhssPoly = 0;
+ 1311 uint16_t lrFhssSeed = 0;
+ 1312 uint16_t lrFhssHopSeqId = 0;
+ 1313 size_t lrFhssFrameBitsRem = 0;
+ 1314 size_t lrFhssFrameHopsRem = 0;
+ 1315 size_t lrFhssHopNum = 0;
+
+ 1317 int16_t modSetup(
float tcxoVoltage,
bool useRegulatorLDO, uint8_t modem);
+ 1318 int16_t config(uint8_t modem);
+ 1319 bool findChip(
const char* verStr);
+ 1320 int16_t startReceiveCommon(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF,
RadioLibIrqFlags_t irqFlags = RADIOLIB_IRQ_RX_DEFAULT_FLAGS,
RadioLibIrqFlags_t irqMask = RADIOLIB_IRQ_RX_DEFAULT_MASK);
+ 1321 int16_t setPacketMode(uint8_t mode, uint8_t len);
+ 1322 int16_t setHeaderType(uint8_t hdrType,
size_t len = 0xFF);
+ 1323 int16_t directMode();
+ 1324 int16_t packetMode();
+
+
+ 1327 int16_t fixSensitivity();
+ 1328 int16_t fixImplicitTimeout();
+ 1329 int16_t fixInvertedIQ(uint8_t iqConfig);
+
+
+ 1332 int16_t buildLRFHSSPacket(
const uint8_t* in,
size_t in_len, uint8_t* out,
size_t* out_len,
size_t* out_bits,
size_t* out_hops);
+ 1333 int16_t resetLRFHSS();
+ 1334 uint16_t stepLRFHSS();
+ 1335 int16_t setLRFHSSHop(uint8_t index);
-
+
+ 1338 void effectEvalPre(uint8_t* buff, uint32_t start);
+ 1339 void effectEvalPost(uint8_t* buff, uint32_t start);
+
+
+
+
+
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:73
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code. Note: It is not recommended to use this c...
Definition: Module.h:82
@ MODE_TX
Transmission mode.
Definition: Module.h:119
diff --git a/class_s_x126x.html b/class_s_x126x.html
index 183f1ae7..bc9fcc2e 100644
--- a/class_s_x126x.html
+++ b/class_s_x126x.html
@@ -2542,7 +2542,7 @@ bool Parameters
- preambleLength | Preamble length to be set in symbols (LoRa) or bits (FSK). |
+ preambleLength | Preamble length to be set in symbols (LoRa) or bits (FSK). NOTE: In FSK mode, sync word length limits the preamble detector length (the number of preamble bits that must be detected to start receiving packet). For details, see the note in SX1261 datasheet, Rev 2.1, section 6.2.2.1, page 45. Preamble detector length is adjusted automatically each time this method is called. |
@@ -2863,7 +2863,7 @@ bool | Parameters
syncWord | FSK sync word to be set. |
- len | FSK sync word length in bytes. |
+ len | FSK sync word length in bytes. NOTE: In FSK mode, sync word length limits the preamble detector length (the number of preamble bits that must be detected to start receiving packet). For details, see the note in SX1261 datasheet, Rev 2.1, section 6.2.2.1, page 45. Preamble detector length is adjusted automatically each time this method is called. |
|