Implement KR Binary v4 protocol

4 files changed, 242 insertions, 0 deletions

diff --git a/setup/default.xml b/setup/default.xml
index 6be4f105d..7422bdf05 100644
--- a/setup/default.xml
+++ b/setup/default.xml
@@ -299,5 +299,6 @@
     <entry key='dragino.port'>5253</entry>
     <entry key='fleetguide.port'>5254</entry>
     <entry key='valtrack.port'>5255</entry>
+    <entry key='snapper.port'>5256</entry>
 
 </properties>
diff --git a/src/main/java/org/traccar/protocol/SnapperProtocol.java b/src/main/java/org/traccar/protocol/SnapperProtocol.java
new file mode 100644
index 000000000..2e294eac6
--- /dev/null
+++ b/src/main/java/org/traccar/protocol/SnapperProtocol.java
@@ -0,0 +1,40 @@
+/*
+ * Copyright 2024 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.LengthFieldBasedFrameDecoder;
+import jakarta.inject.Inject;
+import org.traccar.BaseProtocol;
+import org.traccar.PipelineBuilder;
+import org.traccar.TrackerServer;
+import org.traccar.config.Config;
+
+import java.nio.ByteOrder;
+
+public class SnapperProtocol extends BaseProtocol {
+
+    @Inject
+    public SnapperProtocol(Config config) {
+        addServer(new TrackerServer(config, getName(), false) {
+            @Override
+            protected void addProtocolHandlers(PipelineBuilder pipeline, Config config) {
+                pipeline.addLast(new LengthFieldBasedFrameDecoder(ByteOrder.LITTLE_ENDIAN, 1024, 12, 4, 9, 0, true));
+                pipeline.addLast(new SnapperProtocolDecoder(SnapperProtocol.this));
+            }
+        });
+    }
+
+}
diff --git a/src/main/java/org/traccar/protocol/SnapperProtocolDecoder.java b/src/main/java/org/traccar/protocol/SnapperProtocolDecoder.java
new file mode 100644
index 000000000..3119e347e
--- /dev/null
+++ b/src/main/java/org/traccar/protocol/SnapperProtocolDecoder.java
@@ -0,0 +1,180 @@
+/*
+ * Copyright 2024 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.buffer.ByteBuf;
+import io.netty.buffer.Unpooled;
+import io.netty.channel.Channel;
+import jakarta.json.Json;
+import jakarta.json.JsonObject;
+import org.traccar.BaseProtocolDecoder;
+import org.traccar.NetworkMessage;
+import org.traccar.Protocol;
+import org.traccar.helper.BitUtil;
+import org.traccar.helper.Checksum;
+import org.traccar.model.Position;
+import org.traccar.session.DeviceSession;
+
+import java.io.StringReader;
+import java.net.SocketAddress;
+import java.nio.ByteBuffer;
+import java.nio.charset.StandardCharsets;
+import java.text.DateFormat;
+import java.text.SimpleDateFormat;
+import java.util.TimeZone;
+
+public class SnapperProtocolDecoder extends BaseProtocolDecoder {
+
+    public SnapperProtocolDecoder(Protocol protocol) {
+        super(protocol);
+    }
+
+    public static final int MSG_HELLO = 0x01;
+    public static final int MSG_SENDING_START = 0x02;
+    public static final int MSG_SENDING_FINISH = 0x03;
+    public static final int MSG_SEND_EVENTS = 0x21;
+    public static final int MSG_SEND_TECH_INFO = 0x23;
+    public static final int MSG_UPDATE_CMS_NUM = 0x24;
+    public static final int MSG_SEND_SYSTEM_INFO = 0x26;
+    public static final int MSG_SEND_USER_PHONE_NUMBERS = 0x31;
+    public static final int MSG_SEND_GPS_DATA = 0x32;
+    public static final int MSG_SEND_LBS_DATA = 0x33;
+    public static final int MSG_SEND_SYSTEM_STATUS = 0x34;
+    public static final int MSG_SEND_TRANSIT_SETTINGS = 0x35;
+    public static final int MSG_GET_SETTINGS = 0x36;
+    public static final int MSG_SEND_CONCATENATED_PACKET = 0x37;
+    public static final int MSG_SEND_DEBUG_INFO = 0x38;
+
+    private void sendResponse(
+            Channel channel, SocketAddress remoteAddress, int index, int type, String answer) {
+
+        if (channel != null) {
+            ByteBuf response = Unpooled.buffer();
+            response.writeByte('K');
+            response.writeByte(3); // protocol version
+            response.writeIntLE(0); // reserved
+            response.writeIntLE(0); // reserved
+            response.writeShortLE(0); // encryption
+            response.writeIntLE(answer.length());
+            response.writeShortLE(index);
+            response.writeByte(Checksum.sum(ByteBuffer.wrap(answer.getBytes(StandardCharsets.US_ASCII))));
+            response.writeByte(type);
+            response.writeCharSequence(answer, StandardCharsets.US_ASCII);
+            channel.writeAndFlush(new NetworkMessage(response, remoteAddress));
+        }
+    }
+
+    @Override
+    protected Object decode(
+            Channel channel, SocketAddress remoteAddress, Object msg) throws Exception {
+
+        ByteBuf buf = (ByteBuf) msg;
+
+        buf.readUnsignedByte(); // header
+        buf.readUnsignedByte(); // protocol version
+        buf.readUnsignedIntLE(); // system bonus identifier
+
+        String serialNumber = String.valueOf(buf.readUnsignedIntLE());
+        DeviceSession deviceSession = getDeviceSession(channel, remoteAddress, serialNumber);
+        if (deviceSession == null) {
+            return null;
+        }
+
+        buf.readUnsignedShortLE(); // encryption
+        buf.readUnsignedIntLE(); // length
+        buf.readUnsignedByte(); // flags
+        buf.readUnsignedMediumLE(); // reserved
+        int index = buf.readUnsignedShortLE();
+        buf.readUnsignedByte(); // checksum
+        int type = buf.readUnsignedShortLE();
+
+        if (type == MSG_HELLO) {
+            sendResponse(channel, remoteAddress, index, type, "hello");
+        } else {
+            sendResponse(channel, remoteAddress, index, type, "OK");
+        }
+
+        Position position = new Position(getProtocolName());
+        position.setDeviceId(deviceSession.getDeviceId());
+
+        if (type == MSG_SEND_EVENTS) {
+
+            position.set(Position.KEY_EVENT, buf.readUnsignedByte());
+            buf.readUnsignedByte(); // info 1
+            buf.readUnsignedByte(); // info 2
+            getLastLocation(position, null); // TODO read timestamp
+            return position;
+
+        } else if (type == MSG_SEND_TECH_INFO) {
+
+            buf.readUnsignedByte(); // index
+            int subtype = buf.readUnsignedByte();
+            switch (subtype) {
+                case 0x00:
+                    position.set(Position.KEY_POWER, buf.readUnsignedByte() * 0.1);
+                    position.set(Position.KEY_DEVICE_TEMP, buf.readByte());
+                    position.set(Position.KEY_RSSI, buf.readUnsignedByte());
+                    break;
+                case 0x01:
+                    position.set("interiorTemp", buf.readByte());
+                    position.set("engineTemp", buf.readByte());
+                default:
+                    break;
+            }
+            getLastLocation(position, null);
+            return position;
+
+        } else if (type == MSG_SEND_GPS_DATA) {
+
+            String content = buf.readCharSequence(buf.readableBytes(), StandardCharsets.US_ASCII).toString();
+            JsonObject json = Json.createReader(new StringReader(content)).readObject();
+
+            //{"f":"DE","t":"092304.01","d":"110813","la":"5117.6370",
+            // "lo":"01655.3959","a":"00166.6","s":"","c":"","sv":"08","p":"01.6"}
+
+            DateFormat dateFormat = new SimpleDateFormat("ddMMyyHHmmss.SS");
+            dateFormat.setTimeZone(TimeZone.getTimeZone("UTC"));
+            position.setTime(dateFormat.parse(json.getString("d") + json.getString("t")));
+
+            String lat = json.getString("la");
+            position.setLatitude(Integer.parseInt(lat.substring(0, 2)) + Double.parseDouble(lat.substring(2)) / 60);
+            String lon = json.getString("lo");
+            position.setLongitude(Integer.parseInt(lon.substring(0, 3)) + Double.parseDouble(lon.substring(3)) / 60);
+
+            int flags = Integer.parseInt(json.getString("f"));
+            position.setValid(BitUtil.check(flags, 1));
+            if (!BitUtil.check(flags, 6)) {
+                position.setLatitude(-position.getLatitude());
+            }
+            if (!BitUtil.check(flags, 7)) {
+                position.setLongitude(-position.getLongitude());
+            }
+
+            position.setAltitude(Double.parseDouble(json.getString("a")));
+            position.setSpeed(Double.parseDouble(json.getString("s")));
+            position.setCourse(Double.parseDouble(json.getString("c")));
+
+            position.set(Position.KEY_SATELLITES, Integer.parseInt(json.getString("sv")));
+
+            return position;
+
+        }
+
+
+        return null;
+    }
+
+}
diff --git a/src/test/java/org/traccar/protocol/SnapperProtocolDecoderTest.java b/src/test/java/org/traccar/protocol/SnapperProtocolDecoderTest.java
new file mode 100644
index 000000000..c334565f9
--- /dev/null
+++ b/src/test/java/org/traccar/protocol/SnapperProtocolDecoderTest.java
@@ -0,0 +1,21 @@
+package org.traccar.protocol;
+
+import org.junit.jupiter.api.Test;
+import org.traccar.ProtocolTest;
+
+public class SnapperProtocolDecoderTest extends ProtocolTest {
+
+    @Test
+    public void testDecode() throws Exception {
+
+        var decoder = inject(new SnapperProtocolDecoder(null));
+
+        verifyNull(decoder, binary(
+                "4b0341a6b0c608000040000005000000000000007d5e14010068656c6c6f"));
+
+        // data sample
+        // {"f":"DE","t":"092304.01","d":"110813","la":"5117.6370","lo":"01655.3959","a":"00166.6","s":"","c":"","sv":"08","p":"01.6"}
+
+    }
+
+}