查看LoRa的源代码

== Overview ==

[[文件:LoRa-packet-structure.jpg | 800px]]

PS：可选报头固定CR = 4/8，代码配置的CR作用域是 Payload 和 Payload CRC


* 码片 (Chip): LoRa 信号的底层原始单位，通常比“码元”具有更高的时序分辨率。
* 码元 (Symbol): LoRa 中的一个传输单位，表示一个符号，每 2^SF 个码片组合成一个 码元 (Symbol)。一个码元 (Symbol) 携带 SF 个 bit。
* 编码速率 (Coding Rate):  用于FEC（前向纠错）。例如，4/5的编码速率意味着每传输5个比特，其中4个比特是实际数据，1个比特是纠错码。


LoRa 数据包前导码，用于接收机辩识 rx data flow。内容固定，长度可选。

默认 12 个 symbol, 0x8 (RegPreambleLsb) + 4

10 symbol 的短前导码，通信够用但具有更短的接收周期。。。

当前系统一般皆适用 12 (4 + 8) 的长度

=== 前导码 ===

目的是向接收方提供具有特性的可检查序列，以确定频率和同步。前导码由一定数量未经调制的码元和结束标记组成。其中结束标记长度固定为 4.25个码元，初始未经调制的码元长度可调，总前导码长度为 10~65535 个symbol 

接收机会周期地重启前导检测操作，所以需配置和发射机一样的前导码长度。如果不知道前导码长度或者可变的情况下，接收机需将前导码长度设置为最大。

'''同步字''':  这里是从不同文档中推导出来的，未直接从官方文档中找到确定的说明。 前导码中固定的 4.25 个码元就是同步字，Semtech 节点芯片SX126x/SX127x 都可通过寄存器配置不同的同步字，发射和接收双方的同步字需一致才能正常通信。

=== 可选报头 ===

该报头是可选的，如果使能，数据包就是显性数据包。报头包含两部分：Header和报头自身的CRC校验，固定以CR=4/8传输。

Header提供了如下信息：有效载荷字节数，编码速率CR，有效载荷CRC类型。

=== 有效载荷 ===

即实际用户需传输的数据，最大255字节。

=== 有效载荷CRC ===

可灵活选择多项式和初值。

=== 隐性数据包 ===

相比默认数据包，差别是不带显性报头部分。


<br>

== SDR inside ==

[[SDR]]

Semtech acquired the LoRa wireless technology through its acquisition of Cycleo SAS of Grenoble, France for $5M in 2012.

LoRa’s modulation format is best described as a “frequency modulated (FM) chirp.” The core IP that enables LoRa is the ability to generate a stable chirp using a frac-N phase lock loop (PLL). 

When processing a LoRa message, additional processing gain is achieved due to the modem’s ability to filter on the constant ramp chirp signal. This is how high sensitivity is achieved. 

In order to achieve “lock” to the LoRa signal, a long “constant chirp” preamble is transmitted:

[[文件:LoRa-Preamble-1.jpg]]

Once a LoRa modem has “locked” on to the preamble signal, the end of the preamble is signaled by the “reverse chirp” seen in Figure 1.

Then the data transmission begins, which has a series of “symbols” that function much like M-ARY FSK symbols, but instead happen on a chirp. See Figure 2

[[文件:LoRa-modulation-1.jpg]]

<br>

== LoRaWAN Settings ==

=== Uplink TX ===

[[文件:LoRaWAN-uplink-settins.png]]

<source lang=cpp>
void sx1278_lora_wan()
{
    sx1278_set_opmode(STANDBY);
    sx1278_set_rfmode(LORA);

    sx1278_write_reg(REG_PARAMP, 0x08);       // set 50us PA ramp-up time

    #define FREQ_STEP   61.03515625
    /*
     * freq = (uint32_t)((double)434000000 / (double)FREQ_STEP)
     *      = 7094272 = 0x6C8000             // 434.0MHz
     *
     *  const uint32_t CH_00_433 = 0x6C5333; // 433.3MHz
     *  const uint32_t CH_01_433 = 0x6C6666; // 433.6MHz
     *  const uint32_t CH_02_433 = 0x6C7999; // 433.9MHz
     *  const uint32_t CH_03_433 = 0x6C9333; // 434.3MHz
     */
    sx1278_write_reg(REG_FRFMSB, 0x6C);
    sx1278_write_reg(REG_FRFMID, 0x93);
    sx1278_write_reg(REG_FRFLSB, 0x33);

    sx1278_write_reg(REG_MODEMCONFIG1, 0x72);       // 125KHz, 4/5, Explicit Header
    sx1278_write_reg(REG_MODEMCONFIG2, 0xC4);       // SF=12, TxContin single pkt, crc on, RX timeout msb -> 0x0
    sx1278_write_reg(REG_MODEMCONFIG3, 0x0C);       // low data rate optimization

    sx1278_write_reg(REG_SYNCWORD, 0x34);

    sx1278_write_reg(REG_OCP, 0x20 | 0x1B);   // 240mA
    sx1278_write_reg(REG_PACONFIG, 0x8F);   // select PA_BOOST pin, Output power is limited to +20 dBm (100mW)
}
</source>

