|
| SX1261 (Module *mod) |
| Default constructor. More...
|
|
int16_t | setOutputPower (int8_t power) |
| Sets output power. Allowed values are in range from -17 to 14 dBm. More...
|
|
| SX1262 (Module *mod) |
| Default constructor. More...
|
|
int16_t | begin (float freq=434.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=SX126X_SYNC_WORD_PRIVATE, int8_t power=14, float currentLimit=60.0, uint16_t preambleLength=8, float tcxoVoltage=1.6, bool useRegulatorLDO=false) |
| Initialization method for LoRa modem. More...
|
|
int16_t | beginFSK (float freq=434.0, float br=48.0, float freqDev=50.0, float rxBw=156.2, int8_t power=14, float currentLimit=60.0, uint16_t preambleLength=16, float dataShaping=0.5, float tcxoVoltage=1.6, bool useRegulatorLDO=false) |
| Initialization method for FSK modem. More...
|
|
int16_t | setFrequency (float freq, bool calibrate=true) |
| Sets carrier frequency. Allowed values are in range from 150.0 to 960.0 MHz. More...
|
|
int16_t | setOutputPower (int8_t power) |
| Sets output power. Allowed values are in range from -17 to 22 dBm. More...
|
|
| SX126x (Module *mod) |
| Default constructor. More...
|
|
int16_t | begin (float bw, uint8_t sf, uint8_t cr, uint8_t syncWord, float currentLimit, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO=false) |
| Initialization method for LoRa modem. More...
|
|
int16_t | beginFSK (float br, float freqDev, float rxBw, float currentLimit, uint16_t preambleLength, float dataShaping, float tcxoVoltage, bool useRegulatorLDO=false) |
| Initialization method for FSK modem. More...
|
|
int16_t | reset (bool verify=true) |
| Reset method. Will reset the chip to the default state using RST pin. More...
|
|
int16_t | transmit (uint8_t *data, size_t len, uint8_t addr=0) |
| Blocking binary transmit method. Overloads for string-based transmissions are implemented in PhysicalLayer. More...
|
|
int16_t | receive (uint8_t *data, size_t len) |
| Blocking binary receive method. Overloads for string-based transmissions are implemented in PhysicalLayer. More...
|
|
int16_t | transmitDirect (uint32_t frf=0) |
| Starts direct mode transmission. More...
|
|
int16_t | receiveDirect () |
| Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does not support direct mode reception. Will always return ERR_UNKNOWN. More...
|
|
int16_t | scanChannel () |
| 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. More...
|
|
int16_t | standby () |
| Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator). More...
|
|
int16_t | standby (uint8_t mode) |
| Sets the module to standby mode. More...
|
|
void | setDio1Action (void(*func)(void)) |
| Sets interrupt service routine to call when DIO1 activates. More...
|
|
void | clearDio1Action () |
| Clears interrupt service routine to call when DIO1 activates.
|
|
int16_t | startTransmit (uint8_t *data, size_t len, uint8_t addr=0) |
| Interrupt-driven binary transmit method. Overloads for string-based transmissions are implemented in PhysicalLayer. More...
|
|
int16_t | startReceive (uint32_t timeout=SX126X_RX_TIMEOUT_INF) |
| Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
|
int16_t | startReceiveDutyCycle (uint32_t rxPeriod, uint32_t sleepPeriod) |
| Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen. Note that this function assumes the unit will take 500us + TCXO_delay to change state. See datasheet section 13.1.7, version 1.2. More...
|
|
int16_t | startReceiveDutyCycleAuto (uint16_t senderPreambleLength=0, uint16_t minSymbols=8) |
| Calls startReceiveDutyCycle with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages. More...
|
|
int16_t | readData (uint8_t *data, size_t len) |
| Reads data received after calling startReceive method. More...
|
|
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. More...
|
|
int16_t | setSpreadingFactor (uint8_t sf) |
| Sets LoRa spreading factor. Allowed values range from 5 to 12. More...
|
|
int16_t | setCodingRate (uint8_t cr) |
| Sets LoRa coding rate denominator. Allowed values range from 5 to 8. More...
|
|
int16_t | setSyncWord (uint8_t syncWord, uint8_t controlBits=0x44) |
| Sets LoRa sync word. More...
|
|
int16_t | setCurrentLimit (float currentLimit) |
| Sets current protection limit. Can be set in 0.25 mA steps. More...
|
|
float | getCurrentLimit () |
| Reads current protection limit. More...
|
|
int16_t | setPreambleLength (uint16_t preambleLength) |
| Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535. More...
|
|
int16_t | setFrequencyDeviation (float freqDev) |
| Sets FSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz. More...
|
|
int16_t | setBitRate (float br) |
| Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps. More...
|
|
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.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. More...
|
|
int16_t | setDataShaping (float sh) |
| Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are 0.3, 0.5, 0.7 and 1.0. Set to 0 to disable shaping. More...
|
|
int16_t | setSyncWord (uint8_t *syncWord, uint8_t len) |
| Sets FSK sync word in the form of array of up to 8 bytes. More...
|
|
int16_t | setSyncBits (uint8_t *syncWord, uint8_t bitsLen) |
| Sets FSK sync word in the form of array of up to 8 bytes. More...
|
|
int16_t | setNodeAddress (uint8_t nodeAddr) |
| Sets node address. Calling this method will also enable address filtering for node address only. More...
|
|
int16_t | setBroadcastAddress (uint8_t broadAddr) |
| Sets broadcast address. Calling this method will also enable address filtering for node and broadcast address. More...
|
|
int16_t | disableAddressFiltering () |
| Disables address filtering. Calling this method will also erase previously set addresses. More...
|
|
int16_t | setCRC (uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true) |
| Sets CRC configuration. More...
|
|
int16_t | setWhitening (bool enabled, uint16_t initial=0x0100) |
| Sets FSK whitening parameters. More...
|
|
int16_t | setTCXO (float voltage, uint32_t delay=5000) |
| Sets TCXO (Temperature Compensated Crystal Oscillator) configuration. More...
|
|
int16_t | setDio2AsRfSwitch (bool enable=true) |
| Set DIO2 to function as RF switch (default in Semtech example designs). More...
|
|
float | getDataRate () |
| Gets effective data rate for the last transmitted packet. The value is calculated only for payload bytes. More...
|
|
float | getRSSI () |
| Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. More...
|
|
float | getSNR () |
| Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. More...
|
|
size_t | getPacketLength (bool update=true) |
| Query modem for the packet length of received payload. More...
|
|
int16_t | fixedPacketLengthMode (uint8_t len=SX126X_MAX_PACKET_LENGTH) |
| Set modem in fixed packet length mode. Available in FSK mode only. More...
|
|
int16_t | variablePacketLengthMode (uint8_t maxLen=SX126X_MAX_PACKET_LENGTH) |
| Set modem in variable packet length mode. Available in FSK mode only. More...
|
|
uint32_t | getTimeOnAir (size_t len) |
| Get expected time-on-air for a given size of payload. More...
|
|
int16_t | implicitHeader (size_t len) |
| Set implicit header mode for future reception/transmission. More...
|
|
int16_t | explicitHeader () |
| Set explicit header mode for future reception/transmission. More...
|
|
int16_t | setRegulatorLDO () |
| Set regulator mode to LDO. More...
|
|
int16_t | setRegulatorDCDC () |
| Set regulator mode to DC-DC. More...
|
|
int16_t | setEncoding (uint8_t encoding) |
| Sets transmission encoding. Available in FSK mode only. Serves only as alias for PhysicalLayer compatibility. More...
|
|
int16_t | transmit (__FlashStringHelper *fstr, uint8_t addr=0) |
| Arduino Flash String transmit method. More...
|
|
int16_t | transmit (String &str, uint8_t addr=0) |
| Arduino String transmit method. More...
|
|
int16_t | transmit (const char *str, uint8_t addr=0) |
| C-string transmit method. More...
|
|
virtual int16_t | transmit (uint8_t *data, size_t len, uint8_t addr=0)=0 |
| Binary transmit method. Must be implemented in module class. More...
|
|
int16_t | receive (String &str, size_t len=0) |
| Arduino String receive method. More...
|
|
virtual int16_t | receive (uint8_t *data, size_t len)=0 |
| Binary receive method. Must be implemented in module class. More...
|
|
int16_t | startTransmit (String &str, uint8_t addr=0) |
| Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
|
int16_t | startTransmit (const char *str, uint8_t addr=0) |
| Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
|
virtual int16_t | startTransmit (uint8_t *data, size_t len, uint8_t addr=0)=0 |
| Interrupt-driven binary transmit method. More...
|
|
int16_t | readData (String &str, size_t len=0) |
| Reads data that was received after calling startReceive method. More...
|
|
virtual int16_t | readData (uint8_t *data, size_t len)=0 |
| Reads data that was received after calling startReceive method. More...
|
|
| PhysicalLayer (float freqStep, size_t maxPacketLength) |
| Default constructor. More...
|
|
int16_t | transmit (__FlashStringHelper *fstr, uint8_t addr=0) |
| Arduino Flash String transmit method. More...
|
|
int16_t | transmit (String &str, uint8_t addr=0) |
| Arduino String transmit method. More...
|
|
int16_t | transmit (const char *str, uint8_t addr=0) |
| C-string transmit method. More...
|
|
int16_t | receive (String &str, size_t len=0) |
| Arduino String receive method. More...
|
|
int16_t | startTransmit (String &str, uint8_t addr=0) |
| Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
|
int16_t | startTransmit (const char *str, uint8_t addr=0) |
| Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
|
int16_t | readData (String &str, size_t len=0) |
| Reads data that was received after calling startReceive method. More...
|
|
float | getFreqStep () |
| Gets the module frequency step size that was set in constructor. More...
|
|
|
int16_t | setTx (uint32_t timeout=0) |
|
int16_t | setRx (uint32_t timeout) |
|
int16_t | setCad () |
|
int16_t | setPaConfig (uint8_t paDutyCycle, uint8_t deviceSel, uint8_t hpMax=SX126X_PA_CONFIG_HP_MAX, uint8_t paLut=SX126X_PA_CONFIG_PA_LUT) |
|
int16_t | writeRegister (uint16_t addr, uint8_t *data, uint8_t numBytes) |
|
int16_t | readRegister (uint16_t addr, uint8_t *data, uint8_t numBytes) |
|
int16_t | writeBuffer (uint8_t *data, uint8_t numBytes, uint8_t offset=0x00) |
|
int16_t | readBuffer (uint8_t *data, uint8_t numBytes) |
|
int16_t | setDioIrqParams (uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask=SX126X_IRQ_NONE, uint16_t dio3Mask=SX126X_IRQ_NONE) |
|
uint16_t | getIrqStatus () |
|
int16_t | clearIrqStatus (uint16_t clearIrqParams=SX126X_IRQ_ALL) |
|
int16_t | setRfFrequency (uint32_t frf) |
|
int16_t | calibrateImage (uint8_t *data) |
|
uint8_t | getPacketType () |
|
int16_t | setTxParams (uint8_t power, uint8_t rampTime=SX126X_PA_RAMP_200U) |
|
int16_t | setModulationParams (uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro=0xFF) |
|
int16_t | setModulationParamsFSK (uint32_t br, uint8_t pulseShape, uint8_t rxBw, uint32_t freqDev) |
|
int16_t | setPacketParams (uint16_t preambleLength, uint8_t crcType, uint8_t payloadLength, uint8_t headerType, uint8_t invertIQ=SX126X_LORA_IQ_STANDARD) |
|
int16_t | setPacketParamsFSK (uint16_t preambleLength, uint8_t crcType, uint8_t syncWordLength, uint8_t addrComp, uint8_t whitening, uint8_t packetType=SX126X_GFSK_PACKET_VARIABLE, uint8_t payloadLength=0xFF, uint8_t preambleDetectorLength=SX126X_GFSK_PREAMBLE_DETECT_16) |
|
int16_t | setBufferBaseAddress (uint8_t txBaseAddress=0x00, uint8_t rxBaseAddress=0x00) |
|
int16_t | setRegulatorMode (uint8_t mode) |
|
uint8_t | getStatus () |
|
uint32_t | getPacketStatus () |
|
uint16_t | getDeviceErrors () |
|
int16_t | clearDeviceErrors () |
|
int16_t | startReceiveCommon () |
|
int16_t | setFrequencyRaw (float freq) |
|
int16_t | setPacketMode (uint8_t mode, uint8_t len) |
|
int16_t | setHeaderType (uint8_t headerType, size_t len=0xFF) |
|
int16_t | fixSensitivity () |
|
int16_t | fixPaClamping () |
|
int16_t | fixImplicitTimeout () |
|
int16_t | fixInvertedIQ (uint8_t iqConfig) |
|