Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Dragino LPS8N Basics Station docs #1340

Merged
merged 4 commits into from
Jun 9, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 2 additions & 35 deletions doc/content/gateways/models/dragino-lps8/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,39 +40,6 @@ After signing in, you will be directed to the LPS8N's Web UI.

{{< figure src="web-ui-home-lps8n.png" alt="Web UI hime" >}}

Before proceeding with the next step, we assume you have set up internet access for the LPS8N using one of the following methods:
## Connect to {{% tts %}}

- Using the WAN port of the LPS8N
- As a WiFi client
- Using the built-in 4G modem

On the Web UI, navigate to **LoRaWAN > LoRaWAN** in the menu.

On the LoRaWAN Configuration page, configure the following settings:

1. **Service Provider**: `The Things Network V3`
2. **Server Address**: `eu1.cloud.thethings.network`
3. **Gateway ID**: This is the default Gateway EUI for LPS8N. You can keep it as is.
4. **Uplink Port**: `1700`
5. **Downlink Port**: `1700`

Copy the **Gateway ID** which you will need in the next step.
{{< note "The LPS8N Web UI refers to Gateway EUI as the Gateway ID, which is the Gateway EUI for {{% tts %}}." />}}

Select **Save & Apply**.

{{< figure src="lorawan-config.png" alt="LoRaWAN Configuration" >}}

## Adding LPS8N to {{% tts %}}

You can add the LPS8N gateway to {{% tts %}} by following the instructions on the [ Adding Gateways]({{< ref "/gateways/concepts/adding-gateways" >}}) page. The **Gateway EUI** should be the **Gateway ID** that you have copied from the LPS8N's Web UI.

{{< figure src="add-gateway.png" alt="Add Gateway" >}}

Finally, test your connection by going to the LPS8N's **Overview** page. You should see the gateway status changed to **connected** (indicated by a blue dot) or observe the frequently updating **Last seen** time. Also, see the **Live data** section for various gateway related activities.

{{< figure src="gateway-add-ok.png" alt="Gateway add OK" >}}

You can also verify the presence of a green tick on the LoRa icon in the Web UI.

{{< figure src="lorawan-ok.png" alt="LoRaWAN OK" >}}
After completing the basic configuration, follow the instructions to [Connect Dragino LPS8N with {{< lbs >}}]({{< relref "lbs" >}}) or to [Connect Dragino LPS8N with {{% udp-pf %}}]({{< relref "udp" >}}).
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.
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.
85 changes: 85 additions & 0 deletions doc/content/gateways/models/dragino-lps8/lbs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
title: "Connect Dragino LPS8N with Lora Basics™ Station"
description: ""
---

This section contains instructions for connecting the Dragino LPS8N LoRaWAN® gateway to {{% tts %}} using [{{% lbs %}}]({{< ref "/gateways/concepts/lora-basics-station" >}}).

