433 MHz RAK5146L USB – LoRa Basics Station

TTN version:	TTNv3
Frequency:	Europe 433 MHz (ITU region 1)
Classes:	Ready for LoRaWAN Classes A, B and C
Using Docker:	Yes
Last updated:	July 5, 2024

This article provides instructions for making LoRa Basics Station using Raspberry Pi 3 or 4, RAK5146L and mPCIe to USB Board.

Note: The RAK5146L with GPS is required to support Class B end devices. This article shows the RAK5146L version without GPS and without Class B support, but the LoRa Basics Station setup and build is the same for the RAK5146L version with GPS and Class B support.

 

Prepare

• Raspberry Pi 3 or 4
• Raspberry Pi Power Supply
• microSD card
• mPCIe to USB Board
• RAK5146L Gateway Concentrator Module for LoRaWAN, SX1303 LoRa Core (EU433, USB)
• PC

 

RAK5146L & mPCIe to USB Board

RAK5146L Gateway Concentrator Module for LoRaWAN

The RAK5146L is an LPWAN Concentrator Module with mini-PCIe form factor based on Semtech SX1303. It can be used in any embedded platform offering a free mini-PCIe slot with SPI/USB connection. Furthermore, ZOE- M8Q GPS chip is integrated onboard for precise time synchronization.

This module is an exceptional, complete, and cost-efficient gateway solution offering up to 10 programmable parallel demodulation paths, 8 x 8 channel LoRa packet detectors, 8 x SF5-SF12 LoRa demodulators, and 8 x SF5-SF10 LoRa demodulators. It is capable of detecting an uninterrupted combination of packets at 8 different spreading factors and 10 channels with continuous demodulation of up to 16 packets. This product is best for smart metering fixed networks and Internet-of-Things (IoT) applications.

For more information on RAK5146L Gateway Concentrator Module for LoRaWAN, see:

• RAK5146L Gateway Concentrator Module for LoRaWAN, SX1303 LoRa Core (USB, GPS, LBT)
• RAK5146L WisLink LPWAN Concentrator
• RAK5146L WisLink LPWAN Concentrator Datasheet

 

mPCIe to USB Board

This mPCIe to USB Board is compatible with RAK833, RAK2247, RAK2287, and RAK5146 Concentrator modules for LoRaWAN with a USB interface. The board is compatible with RAK8213 Cellular modules. The converter board is suitable for quick prototyping or adding a LoRaWAN functionality to already existing equipment with a free USB port.

For more information on mPCIe to USB Board, see:

• mPCIe to USB Board

 

Assembly

1. Prepare all the components.
2. Connect the LoRa antenna to the LoRa Concentrator Module.
3. Insert the LoRa Concentrator Module into the mini-PCIe slot on the mPCIe to USB Board.
4. Finally, connect the mPCIe to USB Board to the USB on the Raspberry Pi.

 

Raspberry Pi OS setup

1. From https://www.raspberrypi.com/software/ download Raspberry Pi Imager and install it.
2. Insert the microSD card into the computer.
3. Run Raspberry Pi Imager.
4. Click on CHOOSE OS.
5. Click on Raspberry Pi OS (other).
6. Click on Raspberry Pi OS Lite (32-bit).
7. Click on CHOOSE STORAGE.
8. Select the inserted microSD card on which you want to install Raspberry Pi OS.
9. Click on Next.
10. Would you like to apply OS customisation settings? – EDIT SETTINGS.
11. Set hostname.
12. Set username and password. (we recommend a 17-digit password containing lower and upper case letters, numbers and symbols)
13. If you will use WiFi – Configure wireless LAN. (optional)
14. Set locale settings.
15. Click on tab SERVICES.
16. If you will be connecting remotely via SSH – Enable SSH – Use password authentication. (optional)
17. Click on SAVE.
18. Click on YES.
19. Click on YES.
20. Click on CONTINUE.
21. Insert the microSD card into the Raspberry Pi.
22. Turn on the Raspberry Pi.

 

Remote connection via SSH (optional)

1. Connect to your router and find the IP address of your Raspberry Pi.
2. From a Windows PC, you can connect using Command Prompt (CMD) or PuTTY.
3. On Windows PC open Command Prompt (CMD).
4. Type ssh -p port username@IP_Address (for example: ssh -p 22 loravsb@192.168.1.120).
5. Type your password.

 

Post-installation steps

1. Update, upgrade and reboot Raspberry Pi. This will ensure that any security vulnerabilities are patched:

   $ sudo apt update
   $ sudo apt full-upgrade
   $ sudo reboot

2. Connect again via SSH.
3. Use a different port for SSH and disable root login. First, open the SSH configuration file with a text editor:

   $ sudo nano /etc/ssh/sshd_config
   

4. Locate the line with Port 22 and change it to the desired port number (for example, change the port to 2222). Locate the line with PermitRootLogin and change its value to no (this will disable root login via SSH):

   Port 2222
   PermitRootLogin no
   
   

