Rename lora-semtech-bridge > lora-gateway-bridge.

brocaar · brocaar · commit df5ddb0d8ef2 · 2016-06-30T19:00:15.000+02:00
diff --git a/.travis.yml b/.travis.yml
@@ -31,22 +31,22 @@ deploy:
     skip_cleanup: true
     access_key_id: AKIAIOU53PLXIUE7YBBQ
     secret_access_key:
-      secure: icpQ0132LlnZD6b2m8o/Bhe9JJnuSJh9hDv1OCmS+h4xO1DSfn1hNuk05a6oyDSwPF04HCbmncTLDcGLnbokK+dL2mrlT6M3BCbC29orLcP7rrUKnq5VLCrVI2jdyBAtLmzNIzPYci8dVuJfj9Voom4/BXosxM+2ry2xa0uvl5dYtzQS7yoocxpl7j3LfzP3hM6GEx64ePIikdOC9U6f1wtdMJ/GjDOUOEl4KqRXYcbOKvufXg+HW3BKLskZsFFn2xoUNvG6rMQZGmirJpiKN+GinEW06HmLEKqynsAMEJEoUw4L40kPhLmT2rm3kUbAQU99ZEitBPmAmh9jA85f6bO1kOVYF9J5S7EVIDUCbqCpaIDoG4w5iVNodb/7VHM5j+6SVjnHHNTpZ3LIF6GD4W6775DzZECU6vZELHymy4ro0haMYRcU3xp+rD/OT1LE031lZK8VcakpyJKb8d2/JO8r22SLBqOI7qV96rhtHSzPxdG4Dug3jXr8Cio/mfHVJOZu9WU37xWhPhjRLPta6AIQAbG+AySptCu/3mqq3uKUFsP9YZQYkCgr4kR7H3hMlvYOVSwmhcQReHuFLN5DotoHFA2f2CgVh1uVaSGoNKDDMK8Zf8ArOslGhRzZrSGRYuxKqbWdae9EIhWyPR4cdnzT11C5/Kdfdj9CqQPgvb0=
+      secure: h5ku+etn/Y+CDyXoVIoImMgc5sP1cOjQ0rDSt60sdEUsboHHo7sFfPRybTppcTJwZe33bMl5/nrW0GGHpMpbotWB2ifxe/irRPsRpuXzy2lc0rq1DaT9mHK1SJ3VYEYjIJVH+G5GQFzt5cPxgPagkpPMZyLth+liCg0ry7tz/P1MxGg5Ltn9yIOKjyNBeEIKYGDzsyUlTDlTrN6xKmic9aHa5yulXdyS0r8XVZ6YqT/CLEWS2fF16XnQ3OqNXjh8beBHj7oRxj9Z/SWAS82PBO8WBBQ9wrT7JDuP7oSPKpjZPnbHcOxSCHiakzaVqGAJCTQJ7ndjIYLItQoKJxs1t2XM8NUd10o87d3XE5yDcGvFBkAI53oAIFa/2nmJSyNwBnutp8xg+JcuexxZKZsPwKk8mh0vIpmM0JcWTHIjW+ATskjUkMiX3ap/nn2uvGTBXIC4X9wSNKySkx0yKiM4nW+6U5fseAz4X9zkUby/STEGtIfGIaiFba3AH0d+Ld+qwzdS3RTLIWwIAdvWodekW2YPpeITsaBFpAyKxw5eTQ6GkgOOOV8se4sEY2EDarWlC/xAyPdIpJtveos8SR+uG8z9E030keglZLl49GjBbEgWrMwxAji9p/S3dY0SrBIHtKmEaP2lI7F8uL0dMG49yiY6LUcInhuOPkZ+oXnHn+c=
     bucket: docs.loraserver.io
     local-dir: site
-    upload-dir: lora-semtech-bridge
+    upload-dir: lora-gateway-bridge
     acl: public_read
     region: eu-west-1
     on:
