From a805ecfb56d992e4f7988f5832dce297fd173cd7 Mon Sep 17 00:00:00 2001 From: jgromes Date: Wed, 19 Feb 2025 18:47:16 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=20cf776?= =?UTF-8?q?230a448faf7414f2809e12b95b68ada9014=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _c_c1101_8h_source.html | 72 ++++++++++++++++++++--------------------- 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/_c_c1101_8h_source.html b/_c_c1101_8h_source.html index 9a86eaad..8d2a8e73 100644 --- a/_c_c1101_8h_source.html +++ b/_c_c1101_8h_source.html @@ -824,61 +824,61 @@ $(document).ready(function(){initNavTree('_c_c1101_8h_source.html',''); initResi
1051#endif
Control class for CC1101 module.
Definition CC1101.h:528
void clearPacketReceivedAction() override
Clears interrupt service routine to call when a packet is received.
Definition CC1101.cpp:202
-
int16_t setFrequencyDeviation(float freqDev) override
Sets frequency deviation. Allowed values range from 1.587 to 380.8 kHz.
Definition CC1101.cpp:513
+
int16_t setFrequencyDeviation(float freqDev) override
Sets frequency deviation. Allowed values range from 1.587 to 380.8 kHz.
Definition CC1101.cpp:514
int16_t sleep() override
Sets the module to sleep mode.
Definition CC1101.cpp:121
-
void readBit(uint32_t pin) override
Function to read and process data bit in direct reception mode.
Definition CC1101.cpp:984
-
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition CC1101.cpp:802
-
uint8_t randomByte() override
Get one truly random byte from RSSI noise.
Definition CC1101.cpp:956
+
void readBit(uint32_t pin) override
Function to read and process data bit in direct reception mode.
Definition CC1101.cpp:985
+
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition CC1101.cpp:803
+
uint8_t randomByte() override
Get one truly random byte from RSSI noise.
Definition CC1101.cpp:957
void reset()
Reset method - resets the chip using manual reset sequence (without RESET pin).
Definition CC1101.cpp:23
int16_t transmitDirect(uint32_t frf=0) override
Starts synchronous direct mode transmission.
Definition CC1101.cpp:127
-
void setDirectAction(void(*func)(void)) override
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition CC1101.cpp:980
+
void setDirectAction(void(*func)(void)) override
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition CC1101.cpp:981
void clearPacketSentAction() override
Clears interrupt service routine to call when a packet is sent.
Definition CC1101.cpp:210
void setPacketReceivedAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is received.
Definition CC1101.cpp:198
-
int16_t getChipVersion()
Read version SPI register. Should return CC1101_VERSION_LEGACY (0x04) or CC1101_VERSION_CURRENT (0x14...
Definition CC1101.cpp:975
+
int16_t getChipVersion()
Read version SPI register. Should return CC1101_VERSION_LEGACY (0x04) or CC1101_VERSION_CURRENT (0x14...
Definition CC1101.cpp:976
void setPacketSentAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is sent.
Definition CC1101.cpp:206
-
int16_t setRxBandwidth(float rxBw)
Sets receiver bandwidth. Allowed values are 58, 68, 81, 102, 116, 135, 162, 203, 232,...
Definition CC1101.cpp:474
+
int16_t setRxBandwidth(float rxBw)
Sets receiver bandwidth. Allowed values are 58, 68, 81, 102, 116, 135, 162, 203, 232,...
Definition CC1101.cpp:475
int16_t packetMode()
Stops direct mode. It is required to call this method to switch from direct transmissions to packet-b...
Definition CC1101.cpp:183
-
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.
Definition CC1101.cpp:681
-
int16_t autoSetRxBandwidth()
calculates and sets Rx bandwidth based on the freq, baud and freq uncertainty. Reimplement of atlas0f...
Definition CC1101.cpp:495
-
int16_t disableSyncWordFiltering(bool requireCarrierSense=false)
Disable preamble and sync word filtering and generation.
Definition CC1101.cpp:849
+
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.
Definition CC1101.cpp:682
+
int16_t autoSetRxBandwidth()
calculates and sets Rx bandwidth based on the freq, baud and freq uncertainty. Reimplement of atlas0f...
Definition CC1101.cpp:496
+
int16_t disableSyncWordFiltering(bool requireCarrierSense=false)
Disable preamble and sync word filtering and generation.
Definition CC1101.cpp:850
int16_t transmit(const uint8_t *data, size_t len, uint8_t addr=0) override
Blocking binary transmit method. Overloads for string-based transmissions are implemented in Physical...
Definition CC1101.cpp:28
-
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_CC1101_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition CC1101.cpp:826
-
int16_t setDIOMapping(uint32_t pin, uint32_t value) override
Configure DIO pin mapping to get a given signal on a DIO pin (if available).
Definition CC1101.cpp:989
-
uint8_t getLQI() const
Gets LQI (Link Quality Indicator) of the last received packet.
Definition CC1101.cpp:798
-
int16_t setOutputPower(int8_t pwr) override
Sets output power. Allowed values are -30, -20, -15, -10, 0, 5, 7 or 10 dBm.
Definition CC1101.cpp:565
-
void setRfSwitchPins(uint32_t rxEn, uint32_t txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition CC1101.cpp:948
-
int16_t setCrcFiltering(bool enable=true)
Enable CRC filtering and generation.
Definition CC1101.cpp:854
-
int16_t setNodeAddress(uint8_t nodeAddr, uint8_t numBroadcastAddrs=0)
Sets node and broadcast addresses. Calling this method will also enable address filtering.
Definition CC1101.cpp:728
-
int16_t setBitRate(float br) override
Sets bit rate. Allowed values range from 0.025 to 600.0 kbps.
Definition CC1101.cpp:445
-
int16_t enableSyncWordFiltering(uint8_t maxErrBits=0, bool requireCarrierSense=false)
Enable sync word filtering and generation.
Definition CC1101.cpp:830
+
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_CC1101_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition CC1101.cpp:827
+
int16_t setDIOMapping(uint32_t pin, uint32_t value) override
Configure DIO pin mapping to get a given signal on a DIO pin (if available).
Definition CC1101.cpp:990
+
uint8_t getLQI() const
Gets LQI (Link Quality Indicator) of the last received packet.
Definition CC1101.cpp:799
+
int16_t setOutputPower(int8_t pwr) override
Sets output power. Allowed values are -30, -20, -15, -10, 0, 5, 7 or 10 dBm.
Definition CC1101.cpp:566
+
void setRfSwitchPins(uint32_t rxEn, uint32_t txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition CC1101.cpp:949
+
int16_t setCrcFiltering(bool enable=true)
Enable CRC filtering and generation.
Definition CC1101.cpp:855
+
int16_t setNodeAddress(uint8_t nodeAddr, uint8_t numBroadcastAddrs=0)
Sets node and broadcast addresses. Calling this method will also enable address filtering.
Definition CC1101.cpp:729
+
int16_t setBitRate(float br) override
Sets bit rate. Allowed values range from 0.025 to 600.0 kbps.
Definition CC1101.cpp:446
+
int16_t enableSyncWordFiltering(uint8_t maxErrBits=0, bool requireCarrierSense=false)
Enable sync word filtering and generation.
Definition CC1101.cpp:831
int16_t startTransmit(const uint8_t *data, size_t len, uint8_t addr=0) override
Interrupt-driven binary transmit method for packets less than 64 bytes. Method blocks for packets lon...
Definition CC1101.cpp:229
int16_t standby() override
Sets the module to standby mode.
Definition CC1101.cpp:97
-
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 CC1101.cpp:952
-
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 CC1101.cpp:364
-
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition CC1101.cpp:739
+
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 CC1101.cpp:953
+
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 CC1101.cpp:365
+
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition CC1101.cpp:740
void setGdo0Action(void(*func)(void), uint32_t dir)
Sets interrupt service routine to call when GDO0 activates.
Definition CC1101.cpp:190
int16_t receiveDirectAsync()
Starts asynchronous direct mode reception.
Definition CC1101.cpp:162
int16_t receiveDirect() override
Starts synchronous direct mode reception.
Definition CC1101.cpp:158
-
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER,...
Definition CC1101.cpp:924
-
int16_t checkOutputPower(int8_t power, int8_t *clipped) override
Check if output power is configurable. This method is needed for compatibility with PhysicalLayer::ch...
Definition CC1101.cpp:590
+
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER,...
Definition CC1101.cpp:925
+
int16_t checkOutputPower(int8_t power, int8_t *clipped) override
Check if output power is configurable. This method is needed for compatibility with PhysicalLayer::ch...
Definition CC1101.cpp:591
void clearGdo0Action()
Clears interrupt service routine to call when GDO0 activates.
Definition CC1101.cpp:194
-
float getRSSI() override
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. In direct or asynchronous...
Definition CC1101.cpp:778
-
int16_t getFrequencyDeviation(float *freqDev)
Gets frequency deviation.
Definition CC1101.cpp:540
-
int16_t setPromiscuousMode(bool enable=true, bool requireCarrierSense=false)
Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address,...
Definition CC1101.cpp:864
+
float getRSSI() override
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. In direct or asynchronous...
Definition CC1101.cpp:779
+
int16_t getFrequencyDeviation(float *freqDev)
Gets frequency deviation.
Definition CC1101.cpp:541
+
int16_t setPromiscuousMode(bool enable=true, bool requireCarrierSense=false)
Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address,...
Definition CC1101.cpp:865
void clearGdo2Action()
Clears interrupt service routine to call when GDO0 activates.
Definition CC1101.cpp:222
-
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_CC1101_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition CC1101.cpp:816
-
int16_t setFrequency(float freq) override
Sets carrier frequency. Allowed values are in bands 300.0 to 348.0 MHz, 387.0 to 464....
Definition CC1101.cpp:417
+
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_CC1101_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition CC1101.cpp:817
+
int16_t setFrequency(float freq) override
Sets carrier frequency. Allowed values are in bands 300.0 to 348.0 MHz, 387.0 to 464....
Definition CC1101.cpp:418
void setGdo2Action(void(*func)(void), uint32_t dir)
Sets interrupt service routine to call when GDO2 activates.
Definition CC1101.cpp:214
int16_t begin(float freq=RADIOLIB_CC1101_DEFAULT_FREQ, float br=RADIOLIB_CC1101_DEFAULT_BR, float freqDev=RADIOLIB_CC1101_DEFAULT_FREQDEV, float rxBw=RADIOLIB_CC1101_DEFAULT_RXBW, int8_t pwr=RADIOLIB_CC1101_DEFAULT_POWER, uint8_t preambleLength=RADIOLIB_CC1101_DEFAULT_PREAMBLELEN)
Initialization method.
Definition CC1101.cpp:11
-
int16_t setBitRateTolerance(uint8_t brt)
Sets bit rate tolerance in BSCFG register. Allowed values are 0:(0%), 1(3,125%), 2:(6,...
Definition CC1101.cpp:465
-
int16_t setDataShaping(uint8_t sh) override
Sets Gaussian filter bandwidth-time product that will be used for data shaping. Allowed value is RADI...
Definition CC1101.cpp:905
-
int16_t startReceive() override
Interrupt-driven receive method. GDO0 will be activated when full packet is received.
Definition CC1101.cpp:334
-
int16_t setPreambleLength(uint8_t preambleLength, uint8_t qualityThreshold)
Sets preamble length.
Definition CC1101.cpp:686
+
int16_t setBitRateTolerance(uint8_t brt)
Sets bit rate tolerance in BSCFG register. Allowed values are 0:(0%), 1(3,125%), 2:(6,...
Definition CC1101.cpp:466
+
int16_t setDataShaping(uint8_t sh) override
Sets Gaussian filter bandwidth-time product that will be used for data shaping. Allowed value is RADI...
Definition CC1101.cpp:906
+
int16_t startReceive() override
Interrupt-driven receive method. GDO0 will be activated when full packet is received.
Definition CC1101.cpp:335
+
int16_t setPreambleLength(uint8_t preambleLength, uint8_t qualityThreshold)
Sets preamble length.
Definition CC1101.cpp:687
int16_t receive(uint8_t *data, size_t len) override
Blocking binary receive method. Overloads for string-based transmissions are implemented in PhysicalL...
Definition CC1101.cpp:61
-
bool getPromiscuousMode()
Get whether the modem is in promiscuous mode: no packet filtering (e.g., no preamble,...
Definition CC1101.cpp:901
+
bool getPromiscuousMode()
Get whether the modem is in promiscuous mode: no packet filtering (e.g., no preamble,...
Definition CC1101.cpp:902
int16_t transmitDirectAsync(uint32_t frf=0)
Starts asynchronous direct mode transmission.
Definition CC1101.cpp:131
-
int16_t finishTransmit() override
Clean up after transmission is done.
Definition CC1101.cpp:312
-
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK.
Definition CC1101.cpp:749
+
int16_t finishTransmit() override
Clean up after transmission is done.
Definition CC1101.cpp:313
+
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK.
Definition CC1101.cpp:750
int16_t beginFSK4(float freq=RADIOLIB_CC1101_DEFAULT_FREQ, float br=RADIOLIB_CC1101_DEFAULT_BR, float freqDev=RADIOLIB_CC1101_DEFAULT_FREQDEV, float rxBw=RADIOLIB_CC1101_DEFAULT_RXBW, int8_t pwr=RADIOLIB_CC1101_DEFAULT_POWER, uint8_t preambleLength=RADIOLIB_CC1101_DEFAULT_PREAMBLELEN)
Initialization method for 4-FSK modulation.
Definition CC1101.cpp:17
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