Added pluggable route decoder and filtering based on flight number

Author: alexrobin

sensors/aviation/sensorhub-driver-fltaware/README.md

@@ -1,5 +1,3 @@
-Collection of drivers for Earthcast/Delta project. Includes separate driver classes for:
-- NLDN (lightning)
-- MESH (Hail)
-- Turbulence (Vertical slices of GTGTURB product)
-- FlightAware (Feed for flight plan and location data)
+# FlightAware Add-on
+
+Add-on to ingest real-time flight plan and position data from FlightAware Firehose feed

sensors/aviation/sensorhub-driver-fltaware/src/main/java/org/sensorhub/impl/sensor/flightAware/FlightAwareConfig.java

@@ -57,6 +57,9 @@ enum Mode {
     @DisplayInfo(desc="Airline codes to listen for")
     public List<String> airlines = new ArrayList<>();
 
+    @DisplayInfo(desc="Flight filter configuration")
+    public FlightObjectFilterConfig filterConfig;
+    
     @DisplayInfo(desc="Pub/sub configuration")
     public MessageQueueConfig pubSubConfig;
 }

sensors/aviation/sensorhub-driver-fltaware/src/main/java/org/sensorhub/impl/sensor/flightAware/FlightAwareDriver.java

@@ -86,6 +86,8 @@ public class FlightAwareDriver extends AbstractSensorModule<FlightAwareConfig> i
 	static final String SENSOR_UID_PREFIX = "urn:osh:sensor:aviation:";
 	static final String FLIGHT_UID_PREFIX = "urn:osh:aviation:flight:";
 
+	IFlightObjectFilter flightFilter;
+    IFlightRouteDecoder flightRouteDecoder;
     Cache<String, String> faIdToDestinationCache;
     ScheduledExecutorService watchDogTimer;
     FlightAwareClient firehoseClient;
@@ -219,6 +221,13 @@ public void init() throws SensorHubException
 		addOutput(flightPositionOutput, false);
 		flightPositionOutput.init();
 
+		// init flight filter
+		if (config.filterConfig != null)
+            this.flightFilter = config.filterConfig.getFilter();
+        		
+		// init flight route decoder
+		this.flightRouteDecoder = new FlightRouteDecoderFlightXML(this);
+		
 		// init ID cache
 		this.faIdToDestinationCache = CacheBuilder.newBuilder()
                 .maximumSize(MAX_ID_CACHE_SIZE)

sensors/aviation/sensorhub-driver-fltaware/src/main/java/org/sensorhub/impl/sensor/flightAware/FlightNumberRangeFilter.java

@@ -0,0 +1,86 @@
+/***************************** BEGIN LICENSE BLOCK ***************************
+
+The contents of this file are subject to the Mozilla Public License, v. 2.0.
+If a copy of the MPL was not distributed with this file, You can obtain one
+at http://mozilla.org/MPL/2.0/.
+
+Software distributed under the License is distributed on an "AS IS" basis,
+WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+for the specific language governing rights and limitations under the License.
+
+Copyright (C) 2019 Delta Air Lines, Inc. All Rights Reserved.
+
+******************************* END LICENSE BLOCK ***************************/
+
+package org.sensorhub.impl.sensor.flightAware;
+
+import java.io.BufferedReader;
+import java.io.FileReader;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import com.google.common.collect.Range;
+
+
+/**
+ * Implementation of flight object filter using lists of flight number
+ * ranges for one or more airlines.
+ * @author Alex Robin
+ * @since Nov 26, 2019
+ */
+public class FlightNumberRangeFilter implements IFlightObjectFilter
+{
+    Map<String, List<Range<Integer>>> fltNumRanges = new HashMap<>();
+    
+    
+    protected FlightNumberRangeFilter(FlightNumberRangeFilterConfig config)
+    {
+        try (BufferedReader reader = new BufferedReader(new FileReader(config.dataFile)))
+        {
+            reader.lines().forEach(l -> {
+                if (!l.trim().isEmpty())
+                {
+                    String[] cols = l.split(",");
+                    String airline = cols[0].trim();
+                    int low = Integer.parseInt(cols[1]);
+                    int high = Integer.parseInt(cols[2]);
+                    fltNumRanges.put(airline, Arrays.asList(Range.closed(low, high)));
+                }
+            });
+        }
+        catch (Exception e)
+        {
+            throw new IllegalStateException("Error parsing flight number ranges file", e);
+        }
+    }
+    
+    
+    @Override
+    public boolean test(FlightObject fltObj)
+    {
+        try
+        {
+            String airline = fltObj.ident.substring(0, 3);
+            int fltNum = Integer.parseInt(fltObj.ident.substring(3));        
+        
+            List<Range<Integer>> rangeList = fltNumRanges.get(airline);
+            if (rangeList == null)
+                return false;
+            
+            for (Range<Integer> range: rangeList)
+            {
+                if (range.contains(fltNum))
+                    return true;
+            }
+            
+            //System.err.println("Filter out " + fltObj.ident);
+            return false;
+        }
+        catch (NumberFormatException e)
+        {
+            return false;
+        }
+    }
+
+}

sensors/aviation/sensorhub-driver-fltaware/src/main/java/org/sensorhub/impl/sensor/flightAware/FlightNumberRangeFilterConfig.java

