1.. _lora_api:
2.. _lorawan_api:
3
4LoRa and LoRaWAN
5################
6
7Overview
8********
9
10LoRa (abbrev. for Long Range) is a proprietary low-power wireless
11communication protocol developed by the `Semtech Corporation`_.
12
13LoRa acts as the physical layer (PHY) based on the chirp spread spectrum
14(CSS) modulation technique.
15
16LoRaWAN (for Long Range Wide Area Network) defines a networking layer
17on top of the LoRa PHY.
18
19Zephyr provides APIs for LoRa to send raw data packets directly over the
20wireless interface as well as APIs for LoRaWAN to connect the end device
21to the internet through a gateway.
22
23The Zephyr implementation is based on Semtech's `LoRaMac-node library`_, which
24is included as a Zephyr module.
25
26The LoRaWAN specification is published by the `LoRa Alliance`_.
27
28.. _`Semtech Corporation`: https://www.semtech.com/
29
30.. _`LoRaMac-node library`: https://github.com/Lora-net/LoRaMac-node
31
32.. _`LoRa Alliance`: https://lora-alliance.org/
33
34Configuration Options
35*********************
36
37LoRa PHY
38========
39
40Related configuration options can be found under
41:zephyr_file:`drivers/lora/Kconfig`.
42
43* :kconfig:option:`CONFIG_LORA`
44
45* :kconfig:option:`CONFIG_LORA_SHELL`
46
47* :kconfig:option:`CONFIG_LORA_INIT_PRIORITY`
48
49LoRaWAN
50=======
51
52Related configuration options can be found under
53:zephyr_file:`subsys/lorawan/Kconfig`.
54
55* :kconfig:option:`CONFIG_LORAWAN`
56
57* :kconfig:option:`CONFIG_LORAWAN_SYSTEM_MAX_RX_ERROR`
58
59* :kconfig:option:`CONFIG_LORAMAC_REGION_AS923`
60
61* :kconfig:option:`CONFIG_LORAMAC_REGION_AU915`
62
63* :kconfig:option:`CONFIG_LORAMAC_REGION_CN470`
64
65* :kconfig:option:`CONFIG_LORAMAC_REGION_CN779`
66
67* :kconfig:option:`CONFIG_LORAMAC_REGION_EU433`
68
69* :kconfig:option:`CONFIG_LORAMAC_REGION_EU868`
70
71* :kconfig:option:`CONFIG_LORAMAC_REGION_KR920`
72
73* :kconfig:option:`CONFIG_LORAMAC_REGION_IN865`
74
75* :kconfig:option:`CONFIG_LORAMAC_REGION_US915`
76
77* :kconfig:option:`CONFIG_LORAMAC_REGION_RU864`
78
79API Reference
80*************
81
82LoRa PHY
83========
84
85.. doxygengroup:: lora_api
86
87LoRaWAN
88=======
89
90.. doxygengroup:: lorawan_api
91