WisGateOS2 Extensions

IMPORTANT

WisGateOS2 2.2 comes with significant updates that affect all extensions, downgrade flow, and others. Read the following critical points carefully

Downgrading Restrictions: Once you upgrade to WisGateOS2 2.2.x, you will not be able to revert to version 2.1.x using the standard downgrade (WebUI). Make sure to back up and secure all critical data before proceeding with the upgrade. Only through a recovery procedure will a downgrade be possible. The steps for the recovery procedure can be found here: OpenWrt Recovery Procedure.
Extension Signature Requirement: All extensions for WisGateOS2 2.2.x will now require a signature for increased security and compatibility. Extensions that lack this signature (such as those for WisGateOS2 2.0.x/2.1.x) will not be installable on 2.2.x. This ensures that you are running the new firmware with verified and trusted extensions. On WisGateOS2 2.2.x, the Extension Gallery will automatically update installed Extensions. Some extensions, such as WireGuard, require manual installation after upgrading to WisGateOS2 2.2.x.
Internet Connection: Because the new firmware and Extension gallery require a signature check, an Internet connection is required during the update.
Dual Firmware: Some customers may still be using firmware version 2.1.x. Both versions will be supported, but it is critical to use the correct and corresponding extensions for each version to avoid compatibility issues. We strongly recommend upgrading to the new WisGateOS2 2.2.x version to be able to use the latest features, security, and services.

The following table lists the WisGate Edge Gateway models supported by different versions of WisGateOS:

WisGateOS1 1.x	WisGateOS2 2.x
WisGate Edge Lite (RAK7258 / RAK7258C)	WisGate Edge Lite 2 V2 (RAK7268V2 / RAK7268CV2)
WisGate Edge Lite 2 (RAK7268 / RAK7268C)	WisGate Edge Pro V2 (RAK7289V2 / RAK7289CV2)
WisGate Edge Pro (RAK7289 / RAK7289C)	WisGate Edge Prime V2 (RAK7240V2 / RAK7240CV2)
WisGate Edge Prime (RAK7240 / RAK7240C)	WisGate Edge Ultra (RAK7285 / RAK7285C)
	WisGate Soho Pro (RAK7267)

NOTE

The hardware in V1 and V2 gateways are different. WisGateOS2 can be used only with V2 gateways.

The following table lists the features supported by different versions of WisGateOS:

Features	WisGateOS1 1.x	WisGateOS2 2.x
UDP PF	✔	✔
Basics Station	✔	✔
Built-in LNS	✔	✔
MQTT integrations	✔	✔
HTTP integrations	✔	✔
MultiWAN	✔	✔
WisDM integration	✔	✔
Latest OpenWrt security	X	✔
Secure activation from WisDM	X	✔
OpenSSL1.1	X	✔
OpenVPN	X	✔
WireGuard	X	✔
Extensions	X	✔
LBT	X	✔

NOTE

LBT is available for certain gateway models since they are related to a specific hardware functionality.

Overview

WisGateOS2 features an extension functionality, which provides additional features and functions that can be added, removed, or updated based on your needs.

Supported Extensions

Extensions	Descriptions	Remarks
Breathing Light	By using the breathing light extension you can personalize the LED light’s working modes, frequency, and color.
Custom Logo	The Custom Logo extension allows you to upload your logo in the Web UI. This extension is universal and applicable to all gateways that support WisGateOS2.
Country Settings	LBT (Listen Before Talk) means that, before transmitting, the gateway checks the availability of the channel. This is necessary because LoRaWAN is a multi-channel protocol and uses ISM Band. Anyone can use the band - a collision occurs if two or more end devices send signals simultaneously. LBT is usually governed by regulations per country. In WisGateOS2, there is a country table which includes proper configurations for all countries, so you can set the country code in WisGateOS2.
Open/Close Port	This extension allows you to add or delete packet traffic management rules on the gateway, allowing any (or specific) host IP from a designated subnet to communicate with the gateway through specified ports.
Solar Battery	The Solar Battery extension is used to display the operational status information of the solar battery used by the gateway. This includes information on the performance of the solar battery, battery health status, cycle period, battery capacity, charging and discharging modes, and more.	The extension is compatible with RAK7240V2, RAK7267, RAK7289, RAK7289V2, and RAK7285.
WireGuard	WireGuard is a simple but fast VPN. It aims to be faster, simpler, and leaner than the IPsec protocol. It intends to be more performant than the well-known RAKwireless - Open VPN. Before, it was not possible to use the WireGuard protocol on the RAKwireless gateways, but that is not the case now.
Open VPN Client	Open VPN is a virtual private network (VPN). A VPN is created where a server is deployed that both the Gateway and any number of customer devices (PC, Phone, etc.) can connect to via a public IP address. This can be implemented using any of the backhaul connectivity options the Gateway supports (Ethernet, Wi-Fi, LTE). For the LTE backhaul, make sure that the gateway has a static public IP.
Operation and Maintenance	This is an operation and maintenance tool that features scheduled device reboot and monitoring of the 4G network status. If the 4G network connection is lost, it automatically restarts the cellular module to recover the connection.	This extension is only compatible with WisGateOS2 2.2.2 and later.
Field Test	This is an extension that designed to provide backend computing services for Field Tester. The application communicates with the LoRaWAN network server via MQTT subscribe/publish, supporting both the built-in LoRaWAN network server in the RAK gateway and third-party LoRaWAN network servers. It allows you to view and download measurement data from the Field Tester.	This extension is only compatible with WisGateOS2 2.2.2 and later.
Failover Reboot	The Failover Reboot tool periodically checks the status of all enabled network links (LTE / Ethernet / Wi-Fi) of the gateway. Once it detects that all network links are offline, it will try to restore network connectivity by rebooting LTE module or gateway with failover.	This extension is only compatible with WisGateOS2 2.2.2 and later.

