Updated

Updated for TTS(CE) = Also Known as TTN V3. The code requires the first server to be 'ttn' protocol.

Introduction

This balenaCloud (previously resin.io) setup is based on the Multi-protocol Packet Forwarder by Jac Kersing.

An alternative guide to use this balenaCloud setup can be found in the official TTN documentation at: https://www.thethingsnetwork.org/docs/gateways/rak831/

Difference between Poly-packet-forwarder and Multi-protocol-packet-forwarder

mp-pkt-fwd uses the new protocolbuffers-over-mqtt-over-tcp protocol for gateways, as defined by TTN and used by the TTN kickstarter gateway. Using this protcol the gateway is authenticated, which means it is registered under a specific user and can thus be trusted. Because it uses TCP, the chance of packet loss is much lower than with the previous protocol that used UDP. Protocolbuffers packs the data in a compact binary mode into packets, using much less space than the plaintext json that was previously used. It should therefore consume less bandwidth.

balenaCloud TTN Gateway Connector for Raspberry Pi

balenaCloud Dockerfile & scripts for The Things Network gateways based on the Raspberry Pi. This updated version uses the gateway connector protocol, not the old packet forwarder. See the TTN documentation on Gateway Registration, you need to create a gateway API key.

Currently any Raspberry Pi with one of the following gateway boards, communicating over SPI, are supported, but not limited to these:

• IMST iC880A-SPI. Preferable configured as described by TTN-ZH. You do not need to follow the Setting up the software step, as the setup scripts in this repository does it for you.
• LinkLabs Raspberry Pi "Hat"
• RisingHF IoT Dicovery
• RAK831

Prerequisites

1. Build your hardware.
2. Create a new gateway that uses gateway connector on the TTN Console. Also set the location and altitude of your gateway. Go to API keys and create a new API key with 'link as Gateway to a Gateway Server for traffic exchange, i.e. write uplink and read downlink' rights. Copy the secret and use it for GW_KEY later on.
3. Create and sign into an account at https://www.balena.io/cloud/, which is the central "device dashboard".

Create a balenaCloud application

1. On balenaCloud, create an "Application" for managing your TTN gateway devices. I'd suggest that you give it the name "ttngw", select the appropriate device type (i.e. Raspberry Pi 2 or Raspberry Pi 3), and click "Create New Application". You only need to do this once, after which you'll be able to manage one or many gateways of that type.
2. You'll then be brought to the Device Management dashboard for that Application. Follow the instructions to "Add device" and create a boot SD-card for your Raspberry Pi. (Pro Tip: Use a fast microSD card and a USB 3 adapter if you can, because it can take a while to copy all that data. Either that, or be prepared to be very patient.)
3. When the (long) process of writing the image to the SD card completes, insert it into your Raspberry Pi, connect it to the network with Ethernet, and power it up.
4. After several minutes, on the balenaCloud Devices dashboard you'll now see your device - first in a "Configuring" state, then "Idle". Click it to open the Devices control panel.
5. If you like, enter any new Device Name that you'd like, such as "my-gateway-amsterdam".

Configure the gateway device

Click the "Environment Variables" section at the left side of the screen. This will allow you to configure this and only this device. These variables will be used to pull information about this gateway from TTN, and will be used to create a "global_conf.json" and "local_conf.json" file for this gateway.

For a more complete list of possible environment variables, see CONFIGURATION.

Device environment variables - no GPS

For example, for an IMST iC880A or RAK831 with no GPS, the MINIMUM environment variables that you should configure at this screen should look something like this:

GW_RESET_PIN can be left out if you are using Gonzalo Casas' backplane board, or any other setup using pin 22 as reset pin. This is because pin 22 is the default reset pin used by this balenaCloud setup.

Device environment variables - with GPS

For example a LinkLabs gateway, which has a built-in GPS, you need:

Reset pin values

Depending on the way you connect the concentrator board to the Raspberry Pi, the reset pin of the concentrator might be on a different GPIO pin of the Raspberry Pi. Here follows a table of the most common backplane boards used, and the reset pin number you should use in the GW_RESET_PIN environment variable.

Note that the reset pin you should define is the physical pin number on the Raspberry Pi. To translate between different numbering schemes you can use pinout.xyz.

If you get the message ERROR: [main] failed to start the concentrator after balenaCLoud is finished downloading the application, or when restarting the gateway, it most likely means the GW_RESET_PIN you defined is incorrect. Alternatively the problem can be caused by the hardware, typically for the IMST iC880A-SPI board with insufficient voltage, try another power supply or slightly increase the voltage.

