Skip to content

Commit

Permalink
Add metadata to gateways (#1260)
Browse files Browse the repository at this point in the history
* doc: Add metadata to gateways

* doc: Fix wifx-l1

* doc: Remove image current path

* doc: Update filetype for #1254

* doc: Fix accidental characters

* doc: Add page, ip and backhaul type

* doc: Split Milesight up

* doc: Add IP rating to UG87

* doc: Add missing vendor pages

* doc: Add script and change backhaul

* doc: Add gateway sync to release actions

* doc: Update cotx x3 image

* doc: Fix gateway.csv sync syntax

---------

Co-authored-by: Ben Olayinka <[email protected]>
  • Loading branch information
LDannijs and benolayinka authored Feb 15, 2024
1 parent 8506c5a commit 49b70fb
Show file tree
Hide file tree
Showing 78 changed files with 539 additions and 73 deletions.
5 changes: 5 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,8 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages
FOLDER: public
- name: Make gateways.csv
run: make gateways.csv
- name: Sync gateways.csv to airtable
run: |
curl -X POST ${{ secrets.AIRTABLE_GATEWAYS_API_ENDPOINT }} -H "Authorization: Bearer ${{ secrets.AIRTABLE_GATEWAYS_API_KEY }}" -H "Content-Type: text/csv" --data-binary "@gateways.csv"
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -92,3 +92,6 @@ endif

.PHONY: init
init: deps

gateways.csv:
go run frontmatter.go
11 changes: 8 additions & 3 deletions doc/content/gateways/models/browan-minihub-pro/_index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
---
title: "Browan Minuhub Pro"
description: ""
title: "Browan Minihub Pro"
vendor: Browan
vendor_page: "https://www.browan.com/product/minihub-pro/detail"
description: "The Browan Minihub Pro is a low-cost LoRaWAN® gateway with a WiFi backhaul."
ip_rating:
backhaul: [Wi-Fi]
weight:
aliases: [/gateways/browan-minihub-pro]
image: [minihub-pro.png]
---

{{< figure src="minihub-pro.png" alt="Browan Minihub Pro" class="float plain" >}}
Expand All @@ -11,4 +16,4 @@ The [**Browan Minihub Pro**](https://www.browan.com/product/minihub-pro/detail)

<!--more-->

The detailed guide on how to register Browan Minihub Pro on {{% tts %}} using [{{% udp-pf %}}]({{< ref "/gateways/concepts/udp" >}}) or [{{% lbs %}}]({{< ref "/gateways/concepts/lora-basics-station" >}}) are available in [this document](https://www.browan.com/download/PmN/stream).
The detailed guide on how to register Browan Minihub Pro on {{% tts %}} using [{{% udp-pf %}}]({{< ref "/gateways/concepts/udp" >}}) or [{{% lbs %}}]({{< ref "/gateways/concepts/lora-basics-station" >}}) are available in [this document](https://www.browan.com/download/PmN/stream).
9 changes: 7 additions & 2 deletions doc/content/gateways/models/ciscowirelessgateway/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
---
title: "Cisco Wireless Gateway for LoRaWAN"
description: ""
vendor: "Cisco"
vendor_page: "https://www.cisco.com/c/en/us/products/routers/wireless-gateway-lorawan/"
description: "The Cisco LoRaWAN Gateway is carrier-grade solution suitable for users who have experience with Cisco software, and that are looking for an industrial-grade LoRaWAN gateway. It supports 16 channels, as well as geolocation."
ip_rating: "IP67"
backhaul: [Ethernet, Wi-Fi (add-on), Cellular (add-on)]
alias: [/gateways/ciscowirelessgateway]
image: [cisco.png]
---

This page guides you to connecting the Cisco Wireless Gateway for LoRaWAN® to {{% tts %}}.
Expand All @@ -10,7 +15,7 @@ This page guides you to connecting the Cisco Wireless Gateway for LoRaWAN® to {

Technical specifications for this gateway can be found in [Cisco's official documentation](https://www.cisco.com/c/en/us/products/routers/wireless-gateway-lorawan/).

{{< figure src="cisco.jpg" alt="Cisco LoRaWAN Gateway" class="float plain" >}}
{{< figure src="cisco.png" alt="Cisco LoRaWAN Gateway" class="float plain" width="60%" >}}

## Prerequisites

Expand Down
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.
7 changes: 6 additions & 1 deletion doc/content/gateways/models/cloudgate/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
---
title: "CloudGate"
description: ""
vendor: "Option"
vendor_page: "https://www.option.com/products/"
description: "Option Wireless Technology’s CloudGate is the carrier-approved IoT solution platform that delivers device connectivity, security and processing power for global IoT applications."
ip_rating:
backhaul: [Ethernet, Wi-Fi (add-on), Cellular (add-on)]
aliases: [/gateways/cloudgate]
image: [CloudGate.png]
---

{{< figure src="CloudGate.png" alt="CloudGate Gateway" class="float plain" >}}
Expand Down
6 changes: 6 additions & 0 deletions doc/content/gateways/models/cotx/x1/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
---
title: COTX X1
vendor: COTX
vendor_page: "https://www.cotxnetworks.com/hotspot/cotx-x1"
description: "COTX X1 is a standard LoRaWAN® indoor gateway. It is easy to install and deploy, highly compatible and has a user-friendly interface. COTX offers rich software tools, powerful back office management and technical support."
ip_rating:
backhaul: [Ethernet, Wi-Fi, Cellular (optional)]
aliases: [/gateways/cotx/x1]
image: [X1_1.png]
---

COTX X1 is a standard LoRaWAN® indoor gateway. It is easy to install and deploy, highly compatible and has a user-friendly interface. COTX offers rich software tools, powerful back office management and technical support.
Expand Down
Binary file modified doc/content/gateways/models/cotx/x3/X3_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions doc/content/gateways/models/cotx/x3/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
---
title: COTX X3
vendor: COTX
vendor_page: "https://www.cotxnetworks.com/hotspot/cotx-x3/"
description: "The COTX X3 gateway has similar characteristics to the COTX X1 gateway, only with additional features like outdoor support, BLE support, a small screen for easy monitoring and more."
ip_rating:
backhaul: [Ethernet, Wi-Fi]
aliases: [/gateways/cotx/x3]
image: [X3_1.png]
---

{{< figure src="X3_1.png" alt="COTX X3" class="plain float" >}}
Expand Down
Binary file modified doc/content/gateways/models/cotx/x5/X5_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions doc/content/gateways/models/cotx/x5/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
---
title: COTX X5
vendor: COTX
vendor_page: "https://www.cotxnetworks.com/hotspot/cotx-x5/"
description: "The COTX X5 gateway is an outdoor gateway intended for industrial IoT use cases, with a water and dust proof aluminium case."
aliases: [/gateways/cotx/x5]
ip_rating: "IP67"
backhaul: [Ethernet, Wi-Fi, Cellular]
image: [X5_1.png]
---

{{< figure src="X5_1.png" alt="COTX X5" class="plain float" >}}
Expand Down
7 changes: 6 additions & 1 deletion doc/content/gateways/models/dragino-lps8/_index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
---
title: "Dragino LPS8N"
description: ""
vendor: "Dragino"
vendor_page: "https://www.dragino.com/products/lora-lorawan-gateway/item/200-lps8n.html/"
description: "The Dragino LPS8N is a LoRaWAN® indoor gateway based on the open-source OpenWrt Linux operating system. The LPS8N provides ten programmable parallel demodulation paths. The gateway can be connected to the internet using Ethernet, WiFi, or optional Cellular (3G/4G) connectivity."
ip_rating:
backhaul: [Ethernet, Wi-Fi, Cellular (optional)]
weight:
aliases: [/gateways/dragino-lps8]
image: [dragino-lps8n.jpg]
---

{{< figure src="dragino-lps8n.jpg" alt="Dragino LPS8N" class="float plain" >}}
Expand Down
7 changes: 6 additions & 1 deletion doc/content/gateways/models/kerlinkwirnetistation/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
---
title: "Kerlink Wirnet iStation"
description: ""
vendor: "Kerlink"
vendor_page: "https://www.kerlink.com/product/wirnet-istation/"
description: "The Kerlink Wirnet iStation is an outdoor LoRaWAN® gateway. It offers cellular (4G with 3G/2G fallback) and Ethernet backhauls, as well as fully integrated internal GPS, 4G and LoRa antennas."
ip_rating: "IP67"
backhaul: [Ethernet, Cellular (optional)]
aliases: [/guides/connecting-gateways/kerlinkwirnetistation, /gateways/kerlinkwirnetistation]
image: [Kerlink-Wirnet-iStation.png]
---

{{< figure src="Kerlink-Wirnet-iStation.png" alt="Kerlink Wirnet iStation" class="float plain" >}}
Expand Down
7 changes: 6 additions & 1 deletion doc/content/gateways/models/kerlinkwirnetstation/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
---
title: "Kerlink Wirnet Station"
description: ""
vendor: "Kerlink"
vendor_page: "https://www.kerlink.com/product/wirnet-station/"
description: "The Kerlink Wirnet Station is a robust and highly reliable outdoor LoRaWAN gateway. It was the first commercially available LoRaWAN® gateway on the global market. It offers Ethernet and cellular (3G/2G) backhauls."
ip_rating:
backhaul: [Ethernet, Wi-Fi, Cellular (optional)]
aliases: [/gateways/kerlinkwirnetstation]
image: [wirnet-station.png]
---

{{< warning >}} Kerlink announced the [Product End of Life](https://www.kerlink.com/wp-content/uploads/2020/01/Product-End-of-Life-Wirnet-Station.pdf) in January 2020 for Wirnet Station, so using [Kerlink Wirnet iStation]({{< ref "/gateways/models/kerlinkwirnetistation" >}}) is highly recommended. {{</ warning >}}
Expand Down
7 changes: 6 additions & 1 deletion doc/content/gateways/models/laird-sentrius/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
---
title: "Laird Sentrius™ RG1xx LoRaWAN Gateway"
description: ""
vendor: "Laird"
vendor_page: "https://www.lairdconnect.com/iot-devices/lorawan-iot-devices/sentrius-rg1xx-lorawan-gateway-wi-fi-ethernet-optional-lte-us-only"
description: "The Laird Sentrius™ RG1xx is a secure, scalable, robust LoRaWAN-Enabled Gateway that supports Wi-Fi, Ethernet, and LTE backends."
ip_rating: "IP67 (optional)"
backhaul: [Ethernet, Wi-Fi, Cellular (optional)]
aliases: [/gateways/laird-sentrius]
image: [laird.png]
---

{{< figure src="laird.png" alt="Laird RG1xx" class="float plain" >}}
Expand Down
21 changes: 0 additions & 21 deletions doc/content/gateways/models/lorix-one/udp.md

This file was deleted.

7 changes: 6 additions & 1 deletion doc/content/gateways/models/mikrotik-knot/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
---
title: "MikroTik KNOT"
description: ""
vendor: "MikroTik"
vendor_page: "https://mikrotik.com/product/knot"
description: "The MikroTik KNOT LR8/LR9 kit is a universal device with exceptional connectivity options and protocol support. It is an IoT Gateway which can use ethernet or LTE-M (also known as CAT-M) technology as the gateway backhaul."
ip_rating: "IP20"
backhaul: [Ethernet, Wi-Fi, Cellular]
aliases: ["/gateways/mikrotik-knot"]
image: [mikrotik-knot.jpeg]
---

{{< figure src="mikrotik-knot.jpeg" alt="Ltmikrotik-knotAP" class="plain float" >}}
Expand Down
7 changes: 6 additions & 1 deletion doc/content/gateways/models/mikrotik-ltap/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
---
title: "MikroTik LtAP"
description: ""
vendor: "MikroTik"
vendor_page: "https://mikrotik.com/product/ltap_lte_kit"
description: "The LtAP LTE kit is a compact weatherproof wireless access point with a built-in cellular modem that supports 4G (LTE) connectivity."
ip_rating: "IP54"
backhaul: [Ethernet, Wi-Fi, Cellular]
aliases: ["/gateways/mikrotik-ltap"]
image: [LtaP.jpg]
---

{{< figure src="LtaP.jpg" alt="LtAP" class="plain float" >}}
Expand Down
11 changes: 9 additions & 2 deletions doc/content/gateways/models/mikrotikrouterboard/_index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,23 @@
---
title: "MikroTik Routerboard wAP LoRa8 kit"
description: ""
vendor: "MikroTik"
vendor_page: "https://mikrotik.com/product/wap_lr8_kit"
description: "MikroTik Routerboard wAP LoRa8 kit is a LoRaWAN® gateway that contains a pre-installed UDP packet forwarder and an outdoor weatherproof wireless access point with 2.4 GHz WLAN interface and Ethernet port that could be used as a backend."
ip_rating: "IP54"
backhaul: [Ethernet, Wi-Fi, Cellular]
aliases: ["/gateways/mikrotikrouterboard"]
image: [lr8_kit.png]
---

{{< figure src="lr8_kit.png" alt="lr8 Kit" class="plain float" width="30%" >}}

MikroTik Routerboard wAP LoRa8 kit is a LoRaWAN® gateway that contains a pre-installed UDP packet forwarder and an outdoor weatherproof wireless access point with 2.4 GHz WLAN interface and Ethernet port that could be used as a backend.

This guide shows how to connect this gateway to {{% tts %}}.

<!--more-->

Its technical specifications can be found in [the MikroTik official documentation](https://mikrotik.com/product/wap_lora8_kit).
Its technical specifications can be found in [the MikroTik official documentation](https://mikrotik.com/product/wap_lr8_kit).

{{< warning >}} Currently, this gateway does not support changing frequency channels. {{</ warning >}}

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,23 +1,28 @@
---
title: "Milesight UG6X LoRaWAN Gateway"
description: ""
aliases: [/gateways/milesightug6x]
title: "Milesight UG65 LoRaWAN Gateway"
vendor: "Milesight"
vendor_page: "https://www.milesight.com/iot/product/lorawan-gateway/ug65"
description: "The Milesight UG65 is a high-performance 8-channel LoRaWAN® gateway that offers reliable connectivity for industrial applications."
ip_rating: "IP65"
backhaul: [Ethernet, Wi-Fi, Cellular (optional)]
aliases: [/gateways/milesightug65]
image: [ug65.png]
---

{{< figure src="ug6x.png" alt="Milesight IoT UG6x" class="plain float" >}}
{{< figure src="ug65.png" alt="Milesight IoT UG65" class="plain float" width="80%" >}}

The **Milesight UG6X** is a series of 2 robust 8-channel LoRaWAN® gateways for industrial IoT applications. This page contains information about connecting the Milesight IoT UG6x LoRaWAN gateway to {{% tts %}}.
The **Milesight UG65** is a high-performance 8-channel LoRaWAN® gateway that offers reliable connectivity for industrial applications. This page contains information about connecting the Milesight IoT UG65 LoRaWAN gateway to {{% tts %}}.

<!--more-->

The technical specifications can be found in Milesight's official [UG65](https://www.milesight-iot.com/lorawan/gateway/ug65/) and [UG67](https://www.milesight-iot.com/lorawan/gateway/ug67/) pages.
The technical specifications can be found in Milesight's official [UG65](https://www.milesight-iot.com/lorawan/gateway/ug65/) pages.

The Milesight UG6X LoRaWAN gateways support two ways of connecting {{% tts %}}, using the {{% udp-pf %}} or {{% lbs %}}.
The Milesight UG65 LoRaWAN gateways support two ways of connecting {{% tts %}}, using the {{% udp-pf %}} or {{% lbs %}}.

## Requirements

1. User account on {{% tts %}} with rights to create gateways.
2. Milesight IoT UG6X LoRaWAN gateway connected to the Internet via Ethernet, Wi-Fi or cellular backhaul.
2. Milesight IoT UG65 LoRaWAN gateway connected to the Internet via Ethernet, Wi-Fi or Cellular backhaul.
3. CA certificate for {{% lbs %}} (if using {{% lbs %}}).

## Registration
Expand All @@ -30,7 +35,7 @@ The **Gateway EUI** of the gateway can be found on the gateway's configuration w

## Configuration via Browser

Find the gateway's IP address. The default IP address for the Milesight UG6X LoRaWAN gateway is `192.168.23.150`.
Find the gateway's IP address. The default IP address for the Milesight UG65 LoRaWAN gateway is `192.168.23.150`.

Connect your machine to the same local network as that of the gateway, and enter the gateway's IP address in your web browser. YOu will be presented with a login screen. The default username is `admin` and the default password is `password`.

Expand All @@ -52,4 +57,4 @@ Click **Save** to continue.

## Connect to {{% tts %}}

After completing the basic configuration, follow the instructions to [Connect Milesight UG6X with {{< lbs >}}]({{< relref "lbs" >}}) or to [Connect Milesight UG6X with {{% udp-pf %}}]({{< relref "packet-forwarder" >}}).
After completing the basic configuration, follow the instructions to [Connect Milesight UG65 with {{< lbs >}}]({{< relref "lbs" >}}) or to [Connect Milesight UG65 with {{% udp-pf %}}]({{< relref "packet-forwarder" >}}).
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Connect Milesight UG6X with Lora Basics™ Station"
title: "Connect Milesight UG65 with Lora Basics™ Station"
description: ""
---

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

<!--more-->

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Connect Milesight UG6X with UDP Packet Forwarder"
title: "Connect Milesight UG65 with UDP Packet Forwarder"
description: ""
---

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

<!--more-->

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
60 changes: 60 additions & 0 deletions doc/content/gateways/models/milesightug67/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
title: "Milesight UG67 LoRaWAN Gateway"
vendor: "Milesight"
vendor_page: "https://www.milesight.com/iot/product/lorawan-gateway/ug67"
description: "The Milesight UG67 is a robust outdoor LoRaWAN® gateway designed for outdoor deployments. Powered by the SX1302 LoRa chip and a high-performance quad-core CPU, the UG67 can support connectivity with over 2000 nodes."
ip_rating: "IP67"
backhaul: [Ethernet, Cellular (optional)]
aliases: [/gateways/milesightug67]
image: [ug67.png]
---

{{< figure src="ug67.png" alt="Milesight IoT UG67" class="plain float" width="80%" >}}

The **Milesight UG67** is a robust outdoor LoRaWAN® gateway designed for outdoor deployments. Powered by the SX1302 LoRa chip and a high-performance quad-core CPU, the UG67 can support connectivity with over 2000 nodes. This page contains information about connecting the Milesight IoT UG67 LoRaWAN gateway to {{% tts %}}.

<!--more-->

The technical specifications can be found in Milesight's official [UG67](https://www.milesight-iot.com/lorawan/gateway/ug67/) pages.

The Milesight UG67 LoRaWAN gateways support two ways of connecting {{% tts %}}, using the {{% udp-pf %}} or {{% lbs %}}.

## Requirements

1. User account on {{% tts %}} with rights to create gateways.
2. Milesight IoT UG67 LoRaWAN gateway connected to the Internet via Ethernet or Cellular backhaul.
3. CA certificate for {{% lbs %}} (if using {{% lbs %}}).

## Registration

[Add a gateway]({{< ref "/gateways/concepts/adding-gateways" >}}) by following the instructions for the [Console]({{< ref "/the-things-stack/interact/console#create-gateway" >}}) or the [CLI]({{< ref "/the-things-stack/interact/cli#create-gateway" >}}).

The **Gateway EUI** of the gateway can be found on the gateway's configuration web page. See [Configuration via Browser section]({{< ref "#configuration-via-browser" >}}) below for instructions to access the configuration page.

{{< figure src="eui.png" alt="Gateway EUI" >}}

## Configuration via Browser

Find the gateway's IP address. The default IP address for the Milesight UG67 LoRaWAN gateway is `192.168.23.150`.

Connect your machine to the same local network as that of the gateway, and enter the gateway's IP address in your web browser. YOu will be presented with a login screen. The default username is `admin` and the default password is `password`.

{{< figure src="login.png" alt="Login" >}}

See [Milesight's official documentation](https://www.milesight-iot.com/documents-download) for more information.

### Disable Default Server

In the left menu, choose **Packet Forwarder**. Select the **General** tab.

{{< figure src="eui.png" alt="Packet Forwarder" >}}

Click the pencil icon next to the **localhost**, and uncheck the **Enable** button to disable the **Embedded NS**.

Click **Save** to continue.

{{< figure src="disable.png" alt="Disable default server" >}}

## Connect to {{% tts %}}

After completing the basic configuration, follow the instructions to [Connect Milesight UG67 with {{< lbs >}}]({{< relref "lbs" >}}) or to [Connect Milesight UG67 with {{% udp-pf %}}]({{< relref "packet-forwarder" >}}).
Loading

0 comments on commit 49b70fb

Please sign in to comment.