Skip to main content

Module config

Module config 

Source
Expand description

The settings an SX126x is configured with, and the values its registers take.

Every value here comes from the SX1261/2 datasheet (Rev 2.2): the frequency word of section 13.4.1, the timeout steps of 13.1.4, the image calibration codes of 9.2.1, the LoRa modulation and packet parameters of 13.4.5 and 13.4.6, the power amplifier settings of 13.1.14 and 13.4.4, the sync words of Table 12-1, and the register values the chapter 15 workarounds write. The LoRa settings are built from a [LinkSettings], so a radio sends exactly the frames pamoja-lora computes the airtime of.

Modules§

register
The register addresses the driver reads and writes, from Table 12-1.

Structs§

LoraModulation
The LoRa parameters of a SetModulationParams command, from Tables 13-47 to 13-50.
LoraPacket
The LoRa parameters of a SetPacketParams command, from Tables 13-66 to 13-70.
PaConfig
The parameters of a SetPaConfig command, from Table 13-20.
TxPower
The amplifier configuration and power setting that produce an output power.

Enums§

CodingRate
A LoRa coding rate, from Table 13-49.
FallbackMode
The mode the chip returns to after a transmission or reception, from Table 13-23.
LoraBandwidth
A LoRa signal bandwidth, from Table 13-48.
PacketType
The modem a SetPacketType command selects, from Table 13-38.
PowerAmplifier
Which power amplifier a chip has.
RampTime
How long the power amplifier takes to ramp up, from Table 13-41.
RegulatorMode
How the chip regulates its supply, from Table 13-16.
StandbyMode
The standby mode a SetStandby command selects, from Table 13-4.
SyncWord
A LoRa sync word, written to the two sync word registers at 0x0740, from Table 12-1.
TcxoVoltage
The voltage DIO3 supplies a TCXO with, from Table 13-35.

Constants§

NO_TIMEOUT
The timeout word that disables a transmit or receive timeout.
RTC_STOP
The RTC control value that stops the timer, from section 15.3.
RX_CONTINUOUS
The receive timeout word that keeps the radio listening until told otherwise.
RX_GAIN_BOOSTED
The receive gain register value for boosted sensitivity, from Table 9-3.
RX_GAIN_POWER_SAVING
The receive gain register value for power saving, the default, from Table 9-3.
XTAL_HZ
The crystal frequency the synthesizer divides, in hertz.

Functions§

event_clear
Returns the event mask value that clears a pending RTC timeout, from section 15.3.
frequency_from_word
Returns the frequency a SetRfFrequency word selects.
frequency_word
Returns the word SetRfFrequency takes for a frequency.
image_calibration
Returns the two CalibrateImage codes that cover a band.
iq_polarity
Returns the IQ polarity register value for a polarity, from section 15.4.
llcc68_supports
Reports whether an LLCC68 can use a spreading factor at a bandwidth.
timeout_steps
Returns the 24-bit timeout word for a duration.
tx_clamp
Returns the TX clamp register value that resists antenna mismatch, from section 15.2.
tx_modulation
Returns the TX modulation register value for a transmission, from section 15.1.