@@ -0,0 +1,37 @@
+/***************************** BEGIN LICENSE BLOCK ***************************
+
+The contents of this file are subject to the Mozilla Public License, v. 2.0.
+If a copy of the MPL was not distributed with this file, You can obtain one
+at http://mozilla.org/MPL/2.0/.
+
+Software distributed under the License is distributed on an "AS IS" basis,
+WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+for the specific language governing rights and limitations under the License.
+
+Copyright (C) 2019 Delta Air Lines, Inc. All Rights Reserved.
+
+******************************* END LICENSE BLOCK ***************************/
+
+package org.sensorhub.impl.sensor.flightAware;
+
+import org.sensorhub.api.config.DisplayInfo;
+
+
+/**
+ * Configuration class for flight number range filter
+ * @author Alex Robin
+ * @since Nov 26, 2019
+ */
+public class FlightNumberRangeFilterConfig extends FlightObjectFilterConfig
+{
+        
+    @DisplayInfo(desc="Path of CSV file containing the ranges of accepted flight numbers.\n"
+            + "Each row must have the format: {airline ICAO code},{begin number},{end number}")
+    public String dataFile;
+    
+    
+    public IFlightObjectFilter getFilter()
+    {
+        return new FlightNumberRangeFilter(this);
+    }
+}

sensors/aviation/sensorhub-driver-fltaware/src/main/java/org/sensorhub/impl/sensor/flightAware/FlightObject.java

@@ -18,6 +18,7 @@
 import java.time.ZonedDateTime;
 import java.util.ArrayList;
 import java.util.List;
+import org.sensorhub.impl.sensor.flightAware.FlightPlan.Waypoint;
 
 /**
  * 
@@ -82,10 +83,6 @@
 
  *
  */
-
-
-
-
 public class FlightObject 
 {
 	public String type;  // pos or fp
@@ -98,14 +95,14 @@ public class FlightObject
 
 
 	public String clock;  // posix epoch timestamp
-	public String id = ""; // faFlightId
+	public String id; // faFlightId
 	public String gs;  // ground speed knots
 	public String speed;  // fixed cruising speed in knots
 	public String heading;
 	public String lat;
 	public String lon;
-	public String orig = ""; // 	ICAO airport code, waypoint, or latitude/longitude pair
-	public String dest = ""; // 	ICAO airport code, waypoint, or latitude/longitude pair
+	public String orig; // 	ICAO airport code, waypoint, or latitude/longitude pair
+	public String dest; // 	ICAO airport code, waypoint, or latitude/longitude pair
 	public String reg;
 	public String squawk;
 	public String updateType;
@@ -114,34 +111,22 @@ public class FlightObject
 	public String eat;
 	public String ete;
 	public String fdt;
-	List<Waypoint> waypoints = new ArrayList<>();
+	public String route;
+	public String facility_name;
+	List<Waypoint> decodedRoute;
+	
 
 	// Adding for LawBox support
 	public double verticalChange;  //feet per mminute
 
 	public Long getDepartureTime() {
-		if(edt != null)
-			return Long.parseLong(edt);
+		/*if(edt != null)
+			return Long.parseLong(edt);*/
 		if(fdt != null)
 			return Long.parseLong(fdt);
 
 		return null;
 	}
-	
-	class Waypoint {
-		public Waypoint(float lat, float lon) {
-			this.lat = lat;
-			this.lon = lon;
-		}
-		
-		float lat;
-		float lon;
-		float alt;
-	}
-
-	public void addWaypoints(double lat, double lon) {
-		waypoints.add(new Waypoint((float)lat, (float)lon));
-	}
 
 
 	@Override
@@ -181,24 +166,6 @@ public String toString() {
 
 		return b.toString();
 	}
-
-	public float [] getLats() {
-		float[] lats = new float[waypoints.size()];
-		int i=0;
-		for (Waypoint wp : waypoints) {
-			lats[i++] = wp.lat;
-		}
-		return lats;
-	}
-
-	public float[] getLons() {
-		float [] lons = new float[waypoints.size()];
-		int i=0;
-		for (Waypoint wp : waypoints) {
-			lons[i++] = wp.lon;
-		}
-		return lons;
-	}
 
 	public long getClock() {
 		return Long.parseLong(clock);

sensors/aviation/sensorhub-driver-fltaware/src/main/java/org/sensorhub/impl/sensor/flightAware/FlightObjectFilterConfig.java

@@ -0,0 +1,25 @@
+/***************************** BEGIN LICENSE BLOCK ***************************
+
+The contents of this file are subject to the Mozilla Public License, v. 2.0.
+If a copy of the MPL was not distributed with this file, You can obtain one
+at http://mozilla.org/MPL/2.0/.
+
+Software distributed under the License is distributed on an "AS IS" basis,
+WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+for the specific language governing rights and limitations under the License.
+
+Copyright (C) 2019 Delta Air Lines, Inc. All Rights Reserved.
+
+******************************* END LICENSE BLOCK ***************************/
+
+package org.sensorhub.impl.sensor.flightAware;
+
+
+public abstract class FlightObjectFilterConfig
+{
+    
+    /**
+     * @return new filter instance based in this config
+     */
+    public abstract IFlightObjectFilter getFilter();
+}