The extensions are built to work with gateways running WisGateOS2. With new firmware update for gateway, WisGateOS2 2.2.x simplifies the installation of extensions, allowing you to select and install the required extensions in the Extension gallery. You can choose the installation method for extensions based on the firmware version running on the gateway. To check the gateway firmware version, head to the Dashboard > Overview webpage.

If your gateway is running firmware version WisGateOS2 2.0.x or WisGateOS2 2.1.x, follow carefully the procedure defined in WisGateOS2 2.0.x/2.1.x.
If your gateway is running firmware version WisGateOS2 2.2.x or later, follow carefully the procedure defined in WisGateOS2 2.2.x or Later.

WisGateOS2 2.0.x/2.1.x

Before installing the extension, you need to obtain the extension file in ipk format. Gateways running WisGateOS2 2.0.x/2.1.x support the extensions shown in the table below.

Extension Names	Extension Files
Breathing Light	Download
Custom Logo	Download
Country Settings	Download
Open/Close Port	Download
Solar Battery	Download
WireGuard	Download
OpenVPN Client	Download

How to Add an Extension

To install an extension, start with accessing the gateway. In accessing the gateway, check the Access the WisGateOS 2 Web UI user manual.

Figure 1: Login page

After a successful login, head to the Extensions tab ( ).

NOTE

You can click the WisGate logo ( ) to expand the menu on the left and see the full names of the tabs.
By default, no extensions are installed.

Figure 1: Extensions tab

To install one, you can click either on Add new extension button or the install one now link. An Add new extension window will pop up.

Figure 1: Add New Extension

Now, you can either drag and drop the extension file in the Drop your Extension file here or choose file form or click the choose file link in the form and browse for the extension file.

NOTE

The extension files are in IPK format, specifically created for the WisGateOS2 and WisGate Edge hardware platform. A general IPK file for OpenWrt cannot be installed.

Figure 1: Choosing an Extension

After you choose the extension file, click Add extension to install it. It takes some time for the extension to install.

Figure 1: Adding an Extension

After the installation process is complete, the WisGateOS will reboot and you need to log in again.

Figure 1: Login Page

Head to the Extensions tab again and you should see the installed extension.

Figure 1: Installed Extension

You can now install more extensions via the Add new extension button or configure the installed ones by clicking the Launch button on the extension.

How to Remove an Extension

To remove an extension, head to the Extensions tab.

Figure 1: Installed Extension

Click the Remove button at the extension you want to remove. You will be asked if you want to remove that extension.

Figure 1: Removing an Extension

Click Remove and wait for the process to finish.

Figure 1: Removing extension

Figure 1: Extension is removed

How to Use the Extensions

Breathing Light

The breathing light LED is located on the top cover of the WisGate Edge Lite 2 gateways and helps to easily determine the gateway’s status visually. The breathing light extension allows you to enable or disable the breathing light on the gateway’s top cover. The default state of the LED is as in its Normal state - a slowly blinking blue light.

NOTE

The Breathing Light extension is available only for the WisGate Edge Lite 2 version 2 gateways.

Working Mode

By using the Breathing Light extension, you can customize the working mode, frequency, and color of the LED light. There are two working modes: All and Warning Only.

If you choose the All mode, you can change the Normal light color, that is the light you see when the gateway is working properly. The blinking frequency can be changed as well – you can choose from Slow, Fast, and Steady. It is possible to configure the color of the Warning light in All working mode as well. Note that the colors for the Normal and the Warning Light cannot be the same.

If you choose Warning only mode, the LED light will only work in case of abnormal activities like Internet connection loss. In Warning only mode, you can modify the light's color, but not its frequency.

Install the Breathing Light Extension

To install the extension, follow the steps in How to Add an Extension.

Configure the Breathing Light Extension

To access the Breathing Light extension, click Launch.

Figure 1: Launch the Breathing Light Extension

In the Configuration page, you can configure the mode, color, and blinking frequency of the LED.

Figure 1: Configuration Page

Interface
- Enable Breathing Light: enables/disables the breathing light extension
- Mode: sets the mode of the extension
  - All: Normal light will glow
  - Warning only: only Warning light will glow. This disables the Normal light settings.
Normal light: the settings for the normal light
- Color: the color of the light (red, green, blue)
- Frequency: blink frequency of the led (slow, fast or steady)
NOTE
The Normal light settings are disabled if Warning only mode is selected.
Warning Light: the color of the warning light

To save the changes, click Save changes.

You can check the status of the LED on the gateway itself.

Custom Logo

The Custom Logo extension allows you to upload your logo in the Web UI. This extension is universal and applicable to all gateways that support WisGateOS2. The Custom Logo extension is created with the thought of small or bigger enterprises that want their logo to be recognized and used in their everyday work.

Being able to rebrand your Web UI is particularly useful and even required when it comes to companies that need to promote and visualize their brand or product. This is where RAKWireless’ white label feature comes in handy for the clients.

Size and Format Requirements

The logo image you upload must be in SVG format and cannot exceed 300kb.

And of course, you can preview the Web UI page before finally switching RAKWireless’ logo with the logo of your brand.

Install the Custom Logo Extension

To install the extension, follow the steps in How to Add an Extension.

Configure the Custom Logo Extension

To access the Custom Logo extension, click Launch.

Figure 1: Launch the Custom Logo Extension

In the Configuration page, you can set a custom logo on the login page and on the sidebar menu.

