LoRa modulation compile configurations

Detailed Description

Macros

#define LORA_FREQUENCY_RESOLUTION_DEFAULT   (61.03515625)
 Frequency resolution in Hz.
 
#define CONFIG_LORA_PREAMBLE_LENGTH_DEFAULT   (8U)
 Preamble length, same for Tx and Rx. More...
 
#define CONFIG_LORA_SYMBOL_TIMEOUT_DEFAULT   (10U)
 Symbol timeout period in symbols. More...
 
#define CONFIG_LORA_BW_DEFAULT   (LORA_BW_125_KHZ)
 Set channel bandwidth. More...
 
#define CONFIG_LORA_SF_DEFAULT   (LORA_SF7)
 Set Spreading Factor (SF) More...
 
#define CONFIG_LORA_CR_DEFAULT   (LORA_CR_4_5)
 Set Coding Rate (CR) More...
 
#define CONFIG_LORA_IQ_INVERTED_DEFAULT
 Set this to 1 to enable inverted I/Q mode. More...
 
#define CONFIG_LORA_FREQUENCY_HOPPING_DEFAULT
 Set this to 1 to enable frequency hopping. More...
 
#define CONFIG_LORA_FREQUENCY_HOPPING_PERIOD_DEFAULT   (0U)
 Frequency hopping period in symbols. More...
 
#define CONFIG_LORA_FIXED_HEADER_LEN_MODE_DEFAULT
 Set this to 1 to enable fixed header length mode (implicit header) More...
 
#define LORA_PAYLOAD_CRC_ON_DEFAULT   (true)
 Enable/disable payload CRC, optional. More...
 
#define CONFIG_LORA_PAYLOAD_LENGTH_DEFAULT   (0U)
 Configure payload length. More...
 

Macro Definition Documentation

◆ CONFIG_LORA_BW_DEFAULT

#define CONFIG_LORA_BW_DEFAULT   (LORA_BW_125_KHZ)

Set channel bandwidth.

Configure the channel bandwidth. Refer to country specific regulation on channel usage to identify the correct bandwidth.

Definition at line 81 of file lora.h.

◆ CONFIG_LORA_CR_DEFAULT

#define CONFIG_LORA_CR_DEFAULT   (LORA_CR_4_5)

Set Coding Rate (CR)

Configure Coding Rate (CR). CR denotes the implementation of forward error correction (FEC). This may be done by encoding 4-bit data with redundancies into 5-bit, 6-bit, 7-bit, or 8-bit. Coding Rate (CR) value need to be adjusted according to conditions of the channel used for data transmission. If there are too many interferences in the channel, then it’s recommended to increase the value of CR. However, the rise in CR value will also increase the duration for the transmission. Refer to country specific air time usage regulations before varying the CR. To calculate air time refer https://www.loratools.nl/#/airtime .

Definition at line 137 of file lora.h.

◆ CONFIG_LORA_FIXED_HEADER_LEN_MODE_DEFAULT

#define CONFIG_LORA_FIXED_HEADER_LEN_MODE_DEFAULT

Set this to 1 to enable fixed header length mode (implicit header)

If fixed header length mode ( implicit header mode) is enabled, PHY header (PHDR) in LoRa frame is discarded. For more information, refer to the section "LoRa frame structure" in this publication

Definition at line 177 of file lora.h.

◆ CONFIG_LORA_FREQUENCY_HOPPING_DEFAULT

#define CONFIG_LORA_FREQUENCY_HOPPING_DEFAULT

Set this to 1 to enable frequency hopping.

If Frequency hopping spread spectrum (FHSS) is enabled a portion of each LoRa packet is transmitted on each hopping channel from a look up table of frequencies managed by the host microcontroller.

Definition at line 156 of file lora.h.

◆ CONFIG_LORA_FREQUENCY_HOPPING_PERIOD_DEFAULT

#define CONFIG_LORA_FREQUENCY_HOPPING_PERIOD_DEFAULT   (0U)

Frequency hopping period in symbols.

Configure the hopping period, in symbols, time which each transmission will dwell in any given channel. One symbol has a length in time of (2^SF)/BW seconds.

Definition at line 166 of file lora.h.

◆ CONFIG_LORA_IQ_INVERTED_DEFAULT

#define CONFIG_LORA_IQ_INVERTED_DEFAULT

Set this to 1 to enable inverted I/Q mode.

Enable this to invert the IQ signals used in RF modulation circuit. For more information on I/Q modulation technique visit http://www.ni.com/tutorial/4805/en/

Definition at line 146 of file lora.h.

◆ CONFIG_LORA_PAYLOAD_LENGTH_DEFAULT

#define CONFIG_LORA_PAYLOAD_LENGTH_DEFAULT   (0U)

Configure payload length.

Configure the length of payload. The configuration is unused when using explicit header mode ( CONFIG_LORA_FIXED_HEADER_LEN_MODE_DEFAULT ) as PHDR carries the length information.

Definition at line 200 of file lora.h.

◆ CONFIG_LORA_PREAMBLE_LENGTH_DEFAULT

#define CONFIG_LORA_PREAMBLE_LENGTH_DEFAULT   (8U)

Preamble length, same for Tx and Rx.

Configure preamble used in LoRa frame. Each LoRa frame begins with a preamble. It starts with a series of upchirps to cover the whole frequency band of the particular channel assigned. The last two upchirps encode the sync word. Sync word is used to differentiate between LoRa transmissions that use the same frequency bands. The sync word is followed by two and a quarter downchirps, for a duration of 2.25 symbols. The total duration of this preamble can be configured between 10.25 and 65,539.25 symbol hence the value can range from 8 to 65537.

Definition at line 55 of file lora.h.

◆ CONFIG_LORA_SF_DEFAULT

#define CONFIG_LORA_SF_DEFAULT   (LORA_SF7)

Set Spreading Factor (SF)

Configure Spreading Factor (SF). SF denotes the amount of spreading code applied to the original data signal. A larger SF increases the time on air, which increases energy consumption, reduces the data rate, and improves communication range. Each step up in spreading factor effectively doubles the time on air to transmit the same amount of data. Refer to country specific air time usage regulations before varying the SF. To calculate air time refer https://www.loratools.nl/#/airtime .

Definition at line 111 of file lora.h.

◆ CONFIG_LORA_SYMBOL_TIMEOUT_DEFAULT

#define CONFIG_LORA_SYMBOL_TIMEOUT_DEFAULT   (10U)

Symbol timeout period in symbols.

Configure symbol time out in terms of number of symbols. One symbol has a length in time of (2^SF)/BW seconds.

Definition at line 64 of file lora.h.

◆ LORA_PAYLOAD_CRC_ON_DEFAULT

#define LORA_PAYLOAD_CRC_ON_DEFAULT   (true)

Enable/disable payload CRC, optional.

Deprecated:
Use inverse CONFIG_LORA_PAYLOAD_CRC_OFF_DEFAULT instead. Will be removed after 2021.04 release.

Definition at line 189 of file lora.h.