Merge pull request #5085 from LiGuru/master

Add [Protocol]TranSyncProtocol - AIS 140

3 files changed, 290 insertions, 0 deletions

diff --git a/src/main/java/org/traccar/protocol/TranSyncProtocol.java b/src/main/java/org/traccar/protocol/TranSyncProtocol.java
new file mode 100644
index 000000000..5422380b6
--- /dev/null
+++ b/src/main/java/org/traccar/protocol/TranSyncProtocol.java
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2013 - 2023 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 org.traccar.BaseProtocol;
+import org.traccar.PipelineBuilder;
+import org.traccar.TrackerServer;
+import org.traccar.config.Config;
+
+import javax.inject.Inject;
+
+public class TranSyncProtocol extends BaseProtocol {
+
+    @Inject
+    public TranSyncProtocol(Config config) {
+        addServer(new TrackerServer(config, getName(), false) {
+            @Override
+            protected void addProtocolHandlers(PipelineBuilder pipeline, Config config) {
+                pipeline.addLast(new LengthFieldBasedFrameDecoder(256, 2, 1, 2, 0, true));
+                pipeline.addLast(new TranSyncProtocolDecoder(TranSyncProtocol.this));
+            }
+        });
+    }
+}
diff --git a/src/main/java/org/traccar/protocol/TranSyncProtocolDecoder.java b/src/main/java/org/traccar/protocol/TranSyncProtocolDecoder.java
new file mode 100644
index 000000000..130c916b1
--- /dev/null
+++ b/src/main/java/org/traccar/protocol/TranSyncProtocolDecoder.java
@@ -0,0 +1,235 @@
+/*
+ * Copyright 2013 - 2023 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.channel.Channel;
+import org.traccar.BaseProtocolDecoder;
+import org.traccar.Protocol;
+import org.traccar.helper.BitUtil;
+import org.traccar.helper.DateBuilder;
+import org.traccar.helper.UnitsConverter;
+import org.traccar.model.CellTower;
+import org.traccar.model.Network;
+import org.traccar.model.Position;
+import org.traccar.session.DeviceSession;
+
+import java.net.SocketAddress;
+import java.util.Arrays;
+
+public class TranSyncProtocolDecoder extends BaseProtocolDecoder {
+
+    private static final byte[] STX = new byte[]{0x3a, 0x3a};
+
+    private String getHardwareType(int type) {
+
+        switch (type) {
+            case 1:
+                return  "basic";
+            case 2:
+                return "asset";
+            case 3:
+                return "bike";
+            case 4:
+                return "serial";
+            case 5:
+                return "obd";
+            case 6:
+                return "l1";
+            case 7:
+                return "ais-140";
+            default:
+                return "unknown";
+        }
+    }
+
+    public TranSyncProtocolDecoder(Protocol protocol) {
+        super(protocol);
+    }
+
+    protected void decodeAlarm(Position position, int value) {
+        switch (value) {
+            case 10:
+                position.set(Position.KEY_ALARM, Position.ALARM_SOS);
+                break;
+            case 11:
+                position.set(Position.KEY_EVENT, 11);
+                break;
+            case 16:
+                position.set(Position.KEY_EVENT, 16);
+                break;
+            case 3:
+                position.set(Position.KEY_ALARM, 3);
+                break;
+            case 22:
+                position.set(Position.KEY_ALARM, 22);
+                break;
+            case 9:
+                position.set(Position.KEY_EVENT, 9);
+            case 17:
+                position.set(Position.KEY_ALARM, Position.ALARM_OVERSPEED);
+                break;
+            case 13:
+                position.set(Position.KEY_ALARM, Position.ALARM_BRAKING);
+                break;
+            case 14:
+                position.set(Position.KEY_ALARM, Position.ALARM_ACCELERATION);
+                break;
+            case 15:
+                position.set(Position.KEY_EVENT, 15);
+                break;
+            case 23:
+                position.set(Position.KEY_ALARM, Position.ALARM_ACCIDENT);
+                break;
+            case 12:
+                position.set(Position.KEY_EVENT, 12);
+                break;
+            case 6:
+                position.set(Position.KEY_ALARM, Position.ALARM_POWER_RESTORED);
+                break;
+            case 4:
+                position.set(Position.KEY_ALARM, Position.ALARM_LOW_BATTERY);
+                break;
+            case 5:
+                position.set(Position.KEY_EVENT, 5);
+                break;
+            default:
+                position.set(Position.KEY_EVENT, "unknown");
+        }
+    }
+    private void analizeNegativePosition(Position position, int value) {
+
+        if (!BitUtil.check(value, 1)) {
+            position.setLatitude(-position.getLatitude()); // 0/1 S/N
+        }
+        if (!BitUtil.check(value, 2)) {
+            position.setLongitude(-position.getLongitude()); // 0/1 W/E
+        }
+    }
+
+    private void decodePowerEngineParameters(Position position, int value) {
+
+        position.set(Position.PREFIX_OUT + 1, BitUtil.check(value, 7));
+        position.set(Position.PREFIX_OUT + 2, BitUtil.check(value, 6));
+        position.set(Position.PREFIX_IN + 3, BitUtil.check(value, 5));
+        if (BitUtil.check(value, 4)) {
+            position.set(Position.KEY_ALARM, Position.ALARM_POWER_OFF);
+        }
+        position.set(Position.KEY_IGNITION, BitUtil.check(value, 3));
+        position.set("gpsFix", BitUtil.check(value, 0));
+    }
+
+    private void decodeTrackerStatusParameters(Position position, int value) {
+        if (BitUtil.check(value, 7)) {
+            position.set(Position.KEY_ARCHIVE, true);
+        }
+        if (BitUtil.check(value, 5)) {
+            position.set(Position.KEY_ALARM, Position.ALARM_GPS_ANTENNA_CUT);
+        }
+        position.set(Position.KEY_VERSION_HW, getHardwareType(BitUtil.between(value, 0, 3)));
+    }
+
+    @Override
+    protected Object decode(Channel channel, SocketAddress remoteAddress, Object msg) throws Exception {
+
+        ByteBuf buf = (ByteBuf) msg;
+
+        if (Arrays.equals(ByteBufUtil.getBytes(buf, 0, 2), STX)) {
+            buf.readUnsignedShort();
+        }
+        buf.readByte(); //packetLength
+
+        int locationAreaCode = buf.readUnsignedShort();
+        String deviceId = ByteBufUtil.hexDump(buf.readSlice(8));
+
+        buf.readUnsignedShort(); //informationSerialNumber
+        buf.readUnsignedByte(); //protocolNumber
+
+        DeviceSession deviceSession = getDeviceSession(channel, remoteAddress, deviceId);
+        if (deviceSession == null) {
+            return null;
+        }
+        Position position = new Position(getProtocolName());
+        position.setDeviceId(deviceSession.getDeviceId());
+        position.setValid(true);
+        position.setTime(new DateBuilder()
+                .setDate(buf.readUnsignedByte(), buf.readUnsignedByte(), buf.readUnsignedByte())
+                .setTime(buf.readUnsignedByte(), buf.readUnsignedByte(), buf.readUnsignedByte())
+                .getDate());
+        position.setLatitude(buf.readUnsignedInt() / 1800000.0);
+        position.setLongitude(buf.readUnsignedInt() / 1800000.0);
+        position.setSpeed(UnitsConverter.knotsFromKph(buf.readUnsignedByte()));
+        position.setCourse(buf.readUnsignedShort());
+
+        int mobileNetworkCode = buf.readUnsignedByte();
+        int cellTowerId = buf.readUnsignedShort();
+        int statusParameters = buf.readUnsignedByte();
+
+        decodePowerEngineParameters(position, statusParameters);
+        analizeNegativePosition(position, statusParameters);
+
+        buf.readUnsignedByte(); // reserved
+
+        decodeAlarm(position, buf.readUnsignedByte());
+
+        decodeTrackerStatusParameters(position, buf.readUnsignedByte());
+
+        int gsmSignalStrength = buf.readUnsignedByte();
+
+        position.set(Position.KEY_BATTERY, (double) (buf.readUnsignedByte() / 10));
+        position.set(Position.KEY_SATELLITES, buf.readUnsignedByte());
+        position.set(Position.KEY_HDOP, buf.readUnsignedByte());
+        position.set(Position.PREFIX_ADC + 1, (short) buf.readUnsignedShort());
+
+        CellTower cellTower = CellTower.fromLacCid(getConfig(), locationAreaCode, cellTowerId);
+        cellTower.setMobileNetworkCode(mobileNetworkCode);
+        cellTower.setSignalStrength(gsmSignalStrength);
+
+        position.setNetwork(new Network(cellTower));
+
+        if (buf.readableBytes() > 5) {
+            buf.readUnsignedByte(); // odometerIndex
+            int odometerLength = buf.readUnsignedByte();
+            if (odometerLength > 0) {
+                int odometer = buf.readBytes(odometerLength).readInt();
+                position.set(Position.KEY_ODOMETER, odometer);
+            }
+            if ((buf.readableBytes() > 5)) {
+                buf.readUnsignedByte(); // tagIndex
+                int tagLength = buf.readUnsignedByte();
+                if (tagLength > 0) {
+                    position.set("tag", ByteBufUtil.hexDump(buf.readSlice(tagLength)));
+                }
+            }
+            if ((buf.readableBytes() > 5)) {
+                buf.readUnsignedByte(); // adc2Index
+                int adc2Length = buf.readUnsignedByte();
+                if (adc2Length > 0) {
+                    position.set(Position.PREFIX_ADC + 2, buf.readUnsignedShort());
+                }
+            }
+            if ((buf.readableBytes() > 5)) {
+                buf.readUnsignedByte(); // adc3Index
+                int adc2Length = buf.readUnsignedByte();
+                if (adc2Length > 0 && adc2Length <= buf.readableBytes() - 2) {
+                    position.set(Position.PREFIX_ADC + 3, buf.readUnsignedShort());
+                }
+            }
+        }
+        return position;
+    }
+}
diff --git a/src/test/java/org/traccar/protocol/TranSyncProtocolDecoderTest.java b/src/test/java/org/traccar/protocol/TranSyncProtocolDecoderTest.java
new file mode 100644
index 000000000..c84ae2e0f
--- /dev/null
+++ b/src/test/java/org/traccar/protocol/TranSyncProtocolDecoderTest.java
@@ -0,0 +1,17 @@
+package org.traccar.protocol;
+
+import org.junit.jupiter.api.Test;
+import org.traccar.ProtocolTest;
+
+public class TranSyncProtocolDecoderTest extends ProtocolTest {
+
+    @Test
+    public void testDecode() throws Exception {
+
+        var decoder = inject(new TranSyncProtocolDecoder(null));
+
+        verifyPosition(decoder, binary("3a3a2b583f086065705154043900801017050b11190f01623ef40887dff00000c25e9ff707000007152a2d0000000105004794916902050000100000050252ee060200822323"));
+
+        verifyAttributes(decoder, binary("3a3a2b583f086065705154043900801017050b11190f01623ef40887dff00000c25e9ff707000007152a2d0000000105004794916902050000000000050252ee060200822323"));
+    }
+}