Contents
Introduction
Each type of gateway requires slightly different setup procedure. Please choose the appropriate setup guide from the model-specific list in LoRaWAN® Gateway Guides.
The common setup steps and requirements are listed on this page.
Protocol
For each supported gateway, we provide the LORIOT gateway binary software that uses a custom protocol to talk to our cloud servers, and the connection is encrypted with TLS 1.2.
Sharing / copying the binaries / installers
The gateway binaries and installers can be shared among the same gateway model.
Skills required
To load the binaries and run the installers, you will need to have some basic Linux command line experience and knowledge of setting up computer networks.
Some gateways can come with our binary software pre-installed, for these models no Linux knowledge is needed. Please contact LORIOT or your gateway provider to inquire about this service.
Firewall setup / Network requirements
- Gateway needs to have internet access.
- Port 443 needs to be allowed in the outbound direction, no other ports are used.
- All connections of our binary are outbound (initiated by the gateway).
If your gateway is on the same network as the device you are using to access this web page, no changes in the configuration of your network should be needed.
Running the software without installation
General steps to run the gateway binary:
- Download the gateway binary (register a gateway and go to the gateway detail page).
- Copy the binary onto your gateway (using SSH, Telnet or USB flash drive).
- Run the binary; it will deamonize and run in background by default.
- [Optional] Add link to the binary to startup scripts.
- [Note] No configuration files are needed.
Please make sure no other process on the gateway is accessing the concentrator interface.
Installing and running our software
The LORIOT installer will fully deploy the gateway binary software onto your gateway.
Please make sure any other software that accesses the LoRa radio front-end has been removed prior to installation of our software, otherwise, the LORIOT binary software may fail to start.
| Installation package contents | Description | Usage |
|---|---|---|
| # install.sh | LORIOT install script | Extracted by installer, configures the startup parameters |
| # initd.sh | LORIOT startup script | Extracted by installer, placed in /etc/initd by the install script |
| # loriot-gw | Gateway binary | Extracted by installer, LORIOT executable binary |
Installer command line options
These parameters can be used to modify the installation behavior and the default runtime parameters of the binary.
| Installation-time parameters used for installation | ||
|---|---|---|
| Installer parameter | Parameter usage | Details |
-d [extract folder] | Will extract to this folder | Default is /opt/lrt |
-n | Do not run at startup | Will not load init.d scripts, process will not be started after gateway boot |
-C [certificate file] | SSL root certificate path | Use an alternative certificate file that will be copied to the extract folder. |
| Installation-time parameters passed to runtime | ||
|---|---|---|
| Installer parameter | Parameter usage | Details |
-s [server name] | Target server hostname | Default www.loriot.io, failover servers can be added as coma separated values |
| Target server TCP port | Default is 443 (https) |
-c [certificate file] | SSL root certificate path | Only needs to be specified for private servers |
-i [network interface] | Primary Internet connection interface | Default is eth0, failover interfaces can be added as coma separated values |
-g [default routing IP address] | default routing gateway address | Default route for the primary network interface |
-t [test IP address] | test address | Test address to probe default interface, default address is 8.8.4.4 (TCP port 53 need to be listening on the server) |
-f | Run in foreground | By default the process will fork to background and run as service (daemonize). This parameter let's you run the binary in foreground instead. |
-E [network interface] | gateway ID source inteface | Default is eth0, the gateway EUI is inherited from the MAC address of this interface |
Binary runtime command line options
These parameters adjust the runtime behavior of the binary.
| Binary parameter | Parameter usage | Details |
|---|---|---|
-s [server name] | Target server hostname | Default www.loriot.io, failover servers can be added as coma separated values |
-p [server port] | Target server TCP port | Default is 443 (https) |
-c [certificate file] | SSL root certificate path | Only needs to be specified for private servers |
-i [network interface] | Primary Internet connection interface | Default is eth0, failover interfaces can be added as coma separated values |
-g [default routing IP address] | default routing gateway address | Default route for the primary network interface |
-t [test IP address] | test address | Test address to probe default interface, default address is 8.8.4.4 (TCP port 53 need to be listening on the server) |
-f | Run in foreground | By default the process will fork to background and run as service (daemonize). This parameter let's you run the binary in foreground instead. You can use crtl+c to stop it. |
-E [network interface] | gateway ID source inteface | Default is eth0, the gateway EUI is inherited from the MAC address of this interface |