Figure 1: Configuration Page

Interface: enables/disables custom logo extension
Large logo: This logo will be used on the login page and on the expanded sidebar menu. To upload a logo you can either drop the image in the area or click Choose file and browse for the image.
Small logo: This logo will be used for mobile view and on the collapsed sidebar menu. To upload a logo you can either drop the image in the area or click Choose file and browse for the image.
Preview: After choosing the desired images, you can click preview and see how the logo will look on the login page, expanded and collapsed sidebar in desktop and mobile versions.

Figure 1: Logo Preview for Desktop Users

Figure 1: Logo Preview for Mobile Users

To apply the selected logos, click Save changes. The page will reload and apply the logos.

Country Settings

LBT (Listen Before Talk) means that, before transmitting, the gateway checks the availability of the channel. This is necessary because LoRaWAN is a multi-channel protocol and uses ISM Band. Anyone can use the band - a collision occurs if two or more end devices send signals simultaneously.

The gateway checks for empty channels and uses one of them to send downlink data. If a channel is occupied, the gateway performs a random back off. In case all of the channels are occupied, the gateway waits for a free channel and tries to send the downlink data again.

LBT is usually governed by regulations per country. In WisGateOS2 2.x, there is a country table which includes proper configurations for all countries so you can set the country code in WisGateOS2 2.x.

NOTE

AS923 end-devices operating in Japan shall perform Listen Before Talk (LBT), based on ARIB STD-T108 regulations. The ARIB STD-T108 regulation is available for free and should be consulted as needed.

You can switch the frequency plan in the following regions:

AS923, KR920
EU868, RU864, IN865
CN470

The frequency plan will be limited to a particular region. Tx power will be limited to under the maximum.

Downlink Tx Power
Beacon Tx Power

Install the Country Settings Extension

To install the extension, follow the steps in How to Add an Extension.

Configure the Country Settings Extension

To access the Country Settings extension, click Launch.

Figure 1: Launch the Country Settings/LBT Extension

In the Configuration page, click the Select your Country button to set your country.

Figure 1: Country selection

Figure 1: Find your country in the list

In the new window, find your country and select it. Tick the checkbox below to confirm that you have chosen the country where the gateway is located. Then click Confirm to set the LBT for your country.

Figure 1: Confirm your country

Enable the LBT by clicking on the Enable Listen Before Talk switch.

Figure 1: Enable LBT

To save the changes, click Save changes. Now, your gateway has its LBT enabled.

Open/Close Port

This extension allows you to add or delete packet traffic management rules on the gateway, allowing any (or specific) host IP from a designated subnet to communicate with the gateway through specified ports.

Install the Open/Close Port Extension

To install the extension, follow the steps in How to Add an Extension.

Configure the Open/Close Port Extension

To access the Open/Close Port extension, click Launch.

Figure 1: Launch the Open/Close Port Extension

In the Traffic rules page, you can see the default traffic rules of the Open/Close port extension.

Figure 1: Traffic rules list

Service name: a readable name for the service
Protocol: the protocol used
Family: the protocol version used for the traffic
From: external source
To: internal source

For example, the Allow-http service indicates that any host in WAN can communicate with the gateway through port 80 using the TCP protocol type.

To add a new rule, click the Add new rule and configure the following information.

Figure 1: Add a new rule

Service name: give a readable name for the rule
Protocol: choose the protocol used for the rule:
- TCP
- UDP
- TCP + UDP
Sources
- Allow any host: allows any host to have access to the rule
- Source IP address: you can set up three host IPs
Destination Port: the destination port of the routing

To save the changes, click Add new rule. Then you can view the rule created in the list of Traffic rules interface.

Solar Battery

The Solar Battery extension is used to display the operational status information of the solar battery used by the gateway. This includes information on the performance of the solar battery, battery health status, cycle period, battery capacity, charging and discharging modes, and more.

This extension is compatible with the following gateways:

RAK7240V2
RAK7267
RAK7289
RAK7289V2
RAK7285

You can learn the status of the solar battery in real-time through the UI interface.

Install the Solar Battery Extension

To install the extension, follow the steps in How to Add an Extension.

Configure the Solar Battery Extension

To access the Solar Battery extension, click Launch.

Figure 1: Launch the Solar Battery Extension

In the Details page, enable the switch to activate Monitor solar battery.

Figure 1: Details page

Solar battery performance: shows the performance of the battery in real-time
- Temperature: the temperature of the battery. This parameter is used to prevent the battery from overheating or freezing.
- Voltage: the voltage of the battery
- State of charge: the battery level
- Current: the current of the battery whether it is charging or discharging
About solar battery: contains additional information about the battery
- State of Health: this value represents the health of the battery
- Cycle times: the cycles of charge/recharge
- Remaining Capacity: the remaining capacity of the connected battery
- Full-charge capacity: the capacity of the connected battery
- Battery working mode: the status of the battery if it is charging or discharging
Solar battery active events: notifies about issues with the solar battery
- FAULT: The system identifies a possibly damaged solar battery and alerts on replacing it immediately.
- PROTECT: The system identifies an issue that may cause significant damage to the solar battery, so it switches off the solar battery power as a preventive measure. Once operating conditions become favorable, the solar battery will resume working automatically.

WireGuard

WireGuard is a simple but fast VPN. It aims to be faster, simpler, and leaner than the IPsec protocol. It intends to be more performant than the well-known RAKwireless - OpenVPN. Before, it was not possible to use the WireGuard protocol on the RAKwireless gateways, but that is not the case now.

