unixweb/ttn-resin-gateway-rpi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
b8aca75079
ttn-resin-gateway-rpi/CONFIGURATION.md

3.5 KiB
Raw Blame History

#Environment Variables ##Required global variables

  • GW_ID required
  • GW_KEY required This gateway ID and gateway Key for TTN will be used to fetch the gateway's information form the TTN console. When SERVER_TTN is true, this will also be used to conenct and forward packets to TTN.

##Optional global variables

  • GW_CONTACT_EMAIL optional - default an empty string The gateway owner's contact information. Will be overridden by the value from the TTN console.
  • GW_DESCRIPTION optional - default an empty string A description of this gateway. Will be overridden by the value from the TTN console.
  • GW_RESET_PIN - default 22 The physical pin number on the Raspberry Pi to which the concentrator's reset is connected. See the README file for a description and a list of common values.
  • GW_GPS optional - default False
    • If true, use the hardware GPS.
    • If false, use either fake gps if a location was configured in the TTN console, otherwise try using fake gps with the reference location as set via environment variables, otherwise don't send coordinates.
  • GW_GPS_PORT optional - default /dev/ttyAMA0 The UART to which the hardware GPS is connected to.
  • GW_REF_LATITUDE optional - default 0 The latitude to use for fake gps if the coordinates are not set in the TTN console.
  • GW_REF_LONGITUDE optional - default 0 The longitude to use for fake gps if the coordinates are not set in the TTN console.
  • GW_REF_ALTITUDE optional - default 0 The altitude to use for fake gps if the coordinates are not set in the TTN console.
  • GW_FWD_CRC_ERR optional - default false Forward packets with an invalid CRC.
  • GW_FWD_CRC_VAL optional - default true. Forward packets with a valid CRC.
  • GW_ANTENNA_GAIN optional - default 0. Set this to the dBd gain of your antenna. The dBd value is the dBi value minus 2.15dB, ie. dBd = dBi-2.15. This is used to reduce the TX power of the concentrator to stay within the legal limits.

##Server variables All server variables are optional, but when a server is enabled, it is recommended to set all variables to configure it completely.

  • SERVER_TTN optional - default true Should the gateway connect to the TTN backend

  • SERVER_1_ENABLED optional - default false

  • SERVER_1_TYPE - default "semtech"

  • SERVER_1_ADDRESS

  • SERVER_1_PORTUP - only when using type semtech

  • SERVER_1_PORTDOWN - only when using type semtech

  • SERVER_1_GWID - only when using type ttn

  • SERVER_1_GWKEY - only when using type ttn

  • SERVER_1_DOWNLINK - default false

  • SERVER_2_ENABLED optional - default false

  • SERVER_2_TYPE - default "semtech"

  • SERVER_2_ADDRESS

  • SERVER_2_PORTUP - only when using type semtech

  • SERVER_2_PORTDOWN - only when using type semtech

  • SERVER_2_GWID

  • SERVER_2_GWKEY

  • SERVER_2_DOWNLINK - default false

  • SERVER_3_ENABLED optional - default false

  • SERVER_3_TYPE - default "semtech"

  • SERVER_3_ADDRESS

  • SERVER_3_PORTUP - only when using type semtech

  • SERVER_3_PORTDOWN - only when using type semtech

  • SERVER_3_GWID

  • SERVER_3_GWKEY

  • SERVER_3_DOWNLINK - default false

Note about boolean values

Use true and false as lower case words to enable or disable features via environment variables. Any other format will not be interpreted correctly.

#Logal debugging

docker run --device /dev/ttyAMA0:/dev/ttyAMA0 --device /dev/mem:/dev/mem --privileged -e GW_TYPE="imst-ic880a-spi" -e GW_DESCRIPTION="test gateway" -e GW_CONTACT_EMAIL="" -e GW_ID="" -e GW_KEY="" newforwarder

Make a copy of Dockerfile.template to Dockerfile.

FROM resin/raspberrypi-buildpack-deps
...
CMD ["bash"]