-      repo: brocaar/lora-semtech-bridge
+      repo: brocaar/lora-gateway-bridge
       branch: master
 
   - provider: releases
     skip_cleanup: true
     api_key:
-      secure: hue09xkRBLJpF5gR7nBCn1CySTTwUwe2ZYZA4Q2RjqdQ6Tk8KXgaJp+wk3xl24oWUb4l6dv2dETy+awT/G1DsOz6z5oGzuNFvAuTIqWgk5eIpctwPYlc9t0mgUnBJCx/eDYIoN/ogBxoE2QFE4CCfYcGd5iFpYb2aPw8oP6Pc5LYsm6PYUHi1IE69tyMj9aFWgtMYX8OxjhTx4vFpDvQmipQE3LqYlu9z7DyeIeuxLBgGFnrjOBQsjlUsQcsgmyeazUBN8qSUhYTdhSwYw5OEI45Ddc/Pkj/pz6HbHygUmO6FIa64rLADVK0Cuaw8+jxYSgeFu2sdIk7wE30sWBITzZhvs9k/OLIghwg+eu9mZ0l0i0K1gfdwqMpQA//QnXDzSiu6FkbCz0dNQX95VJNHfmMCSrg8Dd3ebMx+4VceU6IdWEtyJAHwFONJ4cNieufaPawnEym5VBG2uZ/Iv7rYFoS1W53oCD2mGDRWpTMxQkfFMAgD0gIDB+oN0FVaApjWy+/4KVXRYf4+Eqh0BZ6YizTRt+QmD3X+0jh3j/h0wMYUE6lAGqOmTcJUPUpGBzzx3jT9XVBHCeBTVTWT7wZAMtVPGyFj2Izm/B601DIsrIdvCco4QEUTCUjZjKDM6A3OUz512GBSbKYZ0EVGoxhRv2CRSO4MeQM5Y7Lwpu/6mc=
+      secure: i9kTpzo0LVyMdMyN66SxXGBYovd98+B4DW9t/xFxx0cOzCwDKx/2p2WYF7cbT6FhVQVPZHJuIqatEFPVHgkRbiqsLIN26RL7xdCGV0gqjYoXVjJEdr6s9z1BhxUDGHY5oKhTZP7mHM+5jdHyZiwBbVFhJkeEbuZfwaOu7fho3IgGgnMASMh0LODk5niBnAJah1tMyUa5+7lW3fBAjwP2DNPICzIFm35JFjI5ViyirWcSapuTTE70BOH02PNd/wjx/4VnW5+wgCPeZXqjUQ5u94KHNLj5AxwotbzLNM1fDngJeDCmFMUPCjR+LCRnEO+4qhdMAhBdiTn0tXFoVQXlywrmfBdQtA3Kr8GSWHF1x2Oqr6/sIti0+fjyqdHRG2LdL7shEktBrG3muNUrVflpHXBzPOm9HvzQ7Hws6JudY52kermCeCRcbypcWz9PSK+XtAIbQxY0hO3cBRysNKjQ3K6IwPaUUqJzLrdowZ/LRhDur1JBXwc6cxS+4Yv885jUhIIfvFuM/lE1btK1zAtqVT1YVfXSpnMWk/FvBohHbQRy4i80Vd3an41hdM5Di/rPI8rkRaCqGRep3/FitKCVixvI1lKzgfRDFGLIBTBor0tL6tfD4T3ZuC/hRpTzI+UHx8XyO1RGZQIHNj3jIOJl+EBVYz+93KS3Z80v3uMj5ck=
     file_glob: true
     file: "dist/*.tar.gz"
     on:
       tags: true
-      repo: brocaar/lora-semtech-bridge
+      repo: brocaar/lora-gateway-bridge
diff --git a/Dockerfile b/Dockerfile
@@ -1,6 +1,6 @@
 FROM golang:1.6.2
 