The new WisGateOS2 now offers Extension features, where you can install and set up the WireGuard extension. In this tutorial, you will learn how to set the WireGuard client on the gateway.

This guide assumes that you have some knowledge in setting up a WireGuard server and have a WireGuard server set up.

Install the WireGuard Extension

To install the extension, follow the steps in How to Add an Extension.

Configure the WireGuard Extension

To access the WireGuard extension, click Launch.

Figure 1: Launch the WireGuard Extension

In the Configuration page, enable the Enable WireGuard switch and configure the following information.

Figure 1: Congiguration page

Interface: the settings for the WireGuard client
- Address with netmask: the address that the WireGuard client will use. IP of the client must be in the same range (for example, 10.0.8.0 to 10.0.8.255) defined by the server.
- Generate key pair: automatically generate key pair
- Public Key: the public key of the WireGuard client
- Private Key: the private key of the WireGuard client
  
  NOTE
  Do not share your Private Key with anybody.
Server: the settings for the WireGuard server
- Endpoint Host: the IP of the machine/cloud where the WireGuard server is set
- Endpoint Port: the port used for the traffic
- Persistent Keepalive (ms): the time that a keepalive packet is sent to keep the connection
- Public Key: the public key of the WireGuard server
- Enable Preshared Key: this enables the Preshared key field. The preshared key is used as part of the Noise protocol when establishing the encrypted connection between the two peers.
  
  Figure 1: Enable preshared key
Route All Traffic: allows traffic from all IPs
- Allowed IPs: you can set current IPs that will have the right to connect to the gateway via the WireGuard IP. Only available when Route All Traffic is disabled.

To save the changes, click Save changes.

NOTE

Remember to add the WireGuard Client credentials to the WireGuard server configuration.

After the connection is established, check the status of the WireGuard in the Status tab.

Figure 1: WireGuard status

OpenVPN Client

OpenVPN is a virtual private network (VPN). A VPN is created where a server is deployed that both the Gateway and any number of customer devices (PC, Phone, etc.) can connect to via a public IP address. This is possible to implement using any of the backhaul connectivity options the Gateway supports (Ethernet, Wi-Fi, LTE). For the LTE backhaul, make sure that the gateway has a static public IP.

Thus, by connecting to the server via a remote client, can remotely manage the gateway from any point, at any time. As mentioned above, an OpenVPN server is required. This guide shows how to set up a server in the AWS cloud.

Install the OpenVPN Client Extension

To install the extension, follow the steps in How to Add an Extension.

Configure the OpenVPN Client Extension

Make sure you have local network access to your gateway and connect to it to access the Web UI.

To access the OpenVPN Client extension, click Launch.

Figure 1: Launch the OpenVPN Client Extension

To add an OpenVPN tunnel, click either Add tunnel button or add one now link.

Figure 1: Add OpenVPN tunnel

Click choose file link and browse for the .OVPN file or drag and drop the .OVPN file you have created in the WisGate Edge V2 Gateways Remote Management - OpenVPN guide.

Figure 1: Add .OVPN file to the gateway

Once the file is added, click Add tunnel to add the OpenVPN tunnel.

Figure 1: Add OpenVPN tunnel

A success message will appear after the tunnel is added successfully.

Figure 1: Successfully added tunnel

Click Configure button of the VPN tunnel. On the next window, click the Enable Connection switch to enable the OpenVPN tunnel and click Save changes.

Figure 1: Start the OpenVPN tunnel

In the Logs tab, you can check the OpenVPN status.

Figure 1: OpenVPN tunnel status

You can see the assigned IP in the OpenVPN overview page.

Figure 1: OpenVPN assigned IP

WisGateOS2 2.2.x or Later

If your gateway firmware is WisGateOS2 2.2.x or later. Installing extensions becomes easier, you can select and install extensions from the Extension gallery.

How to Add an Extension

To install an extension, start with accessing the gateway. In accessing the gateway, check the Access the WisGateOS 2 Web UI user manual.

Figure 1: Login page

After a successful login, head to the Extensions tab ( ).

NOTE

You can click the WisGate logo ( ) to expand the menu on the left and see the full names of the tabs.
By default, no extensions are installed.

Figure 1: Extensions tab

To install one, click Extension gallery tab. All extensions that support WisGateOS2 2.2.x or later will be displayed in the gallery.

Figure 1: Extension gallery

Choose the extension (for example, RAK OpenVPN Client) to install and click Install button. It takes some time for the extension to install.

NOTE

If the icon appears on the Extension tab, it means that the gateway hardware does not support the installation of this extension.
If the icon 🟢 appears on the Extension tab, it means that the gateway hardware support the installation of this extension. You can choose to install this extension.
If the Auto Update is enabled during installation, the gateway will automatically update the extension when the latest version is available.

Figure 1: Installing extension

Head to the Installed tab and you should see the installed extension.

Figure 1: Installed extension

How to Remove an Extension

To remove an extension, head to the Extensions > Installed.

Figure 1: Installed Extension

Click the Remove button at the extension you want to remove. You will be asked if you want to remove that extension.

Figure 1: Removing an Extension

Click Remove and wait for the process to finish.

Figure 1: Removing extension

Figure 1: Extension is removed

How to Update an Extension

In order to use the latest features of the extension, we strongly recommend updating the extension to the latest version.

To update an extension, head to the Extensions > Installed.

Figure 1: Installed extensions page

If the latest version of the extension is available, the Update button will be highlighted, indicating that you can choose to update the extension. For example, the RAK Open/Close port extension. Click Update. It takes some time for the extension to update.

Figure 1: Updating extension

After the update process is complete, you can see the extension is already in the latest version and there are no updates available.

