LoRa Configuration
The LoRa config options are: Region, Modem Preset, Max Hops, Transmit Power, Bandwidth, Spread Factor, Coding Rate, Frequency Offset, Transmit Enabled, Channel Number, Ignore Incoming Array, Override Duty Cycle Limit, SX126x RX Boosted Gain, and Override Frequency. LoRa config uses an admin message sending a Config.LoRa
protobuf.
In order to communicate fully, devices within a mesh must have identical settings for Region and Modem Preset, or identical custom Modem settings.
LoRa Config Values
You must set your device's lora.region
setting. This will ensure that you are operating within the legal limits for your area.
Region
Sets the region for your node. Default is unset
. As long as this is not set, the node screen will display a message and not transmit any packets.
Region Code | Description |
---|---|
UNSET | Unset |
US | United States |
EU_433 | European Union 433MHz |
EU_868 | European Union 868MHz |
CN | China |
JP | Japan |
ANZ | Australia & New Zealand |
KR | Korea |
TW | Taiwan |
RU | Russia |
IN | India |
NZ_865 | New Zealand 865MHz |
UA_433 | Ukraine 433MHz |
UA_868 | Ukraine 868MHz |
TH | Thailand |
LORA_24 | 2.4 GHz band worldwide |
EU_433 and EU_868 have to adhere to an hourly duty cycle limitation of 10%. Your device will stop transmitting if you reach it, until it is allowed again.
Modem Preset
Default is unset
which equates to LONG_FAST
. Presets are pre-defined modem settings (Bandwidth, Spread Factor, and Coding Rate) which influence both message speed and range. The default will provide a strong mixture of speed and range, for most users.
The presets are designed to provide further options for optimizing either speed (and reduced network congestion) or range, which can be useful for two real world scenarios:
- A high number of devices exist in the mesh, or messages are sent very frequently. Faster speeds (and therefore lower radio time per device) can help with mesh network congestion.
- Maximum range is desired, for long range scenarios where a several second delay in message receipt is acceptable (for instance, attempting to send messages from a town to a distant mountain top).
The Presets available are as follows, and follow a linear pattern of Fastest <--> Slowest, and Shortest <--> Longest range:
-
SHORT_FAST
(Fastest, highest bandwidth, lowest airtime, shortest range) -
SHORT_SLOW
-
MEDIUM_FAST
-
MEDIUM_SLOW
-
LONG_FAST
(Default) -
LONG_MODERATE
-
LONG_SLOW
-
VERY_LONG_SLOW
(Slowest, lowest bandwidth, highest airtime, longest range)
Max Hops
Maximum number of hops. This can't be greater than 7. Default is 3 which should be fine for most applications. Really, 3 is fine.
Transmit Power
If zero then, use default max legal continuous power (i.e. something that won't burn out the radio hardware)
In most cases you should use zero here. Units are in dBm.
Bandwidth
Certain bandwidth numbers are 'special' and will be converted by the device firmware to the appropriate floating point value:
Special Value | Interpreted As |
---|---|
31 | 31.25 kHz |
62 | 62.5 kHz |
200 | 203.125 kHz |
400 | 406.25 kHz |
800 | 812.5 kHz |
1600 | 1625.0 kHz |
Please be aware that values < 62.5kHz may require a TCXO on some hardware devices.
Spread Factor
A number from 7 to 12. Indicates the number of chirps per symbol as 1[<<]spread_factor.
Coding Rate
The denominator of the coding rate. ie for 4/5, the value is 5. 4/8 the value is 8.