Type Alias Config_LoRaConfig

Type declaration

• bandwidth: number

  Bandwidth in MHz Certain bandwidth numbers are 'special' and will be converted to the appropriate floating point value: 31 -> 31.25MHz

  Generated

  from field: uint32 bandwidth = 3;

• channelNum: number

  This controls the actual hardware frequency the radio transmits on. Most users should never need to be exposed to this field/concept. A channel number between 1 and NUM_CHANNELS (whatever the max is in the current region). If ZERO then the rule is "use the old channel name hash based algorithm to derive the channel number") If using the hash algorithm the channel number will be: hash(channel_name) % NUM_CHANNELS (Where num channels depends on the regulatory region).

  Generated

  from field: uint32 channel_num = 11;

• codingRate: number

  The denominator of the coding rate. ie for 4/5, the value is 5. 4/8 the value is 8.

  Generated

  from field: uint32 coding_rate = 5;

• configOkToMqtt: boolean

  Sets the ok_to_mqtt bit on outgoing packets

  Generated

  from field: bool config_ok_to_mqtt = 105;

• frequencyOffset: number

  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.

  Generated

  from field: float frequency_offset = 6;

• hopLimit: number

  Maximum number of hops. This can't be greater than 7. Default of 3 Attempting to set a value > 7 results in the default

  Generated

  from field: uint32 hop_limit = 8;

• ignoreIncoming: number[]

  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 ignore_incoming will have packets they send dropped on receive (by router.cpp)

  Generated

  from field: repeated uint32 ignore_incoming = 103;

• ignoreMqtt: boolean

  If true, the device will not process any packets received via LoRa that passed via MQTT anywhere on the path towards it.

  Generated

  from field: bool ignore_mqtt = 104;

• modemPreset: Config_LoRaConfig_ModemPreset

  Either modem_config or bandwidth/spreading/coding will be specified - NOT BOTH. As a heuristic: If bandwidth is specified, do not use modem_config. Because protobufs take ZERO space when the value is zero this works out nicely. This value is replaced by bandwidth/spread_factor/coding_rate. If you'd like to experiment with other options add them to MeshRadio.cpp in the device code.

  Generated

  from field: meshtastic.Config.LoRaConfig.ModemPreset modem_preset = 2;

• overrideDutyCycle: boolean

  If true, duty cycle limits will be exceeded and thus you're possibly not following the local regulations if you're not a HAM. Has no effect if the duty cycle of the used region is 100%.

  Generated

  from field: bool override_duty_cycle = 12;

• overrideFrequency: number

  This parameter is for advanced users and licensed HAM radio operators. Ignore Channel Calculation and use this frequency instead. The frequency_offset will still be applied. This will allow you to use out-of-band frequencies. Please respect your local laws and regulations. If you are a HAM, make sure you enable HAM mode and turn off encryption.

  Generated

  from field: float override_frequency = 14;

• paFanDisabled: boolean

  If true, disable the build-in PA FAN using pin define in RF95_FAN_EN.

  Generated

  from field: bool pa_fan_disabled = 15;

• region: Config_LoRaConfig_RegionCode

  The region code for the radio (US, CN, EU433, etc...)

  Generated

  from field: meshtastic.Config.LoRaConfig.RegionCode region = 7;

• spreadFactor: number

  A number from 7 to 12. Indicates number of chirps per symbol as 1<<spread_factor.

  Generated

  from field: uint32 spread_factor = 4;

• sx126xRxBoostedGain: boolean

  If true, sets RX boosted gain mode on SX126X based radios

  Generated

  from field: bool sx126x_rx_boosted_gain = 13;

• txEnabled: boolean

  Disable TX from the LoRa radio. Useful for hot-swapping antennas and other tests. Defaults to false

  Generated

  from field: bool tx_enabled = 9;

• txPower: number

  If zero, then use default max legal continuous power (ie. something that won't burn out the radio hardware) In most cases you should use zero here. Units are in dBm.

  Generated

  from field: int32 tx_power = 10;

• usePreset: boolean

  When enabled, the modem_preset fields will be adhered to, else the bandwidth/spread_factor/coding_rate will be taked from their respective manually defined fields

  Generated

  from field: bool use_preset = 1;