Figure 1: Updated extension

To facilitate timely updates, the RAK gateway provides an automatic update feature. It allows you to check the Auto Update button on the extension tab. Once Auto Update is enabled, the gateway will automatically update the extension when the latest version is available.

Figure 1: Auto Update

How to Use the Extensions

RAK Breathing Light

NOTE

The Breathing Light extension is available only for the WisGate Edge Lite 2 version 2 gateways.

Working Mode

By using the Breathing Light extension, you can customize the working mode, frequency, and color of the LED light. There are two working modes: All and Warning Only.

If you choose the All mode, you can change the Normal light color, that is the light you see when the gateway is working properly. The blinking frequency can be changed as well – you can choose from Slow, Fast, and Steady. It’s possible to configure the color of the Warning light in All working mode as well. Note that the colors for the Normal and the Warning Light cannot be the same.

Install the RAK Breathing Light Extension

To install the extension, follow the steps in How to Add an Extension.

Configure the RAK Breathing Light Extension

To access the RAK Breathing Light extension, click Launch.

Figure 1: Launch the RAK Breathing Light Extension

In the Configuration page, you can configure the mode, color, and blinking frequency of the LED.

Figure 1: Configuration Page

Interface
- Enable Breathing Light: enables/disables the breathing light extension
- Mode: sets the mode of the extension
  - All: Normal light will glow
  - Warning only: only Warning light will glow. This disables the Normal light settings.
Normal light: the settings for the normal light
- Color: the color of the light (red, green, blue)
- Frequency: blink frequency of the led (slow, fast or steady)
NOTE
The Normal light settings are disabled if Warning only mode is selected.
Warning Light: the color of the warning light

To save the changes, click Save changes.

You can check the status of the LED on the gateway itself.

RAK Custom Logo

The RAK Custom Logo extension allows you to upload your logo in the Web UI. This extension is universal and applicable to all gateways that support WisGateOS2. The Custom Logo extension is created with the thought of small or bigger enterprises that want their logo to be recognized and used in their everyday work.

Being able to rebrand your Web UI is particularly useful and even required when it comes to companies that need to promote and visualize their brand or product. This is where RAKWireless' white label feature comes in handy for the clients.

Size and Format Requirements

The logo image you upload must be in SVG format and cannot exceed 300kb.

And of course, you can preview the Web UI page before finally switching RAKWireless' logo with the logo of your brand.

Install the RAK Custom Logo Extension

To install the extension, follow the steps in How to Add an Extension.

Configure the RAK Custom Logo Extension

To access the RAK Custom Logo extension, click Launch.

Figure 1: Launch the RAK Custom Logo Extension

In the Configuration page, you can set a custom logo on the login page and on the sidebar menu.

Figure 1: Configuration Page

Interface: enables/disables custom logo extension
Large logo: This logo will be used on the login page and on the expanded sidebar menu. To upload a logo you can either drop the image in the area or click Choose file and browse for the image.
Small logo: This logo will be used for mobile view and on the collapsed sidebar menu. To upload a logo you can either drop the image in the area or click Choose file and browse for the image.
Preview: After choosing the desired images, you can click preview and see how the logo will look on the login page, expanded and collapsed sidebar in desktop and mobile versions.

Figure 1: Logo Preview for Desktop Users

Figure 1: Logo Preview for Mobile Users

To apply the selected logos, click Save changes. The page will reload and apply the logos.

RAK Country Settings

NOTE

AS923 end-devices operating in Japan shall perform Listen Before Talk (LBT), based on ARIB STD-T108 regulations. The ARIB STD-T108 regulation is available for free and should be consulted as needed.

You can switch the frequency plan in the following regions:

AS923, KR920
EU868, RU864, IN865
CN470

The frequency plan will be limited to a particular region. Tx power will be limited to under the maximum.

Downlink Tx Power
Beacon Tx Power

Install the RAK Country Settings Extension

To install the extension, follow the steps in How to Add an Extension.

Configure the RAK Country Settings Extension

To access the RAK Country Settings extension, click Launch.

Figure 1: Launch the RAK Country Settings/LBT Extension

In the Configuration page, click the Select your Country button to set your country.

Figure 1: Country selection

Figure 1: Find your country in the list

In the new window, find your country and select it. Tick the checkbox below to confirm that you have chosen the country where the gateway is located. Then click Confirm to set the LBT for your country.

Figure 1: Confirm your country

Enable the LBT by clicking on the Enable Listen Before Talk switch.

Figure 1: Enable LBT

To save the changes, click Save changes. Now, your gateway has its LBT enabled.

RAK Open/Close Port

Install the RAK Open/Close Port Extension

To install the extension, follow the steps in How to Add an Extension.

Configure the RAK Open/Close Port Extension

To access the RAK Open/Close Port extension, click Launch.

Figure 1: Launch the RAK Open/Close Port Extension

In the Traffic rules page, you can see the default traffic rules of the Open/Close port extension.

Figure 1: Traffic rules page

Service name: a readable name for the service
Protocol: the protocol used
Family: the protocol version used for the traffic
From: external source
To: internal source

For example, the Allow-http service indicates that any host in WAN can communicate with the gateway through port 80 using the TCP protocol type.

To add a new rule, click the Add new rule and configure the following information.

Figure 1: Adding new rule

Service name: give a readable name for the rule
Protocol: choose the protocol used for the rule:
- TCP
- UDP
- TCP + UDP
Sources
- Allow any host: allows any host to have access to the rule
- Source IP address: you can set up three host IPs
Destination Port: the destination port of the routing

To save the changes, click Add new rule. Then you can view the rule created in the list of Traffic rules interface.

