From bb2d7d9783468ccafd236fa5e84b7e6c3fdcd432 Mon Sep 17 00:00:00 2001 From: jgromes Date: Fri, 17 Jan 2025 21:32:03 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=203354c?= =?UTF-8?q?d89dfb78ccb5efc700ab193516b4641d46b=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _a_f_s_k_8h_source.html | 2 +- _c_c1101_8h_source.html | 4 +- _l_l_c_c68_8h_source.html | 8 +- _lo_ra_w_a_n_8h_source.html | 42 +-- _module_8h_source.html | 30 +-- _morse_8h_source.html | 251 +++++++++--------- _physical_layer_8h_source.html | 2 +- _s_x126x_8h_source.html | 8 +- class_c_c1101-members.html | 2 +- class_c_c1101.html | 12 +- class_c_c1101.js | 2 +- class_l_l_c_c68-members.html | 4 +- class_l_l_c_c68.html | 46 ++-- class_l_l_c_c68.js | 4 +- class_module-members.html | 12 +- class_module.html | 314 +++++++++++------------ class_module.js | 12 +- class_s_t_m32_w_lx-members.html | 4 +- class_s_t_m32_w_lx.html | 4 +- class_s_t_m32_w_lx___module-members.html | 12 +- class_s_t_m32_w_lx___module.html | 36 +-- class_s_x1261-members.html | 4 +- class_s_x1261.html | 4 +- class_s_x1262-members.html | 4 +- class_s_x1262.html | 4 +- class_s_x1268-members.html | 4 +- class_s_x1268.html | 4 +- class_s_x126x-members.html | 4 +- class_s_x126x.html | 24 +- functions_func_s.html | 12 +- functions_s.html | 12 +- navtreeindex0.js | 6 +- navtreeindex1.js | 14 +- search/all_10.js | 16 +- search/functions_f.js | 16 +- 35 files changed, 487 insertions(+), 452 deletions(-) diff --git a/_a_f_s_k_8h_source.html b/_a_f_s_k_8h_source.html index cb826627..24f4b2db 100644 --- a/_a_f_s_k_8h_source.html +++ b/_a_f_s_k_8h_source.html @@ -150,7 +150,7 @@ $(document).ready(function(){initNavTree('_a_f_s_k_8h_source.html',''); initResi
BellClient
Client for Bell modem communication. The public interface is the same as Arduino Serial.
Definition BellModem.h:54
FSK4Client
Client for FSK-4 communication. The public interface is the same as Arduino Serial.
Definition FSK4.h:15
HellClient
Client for Hellschreiber transmissions.
Definition Hellschreiber.h:90
-
MorseClient
Client for Morse Code communication. The public interface is the same as Arduino Serial.
Definition Morse.h:93
+
MorseClient
Client for Morse Code communication. The public interface is the same as Arduino Serial.
Definition Morse.h:94
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition PhysicalLayer.h:151
RTTYClient
Client for RTTY communication. The public interface is the same as Arduino Serial.
Definition RTTY.h:17
SSTVClient
Client for SSTV transmissions.
Definition SSTV.h:121
diff --git a/_c_c1101_8h_source.html b/_c_c1101_8h_source.html index 851157b4..2376459c 100644 --- a/_c_c1101_8h_source.html +++ b/_c_c1101_8h_source.html @@ -724,7 +724,7 @@ $(document).ready(function(){initNavTree('_c_c1101_8h_source.html',''); initResi
823
832 int16_t setSyncWord(uint8_t syncH, uint8_t syncL, uint8_t maxErrBits = 0, bool requireCarrierSense = false);
833
-
842 int16_t setSyncWord(uint8_t* syncWord, uint8_t len, uint8_t maxErrBits = 0, bool requireCarrierSense = false);
+
842 int16_t setSyncWord(const uint8_t* syncWord, uint8_t len, uint8_t maxErrBits = 0, bool requireCarrierSense = false);
843
850 int16_t setPreambleLength(uint8_t preambleLength, uint8_t qualityThreshold);
851
@@ -784,7 +784,7 @@ $(document).ready(function(){initNavTree('_c_c1101_8h_source.html',''); initResi
1009 int16_t SPIsetRegValue(uint8_t reg, uint8_t value, uint8_t msb = 7, uint8_t lsb = 0, uint8_t checkInterval = 2);
1010 void SPIreadRegisterBurst(uint8_t reg, uint8_t numBytes, uint8_t* inBytes);
1011 uint8_t SPIreadRegister(uint8_t reg);
-
1012 void SPIwriteRegisterBurst(uint8_t reg, uint8_t* data, size_t len);
+
1012 void SPIwriteRegisterBurst(uint8_t reg, const uint8_t* data, size_t len);
1013 void SPIwriteRegister(uint8_t reg, uint8_t data);
1014
1015 void SPIsendCommand(uint8_t cmd);
diff --git a/_l_l_c_c68_8h_source.html b/_l_l_c_c68_8h_source.html index cc55a3b7..d2c5267e 100644 --- a/_l_l_c_c68_8h_source.html +++ b/_l_l_c_c68_8h_source.html @@ -121,9 +121,9 @@ $(document).ready(function(){initNavTree('_l_l_c_c68_8h_source.html',''); initRe
43
44 // configuration methods
45
-
51 int16_t setBandwidth(float bw);
+
51 int16_t setBandwidth(float bw) override;
52
-
58 int16_t setSpreadingFactor(uint8_t sf);
+
58 int16_t setSpreadingFactor(uint8_t sf) override;
59
65 int16_t setDataRate(DataRate_t dr) override;
66
@@ -142,11 +142,11 @@ $(document).ready(function(){initNavTree('_l_l_c_c68_8h_source.html',''); initRe
89
90#endif
LLCC68
Derived class for LLCC68 modules.
Definition LLCC68.h:19
-
LLCC68::setBandwidth
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 125.0, 250.0 and 500.0 kHz.
Definition LLCC68.cpp:40
LLCC68::checkDataRate
int16_t checkDataRate(DataRate_t dr) override
Check the data rate can be configured by this module.
Definition LLCC68.cpp:92
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 pwr=10, uint16_t preambleLength=8, float tcxoVoltage=0, bool useRegulatorLDO=false)
Initialization method for LoRa modem.
Definition LLCC68.cpp:9
LLCC68::setDataRate
int16_t setDataRate(DataRate_t dr) override
Set data.
Definition LLCC68.cpp:63
-
LLCC68::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 11, depending on currently set spreading f...
Definition LLCC68.cpp:45
+
LLCC68::setBandwidth
int16_t setBandwidth(float bw) override
Sets LoRa bandwidth. Allowed values are 125.0, 250.0 and 500.0 kHz.
Definition LLCC68.cpp:40
+
LLCC68::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf) override
Sets LoRa spreading factor. Allowed values range from 5 to 11, depending on currently set spreading f...
Definition LLCC68.cpp:45
LLCC68::setModem
int16_t setModem(ModemType_t modem) override
Set modem for the radio to use. Will perform full reset and reconfigure the radio using its default p...
Definition LLCC68.cpp:126
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition Module.h:73
SX1262
Derived class for SX1262 modules.
Definition SX1262.h:22
diff --git a/_lo_ra_w_a_n_8h_source.html b/_lo_ra_w_a_n_8h_source.html index b63fddfe..5c9351a9 100644 --- a/_lo_ra_w_a_n_8h_source.html +++ b/_lo_ra_w_a_n_8h_source.html @@ -925,38 +925,38 @@ $(document).ready(function(){initNavTree('_lo_ra_w_a_n_8h_source.html',''); init
LoRaWANNode
LoRaWAN-compatible node (class A device).
Definition LoRaWAN.h:522
LoRaWANNode::clearSession
void clearSession()
Clear an active session, so that the device will have to rejoin the network.
Definition LoRaWAN.cpp:278
LoRaWANNode::sendReceive
virtual int16_t sendReceive(const char *strUp, uint8_t fPort, bool isConfirmed=false, LoRaWANEvent_t *eventUp=NULL, LoRaWANEvent_t *eventDown=NULL)
Send a message to the server and wait for a downlink during Rx1 and/or Rx2 window.
Definition LoRaWAN.cpp:43
-
LoRaWANNode::setDatarate
int16_t setDatarate(uint8_t drUp)
Set uplink datarate. This should not be used when ADR is enabled.
Definition LoRaWAN.cpp:2621
-
LoRaWANNode::scheduleTransmission
void scheduleTransmission(RadioLibTime_t tUplink)
Set the exact time a transmission should occur. Note: this is the internal clock time....
Definition LoRaWAN.cpp:2754
+
LoRaWANNode::setDatarate
int16_t setDatarate(uint8_t drUp)
Set uplink datarate. This should not be used when ADR is enabled.
Definition LoRaWAN.cpp:2624
+
LoRaWANNode::scheduleTransmission
void scheduleTransmission(RadioLibTime_t tUplink)
Set the exact time a transmission should occur. Note: this is the internal clock time....
Definition LoRaWAN.cpp:2757
LoRaWANNode::scanGuard
RadioLibTime_t scanGuard
Rx window padding in milliseconds according to the spec, the Rx window must be at least enough time t...
Definition LoRaWAN.h:851
-
LoRaWANNode::setCSMA
void setCSMA(bool csmaEnabled, uint8_t maxChanges=4, uint8_t backoffMax=0, uint8_t difsSlots=2)
Configures CSMA for LoRaWAN as per TR013, LoRa Alliance.
Definition LoRaWAN.cpp:2736
-
LoRaWANNode::setDutyCycle
void setDutyCycle(bool enable=true, RadioLibTime_t msPerHour=0)
Toggle adherence to dutyCycle limits to on or off.
Definition LoRaWAN.cpp:2711
+
LoRaWANNode::setCSMA
void setCSMA(bool csmaEnabled, uint8_t maxChanges=4, uint8_t backoffMax=0, uint8_t difsSlots=2)
Configures CSMA for LoRaWAN as per TR013, LoRa Alliance.
Definition LoRaWAN.cpp:2739
+
LoRaWANNode::setDutyCycle
void setDutyCycle(bool enable=true, RadioLibTime_t msPerHour=0)
Toggle adherence to dutyCycle limits to on or off.
Definition LoRaWAN.cpp:2714
LoRaWANNode::beginABP
int16_t beginABP(uint32_t addr, const uint8_t *fNwkSIntKey, const uint8_t *sNwkSIntKey, const uint8_t *nwkSEncKey, const uint8_t *appSKey)
Set the device credentials and activation configuration.
Definition LoRaWAN.cpp:613
-
LoRaWANNode::timeUntilUplink
RadioLibTime_t timeUntilUplink()
Returns time in milliseconds until next uplink is available under dutyCycle limits.
Definition LoRaWAN.cpp:3262
-
LoRaWANNode::setDeviceStatus
void setDeviceStatus(uint8_t battLevel)
Set device status.
Definition LoRaWAN.cpp:2750
-
LoRaWANNode::dutyCycleInterval
RadioLibTime_t dutyCycleInterval(RadioLibTime_t msPerHour, RadioLibTime_t airtime)
Calculate the minimum interval to adhere to a certain dutyCycle. This interval is based on the ToA of...
Definition LoRaWAN.cpp:3252
-
LoRaWANNode::setDwellTime
void setDwellTime(bool enable, RadioLibTime_t msPerUplink=0)
Set or disable uplink dwell time limitation; enabled by default if mandatory.
Definition LoRaWAN.cpp:2723
-
LoRaWANNode::getAFCntDown
uint32_t getAFCntDown()
Returns the last application downlink's frame counter; also 0 if no application downlink occured yet.
Definition LoRaWAN.cpp:2770
-
LoRaWANNode::getLastToA
RadioLibTime_t getLastToA()
Get the Time-on-air of the last uplink message (in milliseconds).
Definition LoRaWAN.cpp:2783
+
LoRaWANNode::timeUntilUplink
RadioLibTime_t timeUntilUplink()
Returns time in milliseconds until next uplink is available under dutyCycle limits.
Definition LoRaWAN.cpp:3265
+
LoRaWANNode::setDeviceStatus
void setDeviceStatus(uint8_t battLevel)
Set device status.
Definition LoRaWAN.cpp:2753
+
LoRaWANNode::dutyCycleInterval
RadioLibTime_t dutyCycleInterval(RadioLibTime_t msPerHour, RadioLibTime_t airtime)
Calculate the minimum interval to adhere to a certain dutyCycle. This interval is based on the ToA of...
Definition LoRaWAN.cpp:3255
+
LoRaWANNode::setDwellTime
void setDwellTime(bool enable, RadioLibTime_t msPerUplink=0)
Set or disable uplink dwell time limitation; enabled by default if mandatory.
Definition LoRaWAN.cpp:2726
+
LoRaWANNode::getAFCntDown
uint32_t getAFCntDown()
Returns the last application downlink's frame counter; also 0 if no application downlink occured yet.
Definition LoRaWAN.cpp:2773
+
LoRaWANNode::getLastToA
RadioLibTime_t getLastToA()
Get the Time-on-air of the last uplink message (in milliseconds).
Definition LoRaWAN.cpp:2786
LoRaWANNode::activateABP
virtual int16_t activateABP(uint8_t initialDr=RADIOLIB_LORAWAN_DATA_RATE_UNUSED)
Join network by restoring ABP session or performing over-the-air activation. In this procedure,...
Definition LoRaWAN.cpp:958
LoRaWANNode::TS009
bool TS009
TS009 Protocol Specification Verification switch (allows FPort 224 and cuts off uplink payload instea...
Definition LoRaWAN.h:837
LoRaWANNode::getBufferNonces
uint8_t * getBufferNonces()
Returns the pointer to the internal buffer that holds the LW base parameters.
Definition LoRaWAN.cpp:227
LoRaWANNode::getBufferSession
uint8_t * getBufferSession()
Returns the pointer to the internal buffer that holds the LW session parameters.
Definition LoRaWAN.cpp:428
LoRaWANNode::isActivated
bool isActivated()
Whether there is an ongoing session active.
Definition LoRaWAN.cpp:1048
-
LoRaWANNode::setTxPower
int16_t setTxPower(int8_t txPower)
Configure TX power of the radio module.
Definition LoRaWAN.cpp:2654
-
LoRaWANNode::getMacDeviceTimeAns
int16_t getMacDeviceTimeAns(uint32_t *gpsEpoch, uint8_t *fraction, bool returnUnix=true)
Returns the network time after requesting a DeviceTime MAC command. Returns 'true' if a network respo...
Definition LoRaWAN.cpp:2472
-
LoRaWANNode::getNFCntDown
uint32_t getNFCntDown()
Returns the last network downlink's frame counter; also 0 if no network downlink occured yet.
Definition LoRaWAN.cpp:2766
+
LoRaWANNode::setTxPower
int16_t setTxPower(int8_t txPower)
Configure TX power of the radio module.
Definition LoRaWAN.cpp:2657
+
LoRaWANNode::getMacDeviceTimeAns
int16_t getMacDeviceTimeAns(uint32_t *gpsEpoch, uint8_t *fraction, bool returnUnix=true)
Returns the network time after requesting a DeviceTime MAC command. Returns 'true' if a network respo...
Definition LoRaWAN.cpp:2475
+
LoRaWANNode::getNFCntDown
uint32_t getNFCntDown()
Returns the last network downlink's frame counter; also 0 if no network downlink occured yet.
Definition LoRaWAN.cpp:2769
LoRaWANNode::beginOTAA
int16_t beginOTAA(uint64_t joinEUI, uint64_t devEUI, const uint8_t *nwkKey, const uint8_t *appKey)
Set the device credentials and activation configuration.
Definition LoRaWAN.cpp:584
-
LoRaWANNode::getMaxPayloadLen
uint8_t getMaxPayloadLen()
Returns the maximum allowed uplink payload size given the current MAC state. Most importantly,...
Definition LoRaWAN.cpp:3271
+
LoRaWANNode::getMaxPayloadLen
uint8_t getMaxPayloadLen()
Returns the maximum allowed uplink payload size given the current MAC state. Most importantly,...
Definition LoRaWAN.cpp:3274
LoRaWANNode::activateOTAA
virtual int16_t activateOTAA(uint8_t initialDr=RADIOLIB_LORAWAN_DATA_RATE_UNUSED, LoRaWANJoinEvent_t *joinEvent=NULL)
Join network by restoring OTAA session or performing over-the-air activation. By this procedure,...
Definition LoRaWAN.cpp:868
-
LoRaWANNode::getFCntUp
uint32_t getFCntUp()
Returns the last uplink's frame counter; also 0 if no uplink occured yet.
Definition LoRaWAN.cpp:2759
+
LoRaWANNode::getFCntUp
uint32_t getFCntUp()
Returns the last uplink's frame counter; also 0 if no uplink occured yet.
Definition LoRaWAN.cpp:2762
LoRaWANNode::setBufferNonces
int16_t setBufferNonces(const uint8_t *persistentBuffer)
Fill the internal buffer that holds the LW base parameters with a supplied buffer.
Definition LoRaWAN.cpp:242
-
LoRaWANNode::setRx2Dr
int16_t setRx2Dr(uint8_t dr)
Configure the Rx2 datarate for ABP mode. This should not be needed for LoRaWAN 1.1 as it is configure...
Definition LoRaWAN.cpp:2680
-
LoRaWANNode::sendMacCommandReq
int16_t sendMacCommandReq(uint8_t cid)
Add a MAC command to the uplink queue. Only LinkCheck and DeviceTime are available to the user....
Definition LoRaWAN.cpp:2437
-
LoRaWANNode::getMacLinkCheckAns
int16_t getMacLinkCheckAns(uint8_t *margin, uint8_t *gwCnt)
Returns the quality of connectivity after requesting a LinkCheck MAC command. Returns 'true' if a net...
Definition LoRaWAN.cpp:2461
-
LoRaWANNode::setADR
void setADR(bool enable=true)
Toggle ADR to on or off.
Definition LoRaWAN.cpp:2707
+
LoRaWANNode::setRx2Dr
int16_t setRx2Dr(uint8_t dr)
Configure the Rx2 datarate for ABP mode. This should not be needed for LoRaWAN 1.1 as it is configure...
Definition LoRaWAN.cpp:2683
+
LoRaWANNode::sendMacCommandReq
int16_t sendMacCommandReq(uint8_t cid)
Add a MAC command to the uplink queue. Only LinkCheck and DeviceTime are available to the user....
Definition LoRaWAN.cpp:2440
+
LoRaWANNode::getMacLinkCheckAns
int16_t getMacLinkCheckAns(uint8_t *margin, uint8_t *gwCnt)
Returns the quality of connectivity after requesting a LinkCheck MAC command. Returns 'true' if a net...
Definition LoRaWAN.cpp:2464
+
LoRaWANNode::setADR
void setADR(bool enable=true)
Toggle ADR to on or off.
Definition LoRaWAN.cpp:2710
LoRaWANNode::setBufferSession
int16_t setBufferSession(const uint8_t *persistentBuffer)
Fill the internal buffer that holds the LW session parameters with a supplied buffer.
Definition LoRaWAN.cpp:460
-
LoRaWANNode::getDevAddr
uint32_t getDevAddr()
Returns the DevAddr of the device, regardless of OTAA or ABP mode.
Definition LoRaWAN.cpp:2779
-
LoRaWANNode::resetFCntDown
void resetFCntDown()
Reset the downlink frame counters (application and network) This is unsafe and can possibly allow rep...
Definition LoRaWAN.cpp:2774
+
LoRaWANNode::getDevAddr
uint32_t getDevAddr()
Returns the DevAddr of the device, regardless of OTAA or ABP mode.
Definition LoRaWAN.cpp:2782
+
LoRaWANNode::resetFCntDown
void resetFCntDown()
Reset the downlink frame counters (application and network) This is unsafe and can possibly allow rep...
Definition LoRaWAN.cpp:2777
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition PhysicalLayer.h:151
RadioLibTime_t
unsigned long RadioLibTime_t
Type used for durations in RadioLib.
Definition TypeDef.h:642
LoRaWANBand_t
Structure to save information about LoRaWAN band.
Definition LoRaWAN.h:367
diff --git a/_module_8h_source.html b/_module_8h_source.html index 8f1e6170..dfa95c72 100644 --- a/_module_8h_source.html +++ b/_module_8h_source.html @@ -241,23 +241,23 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
287
293 uint8_t SPIreadRegister(uint32_t reg);
294
-
301 void SPIwriteRegisterBurst(uint32_t reg, uint8_t* data, size_t numBytes);
+
301 void SPIwriteRegisterBurst(uint32_t reg, const uint8_t* data, size_t numBytes);
302
308 void SPIwriteRegister(uint32_t reg, uint8_t data);
309
-
318 void SPItransfer(uint16_t cmd, uint32_t reg, uint8_t* dataOut, uint8_t* dataIn, size_t numBytes);
+
318 void SPItransfer(uint16_t cmd, uint32_t reg, const uint8_t* dataOut, uint8_t* dataIn, size_t numBytes);
319
324 int16_t SPIcheckStream();
325
335 int16_t SPIreadStream(uint16_t cmd, uint8_t* data, size_t numBytes, bool waitForGpio = true, bool verify = true);
336
-
347 int16_t SPIreadStream(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, size_t numBytes, bool waitForGpio = true, bool verify = true);
+
347 int16_t SPIreadStream(const uint8_t* cmd, uint8_t cmdLen, uint8_t* data, size_t numBytes, bool waitForGpio = true, bool verify = true);
348
-
358 int16_t SPIwriteStream(uint16_t cmd, uint8_t* data, size_t numBytes, bool waitForGpio = true, bool verify = true);
+
358 int16_t SPIwriteStream(uint16_t cmd, const uint8_t* data, size_t numBytes, bool waitForGpio = true, bool verify = true);
359
-
370 int16_t SPIwriteStream(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, size_t numBytes, bool waitForGpio = true, bool verify = true);
+
370 int16_t SPIwriteStream(const uint8_t* cmd, uint8_t cmdLen, const uint8_t* data, size_t numBytes, bool waitForGpio = true, bool verify = true);
371
-
383 int16_t SPItransferStream(const uint8_t* cmd, uint8_t cmdLen, bool write, uint8_t* dataOut, uint8_t* dataIn, size_t numBytes, bool waitForGpio);
+
383 int16_t SPItransferStream(const uint8_t* cmd, uint8_t cmdLen, bool write, const uint8_t* dataOut, uint8_t* dataIn, size_t numBytes, bool waitForGpio);
384
385 // pin number access methods
386 // getCs is omitted on purpose, as it can interfere when accessing the SPI in a concurrent environment
@@ -305,16 +305,18 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
541#endif
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition Module.h:73
Module::RFSWITCH_MAX_PINS
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
+
Module::SPIwriteRegisterBurst
void SPIwriteRegisterBurst(uint32_t reg, const uint8_t *data, size_t numBytes)
SPI burst write method.
Definition Module.cpp:145
Module::SPIcheckStatusCb_t
int16_t(* SPIcheckStatusCb_t)(Module *mod)
Callback for validation SPI status.
Definition Module.h:174
-
Module::SPIwriteRegisterBurst
void SPIwriteRegisterBurst(uint32_t reg, uint8_t *data, size_t numBytes)
SPI burst write method.
Definition Module.cpp:145
+
Module::SPItransferStream
int16_t SPItransferStream(const uint8_t *cmd, uint8_t cmdLen, bool write, const uint8_t *dataOut, uint8_t *dataIn, size_t numBytes, bool waitForGpio)
SPI single transfer method for modules with stream-type SPI interface (SX126x, SX128x etc....
Definition Module.cpp:318
+
Module::SPItransfer
void SPItransfer(uint16_t cmd, uint32_t reg, const uint8_t *dataOut, uint8_t *dataIn, size_t numBytes)
SPI single transfer method.
Definition Module.cpp:177
Module::SPIgetRegValue
int16_t SPIgetRegValue(uint32_t reg, uint8_t msb=7, uint8_t lsb=0)
SPI read method that automatically masks unused bits. This method is the preferred SPI read mechanism...
Definition Module.cpp:49
Module::spiConfig
SPIConfig_t spiConfig
SPI configuration structure. The default configuration corresponds to register-access modules,...
Definition Module.h:214
-
Module::SPItransferStream
int16_t SPItransferStream(const uint8_t *cmd, uint8_t cmdLen, bool write, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes, bool waitForGpio)
SPI single transfer method for modules with stream-type SPI interface (SX126x, SX128x etc....
Definition Module.cpp:318
Module::hal
RadioLibHal * hal
Hardware abstraction layer to be used.
Definition Module.h:168
Module::term
void term()
Terminate low-level module control.
Definition Module.cpp:44
+
Module::SPIwriteStream
int16_t SPIwriteStream(uint16_t cmd, const uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)
Method to perform a write transaction with SPI stream.
Definition Module.cpp:267
Module::operator=
Module & operator=(const Module &mod)
Overload for assignment operator.
Definition Module.cpp:27
Module::getGpio
uint32_t getGpio() const
Access method to get the pin number of second interrupt/GPIO.
Definition Module.h:406
-
Module::findRfSwitchMode
const RfSwitchMode_t * findRfSwitchMode(uint8_t mode) const
Find a mode in the RfSwitchTable.
Definition Module.cpp:505
+
Module::findRfSwitchMode
const RfSwitchMode_t * findRfSwitchMode(uint8_t mode) const
Find a mode in the RfSwitchTable.
Definition Module.cpp:513
Module::OpMode_t
OpMode_t
Constants to use in a mode table set be setRfSwitchTable. These constants work for most radios,...
Definition Module.h:105
Module::MODE_TX
@ MODE_TX
Transmission mode.
Definition Module.h:119
Module::MODE_IDLE
@ MODE_IDLE
Idle mode.
Definition Module.h:113
@@ -322,20 +324,18 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
Module::MODE_END_OF_TABLE
@ MODE_END_OF_TABLE
End of table marker, use END_OF_MODE_TABLE constant instead. Value is zero to ensure zero-initialized...
Definition Module.h:110
Module::SPIcheckStream
int16_t SPIcheckStream()
Method to check the result of last SPI stream transfer.
Definition Module.cpp:295
Module::SPIwriteRegister
void SPIwriteRegister(uint32_t reg, uint8_t data)
SPI basic write method. Use of this method is reserved for special cases, SPIsetRegValue should be us...
Definition Module.cpp:161
-
Module::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 Module.cpp:481
-
Module::waitForMicroseconds
void waitForMicroseconds(RadioLibTime_t start, RadioLibTime_t len)
Wait for time to elapse, either using the microsecond timer, or the TimerFlag. Note that in interrupt...
Definition Module.cpp:448
+
Module::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 Module.cpp:489
+
Module::waitForMicroseconds
void waitForMicroseconds(RadioLibTime_t start, RadioLibTime_t len)
Wait for time to elapse, either using the microsecond timer, or the TimerFlag. Note that in interrupt...
Definition Module.cpp:456
Module::SPIparseStatusCb_t
int16_t(* SPIparseStatusCb_t)(uint8_t in)
Callback for parsing SPI status.
Definition Module.h:171
-
Module::SPItransfer
void SPItransfer(uint16_t cmd, uint32_t reg, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes)
SPI single transfer method.
Definition Module.cpp:177
Module::SPIreadRegister
uint8_t SPIreadRegister(uint32_t reg)
SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be use...
Definition Module.cpp:127
Module::getIrq
uint32_t getIrq() const
Access method to get the pin number of interrupt/GPIO.
Definition Module.h:394
-
Module::setRfSwitchTable
void setRfSwitchTable(const uint32_t(&pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition Module.cpp:497
+
Module::setRfSwitchTable
void setRfSwitchTable(const uint32_t(&pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition Module.cpp:505
Module::SPIreadRegisterBurst
void SPIreadRegisterBurst(uint32_t reg, size_t numBytes, uint8_t *inBytes)
SPI burst read method.
Definition Module.cpp:111
Module::init
void init()
Initialize low-level module control.
Definition Module.cpp:37
Module::getRst
uint32_t getRst() const
Access method to get the pin number of hardware reset pin.
Definition Module.h:400
Module::SPIreadStream
int16_t SPIreadStream(uint16_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)
Method to perform a read transaction with SPI stream.
Definition Module.cpp:239
Module::SPIsetRegValue
int16_t SPIsetRegValue(uint32_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF, bool force=false)
Overwrite-safe SPI write method with verification. This method is the preferred SPI write mechanism.
Definition Module.cpp:59
-
Module::SPIwriteStream
int16_t SPIwriteStream(uint16_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)
Method to perform a write transaction with SPI stream.
Definition Module.cpp:267
-
Module::setRfSwitchState
void setRfSwitchState(uint8_t mode)
Set RF switch state.
Definition Module.cpp:516
+
Module::setRfSwitchState
void setRfSwitchState(uint8_t mode)
Set RF switch state.
Definition Module.cpp:524
RadioLibHal
Hardware abstraction library base interface.
Definition Hal.h:13
RADIOLIB_ERR_UNKNOWN
#define RADIOLIB_ERR_UNKNOWN
There was an unexpected, unknown error. If you see this, something went incredibly wrong....
Definition TypeDef.h:110
RadioLibTime_t
unsigned long RadioLibTime_t
Type used for durations in RadioLib.
Definition TypeDef.h:642
diff --git a/_morse_8h_source.html b/_morse_8h_source.html index ad46f1f2..701b3da9 100644 --- a/_morse_8h_source.html +++ b/_morse_8h_source.html @@ -114,133 +114,134 @@ $(document).ready(function(){initNavTree('_morse_8h_source.html',''); initResiza
14#define RADIOLIB_MORSE_INTER_SYMBOL 0x00
15#define RADIOLIB_MORSE_CHAR_COMPLETE 0x01
16#define RADIOLIB_MORSE_WORD_COMPLETE 0x02
-
17
-
18// Morse character table: - using codes defined in ITU-R M.1677-1
-
19// - Morse code representation is saved LSb first, using additional bit as guard
-
20// - position in array corresponds ASCII code minus RADIOLIB_MORSE_ASCII_OFFSET
-
21// - ASCII characters marked RADIOLIB_MORSE_UNSUPPORTED do not have ITU-R M.1677-1 equivalent
-
22static const uint8_t MorseTable[] RADIOLIB_NONVOLATILE = {
-
23 0b00, // space
-
24 0b110101, // ! (unsupported)
-
25 0b1010010, // "
-
26 RADIOLIB_MORSE_UNSUPPORTED, // # (unsupported)
-
27 RADIOLIB_MORSE_UNSUPPORTED, // $ (unsupported)
-
28 RADIOLIB_MORSE_UNSUPPORTED, // % (unsupported)
-
29 RADIOLIB_MORSE_UNSUPPORTED, // & (unsupported)
-
30 0b1011110, // '
-
31 0b101101, // (
-
32 0b1101101, // )
-
33 RADIOLIB_MORSE_UNSUPPORTED, // * (unsupported)
-
34 0b101010, // +
-
35 0b1110011, // ,
-
36 0b1100001, // -
-
37 0b1101010, // .
-
38 0b101001, // /
-
39 0b111111, // 0
-
40 0b111110, // 1
-
41 0b111100, // 2
-
42 0b111000, // 3
-
43 0b110000, // 4
-
44 0b100000, // 5
-
45 0b100001, // 6
-
46 0b100011, // 7
-
47 0b100111, // 8
-
48 0b101111, // 9
-
49 0b1000111, // :
-
50 RADIOLIB_MORSE_UNSUPPORTED, // ; (unsupported)
-
51 RADIOLIB_MORSE_UNSUPPORTED, // < (unsupported)
-
52 0b110001, // =
-
53 RADIOLIB_MORSE_UNSUPPORTED, // > (unsupported)
-
54 0b1001100, // ?
-
55 0b1010110, // @
-
56 0b110, // A
-
57 0b10001, // B
-
58 0b10101, // C
-
59 0b1001, // D
-
60 0b10, // E
-
61 0b10100, // F
-
62 0b1011, // G
-
63 0b10000, // H
-
64 0b100, // I
-
65 0b11110, // J
-
66 0b1101, // K
-
67 0b10010, // L
-
68 0b111, // M
-
69 0b101, // N
-
70 0b1111, // O
-
71 0b10110, // P
-
72 0b11011, // Q
-
73 0b1010, // R
-
74 0b1000, // S
-
75 0b11, // T
-
76 0b1100, // U
-
77 0b11000, // V
-
78 0b1110, // W
-
79 0b11001, // X
-
80 0b11101, // Y
-
81 0b10011, // Z
-
82 RADIOLIB_MORSE_UNSUPPORTED, // [ (unsupported)
-
83 RADIOLIB_MORSE_UNSUPPORTED, // \ (unsupported)
-
84 RADIOLIB_MORSE_UNSUPPORTED, // ] (unsupported)
-
85 0b1101000, // ^ (unsupported, used as alias for end of work)
-
86 0b110101 // _ (unsupported, used as alias for starting signal)
-
87};
-
88
-
-
93class MorseClient: public RadioLibPrint {
-
94 public:
-
99 explicit MorseClient(PhysicalLayer* phy);
-
100
-
101 #if !RADIOLIB_EXCLUDE_AFSK
-
106 explicit MorseClient(AFSKClient* audio);
-
107 #endif
-
108
-
109 // basic methods
-
110
-
117 int16_t begin(float base, uint8_t speed = 20);
-
118
-
123 size_t startSignal();
-
124
-
131 static char decode(uint8_t symbol, uint8_t len);
-
132
-
142 #if !RADIOLIB_EXCLUDE_AFSK
-
143 int read(uint8_t* symbol, uint8_t* len, float low = 0.75f, float high = 1.25f);
-
144 #endif
-
145
-
151 size_t write(uint8_t b) override;
-
152
-
153#if !RADIOLIB_GODMODE
-
154 private:
-
155#endif
-
156 PhysicalLayer* phyLayer;
-
157 #if !RADIOLIB_EXCLUDE_AFSK
-
158 AFSKClient* audioClient;
-
159 #endif
-
160
-
161 uint32_t baseFreq = 0, baseFreqHz = 0;
-
162 float basePeriod = 0.0f;
-
163 uint32_t dotLength = 0;
-
164 uint32_t dashLength = 0;
-
165 uint32_t letterSpace = 0;
-
166 uint16_t wordSpace = 0;
-
167
-
168 // variables to keep decoding state
-
169 uint32_t signalCounter = 0;
-
170 RadioLibTime_t signalStart = 0;
-
171 uint32_t pauseCounter = 0;
-
172 RadioLibTime_t pauseStart = 0;
-
173
-
174 size_t printNumber(unsigned long, uint8_t);
-
175 size_t printFloat(double, uint8_t);
-
176
-
177 int16_t transmitDirect(uint32_t freq = 0, uint32_t freqHz = 0);
-
178 int16_t standby();
-
179};
+
17#define RADIOLIB_MORSE_UNKNOWN_SYMBOL '*'
+
18
+
19// Morse character table: - using codes defined in ITU-R M.1677-1
+
20// - Morse code representation is saved LSb first, using additional bit as guard
+
21// - position in array corresponds ASCII code minus RADIOLIB_MORSE_ASCII_OFFSET
+
22// - ASCII characters marked RADIOLIB_MORSE_UNSUPPORTED do not have ITU-R M.1677-1 equivalent
+
23static const uint8_t MorseTable[] RADIOLIB_NONVOLATILE = {
+
24 0b00, // space
+
25 0b110101, // ! (unsupported)
+
26 0b1010010, // "
+
27 RADIOLIB_MORSE_UNSUPPORTED, // # (unsupported)
+
28 RADIOLIB_MORSE_UNSUPPORTED, // $ (unsupported)
+
29 RADIOLIB_MORSE_UNSUPPORTED, // % (unsupported)
+
30 RADIOLIB_MORSE_UNSUPPORTED, // & (unsupported)
+
31 0b1011110, // '
+
32 0b101101, // (
+
33 0b1101101, // )
+
34 RADIOLIB_MORSE_UNSUPPORTED, // * (unsupported)
+
35 0b101010, // +
+
36 0b1110011, // ,
+
37 0b1100001, // -
+
38 0b1101010, // .
+
39 0b101001, // /
+
40 0b111111, // 0
+
41 0b111110, // 1
+
42 0b111100, // 2
+
43 0b111000, // 3
+
44 0b110000, // 4
+
45 0b100000, // 5
+
46 0b100001, // 6
+
47 0b100011, // 7
+
48 0b100111, // 8
+
49 0b101111, // 9
+
50 0b1000111, // :
+
51 RADIOLIB_MORSE_UNSUPPORTED, // ; (unsupported)
+
52 RADIOLIB_MORSE_UNSUPPORTED, // < (unsupported)
+
53 0b110001, // =
+
54 RADIOLIB_MORSE_UNSUPPORTED, // > (unsupported)
+
55 0b1001100, // ?
+
56 0b1010110, // @
+
57 0b110, // A
+
58 0b10001, // B
+
59 0b10101, // C
+
60 0b1001, // D
+
61 0b10, // E
+
62 0b10100, // F
+
63 0b1011, // G
+
64 0b10000, // H
+
65 0b100, // I
+
66 0b11110, // J
+
67 0b1101, // K
+
68 0b10010, // L
+
69 0b111, // M
+
70 0b101, // N
+
71 0b1111, // O
+
72 0b10110, // P
+
73 0b11011, // Q
+
74 0b1010, // R
+
75 0b1000, // S
+
76 0b11, // T
+
77 0b1100, // U
+
78 0b11000, // V
+
79 0b1110, // W
+
80 0b11001, // X
+
81 0b11101, // Y
+
82 0b10011, // Z
+
83 RADIOLIB_MORSE_UNSUPPORTED, // [ (unsupported)
+
84 RADIOLIB_MORSE_UNSUPPORTED, // \ (unsupported)
+
85 RADIOLIB_MORSE_UNSUPPORTED, // ] (unsupported)
+
86 0b1101000, // ^ (unsupported, used as alias for end of work)
+
87 0b110101 // _ (unsupported, used as alias for starting signal)
+
88};
+
89
+
+
94class MorseClient: public RadioLibPrint {
+
95 public:
+
100 explicit MorseClient(PhysicalLayer* phy);
+
101
+
102 #if !RADIOLIB_EXCLUDE_AFSK
+
107 explicit MorseClient(AFSKClient* audio);
+
108 #endif
+
109
+
110 // basic methods
+
111
+
118 int16_t begin(float base, uint8_t speed = 20);
+
119
+
124 size_t startSignal();
+
125
+
132 static char decode(uint8_t symbol, uint8_t len);
+
133
+
143 #if !RADIOLIB_EXCLUDE_AFSK
+
144 int read(uint8_t* symbol, uint8_t* len, float low = 0.75f, float high = 1.25f);
+
145 #endif
+
146
+
152 size_t write(uint8_t b) override;
+
153
+
154#if !RADIOLIB_GODMODE
+
155 private:
+
156#endif
+
157 PhysicalLayer* phyLayer;
+
158 #if !RADIOLIB_EXCLUDE_AFSK
+
159 AFSKClient* audioClient;
+
160 #endif
+
161
+
162 uint32_t baseFreq = 0, baseFreqHz = 0;
+
163 float basePeriod = 0.0f;
+
164 uint32_t dotLength = 0;
+
165 uint32_t dashLength = 0;
+
166 uint32_t letterSpace = 0;
+
167 uint16_t wordSpace = 0;
+
168
+
169 // variables to keep decoding state
+
170 uint32_t signalCounter = 0;
+
171 RadioLibTime_t signalStart = 0;
+
172 uint32_t pauseCounter = 0;
+
173 RadioLibTime_t pauseStart = 0;
+
174
+
175 size_t printNumber(unsigned long, uint8_t);
+
176 size_t printFloat(double, uint8_t);
+
177
+
178 int16_t transmitDirect(uint32_t freq = 0, uint32_t freqHz = 0);
+
179 int16_t standby();
+
180};
-
180
-
181#endif
+
181
+
182#endif
AFSKClient
Client for audio-based transmissions. Requires Arduino tone() function, and a module capable of direc...
Definition AFSK.h:16
-
MorseClient
Client for Morse Code communication. The public interface is the same as Arduino Serial.
Definition Morse.h:93
+
MorseClient
Client for Morse Code communication. The public interface is the same as Arduino Serial.
Definition Morse.h:94
MorseClient::startSignal
size_t startSignal()
Send start signal.
Definition Morse.cpp:41
MorseClient::write
size_t write(uint8_t b) override
Write one byte. Implementation of interface of the RadioLibPrint/Print class.
Definition Morse.cpp:115
MorseClient::begin
int16_t begin(float base, uint8_t speed=20)
Initialization method.
Definition Morse.cpp:23
diff --git a/_physical_layer_8h_source.html b/_physical_layer_8h_source.html index f1831073..0bd858cf 100644 --- a/_physical_layer_8h_source.html +++ b/_physical_layer_8h_source.html @@ -420,7 +420,7 @@ $(document).ready(function(){initNavTree('_physical_layer_8h_source.html',''); i
HellClient
Client for Hellschreiber transmissions.
Definition Hellschreiber.h:90
LoRaWANNode
LoRaWAN-compatible node (class A device).
Definition LoRaWAN.h:522
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition Module.h:73
-
MorseClient
Client for Morse Code communication. The public interface is the same as Arduino Serial.
Definition Morse.h:93
+
MorseClient
Client for Morse Code communication. The public interface is the same as Arduino Serial.
Definition Morse.h:94
PagerClient
Client for Pager communication.
Definition Pager.h:62
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition PhysicalLayer.h:151
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:246
diff --git a/_s_x126x_8h_source.html b/_s_x126x_8h_source.html index fed5799b..3af2ab4a 100644 --- a/_s_x126x_8h_source.html +++ b/_s_x126x_8h_source.html @@ -654,9 +654,9 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
778
779 // configuration methods
780
-
786 int16_t setBandwidth(float bw);
+
786 virtual int16_t setBandwidth(float bw);
787
-
793 int16_t setSpreadingFactor(uint8_t sf);
+
793 virtual int16_t setSpreadingFactor(uint8_t sf);
794
800 int16_t setCodingRate(uint8_t cr);
801
@@ -915,7 +915,7 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
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:1565
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:1573
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:68
-
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:850
+
SX126x::setBandwidth
virtual 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:850
SX126x::readData
int16_t readData(uint8_t *data, size_t len) override
Reads data received after calling startReceive method. When the packet length is not known in advance...
Definition SX126x.cpp:750
SX126x::calibrateImage
int16_t calibrateImage(float freq)
Perform image rejection calibration for the specified frequency. Will try to use Semtech-defined pres...
Definition SX126x.cpp:1928
SX126x::explicitHeader
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition SX126x.cpp:1553
@@ -977,7 +977,7 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
SX126x::setDio2AsRfSwitch
int16_t setDio2AsRfSwitch(bool enable=true)
Set DIO2 to function as RF switch (default in Semtech example designs).
Definition SX126x.cpp:1810
SX126x::spectralScanGetResult
int16_t spectralScanGetResult(uint16_t *results)
Read the result of spectral scan.
Definition SX126x.cpp:1745
SX126x::setWhitening
int16_t setWhitening(bool enabled, uint16_t initial=0x01FF)
Sets FSK whitening parameters.
Definition SX126x.cpp:1321
-
SX126x::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition SX126x.cpp:901
+
SX126x::setSpreadingFactor
virtual int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition SX126x.cpp:901
SX126x::standbyXOSC
bool standbyXOSC
Whether to use XOSC (true) or RC (false) oscillator in standby mode. Defaults to false.
Definition SX126x.h:497
SX126x::setChannelScanAction
void setChannelScanAction(void(*func)(void)) override
Sets interrupt service routine to call when a channel scan is finished.
Definition SX126x.cpp:504
SX126x::setDataRate
int16_t setDataRate(DataRate_t dr) override
Set data.
Definition SX126x.cpp:1026
diff --git a/class_c_c1101-members.html b/class_c_c1101-members.html index 2814237b..c5ecf28b 100644 --- a/class_c_c1101-members.html +++ b/class_c_c1101-members.html @@ -178,7 +178,7 @@ $(document).ready(function(){initNavTree('class_c_c1101.html',''); initResizable 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 + setSyncWord(const uint8_t *syncWord, uint8_t len, uint8_t maxErrBits=0, bool requireCarrierSense=false)CC1101 PhysicalLayer::setSyncWord(uint8_t *sync, size_t len)PhysicalLayervirtual sleep() overrideCC1101virtual standby() overrideCC1101virtual diff --git a/class_c_c1101.html b/class_c_c1101.html index 8cbf9a6f..01ca3b4a 100644 --- a/class_c_c1101.html +++ b/class_c_c1101.html @@ -231,9 +231,9 @@ void clearGdo2Action ( int16_t setSyncWord (uint8_t syncH, uint8_t syncL, uint8_t maxErrBits=0, bool requireCarrierSense=false)  Sets 16-bit sync word as a two byte value.
  -int16_t setSyncWord (uint8_t *syncWord, uint8_t len, uint8_t maxErrBits=0, bool requireCarrierSense=false) - Sets 1 or 2 bytes of sync word.
-  +int16_t setSyncWord (const uint8_t *syncWord, uint8_t len, uint8_t maxErrBits=0, bool requireCarrierSense=false) + Sets 1 or 2 bytes of sync word.
+  int16_t setPreambleLength (uint8_t preambleLength, uint8_t qualityThreshold)  Sets preamble length.
  @@ -2143,8 +2143,8 @@ void dropSync ()<
- -

◆ setSyncWord() [1/2]

+ +

◆ setSyncWord() [1/2]

@@ -2152,7 +2152,7 @@ void dropSync ()< int16_t CC1101::setSyncWord ( - uint8_t *  + const uint8_t *  syncWord, diff --git a/class_c_c1101.js b/class_c_c1101.js index 9ae5908c..29eab493 100644 --- a/class_c_c1101.js +++ b/class_c_c1101.js @@ -52,7 +52,7 @@ var class_c_c1101 = [ "setRfSwitchPins", "class_c_c1101.html#a5ef45183690bb1879f106af079b01140", null ], [ "setRfSwitchTable", "class_c_c1101.html#a7b401995be4bc136063a035ce1820634", null ], [ "setRxBandwidth", "class_c_c1101.html#a381d0059d7a0ccd8a2f54d7d3376f9b6", null ], - [ "setSyncWord", "class_c_c1101.html#ab89b0932dbacadc34d049a2bd2292001", null ], + [ "setSyncWord", "class_c_c1101.html#a5345d819ea74f583e4e54f3496aa63eb", null ], [ "setSyncWord", "class_c_c1101.html#a433f1a40b33be6c84d3665a1b4cd57d6", null ], [ "sleep", "class_c_c1101.html#a0ead6224d4378274df465f779199bc92", null ], [ "standby", "class_c_c1101.html#a7612bf81e48086004c62548de2682266", null ], diff --git a/class_l_l_c_c68-members.html b/class_l_l_c_c68-members.html index b9dbb0d8..b2460e07 100644 --- a/class_l_l_c_c68-members.html +++ b/class_l_l_c_c68-members.html @@ -153,7 +153,7 @@ $(document).ready(function(){initNavTree('class_l_l_c_c68.html',''); initResizab reset(bool verify=true)SX126x scanChannel() overrideSX126xvirtual scanChannel(const ChannelScanConfig_t &config) overrideSX126xvirtual - setBandwidth(float bw)LLCC68 + setBandwidth(float bw) overrideLLCC68virtual setBitRate(float br) overrideSX126xvirtual setBroadcastAddress(uint8_t broadAddr)SX126x setChannelScanAction(void(*func)(void)) overrideSX126xvirtual @@ -188,7 +188,7 @@ $(document).ready(function(){initNavTree('class_l_l_c_c68.html',''); initResizab 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 + setSpreadingFactor(uint8_t sf) overrideLLCC68virtual 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 diff --git a/class_l_l_c_c68.html b/class_l_l_c_c68.html index 58822fd9..8331b2ad 100644 --- a/class_l_l_c_c68.html +++ b/class_l_l_c_c68.html @@ -121,12 +121,12 @@ Public Member Functions 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 pwr=10, uint16_t preambleLength=8, float tcxoVoltage=0, bool useRegulatorLDO=false)  Initialization method for LoRa modem.
  -int16_t setBandwidth (float bw) - Sets LoRa bandwidth. Allowed values are 125.0, 250.0 and 500.0 kHz.
-  -int16_t setSpreadingFactor (uint8_t sf) - Sets LoRa spreading factor. Allowed values range from 5 to 11, depending on currently set spreading factor.
-  +int16_t setBandwidth (float bw) override + Sets LoRa bandwidth. Allowed values are 125.0, 250.0 and 500.0 kHz.
+  +int16_t setSpreadingFactor (uint8_t sf) override + Sets LoRa spreading factor. Allowed values range from 5 to 11, depending on currently set spreading factor.
+  int16_t setDataRate (DataRate_t dr) override  Set data.
  @@ -268,12 +268,6 @@ void clearDio1Action ( int16_t getChannelScanResult () override  Read the channel scan result.
  -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.0, 250.0 and 500.0 kHz.
-  -int16_t setSpreadingFactor (uint8_t sf) - Sets LoRa spreading factor. Allowed values range from 5 to 12.
-  int16_t setCodingRate (uint8_t cr)  Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
  @@ -687,11 +681,14 @@ bool standbyXOSC<
- -

◆ setBandwidth()

+ +

◆ setBandwidth()

+ + + + + +
@@ -701,6 +698,11 @@ bool <
int16_t LLCC68::setBandwidth standbyXOSC
+ 		+overridevirtual

Sets LoRa bandwidth. Allowed values are 125.0, 250.0 and 500.0 kHz.

@@ -712,6 +714,8 @@ bool standbyXOSC<
Returns
Status Codes
+

Reimplemented from SX126x.

+
@@ -788,11 +792,14 @@ bool standbyXOSC< - -

◆ setSpreadingFactor()

+ +

◆ setSpreadingFactor()

+ + + + + +
@@ -802,6 +809,11 @@ bool <
int16_t LLCC68::setSpreadingFactor standbyXOSC
+ 		+overridevirtual

Sets LoRa spreading factor. Allowed values range from 5 to 11, depending on currently set spreading factor.

@@ -813,6 +825,8 @@ bool standbyXOSC<
Returns
Status Codes
+

Reimplemented from SX126x.

+
The documentation for this class was generated from the following files: