Skip to content

Commit

Permalink
doc: Update images (#1379)
Browse files Browse the repository at this point in the history
  • Loading branch information
LDannijs authored Sep 30, 2024
1 parent 9231330 commit ba4b153
Show file tree
Hide file tree
Showing 61 changed files with 66 additions and 99 deletions.
18 changes: 7 additions & 11 deletions doc/content/devices/models/browan-tbms100/_index.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
---
title: "Browan TBMS100"
title: "Browan TBMS100 Motion Sensor"
description: ""
weight:
---

{{< figure src="tbms100.png" alt="Generic Node Sensor Edition" class="float plain" >}}

The Browan [TBMS100](https://www.browan.com/product/motion-sensor-pir/detail) is a PIR motion sensor designed to detect occupancy or movement in homes or buildings for security and efficient facility management. It helps optimize the utilization of spaces like desks, conference rooms, and bathrooms.
The Browan [TBMS100 Motion Sensor](https://lora-alliance.org/wp-content/uploads/2020/05/RM_Motion-SensorPIR_20200205_v2_with-downlink.pdf) is a PIR motion sensor designed to detect occupancy or movement in homes or buildings for security and efficient facility management. It helps optimize the utilization of spaces like desks, conference rooms, and bathrooms.

<!--more-->

## Provisioning Information
The provisioning information, such as **JoinEUI** and **DevEUI**, can be found on the back of the device. The **AppKey**, which is sensitive information, is provided within an Excel sheet via email to the person who purchased it.


{{< figure src="tbms100-back.png" alt="TBMS100 provisioning information" >}}


{{< note "The TBMS100 doesn’t have a QR code that supports {{% tts %}} to extract provisioning information." />}}

## Onboarding to {{% tts %}}
Expand All @@ -32,6 +30,8 @@ The [Onboarding devices without QR codes]({{< ref "/devices/adding-devices/#onbo
- Hardware Ver.: **1.0**
- Firmware Ver.: **1.0.1**

Then fill in the **Provisioning information**, which were found [in the first steps](#provisioning-information).

After configuring your device, select the **Register end device** button.

{{< figure src="tbms100-device-repository.png" alt="Settings for registration through device repository" >}}
Expand All @@ -41,12 +41,8 @@ If you prefer onboarding **manually**, in the **End device type** section, under
- LoRaWAN version: **LoRaWAN Specification 1.0.3**
- Regional parameters version: **RP001 Regional Parameters 1.0.3 revision A**

After configuring your device, select the **Register end device** button.
Then fill in the **Provisioning information**, which were found [in the first steps](#provisioning-information).

{{< figure src="tbms100-manually.png" alt="Settings for manual registration" >}}

## Monitoring Live Data

When your device is registered, select the **Live Data** tab to view all messages exchanged between the end device and {{% tts %}}.
After configuring your device, select the **Register end device** button.

{{< figure src="tbms100-live-data.png" alt="Live data tab" >}}
{{< figure src="tbms100-manually.png" alt="Settings for manual registration" >}}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
11 changes: 5 additions & 6 deletions doc/content/devices/models/dragino-lht52/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ In the **End device type** section, under **Input method**, select either the **
- Hardware Ver.: **Unknown ver.**
- Firmware Ver.: **1.0**

Then fill in the **Provisioning information**, which were found [in the first steps](#provisioning-information).

After configuring your device, select the **Register end device** button.

{{< figure src="lht52-prov-info-stack.png" alt="Settings for registration through device repository" >}}
Expand All @@ -40,12 +42,9 @@ If you prefer onboarding **manually**, in the **End device type** section, under
- LoRaWAN version: **LoRaWAN Specification 1.0.3**
- Regional parameters version: **RP001 Regional Parameters 1.0.3 revision A**

After configuring your device, select the **Register end device** button.

{{< figure src="manual-register.png" alt="Settings for manual registration" >}}
Then fill in the **Provisioning information**, which were found [in the first steps](#provisioning-information).

## Monitoring Live Data

When your device is registered, select the **Live Data** tab to view all messages exchanged between your end device and {{% tts %}}.
After configuring your device, select the **Register end device** button.

{{< figure src="lht52-live-data.png" alt="Live Data tab" >}}
{{< figure src="manual-register.png" alt="Settings for manual registration" >}}
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/content/devices/models/dragino-lht52/manual-register.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 8 additions & 10 deletions doc/content/devices/models/elsys-ers-lite/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: ""
weight:
---

{{< figure src="elsys-ers-lite.png" alt="ELSYS ERS Lite" class="float plain" width="80%">}}
{{< figure src="ers-lite.png" alt="ELSYS ERS Lite" class="float plain" width="60%">}}

The [Elsys ERS Lite](https://www.elsys.se/en/ers-lite/) is an indoor environment sensor for measuring temperature and humidity.

Expand All @@ -14,7 +14,7 @@ The [Elsys ERS Lite](https://www.elsys.se/en/ers-lite/) is an indoor environment

The provisioning information, **DevEUI**, can be found on the back of the device. You can use all zeros as the **JoinEUI**. The **AppKey** is provided through an email when you purchase the device.

{{< figure src="elsys-ers-lite-back.png" alt="Elsys ERS Lite provisioning information" >}}
{{< figure src="ers-lite-back.png" alt="Elsys ERS Lite provisioning information" class="plain" width="40%">}}

{{< note "Elsys ERS Lite cannot be onboarded to {{% tts %}} using QR code." />}}

Expand All @@ -31,21 +31,19 @@ The [Onboarding devices without QR codes]({{< ref "/devices/adding-devices/#onbo
- Hardware Ver.: **1.0**
- Firmware Ver.: **1.0**

Then fill in the **Provisioning information**, which were found [in the first steps](#provisioning-information).

After configuring your device, select the **Register end device** button.

{{< figure src="elsys-ers-lite-device-repository.png" alt="Settings for registration through device repository" >}}
{{< figure src="ers-lite-repository.png" alt="Settings for registration through device repository" >}}

If you prefer onboarding **manually**, in the **End device type** section, under **Input Method**, select **Enter end device specifics manually** option. The [Manually adding devices]({{< ref "/devices/adding-devices/manual/" >}}) and [Over the Air Activation (OTAA)]({{< ref "/devices/adding-devices/manual/otaa/" >}}) guides explain this procedure in detail. Following details are Elsys ERS Lite-specific:

- LoRaWAN version: **LoRaWAN Specification 1.0.3**
- Regional parameters version: **RP001 Regional Parameters 1.0.3 revision A**

After configuring your device, select the **Register end device** button.

{{< figure src="elsys-ers-lite-manually.png" alt="Settings for manual registration" >}}
Then fill in the **Provisioning information**, which were found [in the first steps](#provisioning-information).

## Monitoring Live Data

When your device is registered, select the **Live Data** tab to view all messages exchanged between the end device and {{% tts %}}.
After configuring your device, select the **Register end device** button.

{{< figure src="elsys-ers-lite-live-data.png" alt="Live data tab" >}}
{{< figure src="ers-lite-manually.png" alt="Settings for manual registration" >}}
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 8 additions & 17 deletions doc/content/devices/models/generic-node-se/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,10 @@ This section explains how to get started with the [Generic Node Sensor Edition](

The Generic Node Sensor Edition comes with a pre-loaded application called [vanilla](https://www.genericnode.com/docs/applications/se-vanilla/) that showcases the device's functions and capabilities. This application utilizes a combination of the onboard components including the LEDs, button, buzzer, accelerometer, secure element, temperature sensor, and humidity sensor. The instructions on how to flash a new application onto the Generic Node SE can be found [here](https://www.genericnode.com/docs/getting-started/se-sw/env-setup/).

# Onboarding GNSE Using the QR Code
## Onboarding GNSE Using the QR Code

The Generic Node can be onboarded to {{% tts %}} using the QR code which is printed on the back of its enclosure.

Sign in to [{{% tts %}}](/getting-started/quick-start/).

In {{% tts %}} **Console**, choose the application to which you want to add the GNSE. See [Adding applications](/integrations/adding-applications/) if you haven't created one yet.

Select the **Register end device** button.

{{< figure src="application-overview.png" alt="Application overview" >}}

In the **Register end device** page select the **Scan end device QR code** button.

{{< figure src="register-end-device.png" alt="Register end device" >}}
Expand All @@ -38,7 +30,7 @@ A window with information scanned from the QR code (like **Claim authentication

To continue with the rest of the registration process you can choose either **LoRaWAN® Device Repository** or **manual registration**.

### Using the LoRaWAN Device Repository
## Using the LoRaWAN Device Repository

The [LoRaWAN® Device repository](https://github.com/TheThingsNetwork/lorawan-devices) comprises over 800 end-device profiles, including the Generic Node Sensor Edition, which requires less information for registration with {{% tts %}}.

Expand Down Expand Up @@ -66,7 +58,7 @@ The device is now registered and you will be redirected to the **Overview** page

{{< figure src="gnse-after-register.png" alt="GNSE overview page" >}}

### Manually
## Manually

The Generic Node Sensor Edition also supports manual registration, but you need to find the required settings from the datasheet and ensure that they are entered correctly.

Expand All @@ -80,18 +72,17 @@ Then select/enter the following values:

Select **Show advanced activation, LoRaWAN class and cluster settings** to expand the section. Ensure that the default selection is **Over the Air Activation (OTAA)**.

{{< figure src="manually-1.png" alt="Settings for manual registartion" >}}
{{< figure src="manually-1.png" alt="Settings for manual registration" >}}

Under **Provisioning information** enter the following settings:

- JoinEUI: pre-filled
- DevEUI: pre-filled (this is the secure element’s DevEUI)
- AppKey: select the **Generate** button.
- End device ID: you can continue with the pre-filled value or use any other unique value.
- JoinEUI: **On the bottom of the device.**
- DevEUI: **On the bottom of the device.**
- AppKey: **select the Generate button.**

Select the **Register end device** button.

{{< figure src="manually-2.png" alt="Settings for manual registartion" >}}
{{< figure src="manually-2.png" alt="Settings for manual registration" >}}

The device is now registered and you will be redirected to the **Overview** page of the device.

Expand Down
Binary file not shown.
Binary file modified doc/content/devices/models/generic-node-se/dev-rep-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/content/devices/models/generic-node-se/dev-rep-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/content/devices/models/generic-node-se/found-qr-data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/content/devices/models/generic-node-se/manually-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/content/devices/models/generic-node-se/manually-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 4 additions & 6 deletions doc/content/devices/models/lw001-bg-pro/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ In the **End device type** section, under **Input method**, select either the **
- Hardware Ver.: **2.4**
- Firmware Ver.: **1.0.7**

Then fill in the **Provisioning information**, which were found [in the first steps](#provisioning-information).

After configuring your device, select the **Register end device** button.

{{< figure src="lw001-bg-pro-prov-info-stack.png" alt="Settings for registration through device repository" >}}
Expand All @@ -59,12 +61,8 @@ If you prefer onboarding **manually**, in the **End device type** section, under
- LoRaWAN version: **LoRaWAN Specification 1.0.3**
- Regional parameters version: **RP001 Regional Parameters 1.0.3 revision A**

Then fill in the **Provisioning information**, which were found [in the first steps](#provisioning-information).

After configuring your device, select the **Register end device** button.

{{< figure src="manual-register.png" alt="Settings for manual registration" >}}

## Monitoring Live Data

When your device is registered, select the **Live Data** tab to view all messages exchanged between your end device and {{% tts %}}.

{{< figure src="lw001-bg-pro-live-data.png" alt="Live Data tab" >}}
Diff not rendered.
Binary file modified doc/content/devices/models/lw001-bg-pro/manual-register.png
21 changes: 11 additions & 10 deletions doc/content/devices/models/milesight-em300-th/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,20 @@ description: ""
weight:
---

{{< figure src="milesight-EM300-TH.png" alt="Milesight EM300-TH" class="float plain" width="75%" >}}
{{< figure src="milesight-EM300-TH.png" alt="Milesight EM300-TH" class="float plain" width="60%" >}}

The [Milesight EM300-TH](https://www.milesight.com/iot/product/lorawan-sensor/em300-th) is an environment sensor suitable for monitoring indoor and outdoor temperature and humidity. It can be widely used in office areas, greenhouses and other environments.

<!--more-->

## Provisioning Information

The provisioning information, **DevEUI**, can be found on the back of the device. You can use `24E124C0002A0001` as the **JoinEUI**. The **AppKey** will be received through an email after purchasing the device.
For the provisioning information:
- **DevEUI**: Can be found on the back of the device.
- **JoinEUI**: `24E124C0002A0001`.
- **AppKey**: Will be received through an email after purchasing the device.

{{< figure src="milesight-EM300-TH-back.png" alt="EM300-TH provisioning information" >}}
{{< figure src="milesight-EM300-TH-back.png" alt="EM300-TH provisioning information" class="plain" width="40%">}}

{{< note "The Milesight EM300-TH cannot be onboarded to {{% tts %}} using QR code." />}}

Expand All @@ -31,21 +34,19 @@ The [Onboarding devices without QR codes]({{< ref "/devices/adding-devices/#onbo
- Hardware Ver.: **V2.2**
- Firmware Ver.: **1.15**

Then fill in the **Provisioning information**, which were found [in the first steps](#provisioning-information).

After configuring your device, select the **Register end device** button.

{{< figure src="em300-th-device-repository.png" alt="Settings for registration through device repository" >}}
{{< figure src="em300-th-repo.png" alt="Settings for registration through device repository" >}}

If you prefer onboarding **manually**, in the **End device type** section, under **Input Method**, select **Enter end device specifics manually** option. The [Manually adding devices]({{< ref "/devices/adding-devices/manual/" >}}) and [Over the Air Activation (OTAA)]({{< ref "/devices/adding-devices/manual/otaa/" >}}) guides explain this procedure in detail. Following details are EM300-TH-specific:

- LoRaWAN version: **LoRaWAN Specification 1.0.3**
- Regional parameters version: **RP001 Regional Parameters 1.0.3 revision A**

Then fill in the **Provisioning information**, which were found [in the first steps](#provisioning-information).

After configuring your device, select the **Register end device** button.

{{< figure src="em300-th-manually.png" alt="Settings for manual registration" >}}

## Monitoring Live Data

When your device is registered, select the **Live Data** tab to view all messages exchanged between the end device and {{% tts %}}.

{{< figure src="em300-th-live-data.png" alt="Live data tab" >}}
Diff not rendered.
Diff not rendered.
6 changes: 1 addition & 5 deletions doc/content/devices/models/mkr1310/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,6 @@ For the **Provisioning information**, enter the following details:
- **DevEUI:** The Device EUI value that was previously copied from Arduino IDE Serial Monitor
- **AppKey:** Generate by clicking the **Generate** button

{{< figure src="stack-prov.png" alt="provisioning information of MKR" >}}

In the device overview you can now see three parameters in the **Activation information** section: **AppEUI**, **DevEUI** and **AppKey**. You are going to need these values for the next steps.

{{< figure src="device-overview.png" alt="Device overview page with activation information highlighted" >}}
Expand All @@ -89,12 +87,10 @@ Now go to {{% tts %}} Console **Live data** tab and you should see messages arri

As the device payload comes to {{% tts %}} in a HEX format, you will need to decode it using a [payload formatter](https://www.thethingsindustries.com/docs/integrations/payload-formatters/). To do this, in your application on {{% tts %}}, navigate to **Payload formatters**.

{{< figure src="stack-pf.png" alt="Payload formatters highlighted" width="70%" >}}
{{< figure src="stack-pf.png" alt="Payload formatters highlighted" >}}

Select the **Custom Javascript formatter** from the **Formatter type** dropdown.

{{< figure src="custom-js.png" alt="Custom javascript selected in dropdown" width="70%" >}}

Enter the following code in the **Formatter code** field:

```js
Expand Down
Binary file removed doc/content/devices/models/mkr1310/custom-js.png
Diff not rendered.
Binary file modified doc/content/devices/models/mkr1310/device-overview.png
100755 → 100644
Binary file modified doc/content/devices/models/mkr1310/live-data.png
Binary file modified doc/content/devices/models/mkr1310/stack-device.png
100755 → 100644
Binary file modified doc/content/devices/models/mkr1310/stack-pf.png
Binary file removed doc/content/devices/models/mkr1310/stack-prov.png
Diff not rendered.
6 changes: 2 additions & 4 deletions doc/content/devices/models/mkr1310/temp.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,9 @@ If the Arduino IDE Serial Monitor does not show DHT sensor data, make sure to do
Now that the device is working go back to {{% tts %}} and set up the payload formatter. A payload formatter will turn the hexadecimal string received into readable text. To do this, in your application on {{% tts %}}, click on **Payload formatters**.
{{< figure src="../stack-pf.png" alt="payload formatter highlighted" width="70%" >}}
{{< figure src="../stack-pf.png" alt="payload formatter highlighted" >}}
Select **Custom Javascript formatter** from the dropdown.
{{< figure src="../custom-js.png" alt="custom javascript selected in dropdown" width="70%" >}}
Select the **Custom Javascript formatter** from the **Formatter type** dropdown.
Now paste the following code in the **Formatter code** field:
```js
Expand Down
14 changes: 5 additions & 9 deletions doc/content/devices/models/quectel-kg200z/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Once you do that, you should see some text show up in your terminal. Now press t

{{< figure src="prov-info.png" class="plain">}}

Using these parameters we can now proceed with [onboarding the device to {{% tts %}}](#onboarding-to--tts-).
Using these values we can now proceed with onboarding the device to {{% tts %}}.

### Windows

Expand All @@ -58,11 +58,11 @@ Now close the program (using the **Cancel** button), then plug in the EVK and tu

{{< figure src="win-com-dev.png" class="plain">}}

Once that is done, hit **Connect** and you should see some text show up in the terminal. Now press the reset button on the EVK to have the device show its provisioning information. Select and copy the **AppKey**, **DevEUI and **AppEUI** and store them somewhere.
Once that is done, hit **Connect** and you should see some text show up in the terminal. Now press the reset button on the EVK to have the device show its provisioning information. Select and copy the **AppKey**, **DevEUI** and **AppEUI** and store them somewhere.

{{< figure src="win-com-prov.png" class="plain">}}

Using these parameters we can now proceed with [onboarding the device to {{% tts %}}](#onboarding-to--tts-).
Using these values we can now proceed with onboarding the device to {{% tts %}}.

{{< note "Quectel KG200ZABTB cannot be onboarded to {{% tts %}} using QR code." />}}

Expand All @@ -75,12 +75,8 @@ To do this, in the **End device type** section, under **Input Method**, select *
- LoRaWAN version: **LoRaWAN Specification 1.0.2**
- Regional parameters version: **RP001 Regional Parameters 1.0.2 revision B**

Then fill in the **Provisioning information**, which were found [in the first steps](#provisioning-information).

After configuring your device, select the **Register end device** button.

{{< figure src="evk-manual-prov.png" alt="Settings for manual registration" >}}

## Monitoring Live Data

When your device is registered, select the **Live Data** tab to view all messages exchanged between the end device and {{% tts %}}.

{{< figure src="evk-live-data.png" alt="Live data tab" >}}
Diff not rendered.
Binary file modified doc/content/devices/models/quectel-kg200z/evk-manual-prov.png
100755 → 100644
12 changes: 5 additions & 7 deletions doc/content/devices/models/rakwireless-rak2560/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ In the **End device type** section, under **Input method**, select either the **
- Hardware Ver.: **1.0**
- Firmware Ver.: **1.0.0**

Then fill in the **Provisioning information**, which were found [in the first steps](#sensor-setup).

After configuring your device, select the **Register end device** button.

{{< figure src="rak2560-register.png" alt="Settings for registration through device repository" >}}
Expand All @@ -52,12 +54,8 @@ If you prefer onboarding **manually**, in the **End device type** section, under
- LoRaWAN version: **LoRaWAN Specification 1.0.3**
- Regional parameters version: **RP001 Regional Parameters 1.0.3 revision A**

After configuring your device, select the **Register end device** button.

{{< figure src="manual-register.png" alt="Settings for manual registration" >}}
Then fill in the **Provisioning information**, which were found [in the first steps](#sensor-setup).

## Monitoring Live Data

When your device is registered, select the **Live Data** tab to view all messages exchanged between your end device and {{% tts %}}.
After configuring your device, select the **Register end device** button.

{{< figure src="rak2560-live-data.png" alt="Live Data tab" >}}
{{< figure src="manual-register.png" alt="Settings for manual registration" >}}
Diff not rendered.
Binary file modified doc/content/devices/models/rakwireless-rak2560/rak2560-register.png
100755 → 100644
Loading

0 comments on commit ba4b153

Please sign in to comment.