If you have not yet registered your gateway, follow [Registering Gateway](#registering-gateway)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is too many repetitive info in the whole page. You should restructure the doc such as:

  • register the gateway, check the boxes for API keys ...
  • if you have already registered your gateway and forgot to check the boxes, or you've been using UDP and want to switch to LBS, create API keys manually ...
  • configure the gateway

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can also use links from here https://www.thethingsindustries.com/docs/gateways/concepts/lora-basics-station/ to compress this even more. For example, for creating keys part you can say just follow this section https://www.thethingsindustries.com/docs/gateways/concepts/lora-basics-station/cups/#create-separate-cups-and-lns-api-keys


If you have already registered your gateway, follow [Registering with API key](#registering-with-api-key)

<!--more-->

## Registering Gateway

In the The Things Stack console, go to the 'Gateways' tab and click the '**Register Gateway**' button to register the gateway and make sure to select the three settings below:

{{< figure src="../register-lbs.png" alt="" width="80%">}}

When the keys popup shows, download the keys, and click "I have downloaded the keys".

{{< figure src="../register-lbs-keys.png" alt="" >}}

### Configuring Gateway

In the Gateway's Web UI, navigate to **LoRaWAN > LoRaWAN** in the top menu.

On this page, configure the following settings:

- **Service Provider**: `The Things Network -- Basic Station`
- **CUPS Server URI**: your server address with :443 (e.g. `https://eu1.cloud.thethings.network:443`)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **CUPS Server URI**: your server address with :443 (e.g. `https://eu1.cloud.thethings.network:443`)
- **CUPS Server URI**: {{% tts %}} server address with port 443 (e.g. `https://eu1.cloud.thethings.network:443`)

- **CUPS Authorization Key**: The CUPS key you just downloaded.
- **LNS Authorization Key**: the LNS key you just downloaded.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **LNS Authorization Key**: the LNS key you just downloaded.
- **LNS Authorization Key**: The LNS key you just downloaded.

- **CUPS Certificate Authority**: Install a certificate by clicking on the `DEFAULT-CERTIFICATE` button.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **CUPS Certificate Authority**: Install a certificate by clicking on the `DEFAULT-CERTIFICATE` button.
- **CUPS Certificate Authority**: Install a certificate by clicking on the `DEFAULT_CERTIFICATE` button.


**Note**: When entering the keys, the **"Authorization: Bearer"** field should not be entered in the TTN Basics Station configuration of the gateway.

{{< figure src="../lbs-key.png" alt="" >}}

{{< figure src="../lbs-config.png" alt="" >}}

Once you've done all that, click **Save & Apply**.

Finally, test your connection by going to the LPS8N's **Overview** page. You should see the gateway status changed to **connected** (indicated by a blue dot) or observe the frequently updating **Last seen** time. Also, see the **Live data** section for various gateway related activities.

{{< figure src="../gateway-add-ok.png" alt="Gateway add OK" >}}

## Registering with API key

If you have forgotten to check the checkboxes for Basics Station at register or if you already have the gateway registered you can still change from UDP to LBS by manually creating the API keys.

In the Stack console, on the Gateway's page, go to **API Keys** in the left-hand menu.

Create an API key for CUPS with the following rights:

{{< figure src="../api-cups.png" alt="" >}}

And create an API key for LNS with the following rights:

{{< figure src="../api-lns.png" alt="" >}}

Once you have created the API keys, go to **General Settings** in the left-hand menu, and in the **LoRa Basics Station LNS Authentication Key** field, paste the LNS API key you generated in the previous step and click on **Save Changes**.

{{< figure src="../gw-lns.png" alt="" >}}

### Configuring Gateway

In the Gateway's Web UI, navigate to **LoRaWAN > LoRaWAN** in the top menu.

On this page, configure the following settings:

- **Service Provider**: `The Things Network -- Basic Station`
- **CUPS Server URI**: your server address with :443 (e.g. `https://eu1.cloud.thethings.network:443`)
- **CUPS Authorization Key**: The CUPS key you just created.
- **LNS Authorization Key**: the LNS key you just created.

Finally, install a certificate by clicking on `DEFAULT-CERTIFICATE`

{{< figure src="../lbs-config.png" alt="" >}}

Once you've done all that, click **Save & Apply**.

Finally, test your connection by going to the LPS8N's **Overview** page. You should see the gateway status changed to **connected** (indicated by a blue dot) or observe the frequently updating **Last seen** time. Also, see the **Live data** section for various gateway related activities.

{{< figure src="../gateway-add-ok.png" alt="Gateway add OK" >}}
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.
45 changes: 45 additions & 0 deletions doc/content/gateways/models/dragino-lps8/udp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: "Connect Dragino LPS8N with UDP Packet Forwarder"
description: ""
---

This section contains instructions for connecting the Dragino LPS8N LoRaWAN® gateway to {{% tts %}} using the [{{% udp-pf %}}]({{< ref "/gateways/concepts/udp" >}}).

<!--more-->

Before proceeding with the next step, we assume you have set up internet access for the LPS8N using one of the following methods:

- Using the WAN port of the LPS8N
- As a WiFi client
- Using the built-in 4G modem
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this seems to be a prerequisite for both LBS and UDP modes, put this in the main file as part of prerequisites


On the Web UI, navigate to **LoRaWAN > LoRaWAN** in the menu.

On the LoRaWAN Configuration page, configure the following settings:

1. **Service Provider**: `The Things Network V3`
2. **Server Address**: `eu1.cloud.thethings.network`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it always this exact server address?

3. **Gateway ID**: This is the default Gateway EUI for LPS8N. You can keep it as is.
4. **Uplink Port**: `1700`
5. **Downlink Port**: `1700`

Copy the **Gateway ID** which you will need in the next step.
{{< note "The LPS8N Web UI refers to Gateway EUI as the Gateway ID, which is the Gateway EUI for {{% tts %}}." />}}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{< note "The LPS8N Web UI refers to Gateway EUI as the Gateway ID, which is the Gateway EUI for {{% tts %}}." />}}
{{< note "The LPS8N Gateway ID is equivalent to {{% tts %}} Gateway EUI." />}}


Select **Save & Apply**.

{{< figure src="../lorawan-config.png" alt="LoRaWAN Configuration" >}}

## Adding LPS8N to {{% tts %}}

You can add the LPS8N gateway to {{% tts %}} by following the instructions on the [ Adding Gateways]({{< ref "/gateways/concepts/adding-gateways" >}}) page. The **Gateway EUI** should be the **Gateway ID** that you have copied from the LPS8N's Web UI.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can add the LPS8N gateway to {{% tts %}} by following the instructions on the [ Adding Gateways]({{< ref "/gateways/concepts/adding-gateways" >}}) page. The **Gateway EUI** should be the **Gateway ID** that you have copied from the LPS8N's Web UI.
You can add the LPS8N gateway to {{% tts %}} by following the instructions on the [ Adding Gateways]({{< ref "/gateways/concepts/adding-gateways" >}}) page. Use the **Gateway ID** value that you previously copied for the **Gateway EUI** field.


{{< figure src="../add-gateway.png" alt="Add Gateway" >}}

Finally, test your connection by going to the LPS8N's **Overview** page. You should see the gateway status changed to **connected** (indicated by a blue dot) or observe the frequently updating **Last seen** time. Also, see the **Live data** section for various gateway related activities.

{{< figure src="../gateway-add-ok.png" alt="Gateway add OK" >}}

You can also verify the presence of a green tick on the LoRa icon in the Web UI.

{{< figure src="../lorawan-ok.png" alt="LoRaWAN OK" >}}
Comment on lines +37 to +39
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this not available for connecting via LBS or?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't know for sure, but i would guess so. I'll add it

Loading