Implement JIDO T63 protocol

4 files changed, 189 insertions, 0 deletions

diff --git a/setup/default.xml b/setup/default.xml
index a592bbbed..fdb4cbf3b 100644
--- a/setup/default.xml
+++ b/setup/default.xml
@@ -308,5 +308,6 @@
     <entry key='techtocruz.port'>5234</entry>
     <entry key='flexapi.port'>5235</entry>
     <entry key='dsf22.port'>5236</entry>
+    <entry key='jido.port'>5237</entry>
 
 </properties>
diff --git a/src/main/java/org/traccar/protocol/JidoProtocol.java b/src/main/java/org/traccar/protocol/JidoProtocol.java
new file mode 100644
index 000000000..2a2e71dbe
--- /dev/null
+++ b/src/main/java/org/traccar/protocol/JidoProtocol.java
@@ -0,0 +1,39 @@
+/*
+ * Copyright 2022 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.string.StringDecoder;
+import io.netty.handler.codec.string.StringEncoder;
+import org.traccar.BaseProtocol;
+import org.traccar.CharacterDelimiterFrameDecoder;
+import org.traccar.PipelineBuilder;
+import org.traccar.TrackerServer;
+
+public class JidoProtocol extends BaseProtocol {
+
+    public JidoProtocol() {
+        addServer(new TrackerServer(false, getName()) {
+            @Override
+            protected void addProtocolHandlers(PipelineBuilder pipeline) {
+                pipeline.addLast(new CharacterDelimiterFrameDecoder(1024, '#'));
+                pipeline.addLast(new StringEncoder());
+                pipeline.addLast(new StringDecoder());
+                pipeline.addLast(new JidoProtocolDecoder(JidoProtocol.this));
+            }
+        });
+    }
+
+}
diff --git a/src/main/java/org/traccar/protocol/JidoProtocolDecoder.java b/src/main/java/org/traccar/protocol/JidoProtocolDecoder.java
new file mode 100644
index 000000000..40fa8864d
--- /dev/null
+++ b/src/main/java/org/traccar/protocol/JidoProtocolDecoder.java
@@ -0,0 +1,128 @@
+/*
+ * 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.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 JidoProtocolDecoder extends BaseProtocolDecoder {
+
+    public JidoProtocolDecoder(Protocol protocol) {
+        super(protocol);
+    }
+
+    private static final Pattern PATTERN = new PatternBuilder()
+            .text("*")
+            .number("(d+),")                     // imei
+            .number("(d+),")                     // command
+            .expression("([AV]),").optional()    // validity
+            .number("(dd)(dd)(dd),")             // date (ddmmyy)
+            .number("(dd)(dd)(dd),")             // time (hhmmss)
+            .number("(d+)(dd.d+),")              // latitude
+            .expression("([NS]),")
+            .number("(d+)(dd.d+),")              // longitude
+            .expression("([EW]),")
+            .groupBegin()
+            .number("(d+),")                     // speed
+            .number("(d+),")                     // odometer
+            .number("(d+),")                     // course
+            .number("(-?d+),")                   // altitude
+            .number("(d+),")                     // satellites
+            .number("d+,")                       // gsm 1
+            .number("d+,")                       // gsm 2
+            .number("([01]),")                   // charging
+            .number("(d+),")                     // battery level
+            .expression("([YKN]),")              // mode
+            .number("([01]),")                   // lock
+            .number("[^,]+,")                    // accelerometer x
+            .number("[^,]+,")                    // accelerometer y
+            .number("[^,]+,")                    // accelerometer z
+            .or()
+            .expression("[^,]*,")                // data
+            .groupEnd()
+            .number("xx")                        // checksum
+            .compile();
+
+    private String decodeAlarm(int type) {
+        switch (type) {
+            case 3:
+                return Position.ALARM_LOW_BATTERY;
+            case 4:
+                return Position.ALARM_TAMPERING;
+            default:
+                return null;
+        }
+    }
+
+    @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.set(Position.KEY_ALARM, decodeAlarm(parser.nextInt()));
+
+        if (parser.hasNext()) {
+            position.setValid(parser.next().equals("A"));
+        } else {
+            position.setValid(true);
+        }
+
+        position.setTime(parser.nextDateTime(Parser.DateTimeFormat.DMY_HMS));
+        position.setLatitude(parser.nextCoordinate());
+        position.setLongitude(parser.nextCoordinate());
+
+        if (parser.hasNext(9)) {
+
+            position.setSpeed(UnitsConverter.knotsFromKph(parser.nextInt()));
+
+            position.set(Position.KEY_ODOMETER, parser.nextInt());
+
+            position.setCourse(parser.nextInt());
+            position.setAltitude(parser.nextInt());
+
+            position.set(Position.KEY_SATELLITES, parser.nextInt());
+            position.set(Position.KEY_CHARGE, parser.nextInt() > 0);
+            position.set(Position.KEY_BATTERY_LEVEL, parser.nextInt());
+            position.set("mode", parser.next());
+            position.set(Position.KEY_BLOCKED, parser.nextInt() > 0);
+
+        }
+
+        return position;
+    }
+
+}
diff --git a/src/test/java/org/traccar/protocol/JidoProtocolDecoderTest.java b/src/test/java/org/traccar/protocol/JidoProtocolDecoderTest.java
new file mode 100644
index 000000000..9e01d7d68
--- /dev/null
+++ b/src/test/java/org/traccar/protocol/JidoProtocolDecoderTest.java
@@ -0,0 +1,21 @@
+package org.traccar.protocol;
+
+import org.junit.Test;
+import org.traccar.ProtocolTest;
+
+public class JidoProtocolDecoderTest extends ProtocolTest {
+
+    @Test
+    public void testDecode() throws Exception {
+
+        var decoder = new JidoProtocolDecoder(null);
+
+        verifyPosition(decoder, text(
+                "*12345678910101000,01,A,130517,160435,1820.5845,N,07833.2478,E,20,0,067,045,05,28,26,1,075,Y,1,0000,0000,0000,59"));
+
+        verifyPosition(decoder, text(
+                "*12345678910101000,03,130517,160435,1820.5845,N,07833.2478,E,1,58"));
+
+    }
+
+}