RAK Solar Battery

The RAK Solar Battery extension is used to display the operational status information of the solar battery used by the gateway. This includes information on the performance of the solar battery, battery health status, cycle period, battery capacity, charging and discharging modes, and more.

This extension is compatible with the following gateways:

RAK7240V2
RAK7267
RAK7289
RAK7289V2
RAK7285

You can learn the status of the solar battery in real-time through the UI interface.

Install the RAK Solar Battery Extension

To install the extension, follow the steps in How to Add an Extension.

Configure the RAK Solar Battery Extension

To access the RAK Solar Battery extension, click Launch.

Figure 1: Launch the RAK Solar Battery Extension

In the Details page, enable the switch to activate Monitor solar battery.

Figure 1: Details page

Solar battery performance: shows the performance of the battery in real-time
- Temperature: the temperature of the battery. This parameter is used to prevent the battery from overheating or freezing.
- Voltage: the voltage of the battery
- State of charge: the battery level
- Current: the current of the battery whether it is charging or discharging
About solar battery: contains additional information about the battery
- State of Health: this value represents the health of the battery
- Cycle times: the cycles of charge/recharge
- Remaining Capacity: the remaining capacity of the connected battery
- Full-charge capacity: the capacity of the connected battery
- Battery working mode: the status of the battery if it is charging or discharging
Solar battery active events: notifies about issues with the solar battery
- FAULT: The system identifies a possibly damaged solar battery and alerts on replacing it immediately.
- PROTECT: The system identifies an issue that may cause significant damage to the solar battery, so it switches off the solar battery power as a preventive measure. Once operating conditions become favorable, the solar battery will resume working automatically.

RAK WireGuard

The new WisGateOS2 now offers Extension features, where you can install and set up the WireGuard extension. In this tutorial, you will learn how to set the WireGuard client on the gateway.

This guide assumes that you have some knowledge in setting up a WireGuard server and have a WireGuard server set up.

Install the RAK WireGuard Extension

To install the extension, follow the steps in How to Add an Extension.

Configure the RAK WireGuard Extension

To access the RAK WireGuard extension, click Launch.

Figure 1: Launch the RAK WireGuard Extension

In the Configuration page, enable the Enable WireGuard switch and configure the following information.

Figure 1: Configuration page

Interface: the settings for the WireGuard client
- Address with netmask: the address that the WireGuard client will use. IP of the client must be in the same range (for example, 10.0.8.0 to 10.0.8.255) defined by the server.
- Generate key pair: automatically generate key pair
- Public Key: the public key of the WireGuard client
- Private Key: the private key of the WireGuard client
  
  NOTE
  Do not share your Private Key with anybody.
- DNS: DNS server
Server: the settings for the WireGuard server
- Endpoint Host: the IP of the machine/cloud where the WireGuard server is set
- Endpoint Port: the port used for the traffic
- Persistent Keepalive (ms): the time that a keepalive packet is sent to keep the connection
- Public Key: the public key of the WireGuard server
- Enable Preshared Key: this enables the Preshared key field. The preshared key is used as part of the Noise protocol when establishing the encrypted connection between the two peers.
  
  Figure 1: Enable preshared key
Route All Traffic: allows traffic from all IPs
- Allowed IPs: you can set current IPs that will have the right to connect to the gateway via the WireGuard IP. Only available when Route All Traffic is disabled.

To save the changes, click Save changes.

NOTE

Remember to add the WireGuard Client credentials to the WireGuard server configuration.

After the connection is established, check the status of the WireGuard in the Status tab.

Figure 1: WireGuard status

RAK OpenVPN Client

Thus, by connecting to the server via a remote client, the user can remotely manage the gateway from any point, at any time. As mentioned above, an OpenVPN server is required. This guide shows how to set up a server in the AWS cloud.

Install the RAK OpenVPN Client Extension

To install the extension, follow the steps in How to Add an Extension.

Configure the RAK OpenVPN Client Extension

Make sure you have local network access to your gateway and connect to it to access the Web UI.

To access the RAK OpenVPN Client extension, click Launch.

Figure 1: Launch the RAK OpenVPN Client Extension

To add an OpenVPN tunnel, click either Add tunnel button or add one now link.

Figure 1: Add OpenVPN tunnel

Click choose file link and browse for the .OVPN file or drag and drop the .OVPN file you have created in the WisGate Edge V2 Gateways Remote Management - OpenVPN guide.

Figure 1: Add .OVPN file to the gateway

Once the file is added, click Add tunnel to add the OpenVPN tunnel.

Figure 1: Add OpenVPN tunnel

A success message will appear after the tunnel is added successfully.

Figure 1: Successfully added tunnel

Click Configure button of the VPN tunnel. On the next window, click the Enable Connection switch to enable the OpenVPN tunnel and click Save changes.

Figure 1: Start the OpenVPN tunnel

From the Logs tab, you can check the OpenVPN status.

Figure 1: OpenVPN tunnel status

You can see the assigned IP in the OpenVPN overview page.

Figure 1: OpenVPN assigned IP

Operation and Maintenance

The Operation and Maintenance extension is operation and maintenance tool that features scheduled device reboot and monitoring of the 4G network status. If the 4G network connection is lost, it automatically restarts the cellular module to recover the connection.

NOTE

This extension is only compatible with WisGateOS2 2.2.2 and later.

Install the Operation and Maintenance Extension

To install the extension, follow the steps in How to Add an Extension.

Configure the Operation and Maintenance Extension

To access the Operation and Maintenance extension, click Launch.

Figure 1: Launch the Operation and Maintenance Extension

