Docker image for Raspberry PI TTN gateway based on Hypriot
Switch branches/tags
Nothing to show
Clone or download

README.md

Raspberry PI TTN gateway

Build Status Docker Pulls Docker Stars License

Raspberry PI TTN gateway image based on Hypriot. This dockerfile is heavily influenced by the install script from The Things Network iC880a-based gateway.

Hardware Preperation

This image is made for and tested on a Raspberry Pi 3 together with a IMST-iC880 SPI LoRaWAN concentrator.

OS preparation

Here are the steps to get the host environment ready for this image:

  1. Download the latest HypriotOS from here: https://blog.hypriot.com/downloads/
  2. Install it on a SD card. Etcher is a easy-to-use tool for this: https://etcher.io/
    • Optional: place an empty ssh file in the root of the SD card to enable SSH access to the Pi
  3. Put the SD card into your Raspberry Pi and power it up
  4. Login with user pirate and password hypriot Note: default keyboard layout is QWERTY. If you are using a QWERTZ keyboard make sure you use the correct 'y' in the password
    • For SSH access: once the Pi has fully booted (the blinking LEDs have calmed down) it shows up with the default hostname black-pearl in your network.
  5. Run sudo apt-get update && sudo apt-get install raspi-config kbd. During setup you can choose a different keyboard layout if you need
  6. Run sudo raspi-config to
    • Set correct timezone: 4 Localisation Options > I2 Change Timezones
    • Enable SPI interface: 5 Interfacing Options > P4 SPI > Yes
  7. Restart the Pi
  8. Find the Pi MAC address and generate gateway EUI (required in next step) by running cat /sys/class/net/eth0/address | awk -F\: '{print $1$2$3"fffe"$4$5$6}'. This turns the 48-bit MAC address into EUI-64, splits it in half and injects fffe (e.g. b827eb8684a2b827ebfffe8684a2).
  9. Run
    docker run -it --privileged --net=host --restart=always \
    -e PI_RESET_PIN=<optional-see-explanation-below> \
    -e GATEWAY_REGION=<optional-see-explanation-below> \
    -e GATEWAY_EUI=<EUI-identified-in-previous-step> \
    -e GATEWAY_LAT=YOUR_LATITUDE \
    -e GATEWAY_LON=YOUR_LONGITUDE \
    -e GATEWAY_ALT=YOUR_ALTITUDE \
    -e GATEWAY_EMAIL=YOUR_EMAIL \
    -e GATEWAY_NAME=YOUR_GATEWAY_NAME \
    netceteragroup/rpi-ttn-gateway
    • PI_RESET_PIN may or may not be required depending on how the concentrator is connected to the Pi. The default reset pin configured by the start script is 25. Installations with simple backplanes such as the one from Gnz can go with the default value. More elaborate backplanes might rewire the reset pin. The one from CH2i for example uses 17. Hence, you would say docker run ... -e PI_RESET_PIN=17 ....

    • GATEWAY_REGION is optional and defaults to EU, it denotes the LoRaWAN region your gateway operates in according to the below frequency table. The TTN server to use is derived from the region.

      Region Frequency
      EU 433 and 863-870 MHz
      US America, 902-928 MHz
      CN China, 470-510 and 779-787 MHz
      AU Australia, 915-928 MHz
      AS Southeast Asia, 923 MHz
      KR Korea, 920-923 MHz

      Check The Things Network frequencies-by-country page for details.

Building the image yourself

To build a (potentially customized) image yourself do as follows:

$ git clone https://github.com/netceteragroup/rpi-ttn-gateway
$ cd rpi-ttn-gateway
$ docker build -t <your-handle-here>/rpi-ttn-gateway . 

<your-handle-here> can be anything that is uniquely you (e.g. name) but you might also use rpi-ttn-gateway w/o any "prefix".

Security considerations

Just a few obvious measures you can/should think about before you release your new gateway into the wild.

  • It does help if the gateway is connected to the internet through a private network that's hard to penerate.
  • Change the default password: connect to the Pi and run passwd to use a custom password.
  • Change the default hostname: edit /boot/device-init.yaml and modify the hostname attribute (source).