Updates to Multitech docs (#57)

Author: jcampanell-cablelabs

docs/content/install/gateway/MultitechGatewaySettings.png

@@ -5,7 +5,6 @@ menu:
         parent: gateway
 ---
 
-## Kerlink
 
 ### Kerlink IOT station
 

docs/content/install/gateway/kerlink.md

@@ -0,0 +1,79 @@
+#!/bin/bash
+#
+# A SysV init script for the lora-gateway-bridge
+#
+### BEGIN INIT INFO
+# Provides:             lora-gateway-bridge
+# Required-Start:       $syslog $network
+# Required-Stop:        $syslog $network
+# Should-Start:         $local_fs
+# Should-Stop:          $local_fs
+# Default-Start:        2 3 4 5
+# Default-Stop:         0 1 6
+# Short-Description:    lora-gateway-bridge
+# Description:          Sends lora messages from the gateway to the open source server..
+### END INIT INFO
+#
+PIDFILE=/var/run/lora-gateway-bridge.pid
+NAME=lora-gateway-bridge
+STARTSCRIPT=/opt/lora-gateway-bridge/bin/runGateway.sh
+RETVAL=0
+
+start() {
+if [ -f $PIDFILE ]; then
+    echo "$NAME is already running"
+else
+    echo "Starting $NAME"
+    # Start the server, passing in the file to get the PID
+    $STARTSCRIPT $PIDFILE
+    RETVAL=$?
+fi
+}
+
+stop() {
+if [ -f $PIDFILE ]; then
+    echo "Shutting down $NAME"
+    kill `cat $PIDFILE`
+    # Get rid of the pidfile so we don't assume it's running any more.
+    rm -f $PIDFILE
+    RETVAL=$?
+else
+    echo "$NAME is not running."
+fi
+}
+
+restart() {
+echo "Restarting $NAME"
+stop
+start
+}
+
+status() {
+if [ -f $PIDFILE ]; then
+    echo "Status for $NAME:"
+    ps -ef `cat $PIDFILE`
+    RETVAL=$?
+else
+    echo "$NAME is not running"
+fi
+}
+
+case "$1" in
+start)
+    start
+    ;;
+stop)
+    stop
+    ;;
+status)
+    status
+    ;;
+restart)
+    restart
+    ;;
+*)
+    echo "Usage: {start|stop|status|restart}"
+    exit 1
+    ;;
+esac
+exit $RETVAL

docs/content/install/gateway/lora-gateway-bridge

@@ -45,7 +45,11 @@ netmask by adding a “#” at the beginning of each line:
 Then reboot, and obtain the issued IP address as outlined above.
 
 The basic setup steps are outlined below for the packet forwarder for each 
-device, followed by `Install lora-gateway-bridge` below.
+device, followed by `Install lora-gateway-bridge` below.  This image shows how 
+the components connect to each other, and what some of the various settings 
+represent:
+
+![Gateway Pieces and Connections](../MultitechGatewaySettings.png)
 
 #### Multitech Conduit AEP
 
@@ -97,6 +101,9 @@ signed certificate.  Accept the certificate to proceed.
         }
     }
     ```
+    Note that the serv_port_up and serv_port_down represent the ports used to 
+    communicate with the lora-gateway-bridge, usually on localhost (the 
+    server_address parameter).  See the image above.
 
 15. Select “Submit”.
 16. Select the “Save and Restart” option on the left menu.
@@ -128,12 +135,19 @@ Now you will want to set up the lora-gateway-bridge on the device.  The
 following are suggested files and locations:
 
 1. Download the arm build of the lora-gateway-bridge (see `Downloads` on the 
-   left), and extract it to `/opt/lora-gateway-bridge/bin/`
+   left), and extract it to `/opt/lora-gateway-bridge/bin/`.  Note that at the 
+   time of this writing, the Multitech boxes are all running 32-bit amd 
+   processors.  This can be verified by issuing the command `uname -a`, where 
+   'armv7' or lower in the output represents 32-bit arm processors, and 'armv8'
+   or higher represents 64-bit arm processors.  Be sure to download the 
+   appropriate binary package for the system processor.
 
-2. Create a script to run the application with the appropriate settings for your
-   installation in /opt/lora-gateway-bridge/bin/runGateway.sh:
+2. Create a script (or download [here](../runGateway.sh)) to run the application 
+   with the appropriate settings for your installation in 
+   /opt/lora-gateway-bridge/bin/runGateway.sh (ensure that the script is 
+   executable `chmod +x /opt/lora-gateway-bridge/bin/runGateway.sh`):
 
-   ```
+    ```
     #!/bin/bash
     # Starts the gateway code
 
@@ -163,11 +177,17 @@ following are suggested files and locations:
     PID=$!
     if [[ $PIDFILE != "" ]]; then
         echo $PID > $PIDFILE
-    fi```
-    
-3. Then create a startup script in /etc/init.d/lora-gateway-bridge:
+    fi
+ 
+    ```
+    Modify the MQTT_* values to reflect the settings for your system.    
+
+3. Then create a startup script (or download [here](../lora-gateway-bridge)) in 
+   /etc/init.d/lora-gateway-bridge (ensure that the script is executable 
+   `chmod +x /etc/init.d/lora-gateway-bridge`):
+
 
-   ```
+    ```
     #!/bin/bash
     #
     # A SysV init script for the lora-gateway-bridge
@@ -246,7 +266,8 @@ following are suggested files and locations:
             exit 1
             ;;
     esac
-    exit $RETVAL```
+    exit $RETVAL
+    ```
     
 4. Make sure the script start on reboot:
 

docs/content/install/gateway/multitech.md

@@ -0,0 +1,30 @@
+#!/bin/bash
+# Starts the gateway code
+
+# Accept a single parameter of where to put the pid of the actual lora-app-server 
+# process.
+if [ "$#" -ge 1 ]; then
+    PIDFILE=$1
+else
+    PIDFILE=
+fi
+
+# These placeholder values will be replaced by the install script at startup.
+# A change in these values will require a manual change here or a reinstall of
+# the lora-gateway-bridge package.
+export MQTT_SERVER="ssl://some.server.net"
+export MQTT_USERNAME="username"
+export MQTT_PASSWORD="password"
+
+# Start the log file by identifying the device.  Just print it out, too, 
+# so we can find it in the system startup output.
+export LORA_CARD_MAC=$(mts-io-sysfs show lora/eui)
+export LORA_CARD_MAC=${LORA_CARD_MAC//:/}
+echo "Lora Gateway Bridge running on device with MAC $LORA_CARD_MAC"
+echo "Lora Gateway Bridge running on device with MAC $LORA_CARD_MAC" > /var/log/lora-gateway-bridge.log
+
+/opt/lora-gateway-bridge/bin/lora-gateway-bridge --log-level 5 >> /var/log/lora-gateway-bridge.log 2>&1 &
+PID=$!
+if [[ $PIDFILE != "" ]]; then
+    echo $PID > $PIDFILE
+fi