In the configuration page, you can set up cellular network monitoring and schedule reboot.

Figure 1: Configuration page

Cellular Network Monitoring: Enabling this feature, the gateway will monitor cellular connection status every 2 minutes. If the 4G network connection is lost, it automatically restarts the cellular module to recover the connection.
Schedule Reboot: Enabling this feature, the gateway will reboot periodically according to the settings.
Gateway Current Time: System time need to sync for schedule task to work properly. If you need to change the current time, head to User Preferences to set it.
Reboot Time: reboot time
Repeat Time: reboot cycle

To save the changes, click Save changes.

Field Test

This is an extension that designed to provide backend computing services for Field Tester. The application communicates with the LoRaWAN network server via MQTT subscribe/publish, supporting both the built-in LoRaWAN network server in the RAK gateway and third-party LoRaWAN network servers. It allows you to view and download measurement data from the Field Tester.

NOTE

This extension is only compatible with WisGateOS2 2.2.2 and later.

Install the Field Test Extension

To install the extension, follow the steps in How to Add an Extension.

Configure the Field Test Extension

The following steps describe how to configure the extension to communicate with the supported LoRaWAN network servers via MQTT.

Built-in Network Server

Before configuring the Field Test extension, make sure your Field Tester device has been registered in the gateway's built-in network server and joined the LoRoWAN network. For information on how to add node devices to the gateway, you can refer to the chapter LoRa Network Servers > Built-In Network Server in the user manual of the RAK gateway you are using.

To access the Field Test extension, click Launch.

Figure 1: Launch the Field Test extension

Click the Configuration tab to set the following parameters.

Figure 1: Set parameters

LoRa NetWork Server: Select the LoRaWAN network server where you registered the Field Tester device. In this example, the Built-in Server is selected.
MQTT Integration:
- MQTT Broker Address: For the Built-in Server, you just need to set the MQTT broker server address to localhost.
- Port: The default port used by the MQTT broker is 1883.
- Enable User Authentication: keep the default value and no authentication is required
- Enable TLS Setting: keep the default value
- Uplink Topic: uplink topic templates: application/{appName}/device/{devEui}/rx. If you want to subscribe to a specific Field Tester device, replace {appName} and {devEui} with the exact values.
- Downlink Topic: downlink topic templates: application/{appName}/device/{devEui}/tx. If you want to publish to a specific Field Tester device, replace {appName} and {devEui} with the exact values.

To save the changes, click Save changes.
Click the Device Overview tab to view the Field Tester device and the collected data.

Figure 1: Device Overview

Optional: Click Show Data to view the detailed device data.

Figure 1: Detailed data

Optional: Click Export to download the data report for local viewing.

NOTE

Only data reports for labeled devices can be exported.

Chirpstack

Before configuring the Field Test extension, make sure your Field Tester device has been registered in the ChripStack network server and joined the LoRoWAN network. In this chapter, external ChirpStack v4 network server is used as an example.

For information on how to register a RAK gateway to ChirpStack network server, you can refer to the chapter LoRa Network Servers > ChirpStack in the user manual of the RAK gateway you are using.

For information on how to register a Field Tester device to ChirpStack network server, you can refer to the chapter Quick Start Guide > RAKXXX Field Tester Guide for Chirpstack in the user manual of the Field Tester you are using.

To access the Field Test extension, click Launch.

Figure 1: Launch the Field Test extension

Click the Configuration tab to set the following parameters.

Figure 1: Set parameters

LoRa Network Server: Select the LoRaWAN network server where you registered the Field Tester device. In this example, the ChirpStack is selected.
MQTT Integration:
- MQTT Broker Address: Set the MQTT broker address to the server where ChirpStack is deployed. In this example, the ChirpStack v4 server IP is 140.179.175.182 (yours will be different).
- Port: The default port used by the MQTT broker is 1883.
- Enable User Authentication: keep the default value and no authentication is required
- Enable TLS Setting: keep the default value
- Uplink Topic: uplink topic templates: application/{applicationId}/device/{devEui}/event/up
- Downlink Topic: downlink topic templates: application/{applicationId}/device/{devEui}/command/down

To save the changes, click Save changes.
Click the Device Overview tab to view the Field Tester devices and the collected data.

Figure 1: Device Overview

Optional: Click Show Data to view the detailed device data.

Figure 1: Detailed data

Optional: Click Export to download the data report for local viewing.

NOTE

Only data reports for labeled devices can be exported.

The Things Network

Before configuring the Field Test extension, make sure your Field Tester device has been registered in the TTNv3 network server and joined the LoRoWAN network.

For information on how to register a RAK gateway to TTNv3 network server, you can refer to the chapter LoRa Network Servers > The Things Network (TTN) in the user manual of the RAK gateway you are using.

For information on how to register a Field Tester device to TTNv3 network server, you can refer to the chapter Quick Start Guide > RAKXXX Field Tester Guide for The Things Network in the user manual of the Field Tester you are using.

To access the Field Test extension, click Launch.

Figure 1: Launch the Field Test extension

Click the Configuration tab to set the following parameters.

Figure 1: Set parameters

For The Things Network server, each application supports MQTT integration and requires connection credentials. To view MQTT connection information, go to Applications > your application >MQTT.

Figure 1: MQTT intergration

LoRa NetWork Server: Select the LoRaWAN network server where you registered the Field Tester device. In this example, the The Things Network is selected.
MQTT Integration:
- MQTT Broker Address: MQTT Broker Address is the Public address eu1.cloud.thethings.network.
- Port: The default port used by the MQTT broker is 1883.
- Enable User Authentication: This option needs to be enabled. UserName: This is the Username in the Connection credentials. Password: This is the Password in the Connection credentials. This value needs to be generated by clicking Generate new API key.
- Enable TLS Setting: keep the default value
- Uplink Topic: uplink topic templates: application/{applicationId}/device/{devEui}/event/up
- Downlink Topic: downlink topic templates: application/{applicationId}/device/{devEui}/command/down

