Make location and altitude optional.

Author: brocaar

docs/changelog.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 2.1.4
+
+* Retry connecting to MQTT broker on startup (thanks @jcampanell-cablelabs).
+* Make latitude, longitude and altitude optional as this data is not always
+  provided by the packet_forwarder and would else incorrectly be set to `0`.
+
 ## 2.1.3
 
 * Provide `TXPacketsReceived` and `TXPacketsEmitted` in stats.

docs/topics.md

@@ -21,12 +21,14 @@ Topic for gateway statistics. Example payload:
 
 ```json
 {
-    "altitude": 0,
-    "latitude": 0,
-    "longitude": 0,
+    "altitude": 10,                 // only available when gateway has gps
+    "latitude": 52.3740364,         // only available when gateway has gps
+    "longitude": 4.9144401,         // only available when gateway has gps
     "mac": "1dee08d0b691d149",
-    "rxPacketsReceived": 2,
-    "rxPacketsReceivedOK": 1,
+    "rxPacketsReceived": 20,
+    "rxPacketsReceivedOK": 15,
+	"txPacketsReceived": 10,
+	"txPacketsEmitted": 9,
     "time": "2016-06-10T14:04:53Z"
 }
 ```

gateway/backend.go

@@ -387,17 +387,23 @@ func (b *Backend) handleTXACK(addr *net.UDPAddr, data []byte) error {
 // newGatewayStatsPacket from Stat transforms a Semtech Stat packet into a
 // gw.GatewayStatsPacket.
 func newGatewayStatsPacket(mac lorawan.EUI64, stat Stat) gw.GatewayStatsPacket {
-	return gw.GatewayStatsPacket{
+	gwStat := gw.GatewayStatsPacket{
 		Time:                time.Time(stat.Time),
 		MAC:                 mac,
 		Latitude:            stat.Lati,
 		Longitude:           stat.Long,
-		Altitude:            float64(stat.Alti),
 		RXPacketsReceived:   int(stat.RXNb),
 		RXPacketsReceivedOK: int(stat.RXOK),
 		TXPacketsReceived:   int(stat.DWNb),
 		TXPacketsEmitted:    int(stat.TXNb),
 	}
+
+	if stat.Alti != nil {
+		alt := float64(*stat.Alti)
+		gwStat.Altitude = &alt
+	}
+
+	return gwStat
 }
 
 // newRXPacketFromRXPK transforms a Semtech packet into a gw.RXPacketBytes.

gateway/backend_test.go

@@ -20,6 +20,10 @@ func TestBackend(t *testing.T) {
 		backendAddr, err := net.ResolveUDPAddr("udp", backend.conn.LocalAddr().String())
 		So(err, ShouldBeNil)
 
+		latitude := float64(1.234)
+		longitude := float64(2.123)
+		altitude := int32(123)
+
 		Convey("Given a fake gateway UDP publisher", func() {
 			gwAddr, err := net.ResolveUDPAddr("udp", "127.0.0.1:0")
 			So(err, ShouldBeNil)
@@ -58,9 +62,9 @@ func TestBackend(t *testing.T) {
 					Payload: PushDataPayload{
 						Stat: &Stat{
 							Time: ExpandedTime(time.Time{}.UTC()),
-							Lati: 1.234,
-							Long: 2.123,
-							Alti: 123,
+							Lati: &latitude,
+							Long: &longitude,
+							Alti: &altitude,
 							RXNb: 1,
 							RXOK: 2,
 							RXFW: 3,
@@ -375,13 +379,17 @@ func TestBackend(t *testing.T) {
 }
 
 func TestNewGatewayStatPacket(t *testing.T) {
-	Convey("Given a (Semtech) Stat struct and gateway MAC", t, func() {
+	Convey("Given a (Semtech) Stat struct and gateway MAC with GPS data", t, func() {
+		latitude := float64(1.234)
+		longitude := float64(2.123)
+		altitude := int32(123)
+
 		now := time.Now().UTC()
 		stat := Stat{
 			Time: ExpandedTime(now),
-			Lati: 1.234,
-			Long: 2.123,
-			Alti: 234,
+			Lati: &latitude,
+			Long: &longitude,
+			Alti: &altitude,
 			RXNb: 1,
 			RXOK: 2,
 			RXFW: 3,
@@ -392,22 +400,53 @@ func TestNewGatewayStatPacket(t *testing.T) {
 		mac := [8]byte{1, 2, 3, 4, 5, 6, 7, 8}
 
 		Convey("When calling newGatewayStatsPacket", func() {
+			latitude := float64(1.234)
+			longitude := float64(2.123)
+			altitude := float64(123)
+
 			gwStats := newGatewayStatsPacket(mac, stat)
 			Convey("Then all fields are set correctly", func() {
 				So(gwStats, ShouldResemble, gw.GatewayStatsPacket{
 					Time:                now,
 					MAC:                 mac,
-					Latitude:            1.234,
-					Longitude:           2.123,
-					Altitude:            234,
+					Latitude:            &latitude,
+					Longitude:           &longitude,
+					Altitude:            &altitude,
 					RXPacketsReceived:   1,
 					RXPacketsReceivedOK: 2,
 					TXPacketsReceived:   4,
 					TXPacketsEmitted:    3,
 				})
 			})
 		})
+	})
 
+	Convey("Given a (Semtech) Stat struct and gateway MAC without GPS data", t, func() {
+		now := time.Now().UTC()
+		stat := Stat{
+			Time: ExpandedTime(now),
+			RXNb: 1,
+			RXOK: 2,
+			RXFW: 3,
+			ACKR: 33.3,
+			DWNb: 4,
+			TXNb: 3,
+		}
+		mac := [8]byte{1, 2, 3, 4, 5, 6, 7, 8}
+
+		Convey("When calling newGatewayStatsPacket", func() {
+			gwStats := newGatewayStatsPacket(mac, stat)
+			Convey("Then all fields are set correctly", func() {
+				So(gwStats, ShouldResemble, gw.GatewayStatsPacket{
+					Time:                now,
+					MAC:                 mac,
+					RXPacketsReceived:   1,
+					RXPacketsReceivedOK: 2,
+					TXPacketsReceived:   4,
+					TXPacketsEmitted:    3,
+				})
+			})
+		})
 	})
 }
 

gateway/structs.go

@@ -394,9 +394,9 @@ type RXPK struct {
 // Stat contains the status of the gateway.
 type Stat struct {
 	Time ExpandedTime `json:"time"` // UTC 'system' time of the gateway, ISO 8601 'expanded' format (e.g 2014-01-12 08:59:28 GMT)
-	Lati float64      `json:"lati"` // GPS latitude of the gateway in degree (float, N is +)
-	Long float64      `json:"long"` // GPS latitude of the gateway in degree (float, E is +)
-	Alti int32        `json:"alti"` // GPS altitude of the gateway in meter RX (integer)
+	Lati *float64     `json:"lati"` // GPS latitude of the gateway in degree (float, N is +)
+	Long *float64     `json:"long"` // GPS latitude of the gateway in degree (float, E is +)
+	Alti *int32       `json:"alti"` // GPS altitude of the gateway in meter RX (integer)
 	RXNb uint32       `json:"rxnb"` // Number of radio packets received (unsigned integer)
 	RXOK uint32       `json:"rxok"` // Number of radio packets received with a valid PHY CRC
 	RXFW uint32       `json:"rxfw"` // Number of radio packets forwarded (unsigned integer)

vendor/github.com/brocaar/loraserver/api/gw/gw.go

@@ -9,10 +9,10 @@
 			"revisionTime": "2016-06-01T11:32:10Z"
 		},
 		{
-			"checksumSHA1": "OczmUysWM7nRgR3w/90QktARp1A=",
+			"checksumSHA1": "6EjJ4tPAes1IG51evTGi4DMLoSc=",
 			"path": "github.com/brocaar/loraserver/api/gw",
-			"revision": "dc0fea616507659ec7272203a8c2caae817aea08",
-			"revisionTime": "2017-02-15T08:45:58Z"
+			"revision": "09db862703abb0923cc842d0e54e201de47df219",
+			"revisionTime": "2017-03-24T09:36:17Z"
 		},
 		{
 			"checksumSHA1": "ya7tMk+wexXh1cmbdp0Sw0lbM1k=",