Skip to main content
X
RAK Logo White RegisteredRAK Logo White Registered
RAKwireless Documentation Center
Store

  • Home
  • WisGateOS 2 User Manual
  • Basics Station to TTNv3
  • product categories
  • software apis and libraries
  • wisgateos2
  • overview

WisGateOS2 User Manual

IMPORTANT

WisGateOS 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 WisGateOS 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 WisGateOS 2.2.x will now require a signature for increased security and compatibility. Extensions that lack this signature (such as those for WisGateOS 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 WisGateOS 2.2.x, the Extension Gallery will automatically update installed Extensions. Some extensions, such as WireGuard, require manual installation after upgrading to WisGateOS 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 WisGateOS 2.2.x version to be able to use the latest features, security, and services.

The following table lists the supported WisGate Edge Gateway models of every WisGateOS:

WisGateOS 1.xWisGateOS 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. WisGateOS 2 can be used only with V2 Gateways.

FeatureWisGateOS 1.xWisGateOS 2.x
UDP PF✔✔
Basics Station✔✔
Built-in LNS✔✔
MQTT integrations✔✔
HTTP integrations✔✔
MultiWAN✔✔
WisDM integration✔✔
Latest OpenWrt securityX✔
Secure activation from WisDMX✔
OpenSSL1.1X✔
OpenVPNX✔
WireGuardX✔
ExtensionsX✔
LBTX✔
Spectral ScanX✔
NOTE

LBT and Spectral Scan will be available for certain gateway models since they are related to a specific hardware functionality.

Overview​

This document describes the functionality of the WisGateOS 2 in detail. The system builds on top of OpenWRT and runs on all RAK WisGate Edge V2 gateways. The guide presents general overview and provides guides and detailed configuration of the gateway. It functions as reference for several products with similar functionality. Thus, some sections will apply to certain products and not others.

Gateway Start-up​

To power up the gateway, check the Quick Start guide of the respective device. There are two ways to access the gateway (Wi-Fi AP Mode and WAN Port (Ethernet)) explained in the corresponding document.

NOTE

Make sure all the antennas are connected before powering the Gateway.

Access the WisGateOS 2 Web UI​

  1. For security reasons, upon first login, you must set the login password. This is done by filling in the desired password and confirming it in the provided fields.

The password needs to comply with the following rules:

  • Should be at least 12 characters long;
  • Has at least one special character (!“#$%&\‘()*+,-./:;<=>?@[\]^_{|}~);
  • Has at least one number;
  • Has at least one standard Latin letter (used in the English alphabet).
Zoomable
Figure 1: Password Setup

  1. When the fields are filled in, click the Set password button to apply it. The Web UI is now accessible and it will load the LoRaWAN Statistics page (Figure 4).

  2. On the next login, use the set password for access. The default login username is root.

Zoomable
Figure 1: Login page

Web Management Platform​

After logging in to the gateway using your credentials, start exploring the configuration and monitoring interface of the device starting with the LoRaWAN Statistics page that opens automatically.

NOTE
  • In WisGateOS 2, only icons are visible for aesthetics reasons, hiding the menu names.
  • You can click the WisGate logo () in the upper left corner to expand the menu on the left and see the full names of the tabs. Click anywhere else on the page to hide the menu names again.
Zoomable
Figure 1: Folded and unfolded sidebar

Dashboard​

This is where statistics about the gateway behavior can be monitored in real time.

LoRaWAN Statistics​

The page consists of several blocks where you can see the overview of some metrics and basic information about the traffic of messages.

  • Packets: Shows the total number of received and transmitted packets by the gateway (uplinks and downlinks). Here are displayed not only messages from devices connected to the gateway directly but from any device that is within the coverage of the gateway and transmitting LoRa messages.
  • End devices: Shows the number of end devices within the gateway's coverage that sent data:
    • Active: The number of the end devices that have sent data in the past hour.
    • Busy: The number of the end devices that have sent an average of 1 uplink packet every minute in the past 10 minutes.
  • Channel Usage: Shows the frequency channel load. Тhe green color indicates low load and the red color indicates high load. To show the channel usage in the graph in a specific time span and range, you may set the Timespan and Range from the dropdown menu.
  • SNR & RSSI: These graphs show the total number of packets with RSSI/SNR value within a specific range. This is also shown in a pie chart to the side of the graphs.
  • Uplink Traffic: Shows the packet-per-minute rate as a function of time and airtime (sec) per minute. Above the graphs, you can see the color-coding of the different Data Rates, where the actual height of the values is a sum of all the packets overall data rates for the time sample. To show the the uplink traffic in a specific time span, you may set the Timespan from the dropdown menu.
  • Downlink Traffic: Shows the packet-per-minute rate as a function of time and airtime (sec) per minute. Above the graphs, you can see the color-coding of the different Data Rates, where the actual height of the values is a sum of all the packets overall data rates for the time sample. To show the the downlink traffic in a specific time span, you may set the Timespan from the dropdown menu.

Overview​

The page consists of several blocks where you can see information about the gateway model, firmware, WAN and LAN interfaces. In addition, you can monitor the performance of the gateway or its packet traffic.

Zoomable
Figure 1: Overview tab
  • In the first block, you can visualize the general information about the gateway:
    • Model: Тhe model of the gateway.
    • Serial number: Тhe serial number of the gateway.
    • EUI: Тhe Extended Unique Identifier of the gateway. It is used to register the gateway in LoRaWAN Network servers.
    • Coordinates: Coordinates of the gateway.
    • MAC address: The Media Access Control address of the gateway.
    • Frequency band: The frequency band set on the gateway.
    • Number of channels: The number of the channels of the gateway (8-channel/16-channel).
    • Uptime – The time the gateway has been working for.
    • Local time- The local time set to the gateway.
    • Firmware: The details about the firmware version. The Firmware details button will redirect you to the General settings. Firmware details will be explained in the Firmware section of this document.
  • Packet capture: This is the feature that records data packets transmitted in the network. By clicking the arrow (), you will be redirected to the Gateway Packet Capture menu.
Zoomable
Figure 1: Gateway Packet Capture page
  • Gateway Packet Capture menu:
    • Pause/Restart session: Тhe button pauses or restarts the session.
    • Download session: Тhe button downloads a .json file with packets data in it.
    • Filter: The button drops-down a filter menu. The Reset filter text, will reset the filter to default. You can filter the packets by:
      • Type: Тype of the packet.
      • Frequency: The frequency on which the packet is received/sent.
      • RSSI: Range of the RSSI.
      • SNR: Range of the SNR.
      • Device address: In the Search Device address field, manually type a device address and the packets sent by that devices will be filtered.
      • Hide CRC_ERR Packets: When enabled, the filter will hide all packets with CRC Error.
  • Performance: This block shows the CPU load and memory used by the gateway in real time.
  • WAN Interfaces: Shows the available and active interfaces. Clicking the arrow (), will redirect you to the Network menu that is explained in detail further down this document.
  • LAN Interfaces: Shows the available and LAN interfaces and the active one. Clicking the arrow (), will redirect you to the Network menu that is explained in detail further down this document.

LoRa​

Configuration​

In the Configuration tab, configure the working mode of the gateway. In the Work mode setting, set the mode to Packet forwarder, Basics station or Built-in network server.

In addition, you can set the Log Level to Error (shows only error logs), Warning (shows warnings logs), Notice (shows notice logs), Info ­(shows all notice, error, and warning logs) or Debug (this is full log, it shows all types of logs, it is used for debugging).

Depending on the chosen mode, the other available settings and tabs change. By default, the gateway is configured to work in Built-in network server.

Zoomable
Figure 1: Configuration tab

Packet Forwarder Mode Settings​

When you choose Packet forwarder work mode, the settings will change to the corresponding ones for this mode. Set a packet forwarder and point to a chosen third-party LoRaWAN Network Server.

Zoomable
Figure 1: Packet forwarder settings

  • Frequency Plan: Here, you can change the frequency plan of the gateway. Click on View detailed regional parameters of the frequency plan to expand the options.

    For middle band gateways (supporting RU864, IN865, and EU868 LoRaWAN regions) and for high band gateways (supporting US915, AU915, KR920, and AS923 LoRaWAN regions) there are differences in the frequency sub-bands section.

    Zoomable
    Figure 1: Frequency plan settings for different LoRaWAN regions
    Zoomable
    Figure 1: Frequency plan settings for different LoRaWAN regions

    • Region: Set the Region here. Note that different hardware supports different LoRaWAN regions.

    • Conform to LoRaWAN: When enabled (by default), the gateway will comply to the LoRaWAN protocol. You may disable it and set their own channels.

      When Conform to LoRaWAN is disabled, you can either Select a template or manually Edit the LoRa channels for each concentrator.

      Zoomable
      Figure 1: Confirm to LoRaWAN is disabled

      • Select a template: You have a list of templates for frequency plans to choose from depending on the LoRaWAN region that the gateway supports.

      • Edit button: Clicking the button will redirect you to the LoRa Concentrator settings, where custom channels can be set.

        Zoomable
        Figure 1: LoRa Concentrator settings
        • Radio 0 Center Frequency (Mhz): The center frequency for radio 0.
        • Radio 1 Center Frequency (Mhz): The center frequency for radio 1.
        • Minimum TX frequency (Mhz): The minimum frequency for transmission.
        • Maximum TX frequency (Mhz): The maximum TX frequency for transmission.
        • Channels: Enable/disable channels with the corresponding switch. In the Radio field, select which radio the channel must use. In the IF field, the difference of the frequency of the selected radio center frequency in kHz is written.

    • LoRaWAN Public: When enabled (by default), the gateway will process data from all end devices. If you want to create a private network, you can to turn it off. The gateway will process the data only from the end devices, which sync word is changed to private.

    • Additional for the middle band gateways (supporting RU864, IN865, and EU868 LoRaWAN regions): Under the LoRaWAN Public switch, the default channels can be seen, and it can be removed by clicking on the X next to it.

      • Multi-SF LoRa Channel Frequency (MHz): Frequency for the Multi-SF LoRa channel.
      • Standard LoRa Channel Frequency (MHz): Frequency for the standard LoRa channel.
      • FSK Channel Frequency (MHz): Frequency for the FSK channel.

    • Additional for the high band gateways (supporting US915, AU915, KR920, and AS923 LoRaWAN regions): Under the LoRaWAN Public switch, the Frequency Sub-band section can be seen. From the dropdown menu, choose sub-bands to use for the uplink traffic.

  • Protocol: Click on Choose from the available protocols and expand the options, then select which protocol to use as well as the Static Interval (sec) (the time interval of how often statistics are pushed to the server).

  • Semtech UDP GWMP Protocol: Choosing this option will give you the ability to set UDP Protocol Parameters.

    • Server address: The address of the LoRa Network Server (LNS).

    • Server Port Up/Down: The ports of the LoRa Server that are going to be used for inbound and outbound traffic.

    • Push Timeout (sec): The time delay for the server response after sending uplink data.

    • Keepalive Interval (sec): The interval of which the gateway sends data to make sure that the server is aware that the gateway is online.

    • Auto-restart Threshold: This variable defines how many times the Keepalive Interval can expire before the Packet Forwarder restarts.

      Zoomable
      Figure 1: UDP Protocol Parameters

  • LoRa Gateway MQTT Bridge: Choosing this option allows you to set LoRa Gateway MQTT Bridge Parameters.

    • MQTT Protocol: From the dropdown menu, choose the MQTT protocol of the MQTT bridge (MQTT for Built-in LoRa Network Server, MQTT for ChirpStack 2.x, MQTT for ChirpStack 3.x (JSON) or MQTT for ChirpStack 3.x (Protobuf)). Note that the MQTT topics change depending on the chosen protocol.
    • MQTT Broker Address: The IP address of the gateway where the MQTT Broker is hosted.
    • MQTT Broker Port: The corresponding port (default port is 1883).
    • MQTT Protocol Version: Choose between V3.1 and V3.1.1. There is very little difference between them, more information can be found here.
    • QoS: Set the desired Quality of Service level.
    • Keepalive Interface (sec): The keepalive interval in seconds (10 default).
    • Clean Session: When this function is enabled, the Broker will not store any subscription information or undelivered messages.
    • Retain: When this function is enabled, the last message published will be retained.
    • Enable User Authentication: This function enables user authentication via username and password.
    • SSL/TLS Mode - When enabled (disabled by default), choose between three modes CA signed server certificate, Self-signed server certificate, and Self-signed server & client certificate, with their corresponding options.
    • Uplink/Downlink/Downlink Acknowledge/Gateway Statistic Topic: MQTT template topics. These topics cannot be changed.
    Zoomable
    Figure 1: LoRa Gateway MQTT Bridge Parameters

  • Class B Settings: Enable/disable the class B beaconing. Click on Configure the beacon period and ping slots of class B devices to use time-sync beacons sent by the gateways to expand class B settings.

    • Enable Beacon: Enables the class B beacon.
    • Beacon Tx Power: The power for transmitting the beacon ping.
    Zoomable
    Figure 1: Class B Settings

  • GPS Information Set fake GPS coordinates (disabled by default). Click on Add your GPS info manually to expand the GPS settings and enable Fake GPS with the switch.

    Zoomable
    Figure 1: GPS Information

  • Packet Filter: Set a filter for the packets from chosen devices (disabled by default). Click on Allows to optimize bandwidth by filtering and forwarding packets from chosen end devices to expand packet filter settings. If White List Mode and Auto Filter are enabled, these are the following options:

    • OUI: This is white list filtering option to filter by Organizationally Unique Identifier of the end device.
    • Network ID: This is a white list filtering option to filter by Network ID.
    • Discard Period (s): This is a period threshold of discard time for nodes (in seconds).
    • Join Period (s): This is a period threshold of Statistics on the latest join request (in seconds).
    • Join Interval (s): This is a time interval threshold of the same device EUI twice-consecutive join request (in seconds).
    • Join Count 1: This is the maximum count of join requests allowed during Join Interval.
    • Join Count 2: This is the maximum count of join requests allowed during the Join Period.

Basics Station Mode Settings​

When the Basics station work mode is chosen, the corresponding settings pop up replacing the ones for other work modes.

Zoomable
Figure 1: Basics station settings
  • To expand the Basics station server setup menu, click on Configure Basics Station server setup.
Zoomable
Figure 1: Basics station server setup
  • Basics Station Server Type: Choose between CUPS-BOOT Server, CUPS Server, LNS Server.
  • Server URL: The address of the server to which the gateway is going to connect.
  • Server Port: This is the corresponding port of the server.
  • Authentication Mode: Choose between four options with their corresponding fields:
    • No Authentication: The server requires no authentication.
    • TLS Server Authentication: The server requires a trust file for authentication.
    • TLS Server and Client Authentication: The server requires trust, certificate, and key files for authentication.
    • TLS Server Authentication and Client Token: The server requires a trust file and a client token.

Built-in Network Server Mode Settings​

When the Built-in network server work mode is chosen, the corresponding settings pop up replacing the ones for other work modes.

Zoomable
Figure 1: Built-in network server settings

  • Frequency Plan: Change the frequency plan of the gateway. Click on View detailed regional parameters of the frequency plan to expand the options.

    For middle band gateways (supporting RU864, IN865, and EU868 LoRaWAN regions) and for high band gateways (supporting US915, AU915, KR920, and AS923 LoRaWAN regions) there are differences in the frequency sub-bands section.

    Zoomable
    Figure 1: Frequency plan settings for different LoRaWAN regions

    • Region: Here is where the region is set. Note that different hardware supports different LoRaWAN regions.

    • LoRaWAN Public: When enabled (by default), the gateway will process data from all end devices. If you want to create a private network, you can turn it off. The gateway will process the data only from the end devices, which sync word is changed to private.

    • Additional for the middle band gateways (supporting RU864, IN865, and EU868 LoRaWAN regions): Under the LoRaWAN Public switch, the default channels can be seen and it can be remove by clicking on the X next to it.

      • Multi-SF LoRa Channel Frequency (MHz): Frequency for the Multi-SF LoRa channel.
      • Standard LoRa Channel Frequency (MHz): Frequency for the standard LoRa channel.
      • FSK Channel Frequency (MHz): Frequency for the FSK channel.

    • Additional for the high band gateways (supporting US915, AU915, KR920, and AS923 LoRaWAN regions): Under the LoRaWAN Public switch, the Frequency Sub-band section can be seen. From the dropdown menu, you may choose sub-bands to use for the uplink traffic.

  • Network Server Parameters: Click on Network server parameters are used to configure general setup for your LoRa built-in server. This section is required for filling-in. to expand the settings menu.

Zoomable
Figure 1: Network Server Parameters

  • Network ID: This is a decimal number to distinguish between networks if deploying multiple ones.

  • Enable ADR: The switch enables/disables Adaptive Data Rate. The built-in server will optimize the data rates, airtime, and energy consumption in the network depending upon the prevailing channel conditions.

  • Minimum/Maximum Allowed TX Data-Rate: DR0 to DR7 can be selected to limit the ADR possible values range. Depends on the Region.

  • ADR Margin (dB): This is visible only when ADR is enabled. It is a value to keep in dB to make sure that the data rate is not overestimated resulting in poor performance (error rate and range).

  • Rx1 Delay (s): This is the delay of the first receive window in seconds.

  • RX1 Data Rate Offset: This determines the data rate of the downlink frames originating from the Gateway for the Rx1 window. By default, it is 0 – identical to the uplink.

  • RX2 Frequency (MHz): This is the frequency of the second receive window in Hz.

  • RX2 Data Rate: The Data Rate of the frames to be sent in the second receive window.

  • Downlink Tx Power (dBm): It is useful, if you want to use a larger antenna with more gain. Values from -6 to 20 are permissible.

  • Disable Frame-counter Validate: this function turns on/off the Frame counter validation.

  • End device-status request interval (s): This shows how often should the end-devices be polled for their status Log Level.

  • Statistic Interval (sec): This shows how often the statistics will be gathered.

  • Gateway backend: To extend the settings field, click on Configure the Gateway Backend to allow the central gateway and extenders to communicate via MQTT.

Zoomable
Figure 1: Gateway backend

  • MQTT Broker Address: The IP address of the machine where the MQTT Broker is hosted (default is 127.0.0.1 for the built-in one).

  • MQTT Broker Port: The corresponding port (default port is 1883).

  • MQTT Protocol Version: Choose between V3.1 and V3.1.1. There is very little difference between them, more information can be found here.

  • QoS: Set the desired Quality of Service level. More information about QoS can be found here.

  • Keepalive Interval (s): The keepalive interval in seconds (10 default).

  • Clean session: When this function is enabled (disabled by default), the Broker will not store any subscription information or undelivered messages.

  • Retain: When this function is enabled (disabled by default), the last message published will be retained.

  • Enable User Authentication: This function enables Encryption of the transmitted data (disabled by default). You to configure the credentials (username and password) used to encrypt the data to secure authentication being performed.

  • SSL/TLS Mode: When this mode is enabled (disabled by default), choose between three modes CA signed server certificate, Self-signed server certificate, Self-signed server & client certificate, with their corresponding options.

  • Uplink/Downlink/Downlink Acknowledge/Gateway Statistic Topic: These are MQTT topic templates. They cannot be changed.

  • Class B Settings: Enable/disable the class B beaconing. To expand the menu, click on Configure the beacon period and ping slots of class B devices to use time-sync beacons sent by the gateways.

Zoomable
Figure 1: Class B Settings

  • Enable Beacon: The switch enables/disables Class B beaconing.

  • PingSlot Channel Frequency: The frequency used for the beacon ping.

  • PingSlot Datarate: The minimum duration of each beacon ping slot.

  • Enable Hopping: Enables/disables Class B hopping as the class B beacon is transmitted following a frequency hopping pattern.

  • Beacon TX Power: This is the transmit power of the beacon ping.

  • Integration Interface Parameters: Configure an integration to an external server. To expand the menu, click on Configure the Integration Interface to forward all received data to an external network server. The settings change depending on the chosen Integration mode.

Zoomable
Figure 1: Integration Interface Parameters
  • Enable Integration Interface: This switch enables the Integration Interface switch enables/disables the integration.
  • Generic MQTT integration mode:
    • MQTT Broker Address: The IP address of the machine where the MQTT Broker is hosted (default is 127.0.0.1 for the built-in one).
    • MQTT Broker Port: The corresponding port (default port is 1883).
    • MQTT Protocol Version: Choose between V3.1 and V3.1.1. There is very little difference between them, more information can be found here.
    • QoS: Set the desired Quality of Service level. More information about the QoS can be found here.
    • Keepalive Interval (s): The keepalive interval in seconds (10 default).
    • Clean session: When this function is enabled, the Broker will not store any subscription information or undelivered messages.
    • Retain: When this function is enabled, the last message published will be retained
    • Enable User Authentication: This function enables user authentication via username and password.
    • SSL/TLS Mode: When this mode is enabled (disabled by default), choose between three modes CA signed server certificate, Self-signed server certificate, Self-signed server & client certificate, with their corresponding options.
    • Join/Uplink/Downlink/Downlink Acknowledge/Status Topic: These are MQTT topic templates. They cannot be changed.
  • AWS IoT Core integration mode:
    • AWS IoT Core endpoint URL: This is the address of the AWS.
    • AWS IoT Core endpoint Port: The corresponding port of the server.
    • Root CA: CA certificate provided by the AWS IoT Core.
    • Certificate: Certificate for the gateway, generated by AWS IoT Core.
    • Key: Private key for the gateway, generated by AWS IoT Core.

Applications​

In this tab, you can create an application and register end devices in the Built-in Network Server. By default, there will be no created Applications. Note that this tab is available only when the gateway is in Built-in Network Server working mode.

Zoomable
Figure 1: Applications tab

Gateways​

In this tab, add extender gateways to work with the LNS. The current gateway do not need to be added as the Network Server is working on it and it acts as the central gateway. Note that this tab is available only when the gateway is in Built-in Network Server working mode.

Zoomable
Figure 1: Gateways tab

Overview​

In this tab, you can see information about the end devices and traffic going thru the extender gateways and the central gateway. Note that this tab is available only when the gateway is in Built-in Network Server working mode.

Zoomable
Figure 1: Overview tab
  • In the first block, you can visualize information about the traffic and the end devices of the central gateway and all extender gateways if any.
    • Total Downlink: Total downlink frames transmitted.
    • Total uplinks: Total uplink frames transmitted.
    • Gateways: The total amount of extender gateways that are forwarding frames to the built-in server plus the central one.
    • End Devices: The total amount of end-devices that are currently authenticated with the server.
    • Total OTAA Requests: The total authentication requests submitted by end-nodes.
    • Rejected OTAA Request: The total authentication requests that were rejected.
    • Uptime: The time the built-in server has been working without interruption.
  • SNR & RSSI: The SNR & RSSI block shows information about the Signal to Noise Ratio (SNR) and Received Signal Strength Indicator (RSSI) of the packets in a graph form.
  • Traffic History: This block shows a general graph of the amount of traffic in packets versus time.
  • DataRate: This block shows the number of packets as per Data Rate (DR0 to DR7).

Network​

In the Network menu, changes on the WAN (Wide Area Network) and LAN (Local Area Network) interfaces can be performed. The WAN menu contains the interfaces for communication with the Internet. The LAN menu contains the interfaces for the local networking.

WAN​

In the WAN menu, you can change the priority of the WAN interfaces. If the highest priority interface goes down, the next in line will be used to access the Internet. The red/green light on the left of the WAN interface name shows if that interface is available.

Zoomable
Figure 1: WAN tab

To rearrange the default order click on the Change priority button. The priority is changed with the arrows left of the interface name(). The arrow pointing up will increase the priority, and the arrow pointing down – will lower it. To save the changes, you need to click on Save priorities.

Zoomable
Figure 1: Editing WAN interface's priority

Expand each interface window by clicking on the name of the interface or the arrow on the left of the interface ().

  • Ethernet: Shows the information about the selected interface. There is also a Settings button which redirects to the selected interface’s settings.
Zoomable
Figure 1: Ethernet

  • Protocol client: The type of the protocol.

  • IP Address: The address assigned to the gateway.

  • Netmask: The netmask of the gateway.

  • Connection time: The time of the gateway's connection to that interface.

  • RX: Packets received.

  • TX: Packets sent.

  • DNS: DNS server addresses.

  • Ethernet settings General tab

    Zoomable
    Figure 1: Ethernet settings General tab
    • Interface: When switched on, this option enables the WAN and disables the LAN interface.
    • Protocol: Choose the type of the protocol. By default, DHCP client is selected.
      • Static address: Set a static address for the gateway.
        • IPv4 Address: The desired static address of the gateway in IPv4.
        • IPv4 Netmask: The netmask of the gateway in IPv4.
        • IPv4 Router: The address of the router in IPv4.
        • DNS Server: Custom DNS server address.
      • DHCP client: The router’s DHCP server will assign an IP to the gateway. The Use DNS server advertised by router switch allows the gateway to assign DNS address from the router. If you want to use custom one, you need to disable it.
      • PPPoE: Set Point-to-Point Protocol over Ethernet, with username and password provided by the internet provider. The DNS server advertised by router switch allows the gateway to assign DNS address from the router. If you want to use custom one, you need to disable it.

  • Ethernet settings Tracking tab: Set up continuous tracking of the interface to automatically switch the gateway to the next available interface when the current interface is no longer stable.

    Zoomable
    Figure 1: Ethernet settings Tracking tab
    • IP: Add an IP address to send the ping test.
    • Reliability: The added minimum number of IP addresses that must respond to confirm a successful ping test.
    • Ping count: Counter of the pings.
    • Ping timeout (s): Timeout of the pings.
    • Ping interval: The ping interval.
    • Down: The number of the ping test that must fail consecutively to confirm the interface is down.
    • Up: The number of the ping test that must fail consecutively to confirm the interface is up.

  • Wi-Fi: Shows the information about the selected interface. There is also a Settings button which redirects to the selected interface’s settings.

    Zoomable
    Figure 1: Wi-Fi
    • Protocol Type: The type of the protocol.
    • IP Address: The IP assigned to the gateway.
    • Netmask: The netmask assigned to the gateway.
    • Connection time: The time the gateway is connected to the Wi-Fi interface.
    • Channel: This field shows which operating frequency will be used.
    • (E)SSID: Тhe SSID of the Wi-Fi network.
    • BSSID: Тhe MAC address of the wireless access point or a router in the wireless network.
    • Bitrate: Тhe bitrate of the wireless network.

  • Wi-Fi settings General tab: Set a connection to the wireless network.

Zoomable
Figure 1: Wi-Fi settings General tab

  • Interface

    • Enabled/Disabled: Enables/disables the Wi-Fi interface.
    • Available (E)SSID networks: The Scan button scans for available wireless networks. Select the desired network or enter it manually.
    • Encryption: Choose what encryption the wireless network uses and type in the password in the Key field. The options are No Encryption, WPA-PSK, WPA2-PSK, and WPA-PSK/WPA2-PSK Mixed Mode (recommended).

  • Protocol: Set a static IP address for the gateway or let the router’s DHCP address to assign one.

    • Static address: Set a static address for the gateway.
      • IPv4 Address: Тhe desired static address of the gateway in IPv4.
      • IPv4 Netmask: Тhe netmask of the gateway in IPv4.
      • IPv4 Router: The address of the router in IPv4.
      • DNS Server: Custom DNS server address.
    • DHCP client: The router’s DHCP server will assign IP to the gateway.
      • Use custom DNS server: When disabled, the DNS server addresses advertised from the router will be ignored.
      • DNS Server: Add custom DNS.

  • Wi-Fi settings Tracking tab: Set up continuous tracking of the interface to automatically switch the gateway to the next available interface when the current interface is no longer stable.

Zoomable
Figure 1: Wi-Fi settings Tracking tab

  • IP: Add an IP address to send the ping test.

  • Reliability: The added minimum number of IP addresses that must respond to confirm a successful ping test.

  • Ping count: The counter of the pings.

  • Ping timeout (s): timeout of the pings.

  • Ping interval: The ping interval.

  • Down: The number of the ping test that must fail consecutively to confirm the interface is down.

  • Up: The number of the ping test that must fail consecutively to confirm the interface is up.

  • Cellular: Shows the information about the selected interface. There is also a Settings button which redirects to the selected interface’s settings.

Zoomable
Figure 1: Cellular

  • ICCID: The Integrated Circuit Card Identifier.

  • IMEI: The International Mobile Equipment Identity.

  • Connection time: The time the gateway was connected to the interface.

  • SIM Card Status: The status of the SIM card.

  • Cellular settings General tab: Set a cellular connection.

Zoomable
Figure 1: Cellular settings General tab

  • Enabled/Disabled: Enable/disable the Cellular interface.

  • APN: The Access Point Name.

  • User (optional): Username used for authorization (leave empty if there is none).

  • Password (optional): Password used for authorization (leave empty if there is none).

  • PIN code (optional): The PIN code of the SIM Card (leave empty if there is none).

  • Cellular settings Tracking tab: Set up continuous tracking of the interface to automatically switch the gateway to the next available interface when the current interface is no longer stable.

Zoomable
Figure 1: Cellular settings Tracking tab
  • IP: Add an IP address to send the ping test.
  • Reliability: The added minimum number of IP addresses that must respond to confirm a successful ping test.
  • Ping count: Counter of the pings.
  • Ping timeout (s): Timeout of the pings.
  • Ping interval: The ping interval.
  • Down: The number of the ping test that must fail consecutively to confirm the interface is down.
  • Up: The number of the ping test that must fail consecutively to confirm the interface is up.

LAN​

In the LAN tab, you can see and edit information about the Local Area Network.

The red/green light on the left shows if the interface is enabled/disabled. Expand each LAN interface window, by clicking on its name or the arrow on the right () of the interface.

Zoomable
Figure 1: LAN tab

  • DHCP Server

    Zoomable
    Figure 1: DHCP Server
    • IP Address: The IP address of the gateway DHCP server.
    • Netmask: The netmask of the DHCP server of the server.
    • The Settings button redirects you to the LAN DHCP settings.

  • DHCP Settings: Change the IPv4 address of the LAN DHCP server.

Zoomable
Figure 1: DHCP Settings

  • Ethernet: The field only shows if the interface is active. The Settings button redirects you to the LAN Ethernet settings.

    Zoomable
    Figure 1: Ethernet

  • Ethernet settings: Enable the LAN Ethernet interface and disable the WAN Ethernet interface.

    Zoomable
    Figure 1: Ethernet settings

  • Wi-Fi

    Zoomable
    Figure 1: Wi-Fi
    • (E)SSID – SSID of the Access Point (AP) of the gateway.
    • Encryption: Encryption of the AP.
    • The Settings button redirects you to the LAN Wi-Fi settings.

  • Wi-Fi settings: Where you can manage the LAN Wi-Fi settings.

    Zoomable
    Figure 1: Wi-Fi settings
    • Enabled/Disabled: Enables/disables the LAN Wi-Fi interface.
    • Channel: Set a channel for the Wi-Fi. Default is Auto, the gateway will automatically choose a channel.
    • (E)SSID: The name of the AP.
    • Encryption: Set an encryption of the AP with a password written in the Key field. The options are No Encryption, WPA-PSK, WPA2-PSK, and WPA-PSK/WPA-PSK2 Mixed Mode (recommended).
    • Hidden: You can hide the AP.

Diagnostics​

In the Diagnostics menu, review the logs on the gateway and perform checks.

System log​

On this page, you can see the complete system logs. It is mainly used for debugging purposes. The System Log reports both system information and actual data from LoRa frames coming from the end nodes.

At the top right corner there is the Auto Refresh button. Depending on the state (ON or OFF) the auto-refresh will be enabled or disabled.

Zoomable
Figure 1: System log tab

Network utilities​

This is where checking via the built-in tools can be performed: Ping, Trace, and Nslookup. You can either enter an URL or an IP Address in the text box and execute the command with one of the buttons. The results are conveniently displayed in a CLI box.

Zoomable
Figure 1: Network utilities tab

Settings​

General settings​

In this tab, change the name of the gateway, setup a system log server or reboot the device.

Zoomable
Figure 1: General settings tab
  • Gateway name: Change the default name of the gateway by typing the desired name in the Name field and clicking the Save button.
  • System log: Point the gateway to a system log server where they can save logs.
    • Buffer size (KiB): This is the maximum size of the log file to be saved.
    • Log expiration: How long does it take for the log file to be saved.
    • External system log server IP address: The address of the external system log server.
    • Port: corresponding port of the system log server.
  • Time synchronization: The switch enables/disables the time synchronization from a Network Time Protocol (NTP) server. In the NTP server candidates area, you an add or remove NTP candidates. To add a new candidate, click on the Add new server candidate text. A new field pops up, where you need to fill the server candidate.
  • Reboot: Here you can reboot the gateway. All unsaved changes will be discarded.

Backup and restore​

In this tab, you can backup, restore or reset the gateway's settings.

Zoomable
Figure 1: Backup and restore tab
  • Backup: The Generate and download backup button creates and downloads an archive file with all current settings.
  • Restore: Where you can upload an archive file by clicking choose file or drag-and-dropping it in the area and restore the previous settings.
  • Reset: With the Reset button, you can restore the factory settings.

Firmware​

The Firmware tab is where you can see the current version of the firmware and update it.

Zoomable
Figure 1: Firmware tab

To update the firmware, begin by flashing a RWI file. This is done by using the choose file button to select the location of the new firmware file and the Update button to initiate the flashing process. There is a tick box to toggle the option of keeping the current settings of the gateway.

NOTE

The Keep settings after updating check box is selected by default, as unchecking it will results in having a gateway with stock settings after the firmware update.

When the Enable FOTA option from the WisDM tab is active, you will not be able to update the firmware, as it is done via WisDM.

Zoomable
Figure 1: Firmware tab inactive

File browser​

Through the File browser tab, you can access the files in the root partition. System logs are saved there and can be downloaded from here.

Zoomable
Figure 1: File browser tab

WisDM​

Here, you can enable/disable WisDM integration and FOTA (Firmware over the air).

Zoomable
Figure 1: WisDM tab
  • Allow WisDM Integration: Enables the WisDM. The gateway can be managed via the WisDM Platform.
  • Enable FOTA: When enabled, the gateway can be upgraded to a newer firmware version via the WisDM platform. If you want to upgrade the firmware via the Web UI, this function must be disabled.

Extensions​

Here, you can install extensions to the gateway via drag-and-drop of an existing IPK file, the Add new extension button or install one now link.

Zoomable
Figure 1: Extension

User preferences​

In the bottom left corner, choose User preferences to logout from the Web UI.

Zoomable
Figure 1: User button

Choosing the User preferences option will redirect you to the corresponding page shown in Figure 55.

Zoomable
Figure 1: User preferences
  • Change password: Change the password for access for the Web UI.
  • Time settings: Set local time to the gateway.
Home
Basics Station to TTNv3
  • Overview
  • Gateway Start-up
  • Access the WisGateOS 2 Web UI
  • Web Management Platform
    • Dashboard
      • LoRaWAN Statistics
    • Overview
  • LoRa
    • Configuration
      • Packet Forwarder Mode Settings
      • Basics Station Mode Settings
      • Built-in Network Server Mode Settings
    • Applications
    • Gateways
    • Overview
  • Network
    • WAN
    • LAN
  • Diagnostics
    • System log
    • Network utilities
  • Settings
    • General settings
    • Backup and restore
    • Firmware
    • File browser
    • WisDM
  • Extensions
  • User preferences

LoRa® is a registered trademark or service mark of Semtech Corporation or its affiliates. LoRaWAN® is a licensed mark.

Copyright © 2014-2024 RAKwireless Technology Limited. All rights reserved.

Copyright © 2014-2024 RAKwireless Technology Limited. All rights reserved.

FacebookRAKwireless FacebookTwitterRAKwireless TwitterInstagramRAKwireless InstagramLinkedInRAKwireless LinkedInYoutubeRAKwireless YoutubePinterestRAKwireless PinterestTikTokRAKwireless TikTokGithubRAKwireless GithubHacksterRAKwireless HacksterDiscordRAKwireless Discord