Implement Portman protocol

3 files changed, 151 insertions, 0 deletions

diff --git a/src/main/java/org/traccar/protocol/PortmanProtocol.java b/src/main/java/org/traccar/protocol/PortmanProtocol.java
new file mode 100644
index 000000000..33de4fd50
--- /dev/null
+++ b/src/main/java/org/traccar/protocol/PortmanProtocol.java
@@ -0,0 +1,39 @@
+/*
+ * Copyright 2020 Anton Tananaev (anton@traccar.org)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.traccar.protocol;
+
+import io.netty.handler.codec.LineBasedFrameDecoder;
+import io.netty.handler.codec.string.StringDecoder;
+import io.netty.handler.codec.string.StringEncoder;
+import org.traccar.BaseProtocol;
+import org.traccar.PipelineBuilder;
+import org.traccar.TrackerServer;
+
+public class PortmanProtocol extends BaseProtocol {
+
+    public PortmanProtocol() {
+        addServer(new TrackerServer(false, getName()) {
+            @Override
+            protected void addProtocolHandlers(PipelineBuilder pipeline) {
+                pipeline.addLast(new LineBasedFrameDecoder(1024));
+                pipeline.addLast(new StringEncoder());
+                pipeline.addLast(new StringDecoder());
+                pipeline.addLast(new PortmanProtocolDecoder(PortmanProtocol.this));
+            }
+        });
+    }
+
+}
diff --git a/src/main/java/org/traccar/protocol/PortmanProtocolDecoder.java b/src/main/java/org/traccar/protocol/PortmanProtocolDecoder.java
new file mode 100644
index 000000000..7d734c9b1
--- /dev/null
+++ b/src/main/java/org/traccar/protocol/PortmanProtocolDecoder.java
@@ -0,0 +1,94 @@
+/*
+ * Copyright 2020 Anton Tananaev (anton@traccar.org)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.traccar.protocol;
+
+import io.netty.channel.Channel;
+import org.traccar.BaseProtocolDecoder;
+import org.traccar.DeviceSession;
+import org.traccar.Protocol;
+import org.traccar.helper.Parser;
+import org.traccar.helper.PatternBuilder;
+import org.traccar.helper.UnitsConverter;
+import org.traccar.model.Position;
+
+import java.net.SocketAddress;
+import java.util.regex.Pattern;
+
+public class PortmanProtocolDecoder extends BaseProtocolDecoder {
+
+    public PortmanProtocolDecoder(Protocol protocol) {
+        super(protocol);
+    }
+
+    private static final Pattern PATTERN = new PatternBuilder()
+            .text("$PTMLA,")                     // header
+            .number("(d+),")                     // imei
+            .expression("([ABCL]),")             // validity
+            .number("(dd)(dd)(dd)")              // date (yymmdd)
+            .number("(dd)(dd)(dd),")             // time (hhmmss)
+            .expression("([NS])")
+            .number("(dd)(dd.d+)")               // latitude
+            .expression("([EW])")
+            .number("(d{2,3})(dd.d+),")          // longitude
+            .number("(d+),")                     // speed
+            .number("(d+),")                     // course
+            .number("(?:NA|C(-?d+)),")           // temperature
+            .number("(x{8}),")                   // status
+            .number("(?:NA|(d+)),")              // card id
+            .number("(d+),")                     // event
+            .number("(d+),")                     // satellites
+            .number("(d+.d+),")                  // odometer
+            .number("(d+),")                     // rssi
+            .number("(?:G(d+)|[^,]*)")           // fuel
+            .compile();
+
+    @Override
+    protected Object decode(
+            Channel channel, SocketAddress remoteAddress, Object msg) throws Exception {
+
+        Parser parser = new Parser(PATTERN, (String) msg);
+        if (!parser.matches()) {
+            return null;
+        }
+
+        DeviceSession deviceSession = getDeviceSession(channel, remoteAddress, parser.next());
+        if (deviceSession == null) {
+            return null;
+        }
+
+        Position position = new Position(getProtocolName());
+        position.setDeviceId(deviceSession.getDeviceId());
+
+        position.setValid(!parser.next().equals("L"));
+        position.setTime(parser.nextDateTime());
+        position.setLatitude(parser.nextCoordinate(Parser.CoordinateFormat.HEM_DEG_MIN));
+        position.setLongitude(parser.nextCoordinate(Parser.CoordinateFormat.HEM_DEG_MIN));
+        position.setSpeed(UnitsConverter.knotsFromKph(parser.nextInt()));
+        position.setCourse(parser.nextInt());
+
+        position.set(Position.PREFIX_TEMP + 1, parser.next());
+        position.set(Position.KEY_STATUS, parser.nextHexLong());
+        position.set(Position.KEY_DRIVER_UNIQUE_ID, parser.next());
+        position.set(Position.KEY_EVENT, parser.nextInt());
+        position.set(Position.KEY_SATELLITES, parser.nextInt());
+        position.set(Position.KEY_ODOMETER, parser.nextDouble() * 1000);
+        position.set(Position.KEY_RSSI, parser.nextInt());
+        position.set(Position.KEY_FUEL_LEVEL, parser.nextInt());
+
+        return position;
+    }
+
+}
diff --git a/src/test/java/org/traccar/protocol/PortmanProtocolDecoderTest.java b/src/test/java/org/traccar/protocol/PortmanProtocolDecoderTest.java
new file mode 100644
index 000000000..0b5dcf0cf
--- /dev/null
+++ b/src/test/java/org/traccar/protocol/PortmanProtocolDecoderTest.java
@@ -0,0 +1,18 @@
+package org.traccar.protocol;
+
+import org.junit.Test;
+import org.traccar.ProtocolTest;
+
+public class PortmanProtocolDecoderTest extends ProtocolTest {
+
+    @Test
+    public void testDecode() throws Exception {
+
+        PortmanProtocolDecoder decoder = new PortmanProtocolDecoder(null);
+
+        verifyPosition(decoder, text(
+                "$PTMLA,355854050074633,A,200612153351,N2543.0681W10009.2974,0,190,NA,C9830000,NA,108,8,2.66,16,GNA"));
+
+    }
+
+}