Implement GPS056 protocol

6 files changed, 266 insertions, 1 deletions

diff --git a/setup/default.xml b/setup/default.xml
index bdcd9227d..cbefc8f41 100644
--- a/setup/default.xml
+++ b/setup/default.xml
@@ -427,7 +427,6 @@
         DELETE FROM device_attribute WHERE deviceId = :deviceId AND attributeId = :attributeId
     </entry>
 
-
     <!-- PROTOCOL CONFIG -->
 
     <entry key='gps103.port'>5001</entry>
@@ -571,5 +570,6 @@
     <entry key='xt2400.port'>5138</entry>
     <entry key='dmthttp.port'>5139</entry>
     <entry key='alematics.port'>5140</entry>
+    <entry key='gps056.port'>5141</entry>
 
 </properties>
diff --git a/src/org/traccar/protocol/Gps056FrameDecoder.java b/src/org/traccar/protocol/Gps056FrameDecoder.java
new file mode 100644
index 000000000..7adfddd07
--- /dev/null
+++ b/src/org/traccar/protocol/Gps056FrameDecoder.java
@@ -0,0 +1,43 @@
+/*
+ * Copyright 2017 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 org.jboss.netty.buffer.ChannelBuffer;
+import org.jboss.netty.channel.Channel;
+import org.jboss.netty.channel.ChannelHandlerContext;
+import org.jboss.netty.handler.codec.frame.FrameDecoder;
+
+import java.nio.charset.StandardCharsets;
+
+public class Gps056FrameDecoder extends FrameDecoder {
+
+    private static final int MESSAGE_HEADER = 4;
+
+    @Override
+    protected Object decode(
+            ChannelHandlerContext ctx, Channel channel, ChannelBuffer buf) throws Exception {
+
+        if (buf.readableBytes() >= MESSAGE_HEADER) {
+            int length = Integer.parseInt(buf.toString(2, 2, StandardCharsets.US_ASCII)) + 5;
+            if (buf.readableBytes() >= length) {
+                return buf.readBytes(length);
+            }
+        }
+
+        return null;
+    }
+
+}
diff --git a/src/org/traccar/protocol/Gps056Protocol.java b/src/org/traccar/protocol/Gps056Protocol.java
new file mode 100644
index 000000000..62d185cfc
--- /dev/null
+++ b/src/org/traccar/protocol/Gps056Protocol.java
@@ -0,0 +1,43 @@
+/*
+ * Copyright 2017 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 org.jboss.netty.bootstrap.ServerBootstrap;
+import org.jboss.netty.channel.ChannelPipeline;
+import org.traccar.BaseProtocol;
+import org.traccar.CharacterDelimiterFrameDecoder;
+import org.traccar.TrackerServer;
+
+import java.util.List;
+
+public class Gps056Protocol extends BaseProtocol {
+
+    public Gps056Protocol() {
+        super("gps056");
+    }
+
+    @Override
+    public void initTrackerServers(List<TrackerServer> serverList) {
+        serverList.add(new TrackerServer(new ServerBootstrap(), getName()) {
+            @Override
+            protected void addSpecificHandlers(ChannelPipeline pipeline) {
+                pipeline.addLast("frameDecoder", new Gps056FrameDecoder());
+                pipeline.addLast("objectDecoder", new Gps056ProtocolDecoder(Gps056Protocol.this));
+            }
+        });
+    }
+
+}
diff --git a/src/org/traccar/protocol/Gps056ProtocolDecoder.java b/src/org/traccar/protocol/Gps056ProtocolDecoder.java
new file mode 100644
index 000000000..2d4f6479a
--- /dev/null
+++ b/src/org/traccar/protocol/Gps056ProtocolDecoder.java
@@ -0,0 +1,135 @@
+/*
+ * Copyright 2017 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 org.jboss.netty.buffer.ChannelBuffer;
+import org.jboss.netty.buffer.ChannelBuffers;
+import org.jboss.netty.channel.Channel;
+import org.traccar.BaseProtocolDecoder;
+import org.traccar.DeviceSession;
+import org.traccar.helper.*;
+import org.traccar.model.Position;
+
+import java.net.SocketAddress;
+import java.nio.charset.StandardCharsets;
+
+public class Gps056ProtocolDecoder extends BaseProtocolDecoder {
+
+    public Gps056ProtocolDecoder(Gps056Protocol protocol) {
+        super(protocol);
+    }
+
+    private static void sendResponse(Channel channel, String type, String imei, ChannelBuffer content) {
+        if (channel != null) {
+            ChannelBuffer response = ChannelBuffers.dynamicBuffer();
+            String header = "*" + type + imei;
+            response.writeBytes(header.getBytes(StandardCharsets.US_ASCII));
+            if (content != null) {
+                response.writeBytes(content);
+            }
+            response.writeByte('#');
+            channel.write(response);
+        }
+    }
+
+    private static double decodeCoordinate(ChannelBuffer buf) {
+        double degrees = buf.getUnsignedShort(buf.readerIndex()) / 100;
+        double minutes = buf.readUnsignedShort() % 100 + buf.readUnsignedShort() * 0.0001;
+        degrees += minutes / 60;
+        byte hemisphere = buf.readByte();
+        if (hemisphere == 'S' || hemisphere == 'W') {
+            degrees = -degrees;
+        }
+        return degrees;
+    }
+
+    private static void decodeStatus(ChannelBuffer buf, Position position) {
+
+        position.set(Position.KEY_INPUT, buf.readUnsignedByte());
+        position.set(Position.KEY_OUTPUT, buf.readUnsignedByte());
+
+        position.set(Position.PREFIX_ADC + 1, ChannelBuffers.swapShort(buf.readShort()) * 5.06); // mV
+
+        position.set(Position.KEY_SATELLITES, buf.readUnsignedByte());
+        position.set(Position.KEY_RSSI, buf.readUnsignedByte());
+
+    }
+
+    @Override
+    protected Object decode(
+            Channel channel, SocketAddress remoteAddress, Object msg) throws Exception {
+
+        ChannelBuffer buf = (ChannelBuffer) msg;
+
+        buf.skipBytes(2); // header
+        buf.skipBytes(2); // length
+
+        String type = buf.readBytes(7).toString(StandardCharsets.US_ASCII);
+        String imei = buf.readBytes(15).toString(StandardCharsets.US_ASCII);
+
+        DeviceSession deviceSession = getDeviceSession(channel, remoteAddress, imei);
+        if (deviceSession == null) {
+            return null;
+        }
+
+        if (type.startsWith("LOGN")) {
+
+            sendResponse(channel, "LGSA" + type.substring(4), imei,
+                    ChannelBuffers.copiedBuffer("1", StandardCharsets.US_ASCII));
+
+        } else if (type.startsWith("GPSL")) {
+
+            Position position = new Position();
+            position.setProtocol(getProtocolName());
+            position.setDeviceId(deviceSession.getDeviceId());
+
+            DateBuilder dateBuilder = new DateBuilder()
+                    .setDateReverse(buf.readUnsignedByte(), buf.readUnsignedByte(), buf.readUnsignedByte())
+                    .setTime(buf.readUnsignedByte(), buf.readUnsignedByte(), buf.readUnsignedByte());
+
+            position.setValid(true);
+            position.setTime(dateBuilder.getDate());
+            position.setLatitude(decodeCoordinate(buf));
+            position.setLongitude(decodeCoordinate(buf));
+            position.setSpeed(UnitsConverter.knotsFromKph(buf.readUnsignedByte()));
+            position.setCourse(buf.readUnsignedShort());
+
+            decodeStatus(buf, position);
+
+            sendResponse(channel, "GPSA" + type.substring(4), imei, buf.readBytes(2));
+
+            return position;
+
+        } else if (type.startsWith("SYNC")) {
+
+            Position position = new Position();
+            position.setProtocol(getProtocolName());
+            position.setDeviceId(deviceSession.getDeviceId());
+
+            getLastLocation(position, null);
+
+            decodeStatus(buf, position);
+
+            sendResponse(channel, "SYSA" + type.substring(4), imei, null);
+
+            return position;
+
+        }
+
+        return null;
+    }
+
+}
diff --git a/test/org/traccar/protocol/Gps056FrameDecoderTest.java b/test/org/traccar/protocol/Gps056FrameDecoderTest.java
new file mode 100644
index 000000000..548154b22
--- /dev/null
+++ b/test/org/traccar/protocol/Gps056FrameDecoderTest.java
@@ -0,0 +1,20 @@
+package org.traccar.protocol;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.traccar.ProtocolTest;
+
+public class Gps056FrameDecoderTest extends ProtocolTest {
+
+    @Test
+    public void testDecode() throws Exception {
+
+        Gps056FrameDecoder decoder = new Gps056FrameDecoder();
+
+        Assert.assertEquals(
+                binary("242432354c4f474e5f3131383632343632303333373832393436322e3123"),
+                decoder.decode(null, null, binary("242432354c4f474e5f3131383632343632303333373832393436322e3123")));
+
+    }
+
+}
diff --git a/test/org/traccar/protocol/Gps056ProtocolDecoderTest.java b/test/org/traccar/protocol/Gps056ProtocolDecoderTest.java
new file mode 100644
index 000000000..01d7cf56f
--- /dev/null
+++ b/test/org/traccar/protocol/Gps056ProtocolDecoderTest.java
@@ -0,0 +1,24 @@
+package org.traccar.protocol;
+
+import org.junit.Test;
+import org.traccar.ProtocolTest;
+
+public class Gps056ProtocolDecoderTest extends ProtocolTest {
+
+    @Test
+    public void testDecode() throws Exception {
+
+        Gps056ProtocolDecoder decoder = new Gps056ProtocolDecoder(new Gps056Protocol());
+
+        verifyNull(decoder, buffer(
+                "$$25LOGN_118624620337829462.1#"));
+
+        verifyPosition(decoder, binary(
+                "242435314750534C5F30323836333037313031353034353834391D0A0E091A0A0B1112C34E1E23230A45FF00000000000000000000000023"));
+
+        verifyAttributes(decoder, binary(
+                "2424323853594E435F313138363330373130313530343538343900000000000023"));
+
+    }
+
+}