From 6fb977bd9143f2b78ae8801623c1faee6befa4df Mon Sep 17 00:00:00 2001 From: LDannijs Date: Mon, 22 Apr 2024 16:25:14 +0200 Subject: [PATCH 1/3] doc: Add info links --- doc/content/lorawan/adaptive-data-rate/_index.md | 4 ++++ doc/content/lorawan/end-device-activation/index.md | 4 ++++ doc/content/lorawan/message-types/index.md | 4 ++++ doc/content/lorawan/regional-parameters/_index.md | 4 ++++ 4 files changed, 16 insertions(+) diff --git a/doc/content/lorawan/adaptive-data-rate/_index.md b/doc/content/lorawan/adaptive-data-rate/_index.md index 4c0b2abba6..bf4b3b2511 100644 --- a/doc/content/lorawan/adaptive-data-rate/_index.md +++ b/doc/content/lorawan/adaptive-data-rate/_index.md @@ -24,6 +24,10 @@ Mobile end devices should be able to detect when they are stationary for a longe ## ADR in The Things Stack +{{< info >}} +Check [The Things Stack documentation](https://www.thethingsindustries.com/docs/reference/adr/#how-adr-works) for more specifics on how ADR works on the Stack. +{{}} + To determine the optimal data rate, the network needs some measurements (uplink messages). Currently The Things Stack takes the 20 most recent uplinks, starting at the moment the ADR bit is set. These measurements contains the frame counter, signal-to-noise ratio (SNR) and number of gateways that received each uplink. When a device unsets the ADR bit (because it knows it is moving or it knows RF conditions are unstable), previous measurements are discarded. As soon as the ADR bit is set again, the network starts measuring again. For each of these measurements, we take the SNR of the best gateway, and we calculate the so-called "margin", which is the measured SNR minus the required SNR to demodulate a message given the data rate. This margin is used to determine how much we can increase the data rate or lower the transmit power. For example, when the network receives a message with data rate `SF12BW125` and SNR `5.0`, that message has a margin of 25 dB. This is a waste of valuable airtime and energy. If we would increase the data rate to `SF7BW125` we would still have a margin of 12.5 dB, but that would be many times more airtime- and energy efficient. We could even lower the transmit power to save even more energy and cause less interference. diff --git a/doc/content/lorawan/end-device-activation/index.md b/doc/content/lorawan/end-device-activation/index.md index 6c32dac9be..e4f1b45dd3 100644 --- a/doc/content/lorawan/end-device-activation/index.md +++ b/doc/content/lorawan/end-device-activation/index.md @@ -13,6 +13,10 @@ Every end device must be registered with a network before sending and receiving The join procedure for LoRaWAN 1.0.x and 1.1 is slightly different. The following two sections describe the join procedure for LoRaWAN 1.0.x and 1.1 separately. +{{< info >}} +For more information on the differences between OTAA and ABP, check the [The Things Stack documentation](https://www.thethingsindustries.com/docs/the-things-stack/concepts/data-formats/). +{{}} + ## Over The Air Activation in LoRaWAN 1.0.x In LoRaWAN 1.0.x, the join procedure requires two MAC messages to be exchanged between the end device and the Network Server: diff --git a/doc/content/lorawan/message-types/index.md b/doc/content/lorawan/message-types/index.md index 79399abbcb..9f4e307a9d 100644 --- a/doc/content/lorawan/message-types/index.md +++ b/doc/content/lorawan/message-types/index.md @@ -6,6 +6,10 @@ images: - payload.png --- +{{< info >}} +For information on The Things Stack's specific data formats, check [The Things Stack documentation](https://www.thethingsindustries.com/docs/the-things-stack/concepts/data-formats/). +{{}} + In this chapter, you will learn about different message types used in LoRaWAN 1.0.x and 1.1. These message types are used to transport MAC commands and application data. The Things Fundamentals Certification exam expects you should have basic knowledge on the following topics with regards to the message types: * Uplink and downlink messages. diff --git a/doc/content/lorawan/regional-parameters/_index.md b/doc/content/lorawan/regional-parameters/_index.md index 5030b42a44..16acd289f9 100644 --- a/doc/content/lorawan/regional-parameters/_index.md +++ b/doc/content/lorawan/regional-parameters/_index.md @@ -4,6 +4,10 @@ section: The Things Fundamentals weight: 40 --- +{{< info >}} +For information on the specific versions of the Regional Parameters check [The Things Stack documentation](https://www.thethingsindustries.com/docs/the-things-stack/concepts/spec-regional-parameters/). +{{}} + LoRaWAN operates in unlicensed radio spectrum. This means that anyone can use the radio frequencies without having to pay million dollar fees for transmission rights. It is similar to WiFi, which uses the 2.4GHz and 5GHz ISM bands worldwide. Anyone is allowed to set up WiFi routers and transmit WiFi signals without the need for a license or permit. LoRaWAN uses lower radio frequencies with a longer range. The fact that frequencies have a longer range also comes with more restrictions, that are often country-specific. This poses a challenge for LoRaWAN, as it strives to maintain uniformity across various regions of the world. As a result, LoRaWAN is specified for several bands within these regions. These bands are similar enough to support a region-agnostic protocol but entail various consequences for the implementation of backend systems. From 1f40d29500d3cd8a17743408edbc3633bac1bb3d Mon Sep 17 00:00:00 2001 From: LDannijs Date: Mon, 24 Jun 2024 09:24:21 +0200 Subject: [PATCH 2/3] doc: TTS tags --- doc/content/lorawan/adaptive-data-rate/_index.md | 2 +- doc/content/lorawan/end-device-activation/index.md | 2 +- doc/content/lorawan/message-types/index.md | 2 +- doc/content/lorawan/regional-parameters/_index.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/content/lorawan/adaptive-data-rate/_index.md b/doc/content/lorawan/adaptive-data-rate/_index.md index bf4b3b2511..3b8b408240 100644 --- a/doc/content/lorawan/adaptive-data-rate/_index.md +++ b/doc/content/lorawan/adaptive-data-rate/_index.md @@ -25,7 +25,7 @@ Mobile end devices should be able to detect when they are stationary for a longe ## ADR in The Things Stack {{< info >}} -Check [The Things Stack documentation](https://www.thethingsindustries.com/docs/reference/adr/#how-adr-works) for more specifics on how ADR works on the Stack. +Check [{{% tts %}} documentation](https://www.thethingsindustries.com/docs/reference/adr/#how-adr-works) for more specifics on how ADR works on the {{% tts %}}. {{}} To determine the optimal data rate, the network needs some measurements (uplink messages). Currently The Things Stack takes the 20 most recent uplinks, starting at the moment the ADR bit is set. These measurements contains the frame counter, signal-to-noise ratio (SNR) and number of gateways that received each uplink. When a device unsets the ADR bit (because it knows it is moving or it knows RF conditions are unstable), previous measurements are discarded. As soon as the ADR bit is set again, the network starts measuring again. diff --git a/doc/content/lorawan/end-device-activation/index.md b/doc/content/lorawan/end-device-activation/index.md index e4f1b45dd3..d57bbe8980 100644 --- a/doc/content/lorawan/end-device-activation/index.md +++ b/doc/content/lorawan/end-device-activation/index.md @@ -14,7 +14,7 @@ Every end device must be registered with a network before sending and receiving The join procedure for LoRaWAN 1.0.x and 1.1 is slightly different. The following two sections describe the join procedure for LoRaWAN 1.0.x and 1.1 separately. {{< info >}} -For more information on the differences between OTAA and ABP, check the [The Things Stack documentation](https://www.thethingsindustries.com/docs/the-things-stack/concepts/data-formats/). +For more information on the differences between OTAA and ABP, check the [{{% tts %}} documentation](https://www.thethingsindustries.com/docs/the-things-stack/concepts/data-formats/). {{}} ## Over The Air Activation in LoRaWAN 1.0.x diff --git a/doc/content/lorawan/message-types/index.md b/doc/content/lorawan/message-types/index.md index 9f4e307a9d..a630185796 100644 --- a/doc/content/lorawan/message-types/index.md +++ b/doc/content/lorawan/message-types/index.md @@ -7,7 +7,7 @@ images: --- {{< info >}} -For information on The Things Stack's specific data formats, check [The Things Stack documentation](https://www.thethingsindustries.com/docs/the-things-stack/concepts/data-formats/). +For information on {{% tts %}} specific data formats, check [{{% tts %}} documentation](https://www.thethingsindustries.com/docs/the-things-stack/concepts/data-formats/). {{}} In this chapter, you will learn about different message types used in LoRaWAN 1.0.x and 1.1. These message types are used to transport MAC commands and application data. The Things Fundamentals Certification exam expects you should have basic knowledge on the following topics with regards to the message types: diff --git a/doc/content/lorawan/regional-parameters/_index.md b/doc/content/lorawan/regional-parameters/_index.md index 16acd289f9..146ffd1da6 100644 --- a/doc/content/lorawan/regional-parameters/_index.md +++ b/doc/content/lorawan/regional-parameters/_index.md @@ -5,7 +5,7 @@ weight: 40 --- {{< info >}} -For information on the specific versions of the Regional Parameters check [The Things Stack documentation](https://www.thethingsindustries.com/docs/the-things-stack/concepts/spec-regional-parameters/). +For information on the specific versions of the Regional Parameters check [{{% tts %}} documentation](https://www.thethingsindustries.com/docs/the-things-stack/concepts/spec-regional-parameters/). {{}} LoRaWAN operates in unlicensed radio spectrum. This means that anyone can use the radio frequencies without having to pay million dollar fees for transmission rights. It is similar to WiFi, which uses the 2.4GHz and 5GHz ISM bands worldwide. Anyone is allowed to set up WiFi routers and transmit WiFi signals without the need for a license or permit. From 04a5b8053f95b8f38a4826126799f6ce0e8b1d31 Mon Sep 17 00:00:00 2001 From: LDannijs Date: Mon, 24 Jun 2024 09:32:16 +0200 Subject: [PATCH 3/3] doc: Add tts shortcode --- doc/layouts/shortcodes/tts.html | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/layouts/shortcodes/tts.html diff --git a/doc/layouts/shortcodes/tts.html b/doc/layouts/shortcodes/tts.html new file mode 100644 index 0000000000..59509549dd --- /dev/null +++ b/doc/layouts/shortcodes/tts.html @@ -0,0 +1 @@ +{{- printf "The Things Stack" -}} \ No newline at end of file