To save the changes, click Save changes.
Click the Device Overview tab to view the Field Tester devices and the collected data.

Figure 1: Device Overview

Optional: Click Show Data to view the detailed device data.

Figure 1: Detailed data

Optional: Click Export to download the data report for local viewing.

NOTE

Only data reports for labeled devices can be exported.

AWS IoT

Before configuring the Field Test extension, make sure your Field Tester device has been registered in the AWS IoT and joined the LoRoWAN network.

For information on how to register a RAK gateway and a node device to AWS IoT, you can refer to the chapter LoRa Network Servers > AWS IoT Core for LoRaWAN in the user manual of the RAK gateway you are using.

To access the Field Test extension, click Launch.

Figure 1: Launch the Field Test extension

Click the Configuration tab to set the following parameters.

Figure 1: Configure the MQTT broker parameters

LoRa NetWork Server: Select the LoRaWAN network server where you registered the Field Tester device. In this example, the AWS IoT is selected.
MQTT Broker Address:

To configure the MQTT broker address, go to AWS IoT > Connect > Domain configurations, and click iot:Data-ATS in the Domain configurations list. Copy the Domain name.

Figure 1: Configure the MQTT broker address
Port: The port is 8883.
Enable User Authentication: keep the default value and no authentication is required
Enable TLS Setting: Enable TLS setting to ensure the security of MQTT message transmissions. Therefore, you need to create certificates in AWS IoT.

a. AWS IoT policies allow you to control access to the AWS IoT Core data plane operations. To create an AWS IoT policy. Go to AWS IoT > Security > Policies, click Create policy.

Figure 1: Go to create an AWS IoT policy

b. Configure policy parameters and click Create.

Figure 1: Configure parameters

c. Create certificates to authenticate the connection between the device and the Field Test extension. Go to AWS IoT > Security > Certificates, click Create certificate.

Figure 1: Go to create certificates

d. Configure certificate parameters and click Create.

Figure 1: Configure parameters

e. Download the certificate and key files. Click Continue.

Figure 1: Download the certificate and key files

f. In the Certificates list, click the Certificate ID created in the previous step to enter the certificate details page.

Figure 1: Certificate details

g. Click Attach policies to add the created AWS IoT policy for the certificates.

Figure 1: Attach policies

h. Add the certificates to the Field Test extension.

Figure 1: Add certificates
Uplink Topic: To receive the uplink data from AWS IoT, you need to create a destination that will process the uplink data to this uplink topic.

a. To create a destination. Go to AWS IoT > Manage > LPWAN devices > Destination, click Add destination.

Figure 1: Create a destination

b. Assign the created destination to your Field tester device.

Figure 1: Assign the destination to your device.png

c. Configure the uplink topic.

Figure 1: Uplink topic

Downlink Topic: To send downlink messages to a Field Tester device, you need to create a Lambda function.

a. To create a Lambda function. Go to the AWS Lambda console and click Create function.

b. Configure the function name and runtime.

Figure 1: Create Lambda function

c. Copy the following Python code into the Code source and click Deploy.

import json
import boto3
import base64
import codecs
import binascii

client = boto3.client("iotwireless")

def lambda_handler(event, context):

    print(event)

    device_id = event["deviceID"]
    data = event["data"]
    fPort = event["fPort"]


    client.send_data_to_wireless_device(TransmitMode=0,
                                        Id=device_id,
                                        WirelessMetadata={
                                            "LoRaWAN": {"FPort": fPort}},
                                        PayloadData=data)
    return {
        'statusCode': 200,
        'body': json.dumps('Hello from Lambda!')
    }

Figure 1: Add Python code

d. Create a message routing rule in AWS IoT to subscribe the downlink topic and call this Lambda Function to process the downlink message. Go to AWS IoT > Message routing > Rules and click Create rule.

e. Follow the steps in the following figure to create the message routing rule. Then click Create.

Figure 1: Specify rule properties

Figure 1: Configure SQL statement

Figure 1: Attach rule actions

Figure 1: Review and create

f. Configure the downlink topic.

Figure 1: Downlink topic

To save the changes, click Save changes.
Click the Device Overview tab to view the Field Tester devices and the collected data.

Figure 1: Device Overview

Optional: Click Show Data to view the detailed device data.

Figure 1: Detailed data

Optional: Click Export to download the data report for local viewing.

NOTE

Only data reports for labeled devices can be exported.

Failover Reboot

The Failover Reboot tool periodically checks the status of all enabled network links (LTE / Ethernet / Wi-Fi) of the gateway. Once it detects that all network links are offline, it will try to restore network connectivity by rebooting LTE module or gateway with failover.

The following is the logic diagram of the Failover Reboot extension.

Figure 1: Logic diagram

NOTE

This extension is only compatible with WisGateOS2 2.2 and later.
The gateway can be rebooted up to five times.

Install the Failover Reboot Extension

To install the extension, follow the steps in How to Add an Extension.

Configure the Failover Reboot Extension

To access the Failover Reboot extension, click Launch.

Figure 1: Extensions tab

In the configuration page, enable the Failover Reboot service and set the Check Interval.

Figure 1: Configuration page

Enable Service: the Failover Reboot service
Check Interval: time interval for checking the network status, in minutes

To save the changes, click Save changes.