-ENV PROJECT_PATH=/go/src/github.com/brocaar/lora-semtech-bridge
+ENV PROJECT_PATH=/go/src/github.com/brocaar/lora-gateway-bridge
 ENV PATH=$PATH:$PROJECT_PATH/build
 
 # install tools
@@ -17,4 +17,4 @@ COPY . $PROJECT_PATH
 # build
 RUN make build
 
-CMD ["semtech-bridge"]
+CMD ["lora-gateway-bridge"]
diff --git a/Makefile b/Makefile
@@ -7,7 +7,7 @@ GOARCH ?= amd64
 build:
 	@echo "Compiling source for $(GOOS) $(GOARCH)"
 	@mkdir -p build
-	@GOOS=$(GOOS) GOARCH=$(GOARCH) go build -ldflags "-X main.version=$(VERSION)" -o build/semtech-bridge$(BINEXT) cmd/semtech-bridge/main.go
+	@GOOS=$(GOOS) GOARCH=$(GOARCH) go build -ldflags "-X main.version=$(VERSION)" -o build/lora-gateway-bridge$(BINEXT) cmd/lora-gateway-bridge/main.go
 
 clean:
 	@echo "Cleaning up workspace"
@@ -26,13 +26,13 @@ package: clean build
 	@echo "Creating package for $(GOOS) $(GOARCH)"
 	@mkdir -p dist/$(VERSION)
 	@cp build/* dist/$(VERSION)
-	@cd dist/$(VERSION)/ && tar -pczf ../lora_semtech_bridge_$(VERSION)_$(GOOS)_$(GOARCH).tar.gz .
+	@cd dist/$(VERSION)/ && tar -pczf ../lora_gateway_bridge_$(VERSION)_$(GOOS)_$(GOARCH).tar.gz .
 	@rm -rf dist/$(VERSION)
 
 # shortcuts for development
 
 serve: build
-	./build/semtech-bridge
+	./build/lora-gateway-bridge
 
 run-compose-test:
-	docker-compose run --rm semtechbridge make test
+	docker-compose run --rm gatewaybridge make test
diff --git a/README.md b/README.md
@@ -1,40 +1,48 @@
-# LoRa Semtech Bridge
+# LoRa Gateway Bridge
 
-[![Build Status](https://travis-ci.org/brocaar/lora-semtech-bridge.svg?branch=master)](https://travis-ci.org/brocaar/lora-semtech-bridge)
-[![Documentation Status](https://readthedocs.org/projects/lora-semtech-bridge/badge/?version=latest)](http://lora-semtech-bridge.readthedocs.org/en/latest/?badge=latest)
-[![Documentation Status](https://readthedocs.org/projects/lora-semtech-bridge/badge/?version=stable)](http://lora-semtech-bridge.readthedocs.org/en/stable/?badge=stable)
-[![GoDoc](https://godoc.org/github.com/brocaar/lora-semtech-bridge/cmd/semtech-bridge?status.svg)](https://godoc.org/github.com/brocaar/lora-semtech-bridge/cmd/semtech-bridge)
-
-LoRa Semtech Bridge is a service which abstracts the 
-[Semtech protocol](https://github.com/Lora-net/packet_forwarder/blob/master/PROTOCOL.TXT)
-into JSON over MQTT. This project is part of [LoRa Server](https://github.com/brocaar/loraserver).
+[![Build Status](https://travis-ci.org/brocaar/lora-gateway-bridge.svg?branch=master)](https://travis-ci.org/brocaar/lora-gateway-bridge)
+[![GoDoc](https://godoc.org/github.com/brocaar/lora-gateway-bridge/cmd/gateway-bridge?status.svg)](https://godoc.org/github.com/brocaar/lora-gateway-bridge/cmd/lora-gateway-bridge)
 
+LoRa Gateway Bridge is a service which abstracts the 
+[packet_forwarder UDP protocol](https://github.com/Lora-net/packet_forwarder/blob/master/PROTOCOL.TXT)
+running on most LoRa gateways into JSON over MQTT. It enables you to use MQTT for
+receiving data from and sending data to your gateways.
+This project is part of [LoRa Server](https://github.com/brocaar/loraserver).
 
 ## Documentation
 
-See the [http://lora-semtech-bridge.readthedocs.io/](http://lora-semtech-bridge.readthedocs.io/)
-for documentation about setting up LoRa Semtech Bridge.
+See [http://docs.loraserver.io/lora-gateway-bridge](http://docs.loraserver.io/lora-gateway-bridge)
+for documentation about setting up LoRa Gateway Bridge.
 
 ## Compatibility
 
-The table below shows the compatibility between LoRa Semtech Bridge and the
-available Semtech UDP protocol versions:
+The table below shows the compatibility between LoRa Gateway Bridge and the
+packet_forwarder UDP protocol versions:
+
+| LoRa Gateway Bridge | packet_forwarder protocol version | Note                                                                |
+|---------------------|-----------------------------------|---------------------------------------------------------------------|
+| 1.x.x               | 1                                 |                                                                     |
+| 2.x.x               | 2                                 | This protocol is used since version 3.0.0 of the `packet_forwarder` |
+
 
-| LoRa Semtech Bridge | Semtech UDP protocol version | Note                                                                |
-|---------------------|------------------------------|---------------------------------------------------------------------|
-| 1.x.x               | 1                            |                                                                     |
-| 2.x.x               | 2                            | This protocol is used since version 3.0.0 of the `packet_forwarder` |
+LoRa Gateway Bridge v1.x.x will be update with bugfixes for the near future as
+not all gateways are using packet_forwarder v3.0.0+ yet.
 
 ## Downloads
 
-Pre-compiled binaries are available for:
+Pre-compiled binaries are available from the [releases](https://github.com/brocaar/lora-gateway-bridge/releases) page:
 
-* Linux (and ARM build for e.g. Raspberry Pi)
+* Linux (including ARM / Raspberry Pi)
 * OS X
 * Windows
 
-See [releases](https://github.com/brocaar/lora-semtech-bridge/releases).
+Source-code can be found at [https://github.com/brocaar/lora-gateway-bridge](https://github.com/brocaar/lora-gateway-bridge).
+
+## Issues / feature-requests
+
+Issues or feature-requests can be opened at [https://github.com/brocaar/lora-gateway-bridge/issues](https://github.com/brocaar/lora-gateway-bridge/issues).
 
 ## License
 
-LoRa Server is licensed under the MIT license. See ``LICENSE``.
+LoRa Gateway Bridge is distributed under the MIT license. See 
+[LICENSE](https://github.com/brocaar/lora-gateway-bridge/blob/master/LICENSE).
diff --git a/cmd/lora-gateway-bridge/doc.go b/cmd/lora-gateway-bridge/doc.go
@@ -1,13 +1,13 @@
 /*
 NAME:
-   semtech-bridge - communicate with a LoRa gateway (Semtech UDP protocol) over MQTT
+   lora-gateway-bridge - abstracts the packet_forwarder protocol into JSON over MQTT
 
 USAGE:
    main [global options] command [command options] [arguments...]
-   
+
 COMMANDS:
    help, h	Shows a list of commands or help for one command
-   
+
 GLOBAL OPTIONS:
    --udp-bind "0.0.0.0:1700"		ip:port to bind the UDP listener to [$UDP_BIND]
    --mqtt-server "tcp://127.0.0.1:1883"	MQTT server [$MQTT_SERVER]
@@ -16,10 +16,10 @@ GLOBAL OPTIONS:
    --log-level "4"			debug=5, info=4, warning=3, error=2, fatal=1, panic=0 [$LOG_LEVEL]
    --help, -h				show help
    --version, -v			print the version
-   
+
 COPYRIGHT:
-   See http://github.com/brocaar/lora-semtech-bridge for copyright information
-   
+   See http://github.com/brocaar/lora-gateway-bridge for copyright information
+
 
 */
 package main