<br><br>

=== BaseStation RX ===

[[文件:LoRaWAN-downlink-settings.png]]


* Reg_LNA = 0x23

http://www.semtech.com/images/datasheet/SX1272_settings_for_LoRaWAN_v2.0.pdf

<br><br>

== Notes  ==

* U, Voltage, 0x00
* T, Temperature, 0x01
* H, Humidy, 0x02
* L, Light, 0x03
* P, Pressure, 0x04
* Q, Flow Rate, 0x05
* V, Velocity, 0x06


* W, Water, 0x07
* D, Door, 0x08


* CH4, CH4, 0x10
* CO2, CO2, 0x11
* G, GPS, 0x20


* [[SX127x]]
* [[LoRaWAN]]
* [[Antenna]]
* [[Raspberry#Reference]]

<br>

== Key Concepts ==

=== Spreading Factor ===

[[文件:Sx1278-spreading-factor.png]]


'''Note:'''

The Spreading Factor must be known in advance on both transmit and receive sides of the link as different spreading factors are orthogonal to each other


Spreading Factor 6:

* Set Spreading Factor = 6 in Reg_ModemConfig2
* The head must be set to Implicit mode (Reg_ModemConfig1[0] := 1)
* Set the DetectionOptimize of Reg_LoRaDetectOptimize to value '0b101'
* Write 0x0C in the RegDetectionThreshold


<source lang=cpp>
void sx1278_set_spread_fact(uint8_t factor)
{
    uint8_t d;
    d = sx1278_read_reg(REG_MODEMCONFIG2);
    d = (d & MODEMCONFIG2_SF_MASK) | (factor << 4);
    sx1278_write_reg(REG_MODEMCONFIG2, d);

    if (factor == 6) {
        sx1278_write_reg(REG_DETECTIONOPTIMIZE, 0x5);                                       
        sx1278_write_reg(REG_DETECTIONTHRESHOLD, 0xC);                                      
    } else {
        sx1278_write_reg(REG_DETECTIONOPTIMIZE, 0x3);
        sx1278_write_reg(REG_DETECTIONTHRESHOLD, 0xA);                                      
    }
}

/* Reg_ModemConfig1[0] */
void sx1278_set_head_on(bool enable)
{
    uint8_t rxd;
    rxd = sx1278_read_reg(REG_MODEMCONFIG1);
    rxd = (rxd & MODEMCONFIG1_IMPLICITHEADER_MASK) | (enable);
    sx1278_write_reg(REG_MODEMCONFIG1, rxd);
}
</source>

<br>

=== Signal Bandwidth ===

[[文件:Sx1278-signal-bandwidth.png]]


* Reg_ModemConfig[7:4]
* In the lower band (169MHz), signal bandwidths 8 & 9 are not supported


'''Note:'''

The Spreading Factor must be known in advance on both transmit and receive sides of the link


<source lang=cpp>
/*
 * Lora band width 
 *   0: 7.8 kHz, 1: 10.4 kHz, 2: 15.6 kHz, 3: 20.8 kHz,
 *   4: 31.2 kHz,5: 41.6 kHz, 6: 62.5 kHz, 7: 125 kHz,
 *   8: 250 kHz, 9: 500 kHz, other: Reserved
*/
void sx1278_set_bandwidth(uint8_t bw)
{
    uint8_t d;
    d = sx1278_read_reg(REG_MODEMCONFIG1);
    d = (d & MODEMCONFIG1_BW_MASK) | (bw << 4);
    sx1278_write_reg(REG_MODEMCONFIG1, d);
}
</source>

<br>

=== Coding Rate ===

[[文件:Sx1278-coding-rate.png]]


* Reg_ModemConfig[3:1] 
* 1   --- >  4/5
* 2   --->   4/6
* 3   --->   4/7
* 4   --->   4/8


<source lang=cpp>
 /*
  * Lora Error Coding:
  *
  *   1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8
 */
void sx1278_set_error_coding(uint8_t value)
{   
    uint8_t d;
    d = sx1278_read_reg(REG_MODEMCONFIG1);
    d = (d & MODEMCONFIG1_CODINGRATE_MASK) | (value << 1);
    sx1278_write_reg(REG_MODEMCONFIG1, d);
}

/* Reg_ModemConfig2[2] */
void sx1278_set_crc_on(bool enable)
{
    uint8_t d;
    d = sx1278_read_reg(REG_MODEMCONFIG2);
    d = (d & MODEMCONFIG2_RXPAYLOADCRC_MASK) | (enable << 2);
    sx1278_write_reg(REG_MODEMCONFIG2, d);
}
</source>
 
<br><br>

== TX ==

* Static configuration registers can only be accessed in Sleep, Standby or FSTX mode
* The LoRa FIFO can only be filled in Standby mode
* Data TX is initiated by sending TX mode request
* Upon completion the TxDone interrupt is issued and the radio returns to Standby mode
* Following transmission the radio can be manually placed in Sleep mode or the FIFO refilled for subsequent TX operation


LoRa TX data FIFO filling:

* Set Reg_FifoAddrPtr to Reg_FifoTxBaseAddr
* Write PayloadLength bytes to the FIFO (Reg_Fifo)


Reg_Fifo 是 FIFO 的统一读写口，SPI 读写 Reg_Fifo，就会去 FIFO 内部地址为 Reg_FifoAddrPtr 的位置取放数据

TX_Modem 直接去 FIFO 地址为 Reg_FifoTxBaseAddr 的位置，取 PayloadLength 字节的数据

<br><br>

== TX Power ==

1. Set Reg_PaConfig[7:7] to select PA output pin

* 0 to select RFO pin, Output power is limited to +14 dBm (25mW)
* 1 to select PA_BOOST pin, Output power is limited to +20 dBm (100mW)


2. Set Reg_PaConfig[6:4] to select max output power

* Pmax = 10.8 + 0.6 * MaxPower [dBm], valide when user select the RFO pin as the output


3. Set Reg_PaConfig[3:0] to select OutputPower

* Pout = Pmax - (15 - OutputPower) if PaSelect = 1 (RFO pin)
* Pout = 17 - (15 - OutputPower) if PaSelect = 1 (PA_BOOST pin)


<source lang=cpp>
void sx1278_set_rf_maxpower()
{
    sx1278_write_reg(REG_PACONFIG, 0x8F);
}
</source>

<br><br>

== Schematics ==

=== inair4 ===

[[文件:Sx1276-sch.png | 1024px]]

http://modtronix.com/prod/imod/inair4/inair4_r1_sch.pdf

<br><br>

=== Official ===

==== Combined RFI and RFO, switchless (Ref design only) ====

[[文件:Sx1272-ref-combi-rxtx-switchless.png | 1024px]]

<br>

==== Combined RFI and RFO design ====

[[文件:Sx1272-ref-combi-rxtx.png | 1024px]]

<br>

==== Combined RFI and PA_BOOST design ====

[[文件:Sx1272-ref-combi-rxpaboost.png | 1024px]]


[[文件:Sx1272-bom.png | 1024px]]

<br><br>

== MCU Spec ==

[[文件:LoRaWAN-MCU-spec.png]]

<br><br>

== Chip ==

[[文件:SX1276-77-78-79 .png]]

<br>

=== Band ===

* Band 1 (HF): 862 (*779)  - 1020 (*960) MHz ---> SX1276/77/79
* Band 2 (LF): 410 - 525 (*480) MHz ---> SX1276/77/78/79
* Band 3 (LF): 137 - 175 (*160) MHz ---> SX1276/77/78/79


'''SX1279:''' 

* Band 1: 779 - 960 MHz
* Band 2: 410 - 480 MHz
* Band 3: 137 - 160 MHz

'''SX1278:'''

* Band 2 (LF): 410 - 525 MHz
* Band 3 (LF): 137 - 175 MHz

'''SX1276''':

* Band 1 (HF): 862 - 1020 MHz
* Band 2 (LF): 410 - 525 MHz
* Band 3 (LF): 137 - 175 MHz

<br>

=== SX1278 ===

* Low RX current of 9.9 mA, 200 nA register retention
* 168 dB maximum link budget
* +20 dBm - 100 mW constant RF output vs. V supply
* +14 dBm high efficiency PA
* Programmable bit rate up to 300 kbps
* High sensitivity: down to -148 dBm
* Power Supply: 1.8 ~ 3.7V (17dBm), 2.4 ~ 3.7V (20dBm)


* [http://www.semtech.com/images/datasheet/sx1276_77_78_79.pdf SX1278 Datasheet]

* http://www.semtech.com/wireless-rf/rf-transceivers/sx1278/
* http://www.semtech.com/images/datasheet/LoraLowEnergyDesign_STD.pdf
* http://www.semtech.com/images/datasheet/LoraDesignGuide_STD.pdf
* http://www.semtech.com/images/datasheet/AN1200.19_SX127x_RefDesign_STD.pdf
* http://www.semtech.com/images/datasheet/an120014-xo-guidance-lora-modulation.pdf

* [http://www.semtech.com/images/datasheet/SX1272_settings_for_LoRaWAN_v2.0.pdf Recommended SX1272 Settings for EU868 LoRaWAN Network Operation]

<br><br>

=== SX1301 ===

The SX1301 digital baseband chip is a massive digital signal processing engine specifically designed to offer breakthrough gateway capabilities in the ISM bands worldwide. It integrates the LORA concentrator IP.

[[文件:Sx1301-bd.gif]]


* Up to -142 dBm sensitivity with SX1257 or SX1255 Tx/Rx front-end
* -139.5 dBm with included ref design
* 70 dB CW interferer rejection at c1 MHz offset
* Able to operate with negative SNR
* CCR up to 9 dB
* Emulates 49x LoRa demodulators and 1x (G)FSK demodulator
* Dual digital Tx & Rx radio front-end interfaces
* 10 programmable parallel demodulation paths
* Dynamic data-rate adaptation (ADR)
* True antenna diversity or simultaneous dual-band operation


[http://www.semtech.com/images/datasheet/sx1301.pdf SX1301 Datasheet]

<br><br>

=== SX126x ===

* SX1262: （+22dBm）, 150-960 MHz (e.g. 430/490MHz, 868/915MHz), Rx Current 4.6mA, QFN 4x4mm
* SX1261: （+15dBm）, 150-960 MHz (e.g. 430/490MHz, 868/915MHz), Rx Current 4.6mA, QFN 4x4mm
* SX1268: （+22dBm）, 410-810 MHz, Rx Current 4.6mA, QFN 4x4mm


* 4.2 mA of active receive current consumption
* 25 mA TX @ 14dbm
* Programmable bit rate up to 62.5 kbps LoRa and 300 kbps FSK
* High sensitivity: down to -148 dBm


* https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1262

<br><br>

=== Sensors ===

* [http://wiki.jackslab.org/ADC#MCP3421 MCP3421]: 2.7V ~ 5.5V, 145 uA (Continuous Conversion) or 39 uA (One-Shot Conversion with 1 SPS)
* [https://www.sensirion.com/en/environmental-sensors/humidity-sensors/digital-humidity-sensors-for-various-applications/ SHT3x]: 2.15 ~ 5.5 V, 4.8µW (at 2.4 V, low repeatability, 1 measurement / s) ADDR: 0x44(LOW)/0x45(HIGH)


* [[SHT2x]]: 2.1 ~ 3.6 V, 3.2µW (at 8 bit, 1 measurement / s, ADDR: 0x40)
* [https://cdn-shop.adafruit.com/datasheets/TSL2561.pdf TSL2561]: 2.7 ~ 3.6V, 0.75 mW Typical, ADDR: 0x29(LOW)/0x39(FLOAT)/0x49(HIGH)
* [[BH1750]]: 2.4 - 3.6V, 120uA, powerdown current 1uA, ADDR: 0x5C(HIGH) / 0x23(LOW)
* [https://cdn-shop.adafruit.com/datasheets/BST-BMP180-DS000-09.pdf BMP180]: 1.8~3.6V, 5µA at 1 sample / sec. in standard mode, ADDR: 0x77
* [https://www.sparkfun.com/datasheets/Components/General/BST-BMP085-DS000-05.pdf BMP085]: 1.8~3.6V, 5µA at 1 sample / sec. in standard mode, ADDR: 0x77
* BME280, Addr: 0x76 (SDO Low) / 0x77 (SDO High)
* MAX44009, Addr: 0x96/0x97 (A0 High), 0x94/0x95 (A0 Low)


* GPS: 2.7 ~ 3.6V, BDS/GPS 双模连续运行：<23mA（@3.3V）, 待机 <10uA（@3.3V）
* SX1278: 1.8 ~ 3.7V (17dBm), 2.4 ~ 3.7V (20dBm)
* EFM32ZG: 1.98 ~ 3.8V，deep sleep < 1uA
* ATmega328p: 1.8 ~ 5.5V, deep sleep <  4.3uA
* [http://wiki.jackslab.org/Power AP2112]: Max 6.5V input, Low Quiescent Current: 55μA (Typ.), Low Standby Current: 0.01μA (Typ.) 

<br><br>

== Reference ==

* [[ZSL42x]]
* [[HC32L13x]]
* [[EFM32]]
* [[ASR650x]]
* [[STM8]]
* [[STM32]]
* [[SX127x]]
* [[SX126x]]



* http://www.semtech.com/wireless-rf/rf-transceivers/sx1272/
* http://cpham.perso.univ-pau.fr/LORA/RPIgateway.html

<br><br>
<br><br>