Merge pull request #2906 from jon-stumpf/jss-minifinder

MiniFinder Updates

11 files changed, 161 insertions, 88 deletions

diff --git a/src/org/traccar/model/Position.java b/src/org/traccar/model/Position.java
index 6fe008688..350524f32 100644
--- a/src/org/traccar/model/Position.java
+++ b/src/org/traccar/model/Position.java
@@ -22,7 +22,8 @@ public class Position extends Message {
     public static final String KEY_ORIGINAL = "raw";
     public static final String KEY_INDEX = "index";
     public static final String KEY_HDOP = "hdop";
-    public static final String KEY_SATELLITES = "sat";
+    public static final String KEY_SATELLITES = "sat"; // in use
+    public static final String KEY_SATELLITES_VISIBLE = "satVisible";
     public static final String KEY_RSSI = "rssi";
     public static final String KEY_GPS = "gps";
     public static final String KEY_EVENT = "event";
@@ -87,7 +88,7 @@ public class Position extends Message {
     public static final String ALARM_GPS_ANTENNA_CUT = "gpsAntennaCut";
     public static final String ALARM_ACCIDENT = "accident";
     public static final String ALARM_TOW = "tow";
-    public static final String ALARM_ACCELETATION = "hardAcceleration";
+    public static final String ALARM_ACCELERATION = "hardAcceleration";
     public static final String ALARM_BREAKING = "hardBreaking";
     public static final String ALARM_FATIGUE_DRIVING = "fatigueDriving";
     public static final String ALARM_POWER_CUT = "powerCut";
diff --git a/src/org/traccar/protocol/At2000ProtocolDecoder.java b/src/org/traccar/protocol/At2000ProtocolDecoder.java
index f990e05c2..182066629 100644
--- a/src/org/traccar/protocol/At2000ProtocolDecoder.java
+++ b/src/org/traccar/protocol/At2000ProtocolDecoder.java
@@ -143,7 +143,7 @@ public class At2000ProtocolDecoder extends BaseProtocolDecoder {
                 position.set(Position.KEY_POWER, buf.readUnsignedShort() + "mV");
 
                 buf.readUnsignedShort(); // cid
-                buf.readUnsignedByte(); // rssi
+                position.set(Position.KEY_RSSI, buf.readUnsignedByte());
                 buf.readUnsignedByte(); // current profile
 
                 position.set(Position.KEY_BATTERY, buf.readUnsignedByte());
diff --git a/src/org/traccar/protocol/AtrackProtocolDecoder.java b/src/org/traccar/protocol/AtrackProtocolDecoder.java
index 8e3cd2089..d80c19706 100644
--- a/src/org/traccar/protocol/AtrackProtocolDecoder.java
+++ b/src/org/traccar/protocol/AtrackProtocolDecoder.java
@@ -93,7 +93,7 @@ public class AtrackProtocolDecoder extends BaseProtocolDecoder {
                     position.set(Position.KEY_BATTERY, buf.readUnsignedShort());
                     break;
                 case "GQ":
-                    buf.readUnsignedByte(); // rssi
+                    position.set(Position.KEY_RSSI, buf.readUnsignedByte());
                     break;
                 case "CE":
                     buf.readUnsignedInt(); // cid
diff --git a/src/org/traccar/protocol/Avl301ProtocolDecoder.java b/src/org/traccar/protocol/Avl301ProtocolDecoder.java
index c19b96cb9..cc61be91b 100644
--- a/src/org/traccar/protocol/Avl301ProtocolDecoder.java
+++ b/src/org/traccar/protocol/Avl301ProtocolDecoder.java
@@ -100,7 +100,7 @@ public class Avl301ProtocolDecoder extends BaseProtocolDecoder {
             int gpsLength = buf.readUnsignedByte(); // gps len and sat
             position.set(Position.KEY_SATELLITES, gpsLength & 0xf);
 
-            buf.readUnsignedByte(); // satellites
+            position.set(Position.KEY_SATELLITES_VISIBLE, buf.readUnsignedByte()); // satellites
 
             double latitude = buf.readUnsignedInt() / 600000.0;
             double longitude = buf.readUnsignedInt() / 600000.0;
diff --git a/src/org/traccar/protocol/MiniFinderProtocolDecoder.java b/src/org/traccar/protocol/MiniFinderProtocolDecoder.java
index 360df726a..94c67b616 100644
--- a/src/org/traccar/protocol/MiniFinderProtocolDecoder.java
+++ b/src/org/traccar/protocol/MiniFinderProtocolDecoder.java
@@ -34,106 +34,175 @@ public class MiniFinderProtocolDecoder extends BaseProtocolDecoder {
         super(protocol);
     }
 
-    private static final Pattern PATTERN = new PatternBuilder()
-            .expression("![A-D],")
+    private static final Pattern PATTERN_FIX = new PatternBuilder()
             .number("(d+)/(d+)/(d+),")           // date
             .number("(d+):(d+):(d+),")           // time
             .number("(-?d+.d+),")                // latitude
             .number("(-?d+.d+),")                // longitude
-            .number("(d+.?d*),")                 // speed
+            .compile();
+
+    private static final Pattern PATTERN_STATE = new PatternBuilder()
+            .number("(d+.?d*),")                 // speed (km/h)
             .number("(d+.?d*),")                 // course
-            .groupBegin()
             .number("(x+),")                     // flags
-            .number("(-?d+.d+),")                // altitude
-            .number("(d+),")                     // battery
+            .number("(-?d+.d+),")                // altitude (meters)
+            .number("(d+),")                     // battery (percentage)
+            .compile();
+
+    private static final Pattern PATTERN_GPS_PRECISION = new PatternBuilder()
             .number("(d+),")                     // satellites in use
             .number("(d+),")                     // satellites in view
-            .text("0")
-            .or()
-            .any()
-            .groupEnd()
+            .number("(d+.?d*)")                  // hdop
+            .compile();
+
+    private static final Pattern PATTERN_A = new PatternBuilder()
+            .text("!A,")
+            .expression(PATTERN_FIX.pattern())
+            .any()                               // unknown 3 fields
+            .compile();
+
+   private static final Pattern PATTERN_C = new PatternBuilder()
+            .text("!C,")
+            .expression(PATTERN_FIX.pattern())
+            .expression(PATTERN_STATE.pattern())
+            .any()                               // unknown 3 fields
             .compile();
 
+    // The !B (buffered data) records are the same as !D (live data) records.
+    private static final Pattern PATTERN_BD = new PatternBuilder()
+            .expression("![BD],")
+            .expression(PATTERN_FIX.pattern())
+            .expression(PATTERN_STATE.pattern())
+            .expression(PATTERN_GPS_PRECISION.pattern())
+            .compile();
+
+    private void decodeFix(Position position, Parser parser) {
+
+        DateBuilder dateBuilder = new DateBuilder()
+                .setDateReverse(parser.nextInt(), parser.nextInt(), parser.nextInt())
+                .setTime(parser.nextInt(), parser.nextInt(), parser.nextInt());
+        position.setTime(dateBuilder.getDate());
+
+        position.setLatitude(parser.nextDouble());
+        position.setLongitude(parser.nextDouble());
+    }
+
+    private void decodeFlags(Position position, int flags) {
+
+        position.setValid(BitUtil.check(flags, 0));
+
+        if (BitUtil.check(flags, 2)) {
+            position.set(Position.KEY_ALARM, Position.ALARM_FAULT);
+        }
+        if (BitUtil.check(flags, 6)) {
+            position.set(Position.KEY_ALARM, Position.ALARM_SOS);
+        }
+        if (BitUtil.check(flags, 7)) {
+            position.set(Position.KEY_ALARM, Position.ALARM_OVERSPEED);
+        }
+        if (BitUtil.check(flags, 8)) {
+            position.set(Position.KEY_ALARM, Position.ALARM_FALL_DOWN);
+        }
+        if (BitUtil.check(flags, 9) || BitUtil.check(flags, 10) || BitUtil.check(flags, 11)) {
+            position.set(Position.KEY_ALARM, Position.ALARM_GEOFENCE);
+        }
+        if (BitUtil.check(flags, 12)) {
+            position.set(Position.KEY_ALARM, Position.ALARM_LOW_BATTERY);
+        }
+        if (BitUtil.check(flags, 15) || BitUtil.check(flags, 14)) {
+            position.set(Position.KEY_ALARM, Position.ALARM_MOVEMENT);
+        }
+
+        position.set(Position.KEY_RSSI, BitUtil.between(flags, 16, 20));
+        position.set(Position.KEY_CHARGE, BitUtil.check(flags, 22));
+    }
+
+    private void decodeState(Position position, Parser parser) {
+
+        position.setSpeed(UnitsConverter.knotsFromKph(parser.nextDouble()));
+
+        position.setCourse(parser.nextDouble());
+        if (position.getCourse() > 360) {
+            position.setCourse(0);
+        }
+
+        decodeFlags(position, parser.nextInt(16));
+
+        position.setAltitude(parser.nextDouble());
+
+        position.set(Position.KEY_BATTERY, parser.nextInt());
+    }
+
+    private void decodeGPSPrecision(Position position, Parser parser) {
+
+        position.set(Position.KEY_SATELLITES, parser.nextInt());
+        position.set(Position.KEY_SATELLITES_VISIBLE, parser.nextInt());
+        position.set(Position.KEY_HDOP, parser.nextDouble());
+    }
+
     @Override
     protected Object decode(
             Channel channel, SocketAddress remoteAddress, Object msg) throws Exception {
 
         String sentence = (String) msg;
 
-        if (sentence.startsWith("!1")) {
+        if (sentence.startsWith("!1,")) {
 
             getDeviceSession(channel, remoteAddress, sentence.substring(3, sentence.length()));
 
-        } else if (sentence.matches("![A-D].*")) {
+            return null;
+        }
 
-            DeviceSession deviceSession = getDeviceSession(channel, remoteAddress);
-            if (deviceSession == null) {
-                return null;
-            }
+        DeviceSession deviceSession = getDeviceSession(channel, remoteAddress);
+        if (deviceSession == null) {
+            return null;
+        }
+
+        if (!sentence.matches("![A-D],.*")) {
+            return null;
+        }
 
-            Parser parser = new Parser(PATTERN, sentence);
+        Position position = new Position();
+        position.setProtocol(getProtocolName());
+        position.setDeviceId(deviceSession.getDeviceId());
+
+        String recordType = sentence.substring(1, 2);
+        position.set(Position.KEY_TYPE, recordType);
+
+        if (recordType.matches("[BD]")) {
+            Parser parser = new Parser(PATTERN_BD, sentence);
             if (!parser.matches()) {
                 return null;
             }
 
-            Position position = new Position();
-            position.setProtocol(getProtocolName());
-            position.setDeviceId(deviceSession.getDeviceId());
+            decodeFix(position, parser);
+            decodeState(position, parser);
+            decodeGPSPrecision(position, parser);
 
-            DateBuilder dateBuilder = new DateBuilder()
-                    .setDateReverse(parser.nextInt(), parser.nextInt(), parser.nextInt())
-                    .setTime(parser.nextInt(), parser.nextInt(), parser.nextInt());
-            position.setTime(dateBuilder.getDate());
-
-            position.setLatitude(parser.nextDouble());
-            position.setLongitude(parser.nextDouble());
-            position.setSpeed(UnitsConverter.knotsFromKph(parser.nextDouble()));
+            return position;
+        }
 
-            position.setCourse(parser.nextDouble());
-            if (position.getCourse() > 360) {
-                position.setCourse(0);
+        if (recordType.matches("C")) {
+            Parser parser = new Parser(PATTERN_C, sentence);
+            if (!parser.matches()) {
+                return null;
             }
 
-            if (parser.hasNext(5)) {
-
-                int flags = parser.nextInt(16);
-
-                position.setValid(BitUtil.check(flags, 0));
-
-                if (BitUtil.check(flags, 2)) {
-                    position.set(Position.KEY_ALARM, Position.ALARM_FAULT);
-                }
-                if (BitUtil.check(flags, 6)) {
-                    position.set(Position.KEY_ALARM, Position.ALARM_SOS);
-                }
-                if (BitUtil.check(flags, 7)) {
-                    position.set(Position.KEY_ALARM, Position.ALARM_OVERSPEED);
-                }
-                if (BitUtil.check(flags, 8)) {
-                    position.set(Position.KEY_ALARM, Position.ALARM_FALL_DOWN);
-                }
-                if (BitUtil.check(flags, 9) || BitUtil.check(flags, 10) || BitUtil.check(flags, 11)) {
-                    position.set(Position.KEY_ALARM, Position.ALARM_GEOFENCE);
-                }
-                if (BitUtil.check(flags, 12)) {
-                    position.set(Position.KEY_ALARM, Position.ALARM_LOW_BATTERY);
-                }
-                if (BitUtil.check(flags, 15) || BitUtil.check(flags, 14)) {
-                    position.set(Position.KEY_ALARM, Position.ALARM_MOVEMENT);
-                }
-
-                position.set(Position.KEY_RSSI, BitUtil.between(flags, 16, 20));
-                position.set(Position.KEY_CHARGE, BitUtil.check(flags, 22));
-
-                position.setAltitude(parser.nextDouble());
-
-                position.set(Position.KEY_BATTERY, parser.next());
-                position.set(Position.KEY_SATELLITES, parser.next());
+            decodeFix(position, parser);
+            decodeState(position, parser);
 
+            return position;
+        }
+
+        if (recordType.matches("A")) {
+            Parser parser = new Parser(PATTERN_A, sentence);
+            if (!parser.matches()) {
+                return null;
             }
 
-            return position;
+            decodeFix(position, parser);
 
+            return position;
         }
 
         return null;
diff --git a/src/org/traccar/protocol/NavigilProtocolDecoder.java b/src/org/traccar/protocol/NavigilProtocolDecoder.java
index d18217861..263e5fc2b 100644
--- a/src/org/traccar/protocol/NavigilProtocolDecoder.java
+++ b/src/org/traccar/protocol/NavigilProtocolDecoder.java
@@ -95,8 +95,8 @@ public class NavigilProtocolDecoder extends BaseProtocolDecoder {
         position.setLongitude(buf.readInt() * 0.0000001);
         position.setAltitude(buf.readUnsignedShort());
 
-        buf.readUnsignedShort(); // satellites in fix
-        buf.readUnsignedShort(); // satellites in track
+        position.set(Position.KEY_SATELLITES, buf.readUnsignedShort()); // satellites in fix
+        position.set(Position.KEY_SATELLITES_VISIBLE, buf.readUnsignedShort()); // satellites in track
         buf.readUnsignedShort(); // GPS antenna state
 
         position.setSpeed(buf.readUnsignedShort() * 0.194384);
@@ -107,7 +107,7 @@ public class NavigilProtocolDecoder extends BaseProtocolDecoder {
 
         position.set(Position.KEY_BATTERY, buf.readUnsignedShort() * 0.001);
 
-        buf.readUnsignedShort(); // battery charger status
+        position.set(Position.KEY_CHARGE, buf.readUnsignedShort()); // battery charger status
 
         position.setTime(convertTimestamp(buf.readUnsignedInt()));
 
@@ -133,8 +133,8 @@ public class NavigilProtocolDecoder extends BaseProtocolDecoder {
         position.setLongitude(buf.readInt() * 0.0000001);
         position.setAltitude(buf.readUnsignedShort());
 
-        buf.readUnsignedByte(); // satellites in fix
-        buf.readUnsignedByte(); // satellites in track
+        position.set(Position.KEY_SATELLITES, buf.readUnsignedByte()); // satellites in fix
+        position.set(Position.KEY_SATELLITES_VISIBLE, buf.readUnsignedByte()); // satellites in track
 
         position.setSpeed(buf.readUnsignedShort() * 0.194384);
         position.setCourse(buf.readUnsignedShort());
@@ -219,8 +219,8 @@ public class NavigilProtocolDecoder extends BaseProtocolDecoder {
         position.setLongitude(buf.readInt() * 0.0000001);
         position.setAltitude(buf.readUnsignedShort());
 
-        buf.readUnsignedByte(); // satellites in fix
-        buf.readUnsignedByte(); // satellites in track
+        position.set(Position.KEY_SATELLITES, buf.readUnsignedByte()); // satellites in fix
+        position.set(Position.KEY_SATELLITES_VISIBLE, buf.readUnsignedByte()); // satellites in track
 
         position.setSpeed(buf.readUnsignedShort() * 0.194384);
         position.setCourse(buf.readUnsignedShort() * 0.1);
@@ -258,7 +258,7 @@ public class NavigilProtocolDecoder extends BaseProtocolDecoder {
         position.setSpeed(UnitsConverter.knotsFromKph(buf.readUnsignedByte()));
         position.setCourse(buf.readUnsignedByte() * 2.0);
 
-        buf.readUnsignedByte(); // satellites in fix
+        position.set(Position.KEY_SATELLITES, buf.readUnsignedByte()); // satellites in fix
 
         position.set(Position.KEY_BATTERY, buf.readUnsignedShort() * 0.001);
 
diff --git a/src/org/traccar/protocol/Pt502ProtocolDecoder.java b/src/org/traccar/protocol/Pt502ProtocolDecoder.java
index 54f54d392..a72d237d3 100644
--- a/src/org/traccar/protocol/Pt502ProtocolDecoder.java
+++ b/src/org/traccar/protocol/Pt502ProtocolDecoder.java
@@ -65,7 +65,7 @@ public class Pt502ProtocolDecoder extends BaseProtocolDecoder {
             case "TOW":

                 return Position.ALARM_TOW;

             case "HDA":

-                return Position.ALARM_ACCELETATION;

+                return Position.ALARM_ACCELERATION;

             case "HDB":

                 return Position.ALARM_BREAKING;

             case "FDA":

diff --git a/src/org/traccar/protocol/TeltonikaProtocolDecoder.java b/src/org/traccar/protocol/TeltonikaProtocolDecoder.java
index 4d4d68ec2..9c1e0a2ff 100644
--- a/src/org/traccar/protocol/TeltonikaProtocolDecoder.java
+++ b/src/org/traccar/protocol/TeltonikaProtocolDecoder.java
@@ -171,7 +171,7 @@ public class TeltonikaProtocolDecoder extends BaseProtocolDecoder {
                 }
 
                 if (BitUtil.check(locationMask, 6)) {
-                    buf.readUnsignedByte(); // rssi
+                    position.set(Position.KEY_RSSI, buf.readUnsignedByte());
                 }
 
                 if (BitUtil.check(locationMask, 7)) {
diff --git a/src/org/traccar/protocol/TmgProtocolDecoder.java b/src/org/traccar/protocol/TmgProtocolDecoder.java
index beb2b0b78..3b73a1516 100644
--- a/src/org/traccar/protocol/TmgProtocolDecoder.java
+++ b/src/org/traccar/protocol/TmgProtocolDecoder.java
@@ -50,10 +50,10 @@ public class TmgProtocolDecoder extends BaseProtocolDecoder {
             .number("(-?d+.?d*),")               // altitude
             .number("(d+.d+),")                  // hdop
             .number("(d+),")                     // satellites
-            .number("d+,")                       // visible satellites
-            .number("[^,]*,")                    // operator
-            .number("d+,")                       // rssi
-            .number("[^,]*,")                       // cid
+            .number("(d+),")                     // visible satellites
+            .number("([^,]*),")                  // operator
+            .number("(d+),")                     // rssi
+            .number("[^,]*,")                    // cid
             .expression("([01]),")               // ignition
             .number("(d+.?d*),")                 // battery
             .number("(d+.?d*),")                 // power
@@ -122,6 +122,9 @@ public class TmgProtocolDecoder extends BaseProtocolDecoder {
 
         position.set(Position.KEY_HDOP, parser.nextDouble());
         position.set(Position.KEY_SATELLITES, parser.nextInt());
+        position.set(Position.KEY_SATELLITES_VISIBLE, parser.nextInt());
+        position.set("operator", parser.next());
+        position.set(Position.KEY_RSSI, parser.nextInt());
         position.set(Position.KEY_IGNITION, parser.nextInt() == 1);
         position.set(Position.KEY_BATTERY, parser.nextDouble());
         position.set(Position.KEY_POWER, parser.nextDouble());
diff --git a/src/org/traccar/protocol/TzoneProtocolDecoder.java b/src/org/traccar/protocol/TzoneProtocolDecoder.java
index 2b5d90e7a..0fc93a03c 100644
--- a/src/org/traccar/protocol/TzoneProtocolDecoder.java
+++ b/src/org/traccar/protocol/TzoneProtocolDecoder.java
@@ -45,7 +45,7 @@ public class TzoneProtocolDecoder extends BaseProtocolDecoder {
             case 0x14:
                 return Position.ALARM_BREAKING;
             case 0x15:
-                return Position.ALARM_ACCELETATION;
+                return Position.ALARM_ACCELERATION;
             case 0x30:
                 return Position.ALARM_PARKING;
             case 0x42:
diff --git a/test/org/traccar/protocol/MiniFinderProtocolDecoderTest.java b/test/org/traccar/protocol/MiniFinderProtocolDecoderTest.java
index ccefee049..57201670f 100644
--- a/test/org/traccar/protocol/MiniFinderProtocolDecoderTest.java
+++ b/test/org/traccar/protocol/MiniFinderProtocolDecoderTest.java
@@ -20,7 +20,7 @@ public class MiniFinderProtocolDecoderTest extends ProtocolTest {
                 "!1,860719027585011"));
 
         verifyPosition(decoder, text(
-                "!D,28/11/16,00:04:09,42.926067,-85.747589,124,236,140001,179.8,60,11,16,0;"));
+                "!D,28/11/16,00:04:09,42.926067,-85.747589,124,236,140001,179.8,60,11,16,0"));
 
         verifyPosition(decoder, text(
                 "!C,30/1/16,1:1:6,31.259157,30.020910,0,0,100001,25.32,100,0.03,0.01,0"));