5. Save the changes and exit the text editor.
6. Restart the SSH service to apply the changes:

   $ sudo systemctl restart ssh
   

7. Log out and connect again via SSH on the new port.
8. Install and configure the built-in firewall, ufw, to limit incoming network connections. In the sudo ufw limit 2222/tcp rule, change port 2222 to port you have chose for SSH above.

   $ sudo apt install ufw
   $ sudo ufw default deny incoming
   $ sudo ufw limit 2222/tcp
   $ sudo ufw enable
   

   Note: Firewall rules will have no effect on ports opened by Docker.

9. Reboot Raspberry Pi:

   $ sudo reboot

 

Docker

1. Connect again via SSH.
2. Install the latest Docker version using the convenience script provided by docker:

   $ curl -fsSL https://get.docker.com -o get-docker.sh
   $ sudo sh get-docker.sh
   $ sudo groupadd docker
   $ sudo usermod -aG docker $USER
   $ newgrp docker
   $ sudo systemctl enable docker.service
   $ sudo systemctl enable containerd.service

For more information on Docker installation, see https://docs.docker.com/engine/install/.

 

LoRa Basics Station setup

1. First, get the Gateway EUI by running the following command:

   $ cat /sys/class/net/eth0/address | awk -F\: '{print toupper($1$2$3"FFFE"$4$5$6)}'

 

The Things Stack

1. Create an account on The Things Network if you don’t have one.
2. Login on The Things Network.
3. Click on your username and choose Console.
4. Select a network cluster.
5. Go to gateways.
6. Click on button + Register gateway.
7. Write the previously detected Gateway EUI in the Gateway EUI field.
8. Click on button Confirm.
9. Write something into Gateway ID.
10. Write something into Gateway name.
11. Frequency plan – Europe 433 MHz (ITU region 1).
12. Click on button Register gateway.
13. In API keys click on button +Add API key.
14. Write something into Name.
15. Click on Grant individual rights.
16. Select Link as Gateway to a Gateway Server for traffic exchange, i.e. write uplink and read downlink.
17. Click on button Create API key.
18. Click the Copy to clipboard button and paste the key into some text document for future use.
19. Click on button I have copied the key.

 

Raspberry Pi’s Interfaces

1. Run the following command to configure the Raspberry Pi’s Interfaces:

   $ sudo raspi-config

   

2. In 3 Interface Options -> I4 SPI.
3. Would you like the SPI interface to be enabled? -> Yes.
4. Ok.
5. In 3 Interface Options -> I5 I2C.
6. Would you like the ARM I2C interface to be enabled? -> Yes.
7. Ok.
8. In 3 Interface Options -> I6 Serial Port.
9. Would you like a login shell to be accessible over serial? -> No.
10. Would you like the serial port hardware to be enabled? -> Yes.
11. Ok.
12. Finish.
13. Would you like to reboot now? -> Yes.

LoRa Basics Station

1. Connect again via SSH.
2. Run this command to create and edit the docker-compose.yml file:

3. $ sudo nano docker-compose.yml

4. Copy and paste the configuration below into your docker-compose.yml file. Copy and paste the API key you got previously saved to the TC_KEY variable.

   version: '2.0'
   services:
     basicstation:
         image: xoseperez/basicstation:latest
         container_name: basicstation
         restart: unless-stopped
         privileged: true
         network_mode: host
         environment:
           INTERFACE: "USB"
           MODEL: "SX1303"
           TC_KEY: "NNSXS...."     # Copy here your API key from the TTS

5. Next, create a script that automatically on system startup (or power on) will recreate the container (because there were errors when starting the original container).
6. Create the script reset-docker-compose.sh:

   $ sudo nano reset-docker-compose.sh

7. Copy and paste the content below into your reset-docker-compose.sh file. In the path, replace yourUsername with your username:

   #!/bin/bash
   cd /home/yourUsername/
   sleep 30
   sudo docker compose down
   sudo docker compose up -d --force-recreate

8. Make the script executable:

   $ sudo chmod +x reset-docker-compose.sh

9. Create a systemd service:

   $ sudo nano /etc/systemd/system/docker-reset.service

10. Copy and paste the content below into your docker-reset.service file. In the path, replace yourUsername with your username:

    [Unit]
    Description=Reset Docker Compose on Startup
    
    [Service]
    Type=oneshot
    ExecStart=/home/yourUsername/reset-docker-compose.sh
    
    [Install]
    WantedBy=multi-user.target

11. Enable and start the service. The second command will take 30 seconds to execute:

    $ sudo systemctl enable docker-reset
    $ sudo systemctl start docker-reset

12. Finaly, check that the gateway status is Connected in the TTS console.

 

For more information on LoRa Basics™ Station for Docker, see:

• https://github.com/RAKWireless/basicstation
• https://hub.docker.com/r/xoseperez/basicstation
• https://news.rakwireless.com/basics-station-on-rak-wisgate-developer-gateways/