LoRa Configuration

The LoRa config options are: Region, Modem Preset, Max Hops, Transmit Power, Bandwidth, Spread Factor, Coding Rate, Frequency Offset, Transmit Enabled, Frequency Slot, Ignore Incoming Array, Ignore MQTT, Override Duty Cycle Limit, SX126x RX Boosted Gain, and Override Frequency. LoRa config uses an admin message sending a Config.LoRa protobuf.

note

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

note

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	Frequency Range (MHz)	Duty Cycle (%)	Power Limit (dBm)
UNSET	Unset	N/A	N/A	N/A
US	United States	902.0 - 928.0	100	30
EU_433	European Union 433MHz	433.0 - 434.0	10	12
EU_868	European Union 868MHz	869.4 - 869.65	10	27
CN	China	470.0 - 510.0	100	19
JP	Japan	920.8 - 927.8	100	16
ANZ	Australia & New Zealand	915.0 - 928.0	100	30
KR	Korea	920.0 - 923.0	100
TW	Taiwan	920.0 - 925.0	100	27
RU	Russia	868.7 - 869.2	100	20
IN	India	865.0 - 867.0	100	30
NZ_865	New Zealand 865MHz	864.0 - 868.0	100	36
TH	Thailand	920.0 - 925.0	100	16
UA_433	Ukraine 433MHz	433.0 - 434.7	10	10
UA_868	Ukraine 868MHz	868.0 - 868.6	1	14
MY_433	Malaysia 433MHz	433.0 - 435.0	100	20
MY_919	Malaysia 919MHz	919.0 - 924.0	100	27
SG_923	Singapore 923MHz	917.0 - 925.0	100	20
LORA_24	2.4 GHz band worldwide	2400.0 - 2483.5	100	10

info

EU_433 and EU_868 have to adhere to an hourly duty cycle limitation of 10%, calculated every minute on a rolling 1-hour basis. 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:

1. 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.
2. 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:

1. SHORT_TURBO (Fastest, highest bandwidth, lowest airtime, shortest range. It is not legal to use in all regions due to it's 500kHz bandwidth.)

2. SHORT_FAST

3. SHORT_SLOW

4. MEDIUM_FAST

5. MEDIUM_SLOW

6. LONG_FAST (Default)

7. LONG_MODERATE

8. LONG_SLOW

9. VERY_LONG_SLOW (Slowest, lowest bandwidth, highest airtime, longest range. Not recommended for regular usage as does not form meshes well and is unreliable)

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.

Frequency Offset

This parameter is for advanced users with advanced test equipment, we do not recommend most users use it.

A frequency offset that is added to to the calculated band center frequency. Used to correct for crystal calibration errors.

Transmit Enabled

Allows you to enable and disable transmit (TX) from the LoRa radio. Useful for hot-swapping antennas and other tests.

Defaults to true

Frequency Slot

This setting controls the actual hardware frequency at which the radio transmits, represented by a frequency slot between 1 and NUM_SLOTS (the maximum for the current region and modem preset). If set to 0/UNSET, the device reverts to the older channel name hash-based algorithm for determining the frequency slot.

Ignore Incoming Array

For testing it is useful sometimes to force a node to never listen to particular other nodes (simulating radio out of range). All nodenums listed in the ignore_incoming array will have packets they send dropped on receive (by router.cpp)

Ignore MQTT

Setting this to option to 'true' means the device will ignore any messages it receives via LoRa that came via MQTT somewhere along the path towards the device. Note this only works when your device and the MQTT node are running at least firmware version 2.2.19.

OK to MQTT

Acceptable values: true, false

Default is false. When set to true, this configuration indicates that the user approves their packets to be uplinked to MQTT brokers. If set to false, nodes receiving your packets are requested not to forward packets to MQTT. This configuration only applies to Channels configured with the defaultpsk and eventpsk keys set in the Meshtastic Firmware; Channels with custom keys ignore this setting.

Important: This is not a cryptographic solution but a polite request that is enforced in the official firmware.

Override Duty Cycle Limit

Setting this option to 'true' means the device will ignore the hourly duty cycle limit in Europe. This means that you might violate regulations if the device transmits too much. By default, this option is set to 'false,' which means the device will stop sending data when it reaches the hourly limit and will start again when it is allowed to do so.

SX126x RX Boosted Gain

This is an option specific to the SX126x chip series which allows the chip to consume a small amount of additional power to increase RX sensitivity.

Override Frequency

This parameter is for advanced users and licensed HAM radio operators. When enabled, the channel calculation will be ignored, and the set frequency will be used instead (frequency_offset still applies). This will allow you to use out-of-band frequencies. Please respect your local laws and regulations. If you are a license HAM operator, make sure you enable HAM mode and turn off encryption.

LoRa Config Client Availability

Android

Android

info

LoRa Config options are available on Android.

1. Open the Meshtastic App
2. Navigate to: Vertical Ellipsis (3 dots top right) > Radio Configuration > LoRa

Apple

Apple

info

All LoRa config options are available on iOS, iPadOS and macOS at Settings > Radio Configuration > LoRa.

CLI

CLI

info

LoRa config commands are available in the python CLI. Example commands are below:

Setting	Acceptable Values	Default
lora.modem_preset	LONG_FAST, LONG_SLOW, VERY_LONG_SLOW, MEDIUM_SLOW, MEDIUM_FAST, SHORT_SLOW, SHORT_FAST, SHORT_TURBO	LONG_FAST
lora.use_preset	false, true	false
lora.region	UNSET, US, EU_433, EU_868, CN, JP, ANZ, KR, TW, RU ,IN, NZ_865, TH, LORA_24, UA_433, UA_868, MY_433, MY_919, SG_923	UNSET
lora.bandwidth	31, 62, 125, 250, 500	250
lora.spread_factor	7, 8, 9, 10, 11, 12	12
lora.coding_rate	5, 6, 7, 8	8
lora.frequency_offset	0 to 1000000	0
lora.hop_limit	1,2,3,4,5,6,7	3
lora.tx_power	0 to 30	0
lora.tx_enabled	false, true	true
lora.channel_num	0, 1 to NUM_CHANNELS	0
lora.ignore_mqtt	false, true	false
lora.config_ok_to_mqtt	true, false	false
lora.override_duty_cycle	false, true	false
lora.sx126x_rx_boosted_gain	false, true	false
lora.override_frequency	Any supported frequency the LoRA radio is capable of. Please respect local rules and regulations	0

tip

Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.

Example:

meshtastic --set lora.region US --set lora.modem_preset LONG_FAST

Set Modem Preset

meshtastic --set lora.modem_preset LONG_FAST
meshtastic --set lora.modem_preset MEDIUM_FAST

Set Region

meshtastic --set lora.region US
meshtastic --set lora.region EU_433

Set Hop Limit

meshtastic --set lora.hop_limit 2

Override Duty Cycle

meshtastic --set lora.override_duty_cycle true
meshtastic --set lora.override_duty_cycle false

Web

Web

info

All LoRa config options are available in the Web UI.