Special note for using a Raspberry Pi 3

There is a backward incomatibility between the Raspberry Pi 1 and 2 hardware, and Raspberry Pi 3. For Raspberry Pi 3, it is necessary to make a small additional configuration change.

Click <- to go back to the Device List, and note that on the left there is an option called "Fleet Configuration". Click it.

Add a New config variable as follows:

Application config variables

TRANSFERRING TTN GATEWAY SOFTWARE TO BALENACLOUD SO THAT IT MAY BE DOWNLOADED ON YOUR DEVICES

1. On your computer, clone this git repo. For example in a terminal on Mac or Linux type:

   git clone https://github.com/kersing/ttn-resin-gateway-rpi-1
   cd ttn-resin-gateway-rpi-1/

2. Now, type the command that you'll see displayed in the edit control in the upper-right corner of the balenaCloud devices dashboard for your device. This command "connects" your local directory to the balenaCloud GIT service, which uses GIT to "receive" the gateway software from TTN, and it looks something like this:

   git remote add balena [email protected]:youraccount/yourapplication.git

3. Add your SSH public key to the list at https://dashboard.balena-cloud.com/preferences/sshkeys. You may need to search the internet how to create a SSH key on your operating system, where to find it afterwards, copy the content, and paste the content to the balenaCloud console.

4. Type the following commands into your terminal to "push" the TTN files up to balenaCloud:

   git add .
   git commit -m "first upload of ttn files to balenaCloud"
   git push -f balena master

5. What you'll now see happening in terminal is that this "git push" does an incredible amount of work:

6. It will upload a Dockerfile, a "build script", and a "run script" to balenaCloud

7. It will start to do a "docker build" using that Dockerfile, running it within a QEMU ARM virtual machine on the balenaCloud service.

8. In processing this docker build, it will run a "build.sh" script that downloads and builds the packet forwarder executable from source code, for RPi+iC880A-SPI.

9. When the build is completed, you'll see a unicorn 🦄 ASCII graphic displayed in your terminal.

10. Now, switch back to your device dashboard, you'll see that your Raspberry Pi is now "updating" by pulling the Docker container from the balenaCloud service. Then, after "updating", you'll see the gateway's log file in the window at the lower right corner. You'll see it initializing, and will also see log output each time a packet is forwarded to TTN. You're done!

Troubleshooting

If you get the error below please check if your ssh public key has been added to you balenaCloud account. In addition verify whether your private key has the correct permissions (i.e. chmod 400 ~/.ssh/id_rsa).

$ git push -f balena master
Connection closed by xxx.xxx.xxx.xxx port 22
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.
$

Pro Tips

• At some point if you would like to add a second gateway, third gateway, or a hundred gateways, all you need to do is to add a new device to your existing Application. You needn't upload any new software to balenaCloud, because balenaCloud already knows what software belongs on the gateway. So long as the environment variables are configured correctly for that new device, it'll be up and running immediately after you burn an SD card and boot it.

• balenaCloud will automatically restart the gateway software any time you change the environment variables. You'll see this in the log. Also, note that balenaCloud restarts the gateway properly after power failures. If the packet forwarder fails because of an error, it will also automatically attempt to restart.

• If you'd like to update the software across all the gateways in your device fleet, simply do the following:

  git add .
  git commit -m "Updated gateway version"
  git push -f balena master
  

• For devices without a GPS, the location that is configured on the TTN console is used. This location is only read at startup of the gateway. Therefore, after you set or changed the location, restart the application from the balenaCloud console.

Device statistics

If you want to show nice looking statistics for your gateway(s) there are a couple of additional steps to take. First, copy Dockerfile.template.metering to Dockerfile.template. Next copy start.sh.metering to start.sh. Now use the instructions above to update the balenaCloud image.

Once the new image is deployed, go to the balenaCloud dashboard for your devices and select 'Enable Public device URL' in the drop down menu (the one to the right of the light bulb). That is all that is required to provide metrics. Now you will need to install a metrics collector on a seperate system as outlined in Fleet-wide Machine Metrics Monitoring in 20mins.

(To show packet forwarder graphs you need to add your own graphs to the provided templates)

Credits

• Gonzalo Casas on the iC880a-based gateway
• Ruud Vlaming on the Lorank8 installer
• Jac Kersing on the Multi-protocol packet forwarder
• Ray Ozzie on the original ResinIO setup
• The Team at balena