Skip to content

Commit 5d29b99

Browse files
nejraselimovicnejraselimovic
authored
doc: Remove unnecessary notes, remove old new-in-version tags (TheThingsIndustries#651)
1 parent 0d3c0a2 commit 5d29b99

136 files changed

Lines changed: 426 additions & 609 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎doc/content/devices/abp-vs-otaa/_index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ This section can help you understand the differences between ABP and OTAA activa
88

99
<!--more-->
1010

11-
{{< note >}} Learn more about device activation in general and details about OTAA and ABP flow in [The Things Network LoRaWAN documentation](https://www.thethingsnetwork.org/docs/lorawan/end-device-activation/). {{</ note >}}
11+
Learn more about device activation in general and details about OTAA and ABP flow in [The Things Network LoRaWAN documentation](https://www.thethingsnetwork.org/docs/lorawan/end-device-activation/).
1212

1313
A `DevEUI` is a 64-bit unique ID assigned to an end device by the manufacturer. This value is linked to the hardware and it cannot be altered.
1414

1515
Unlike `DevEUI`, which identifies an end device globally, a 32-bit `DevAddr` identifies the end device within the current network and all communication after joining the network is done with it. A `DevAddr` value consists of `NwkAddr` (end device address within network) prefixed by a `NwkID` (network identifier).
1616

17-
{{< note >}} `DevAddr` is not unique - multiple devices can have the same `DevAddr`. {{</ note >}}
17+
Please keep in mind that the `DevAddr` value is not unique - multiple devices can have the same `DevAddr`.
1818

1919
A `DevAddr` and session keys are assigned to an end device during a procedure called **activation**. LoRaWAN supports two modes of activating an end device: **ABP (Activation By Personalization)** and **OTAA (Over-The-Air Activation)**.
2020

‎doc/content/devices/adding-devices/_index.md‎

Lines changed: 23 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ In addition to the written instructions below, a video with instructions for add
3333

3434
To use the device repository, make sure the **From the LoRaWAN Device Repository** tab is selected. Then, select the **Brand**, **Model**, **Hardware Version**, **Software Version**, and **Region** for your device.
3535

36-
{{< note "If your device is not in the device repository, see [Manually Create End Device](#manually-create-end-device) below." />}}
36+
If your device is not in the device repository, see [Manually Create End Device](#manually-create-end-device) below.
3737

3838
{{< figure src="device-repo.png" alt="Creating a new device with the Device Repository" >}}
3939

@@ -53,11 +53,7 @@ For LoRaWAN version 1.1.x devices, you will also see a **NwkKey** field. If it i
5353

5454
{{< figure src="device-repo-settings.png" alt="Device information" >}}
5555

56-
Finally, give your device a unique **End device ID**, and click the **Register end device** button to create the end device.
57-
58-
{{< note >}}
59-
See [ID and EUI constraints]({{< ref "reference/id-eui-constraints" >}}) for guidelines about choosing a unique ID.
60-
{{</ note >}}
56+
Finally, give your device a unique **End device ID**, and click the **Register end device** button to create the end device. See [ID and EUI constraints]({{< ref "reference/id-eui-constraints" >}}) for guidelines about choosing a unique ID.
6157

6258
{{< figure src="device-repo-settings.png" alt="Device information" >}}
6359

@@ -113,21 +109,15 @@ If using an External Join Server, enter its address in the **Join Server** field
113109

114110
Over-the-Air-Activation (OTAA) is the secure, scalable way to activate LoRaWAN devices. All commercially available LoRaWAN devices support OTAA, and it is selected by default. If you are using a custom or DIY device, and cannot use OTAA, see the [Activation by Personalisation](#abp-devices) section.
115111

116-
{{< note >}}
117112
The example in this guide covers adding a device using [OTAA]({{< ref "reference/glossary#over-the-air-activation" >}}) (the most secure and preferred activation method) and [LoRaWAN version]({{< ref "reference/glossary#lorawan-version" >}}) MAC V1.0.2 (the most common LoRaWAN version, although newer versions are better and more secure). Names and keys may vary slightly for other versions, but the process is the same and any differences are noted.
118-
{{</ note >}}
119113

120114
Enter your **DevEUI**. This should be provided by your manufacturer for commercial devices. If your device is programmable, you may generate an EUI using the **Generate** button, and program it in your device.
121115

122116
Enter a **JoinEUI/AppEUI** if provided by your manufacturer. If your device is programmable, you may use the **Fill with zeros** button, and then program the same JoinEUI/AppEUI (`0000000000000000`) in the device.
123117

124118
If your manufacturer provides an **AppKey**, enter it. Otherwise, use the **Generate** button to create one, and program it in to your device.
125119

126-
Give your device a unique **End device ID**.
127-
128-
{{< note >}}
129-
See [ID and EUI constraints]({{< ref "reference/id-eui-constraints" >}}) for guidelines about choosing a unique ID.
130-
{{</ note >}}
120+
Give your device a unique **End device ID**. See [ID and EUI constraints]({{< ref "reference/id-eui-constraints" >}}) for guidelines about choosing a unique ID.
131121

132122
{{< figure src="manual-network-settings-otaa.png" alt="Manually create OTAA end device" >}}
133123

@@ -153,11 +143,7 @@ For LoRaWAN versions 1.0.x, generate an **AppSKey** and **NwkSKey** and program
153143

154144
For LoRaWAN versions 1.1.x, generate an **AppSKey**, **FNwkSIntKey**, **SNwkSIntKey**, and **NwkSEncKey**, and program them in your device.
155145

156-
Finally, give your device a unique **End device ID**.
157-
158-
{{< note >}}
159-
See [ID and EUI constraints]({{< ref "reference/id-eui-constraints" >}}) for guidelines about choosing a unique ID.
160-
{{</ note >}}
146+
Finally, give your device a unique **End device ID**. See [ID and EUI constraints]({{< ref "reference/id-eui-constraints" >}}) for guidelines about choosing a unique ID.
161147

162148
{{< figure src="manual-network-settings-abp.png" alt="Manually create OTAA end device" >}}
163149

@@ -208,15 +194,17 @@ $ ttn-lw-cli end-devices create app1 dev1 \
208194
--lorawan-phy-version 1.0.3-a
209195
```
210196

211-
This will create a LoRaWAN 1.0.3 end device `dev1` in application `app1` with the `EU_863_870` frequency plan.
197+
This will create a LoRaWAN 1.0.3 end device `dev1` in application `app1` with the `EU_863_870` frequency plan. Please note that the `AppEUI` is returned as `join_eui` ({{% tts %}} uses LoRaWAN 1.1 terminology).
212198

213-
The end device should now be able to join the private network.
199+
{{< note >}} If you do not have a `JoinEUI` or `AppEUI`, you could use `0000000000000000`.
214200

215-
{{< note >}} If you do not have a `JoinEUI` or `AppEUI`, it is okay to use `0000000000000000`. Be sure to use the same `JoinEUI` in your device as you enter in {{% tts %}}. {{</ note >}}
201+
Some devices do not support using `0000000000000000` as a JoinEUI/AppEUI, because technically, this value is invalid. However, {{% tts %}} supports using this value to indicate the absence of an actual JoinEUI/AppEUI.
216202

217-
{{< note >}} The `AppEUI` is returned as `join_eui` ({{% tts %}} uses LoRaWAN 1.1 terminology). {{</ note >}}
203+
If your device gives an error when using `0000000000000000`, try using the DevEUI value as a JoinEUI/AppEUI, both in {{% tts %}} and on your device. {{</ note >}}
204+
205+
You can also pass `--with-root-keys` to have root keys generated. In this case, you do not need to specify `--root-keys.app-key.key`.
218206

219-
{{< note >}} You can also pass `--with-root-keys` to have root keys generated. In this case, you do not need to specify `--root-keys.app-key.key`. {{</ note >}}
207+
The end device should now be able to join the private network.
220208

221209
**LoRaWAN 1.1.x:**
222210

@@ -235,11 +223,15 @@ $ ttn-lw-cli end-devices create app1 dev1 \
235223

236224
This will create a LoRaWAN 1.1.0 end device `dev1` in application `app1` with the `EU_863_870` frequency plan.
237225

238-
The end device should now be able to join the private network.
226+
{{< note >}} If you do not have a `JoinEUI` or `AppEUI`, you could use `0000000000000000`.
227+
228+
Some devices do not support using `0000000000000000` as a JoinEUI/AppEUI, because technically, this value is invalid. However, {{% tts %}} supports using this value to indicate the absence of an actual JoinEUI/AppEUI.
229+
230+
If your device gives an error when using `0000000000000000`, try using the DevEUI value as a JoinEUI/AppEUI, both in {{% tts %}} and on your device. {{</ note >}}
239231

240-
{{< note >}} If you do not have a `JoinEUI` or `AppEUI`, it is okay to use `0000000000000000`. Be sure to use the same `JoinEUI` in your device as you enter in {{% tts %}}. {{</ note >}}
232+
You can also pass `--with-root-keys` to have root keys generated. In this case, you do not need to specify `--root-keys.app-key.key` or `root-keys.nwk-key.key`.
241233

242-
{{< note >}} You can also pass `--with-root-keys` to have root keys generated. In this case, you do not need to specify `--root-keys.app-key.key` or `root-keys.nwk-key.key`. {{</ note >}}
234+
The end device should now be able to join the private network.
243235

244236
### Activation By Personalization (ABP) Device
245237

@@ -258,9 +250,9 @@ $ ttn-lw-cli end-devices create app1 dev2 \
258250
--session.keys.nwk-s-key.key B7F3E161BC9D4388E6C788A0C547F255
259251
```
260252

261-
{{< note >}} The `NwkSKey` is returned as `f_nwk_s_int_key` ({{% tts %}} uses LoRaWAN 1.1 terminology). {{</ note >}}
253+
Please note that the `NwkSKey` is returned as `f_nwk_s_int_key` ({{% tts %}} uses LoRaWAN 1.1 terminology).
262254

263-
{{< note >}} You can also pass `--with-session` to have a session generated. {{</ note >}}
255+
You can also pass `--with-session` to have a session generated.
264256

265257
**LoRaWAN 1.1.x:**
266258

@@ -280,7 +272,7 @@ $ ttn-lw-cli end-devices create app1 dev2 \
280272
--session.keys.nwk-s-enc-key.key 01020304050607080102030405060708
281273
```
282274

283-
{{< note >}} You can also pass `--with-session` to have a session generated. {{</ note >}}
275+
You can also pass `--with-session` to have a session generated.
284276

285277
### Set Device Location with the CLI
286278

@@ -297,11 +289,9 @@ $ ttn-lw-cli end-devices set $APP_ID $DEVICE_ID \
297289
--location.altitude 500 \
298290
```
299291

300-
You can also set the end device location to be updated from various sources with the `--location.source` flag. The source of the location data can be the registry, GPS data, results of the LoRa RSSI geolocation, etc.
301-
302-
{{< note >}} Use `ttn-lw-cli end-devices set app1 dev1 --help` command to see the full list of the available location sources and other relatable info.
292+
You can also set the end device location to be updated from various sources with the `--location.source` flag.
303293

304-
If you set the alternative location source, the location settings you manually set will be overwritten by the automatic updates from that source. {{</ note >}}
294+
The source of the location data can be the registry, GPS data, results of the LoRa RSSI geolocation, etc. Use `ttn-lw-cli end-devices set app1 dev1 --help` command to see the full list of the available location sources and other relatable info. If you set the alternative location source, the location settings you manually set will be overwritten by the automatic updates from that source.
305295

306296
The CLI will return something like:
307297

‎doc/content/devices/class-b/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ $ ttn-lw-cli end-devices set app1 dev1 --supports-class-b
2222

2323
This will enable the Class B downlink scheduling of the device. Downlink messages are now scheduled during the next available ping slot.
2424

25-
To disable Class B scheduling, reset with `--supports-class-b=false`.
25+
For unicast devices, Class B downlink scheduling starts when the end device sends an uplink with the Class B bit set. This means that an OTAA device should send an uplink message with the Class B bit set after receiving the join-accept in order to enable Class B downlink scheduling.
2626

27-
{{< note >}} For unicast devices, Class B downlink scheduling starts when the end device sends an uplink with the Class B bit set. This means that an OTAA device should send an uplink message with the Class B bit set after receiving the join-accept in order to enable Class B downlink scheduling. {{</ note >}}
27+
To disable Class B scheduling, reset with `--supports-class-b=false`.
2828

2929
## Multicast Group
3030

‎doc/content/devices/class-c/_index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ $ ttn-lw-cli end-devices set app1 dev1 --supports-class-c
2424

2525
This will enable the Class C downlink scheduling of the device. That's it! Downlink messages are now scheduled as soon as possible.
2626

27-
To disable Class C scheduling, reset with `--supports-class-c=false`.
27+
For unicast devices, Class C downlink scheduling starts after the end device sends an uplink in the session. This means that an OTAA end device should send an uplink message after receiving the join-accept in order to enable Class C downlink scheduling.
2828

29-
{{< note >}} For unicast devices, Class C downlink scheduling starts after the end device sends an uplink in the session. This means that an OTAA end device should send an uplink message after receiving the join-accept in order to enable Class C downlink scheduling. {{</ note >}}
29+
To disable Class C scheduling, reset with `--supports-class-c=false`.
3030

3131
## Multicast Group
3232

‎doc/content/devices/device-claiming/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,4 @@ After pre-provisioning a device, device makers register it on The Things Join Se
2727

2828
[Learn how to claim a device]({{< ref "/devices/device-claiming/claim-devices" >}})
2929

30-
{{< note >}} Device claiming does not transfer a security session for a device, it only transfers ownership. The original LoRaWAN session is deleted. The device needs to join the network again for traffic to appear. {{</ note >}}
30+
Device claiming does not transfer a security session for a device, it only transfers ownership. The original LoRaWAN session is deleted. The device needs to join the network again for traffic to appear.

‎doc/content/devices/device-claiming/claim-devices.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ Authorize your browser to access the camera, scan the the device's QR code for c
3030

3131
The device has been successfully claimed, so you can return to the Console and you will see the device in your application.
3232

33-
{{< note >}} Device claiming does not transfer a security session for a device, it only transfers ownership. The original LoRaWAN session is deleted. The device needs to join the network again for traffic to appear. {{</ note >}}
33+
Keep in mind that device claiming does not transfer a security session for a device, it only transfers ownership. The original LoRaWAN session is deleted. The device needs to join the network again for traffic to appear.

‎doc/content/devices/downlink-queue-ops/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ $ ttn-lw-cli end-devices downlink replace app1 dev1 \
4040
--f-port 42
4141
```
4242

43-
{{< note >}} {{% tts %}} limits the application downlink queue on 10k messages per end device. When this limit is reached, no more scheduled downlinks can be placed in the queue and {{% tts %}} will drop them. In order to avoid hitting the application downlink queue limit and loosing downlinks, we advise scheduling downlink messages in batches. {{</ note >}}
43+
{{% tts %}} limits the application downlink queue on 10k messages per end device. When this limit is reached, no more scheduled downlinks can be placed in the queue and {{% tts %}} will drop them. In order to avoid hitting the application downlink queue limit and loosing downlinks, we advise scheduling downlink messages in batches.
4444

4545
## List queue
4646

‎doc/content/devices/end-device-templates/assigning-euis.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ You can use the command in two different ways:
1515

1616
Once the device templates are personalized with EUIs, you can set additional fields (see [Creating Templates]({{< relref "creating.md" >}})) or execute templates (see [Executing Templates]({{< relref "executing.md" >}})).
1717

18-
{{< note >}} To make your device compliant with most LoRaWAN networks, use the `JoinEUI` of the LoRaWAN Join Server where the devices will be registered and use a `DevEUI` from an IEEE issued MAC address block that is assigned to your company.
18+
To make your device compliant with most LoRaWAN networks, use the `JoinEUI` of the LoRaWAN Join Server where the devices will be registered and use a `DevEUI` from an IEEE issued MAC address block that is assigned to your company.
1919

20-
If you intend to operate your own LoRaWAN Join Server, use a `JoinEUI` from your IEEE assigned MAC address block as LoRa Alliance requires that for DNS lookup. [Learn how to apply for a IEEE issued MAC address block](https://standards.ieee.org/products-services/index.html). {{</ note >}}
20+
If you intend to operate your own LoRaWAN Join Server, use a `JoinEUI` from your IEEE assigned MAC address block as LoRa Alliance requires that for DNS lookup. [Learn how to apply for a IEEE issued MAC address block](https://standards.ieee.org/products-services/index.html).
2121

2222
## Example
2323

‎doc/content/devices/end-device-templates/converting.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Given input data, you can use the `end-device template from-data` command to get
3131

3232
## Example
3333

34-
{{< note >}} This example uses a **Microchip ATECC608A-MAHTN-T Manifest File**. This file contains provisioning data for The Things Join Server. You can download the example file [here](../microchip-atecc608a-mahtn-t-example.json). {{</ note >}}
34+
This example uses a **Microchip ATECC608A-MAHTN-T Manifest File**. This file contains provisioning data for The Things Join Server. You can download the example file [here](../microchip-atecc608a-mahtn-t-example.json).
3535

3636
```bash
3737
$ ttn-lw-cli end-devices template from-data microchip-atecc608a-mahtn-t --local-file example.json

‎doc/content/devices/end-device-templates/creating.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,9 @@ You can create a device template from an existing device or extend an existing d
1212

1313
You can use the `end-device template create` command to create a template from an existing device.
1414

15-
{{< note >}} By default, `end-device template create` strips the device's application ID, device ID, `JoinEUI`, `DevEUI` and server addresses to create a generic template.
15+
By default, `end-device template create` strips the device's application ID, device ID, `JoinEUI`, `DevEUI` and server addresses to create a generic template.
1616

1717
You can include the end device identifiers by passing the concerning flags: `--application-id`, `--device-id`, `--join-eui` and `--dev-eui`.
18-
{{</ note >}}
1918

2019
Pipe the output from getting a device to create a template, for example:
2120

0 commit comments

Comments
 (0)