Add flexible report protocol

4 files changed, 203 insertions, 0 deletions

diff --git a/setup/default.xml b/setup/default.xml
index 4e9e96de8..67a1a9f12 100644
--- a/setup/default.xml
+++ b/setup/default.xml
@@ -291,5 +291,6 @@
     <entry key='mavlink2.port'>5224</entry>
     <entry key='uux.port'>5225</entry>
     <entry key='r12w.port'>5226</entry>
+    <entry key='flexiblereport.port'>5227</entry>
 
 </properties>
diff --git a/src/main/java/org/traccar/protocol/FlexibleReportProtocol.java b/src/main/java/org/traccar/protocol/FlexibleReportProtocol.java
new file mode 100644
index 000000000..0cd55343a
--- /dev/null
+++ b/src/main/java/org/traccar/protocol/FlexibleReportProtocol.java
@@ -0,0 +1,33 @@
+/*
+ * Copyright 2021 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.traccar.BaseProtocol;
+import org.traccar.PipelineBuilder;
+import org.traccar.TrackerServer;
+
+public class FlexibleReportProtocol extends BaseProtocol {
+
+    public FlexibleReportProtocol() {
+        addServer(new TrackerServer(true, getName()) {
+            @Override
+            protected void addProtocolHandlers(PipelineBuilder pipeline) {
+                pipeline.addLast(new FlexibleReportProtocolDecoder(FlexibleReportProtocol.this));
+            }
+        });
+    }
+
+}
diff --git a/src/main/java/org/traccar/protocol/FlexibleReportProtocolDecoder.java b/src/main/java/org/traccar/protocol/FlexibleReportProtocolDecoder.java
new file mode 100644
index 000000000..44a2ae6e1
--- /dev/null
+++ b/src/main/java/org/traccar/protocol/FlexibleReportProtocolDecoder.java
@@ -0,0 +1,151 @@
+/*
+ * Copyright 2021 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.ByteBufUtil;
+import io.netty.buffer.Unpooled;
+import io.netty.channel.Channel;
+import org.traccar.BaseProtocolDecoder;
+import org.traccar.DeviceSession;
+import org.traccar.NetworkMessage;
+import org.traccar.Protocol;
+import org.traccar.helper.BitUtil;
+import org.traccar.helper.UnitsConverter;
+import org.traccar.model.Position;
+
+import java.net.SocketAddress;
+import java.util.Date;
+
+public class FlexibleReportProtocolDecoder extends BaseProtocolDecoder {
+
+    public FlexibleReportProtocolDecoder(Protocol protocol) {
+        super(protocol);
+    }
+
+    public static final int MSG_GENERAL = 0x00;
+
+    private void sendResponse(Channel channel, SocketAddress remoteAddress, int index) {
+        if (channel != null) {
+            ByteBuf response = Unpooled.buffer();
+            response.writeByte(0x7E); // header
+            response.writeShort(2); // length
+            response.writeByte(0xE0);
+            response.writeByte(BitUtil.check(index, 0) ? 0x4F : 0x0F);
+            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
+        int flags = buf.readUnsignedByte();
+
+        String imei = ByteBufUtil.hexDump(buf.readSlice(8)).substring(1);
+        DeviceSession deviceSession = getDeviceSession(channel, remoteAddress, imei);
+        if (deviceSession == null) {
+            return null;
+        }
+
+        int index = buf.readUnsignedShort();
+
+        if (BitUtil.to(flags, 2) > 0) {
+            sendResponse(channel, remoteAddress, index);
+        }
+
+        Date time = new Date(buf.readUnsignedInt() * 1000);
+        int event = buf.readUnsignedByte();
+
+        buf.readUnsignedByte(); // length
+
+        int type = buf.readUnsignedByte();
+
+        if (type == MSG_GENERAL) {
+
+            Position position = new Position(getProtocolName());
+            position.setDeviceId(deviceSession.getDeviceId());
+
+            position.setDeviceTime(time);
+
+            position.set(Position.KEY_EVENT, event);
+
+            buf.readUnsignedByte(); // length
+            long mask = buf.readUnsignedInt();
+
+            if (BitUtil.check(mask, 0)) {
+                buf.readUnsignedByte(); // product id
+            }
+            if (BitUtil.check(mask, 1)) {
+                position.setFixTime(new Date(buf.readUnsignedInt() * 1000));
+            }
+            if (BitUtil.check(mask, 2)) {
+                position.setValid(true);
+                position.setLatitude(buf.readUnsignedInt() / 1000000.0 - 90);
+                position.setLongitude(buf.readUnsignedInt() / 1000000.0 - 180);
+            }
+            if (BitUtil.check(mask, 3)) {
+                position.setSpeed(UnitsConverter.knotsFromKph(buf.readUnsignedByte()));
+                position.setCourse(buf.readUnsignedShort());
+            }
+            if (BitUtil.check(mask, 4)) {
+                position.setAltitude(buf.readShort());
+            }
+            if (BitUtil.check(mask, 5)) {
+                buf.readUnsignedShort(); // gps accuracy
+            }
+            if (BitUtil.check(mask, 6)) {
+                position.set(Position.KEY_POWER, buf.readUnsignedShort() * 0.01);
+            }
+            if (BitUtil.check(mask, 7)) {
+                position.set(Position.KEY_BATTERY, buf.readUnsignedShort() * 0.01);
+            }
+            if (BitUtil.check(mask, 8)) {
+                position.set("auxPower", buf.readUnsignedShort() * 0.01);
+            }
+            if (BitUtil.check(mask, 9)) {
+                position.set("solarPower", buf.readUnsignedShort() * 0.01);
+            }
+            if (BitUtil.check(mask, 10)) {
+                buf.skipBytes(5); // cell info
+            }
+            if (BitUtil.check(mask, 11)) {
+                buf.readUnsignedByte(); // rssi
+            }
+            if (BitUtil.check(mask, 12)) {
+                position.set(Position.PREFIX_IO + 1, buf.readUnsignedByte());
+            }
+            if (BitUtil.check(mask, 13)) {
+                position.set(Position.PREFIX_IO + 2, buf.readUnsignedByte());
+            }
+            if (BitUtil.check(mask, 14)) {
+                position.set(Position.KEY_ODOMETER, buf.readUnsignedInt() * 1000);
+            }
+            if (BitUtil.check(mask, 15)) {
+                position.set(Position.PREFIX_TEMP + 1, buf.readUnsignedShort() * 0.01);
+            }
+
+            return position;
+
+        }
+
+        return null;
+    }
+
+}
diff --git a/src/test/java/org/traccar/protocol/FlexibleReportProtocolDecoderTest.java b/src/test/java/org/traccar/protocol/FlexibleReportProtocolDecoderTest.java
new file mode 100644
index 000000000..068447074
--- /dev/null
+++ b/src/test/java/org/traccar/protocol/FlexibleReportProtocolDecoderTest.java
@@ -0,0 +1,18 @@
+package org.traccar.protocol;
+
+import org.junit.Test;
+import org.traccar.ProtocolTest;
+
+public class FlexibleReportProtocolDecoderTest extends ProtocolTest {
+
+    @Test
+    public void testDecode() throws Exception {
+
+        var decoder = new FlexibleReportProtocolDecoder(null);
+
+        verifyAttributes(decoder, binary(
+                "7D010860112040978399000027E3CFC30130002E7FFFFFFF0C00000000055D4A800ABA9500000000000000002F5D0E800000000000FFFFFFFF158A0000000000FFFF"));
+
+    }
+
+}