diff --git a/cmd/lora-gateway-bridge/doc.sh b/cmd/lora-gateway-bridge/doc.sh
diff --git a/cmd/lora-gateway-bridge/main.go b/cmd/lora-gateway-bridge/main.go
@@ -8,8 +8,8 @@ import (
 	"syscall"
 
 	log "github.com/Sirupsen/logrus"
-	"github.com/brocaar/lora-semtech-bridge/backend/mqttpubsub"
-	"github.com/brocaar/lora-semtech-bridge/gateway"
+	"github.com/brocaar/lora-gateway-bridge/backend/mqttpubsub"
+	"github.com/brocaar/lora-gateway-bridge/gateway"
 	"github.com/brocaar/lorawan"
 	"github.com/codegangsta/cli"
 )
@@ -72,9 +72,9 @@ func run(c *cli.Context) error {
 
 func main() {
 	app := cli.NewApp()
-	app.Name = "semtech-bridge"
-	app.Usage = "communicate with a LoRa gateway (Semtech UDP protocol) over MQTT"
-	app.Copyright = "See http://github.com/brocaar/lora-semtech-bridge for copyright information"
+	app.Name = "lora-gateway-bridge"
+	app.Usage = "abstracts the packet_forwarder protocol into JSON over MQTT"
+	app.Copyright = "See http://github.com/brocaar/lora-gateway-bridge for copyright information"
 	app.Version = version
 	app.Action = run
 	app.Flags = []cli.Flag{
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,10 +1,10 @@
-semtechbridge:
+gatewaybridge:
   build: .
   command: make serve
   ports:
     - "1700/udp:1700/udp"
   volumes:
-    - ./:/go/src/github.com/brocaar/lora-semtech-bridge
+    - ./:/go/src/github.com/brocaar/lora-gateway-bridge
   links:
     - mosquitto
   environment:
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.0.2
+
+* Rename from `lora-semtech-bridge` to `lora-gateway-bridge`
+
 ## 2.0.1
 
 * Update `lorawan` vendor to fix a mac command related marshaling issue.
diff --git a/docs/frequently-asked-questions.md b/docs/frequently-asked-questions.md
@@ -1,3 +1,5 @@
+# Frequently asked questions
+
 ## Packet-loss (packet_forwarder)
 
 There are many issues that can cause packet-loss (data is not received or
@@ -30,7 +32,7 @@ To be investigated
 
 To be investigated
 
-## semtech-bridge errors
+## lora-gateway-bridge errors
 
 ### `gateway: could not handle packet: gateway: invalid protocol version`
 
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -1,36 +1,36 @@
+# Getting started
+
 ## Strategies
 
-There are multiple ways that you can deploy the LoRa Semtech Bridge:
+There are multiple ways that you can deploy the LoRa Gateway Bridge:
 
 ### Single instance
 
 The most basic strategy is to connect all your gateways to a single instance
-of the LoRa Semtech Bridge.
+of the LoRa Gateway Bridge.
 
 ### Multiple instances
 
-To make the LoRa Semtech Bridge HA, you can run a cluster of instances
+To make the LoRa Gateway Bridge HA, you can run a cluster of instances
 (connecting to the same MQTT broker).
 **Important:** make sure that each gateway connection is always routed to the
 same instance!
 
 ### On each gateway
 
-Depending on the capabilities of your gateway, you can deploy the LoRa Semtech
+Depending on the capabilities of your gateway, you can deploy the LoRa Gateway
 Bridge on each of your gateways. This enables you to encrypt all traffic from
 your gateway by connecting to the MQTT broker over SSL/TLS.
 
 
-
-
 ## Requirements
 
-Before you install the LoRa Semtech Bridge, make sure you've installed the
+Before you install the LoRa Gateway Bridge, make sure you've installed the
 following requirements:
 
 ### MQTT broker
 
-LoRa Semtech Brige makes use of MQTT for communication with the gateways and
+LoRa Gateway Brige makes use of MQTT for communication with the gateways and
 applications. [Mosquitto](http://mosquitto.org/) is a popular open-source MQTT
 server. Make sure you install a **recent** version of Mosquitto (the Mosquitto
 project provides [repositories for various Linux distributions](http://mosquitto.org/download/)).
@@ -40,16 +40,16 @@ project provides [repositories for various Linux distributions](http://mosquitto
 See [packet_forwarder](packet-forwarder.md) for instructions about how to
 setup the packet_forwarder on your gateway.
 
-## Install LoRa Semtech Brige
+## Installing the LoRa Gateway Brige
 
 !!! warning "Compatibility"
     Please check the [Compatibility](index.md#compatibility) to make sure you
-    download the correct LoRa Semtech Bridge version.
+    download the correct LoRa Gateway Bridge version.
 
 ### Download
 
 Download and unpack a pre-compiled binary from the
-[releases](https://github.com/brocaar/lora-semtech-bridge/releases) page.
+[releases](https://github.com/brocaar/lora-gateway-bridge/releases) page.
 Alternatively, build the code from source (not covered).
 
 ### Configuration
@@ -60,31 +60,31 @@ arguments. Arguments and environment variables can be mixed.
 To get a list (and explanation) of all the available arguments, execute:
 
 ``` bash
-$ ./semtech-bridge --help
+$ ./lora-gateway-bridge --help
 ```
 
-### Starting LoRa Semtech Bridge
+### Starting LoRa Gateway Bridge
 
 Assuming you have a MQTT broker running on the same host without authentication,
-starting LoRa Semtech Bridge is as simple as:
+starting LoRa Gateway Bridge is as simple as:
 
 ``` bash
-$ ./semtech-bridge \
+$ ./lora-gateway-bridge \
     --udp-bind 0.0.0.0:1700             \  # this is the port you must use in the packet_forwarder
     --mqtt-server tcp://127.0.0.1:1883
 ```
 
 ### LoRa gateway configuration
 
-Now you have the LoRa Semtech Bridge running, it is time to configure the
+Now you have the LoRa Gateway Bridge running, it is time to configure the
 packet_forwarder on your gateway. Edit the file ``local_config.json``:
 
 ``` json
 {
     "gateway_conf": {
         "gateway_ID": "...",      /* you must pick a unique 64b number for each gateway (represented by an hex string) */
-        "server_address": "...",  /* the IP address on which the LoRa Semtech Bridge is running */
-        "serv_port_up": 1700,     /* 1700 is the default LoRa Semtech Bridge port for up and down */
+        "server_address": "...",  /* the IP address on which the LoRa Gateway Bridge is running */
+        "serv_port_up": 1700,     /* 1700 is the default LoRa Gateway Bridge port for up and down */
         "serv_port_down": 1700
     }
 }
@@ -111,9 +111,9 @@ INFO[0021] backend/mqttpubsub: publishing packet         topic=gateway/1dee08d0b
 ```
 
 For an explanation of the different types of data you can receive from and
-send to the LoRa Semtech Bridge see [topics](topics.md).
+send to the LoRa Gateway Bridge see [topics](topics.md).
 
 ## Setup LoRa Server
 
-Now you have your LoRa Semtech bridge instance up and running, it is time to
+Now you have your LoRa Gateway bridge instance up and running, it is time to
 setup [LoRa Server](https://github.com/brocaar/loraserver).
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/packet-forwarder.md b/docs/packet-forwarder.md
diff --git a/mkdocs.yml b/mkdocs.yml
diff --git a/vendor/vendor.json b/vendor/vendor.json
