Implement XRB 28 protocol

5 files changed, 275 insertions, 0 deletions

diff --git a/src/org/traccar/protocol/Xrb28Protocol.java b/src/org/traccar/protocol/Xrb28Protocol.java
new file mode 100644
index 000000000..bb8c4fa39
--- /dev/null
+++ b/src/org/traccar/protocol/Xrb28Protocol.java
@@ -0,0 +1,46 @@
+/*
+ * Copyright 2018 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.LineBasedFrameDecoder;
+import io.netty.handler.codec.string.StringDecoder;
+import io.netty.handler.codec.string.StringEncoder;
+import org.traccar.BaseProtocol;
+import org.traccar.PipelineBuilder;
+import org.traccar.TrackerServer;
+import org.traccar.model.Command;
+
+public class Xrb28Protocol extends BaseProtocol {
+
+    public Xrb28Protocol() {
+        setSupportedDataCommands(
+                Command.TYPE_CUSTOM,
+                Command.TYPE_POSITION_SINGLE,
+                Command.TYPE_POSITION_PERIODIC,
+                Command.TYPE_ALARM_ARM,
+                Command.TYPE_ALARM_DISARM);
+        addServer(new TrackerServer(false, getName()) {
+            @Override
+            protected void addProtocolHandlers(PipelineBuilder pipeline) {
+                pipeline.addLast(new LineBasedFrameDecoder(1024));
+                pipeline.addLast(new StringEncoder());
+                pipeline.addLast(new StringDecoder());
+                pipeline.addLast(new Ardi01ProtocolDecoder(Xrb28Protocol.this));
+            }
+        });
+    }
+
+}
diff --git a/src/org/traccar/protocol/Xrb28ProtocolDecoder.java b/src/org/traccar/protocol/Xrb28ProtocolDecoder.java
new file mode 100644
index 000000000..c3af2c4f3
--- /dev/null
+++ b/src/org/traccar/protocol/Xrb28ProtocolDecoder.java
@@ -0,0 +1,114 @@
+/*
+ * Copyright 2018 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.NetworkMessage;
+import org.traccar.Protocol;
+import org.traccar.helper.DateBuilder;
+import org.traccar.helper.Parser;
+import org.traccar.helper.PatternBuilder;
+import org.traccar.model.Command;
+import org.traccar.model.Position;
+
+import java.net.SocketAddress;
+import java.util.regex.Pattern;
+
+public class Xrb28ProtocolDecoder extends BaseProtocolDecoder {
+
+    private String pendingCommand;
+
+    public void setPendingCommand(String pendingCommand) {
+        this.pendingCommand = pendingCommand;
+    }
+
+    public Xrb28ProtocolDecoder(Protocol protocol) {
+        super(protocol);
+    }
+
+    private static final Pattern PATTERN = new PatternBuilder()
+            .text("*HBCR,")
+            .expression("..,")                   // vendor
+            .number("d{15},")                    // imei
+            .expression("..,")                   // type
+            .number("0,")                        // reserved
+            .number("(dd)(dd)(dd).d+,")          // time (hhmmss)
+            .expression("([AV]),")               // validity
+            .number("(dd)(dd.d+),")              // latitude
+            .expression("([NS]),")
+            .number("(d{2,3})(dd.d+),")          // longitude
+            .expression("([EW]),")
+            .number("(d+),")                     // satellites
+            .number("(d+.d+),")                  // hdop
+            .number("(dd)(dd)(dd),")             // date (ddmmyy)
+            .number("(-?d+),")                   // altitude
+            .expression(".,")                    // height unit
+            .expression(".#")                    // mode
+            .compile();
+
+    @Override
+    protected Object decode(
+            Channel channel, SocketAddress remoteAddress, Object msg) throws Exception {
+
+        String sentence = (String) msg;
+
+        DeviceSession deviceSession = getDeviceSession(channel, remoteAddress, sentence.substring(10, 26));
+        if (deviceSession == null) {
+            return null;
+        }
+
+        String type = sentence.substring(27, 29);
+        if (channel != null) {
+            if (type.matches("L0|L1|W0|E1")) {
+                channel.write(new NetworkMessage(
+                        sentence.substring(0, 29) + "#\n", remoteAddress));
+            } else if (type.equals("R0") && pendingCommand != null) {
+                String command = pendingCommand.equals(Command.TYPE_ALARM_ARM) ? "L1," : "L0,";
+                channel.write(new NetworkMessage(
+                        sentence.substring(0, 27) + command + sentence.substring(32) + "\n", remoteAddress));
+                pendingCommand = null;
+            }
+        }
+
+        Parser parser = new Parser(PATTERN, sentence.substring(2));
+        if (!parser.matches()) {
+            return null;
+        }
+
+        Position position = new Position(getProtocolName());
+        position.setDeviceId(deviceSession.getDeviceId());
+
+        DateBuilder dateBuilder = new DateBuilder()
+                .setTime(parser.nextInt(), parser.nextInt(), parser.nextInt());
+
+        position.setValid(parser.next().equals("A"));
+        position.setLatitude(parser.nextCoordinate());
+        position.setLongitude(parser.nextCoordinate());
+
+        position.set(Position.KEY_SATELLITES, parser.nextInt());
+        position.set(Position.KEY_HDOP, parser.nextDouble());
+
+        dateBuilder.setDateReverse(parser.nextInt(), parser.nextInt(), parser.nextInt());
+        position.setTime(dateBuilder.getDate());
+
+        position.setAltitude(parser.nextInt());
+
+        return position;
+    }
+
+}
diff --git a/src/org/traccar/protocol/Xrb28ProtocolEncoder.java b/src/org/traccar/protocol/Xrb28ProtocolEncoder.java
new file mode 100644
index 000000000..af60661fa
--- /dev/null
+++ b/src/org/traccar/protocol/Xrb28ProtocolEncoder.java
@@ -0,0 +1,52 @@
+/*
+ * Copyright 2018 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.BaseProtocolEncoder;
+import org.traccar.model.Command;
+
+public class Xrb28ProtocolEncoder extends BaseProtocolEncoder {
+
+    private String formatCommand(Command command, String content) {
+        return String.format("\u00ff\u00ff*HBCS,OM,%s,%s#\n", getUniqueId(command.getDeviceId()), content);
+    }
+
+    @Override
+    protected Object encodeCommand(Channel channel, Command command) {
+
+        switch (command.getType()) {
+            case Command.TYPE_CUSTOM:
+                return formatCommand(command, command.getString(Command.KEY_DATA));
+            case Command.TYPE_POSITION_SINGLE:
+                return formatCommand(command, "D0");
+            case Command.TYPE_POSITION_PERIODIC:
+                return formatCommand(command, "D1," + command.getInteger(Command.KEY_FREQUENCY));
+            case Command.TYPE_ENGINE_STOP:
+            case Command.TYPE_ALARM_DISARM:
+                if (channel != null) {
+                    Xrb28ProtocolDecoder decoder = channel.pipeline().get(Xrb28ProtocolDecoder.class);
+                    if (decoder != null) {
+                        decoder.setPendingCommand(command.getType());
+                    }
+                }
+                return formatCommand(command, "R0,0,20,1234," + System.currentTimeMillis() / 1000);
+            default:
+                return null;
+        }
+    }
+
+}
diff --git a/test/org/traccar/protocol/Xrb28ProtocolDecoderTest.java b/test/org/traccar/protocol/Xrb28ProtocolDecoderTest.java
new file mode 100644
index 000000000..441d7b811
--- /dev/null
+++ b/test/org/traccar/protocol/Xrb28ProtocolDecoderTest.java
@@ -0,0 +1,24 @@
+package org.traccar.protocol;
+
+import org.junit.Test;
+import org.traccar.ProtocolTest;
+
+public class Xrb28ProtocolDecoderTest extends ProtocolTest {
+
+    @Test
+    public void testDecode() throws Exception {
+
+        Xrb28ProtocolDecoder decoder = new Xrb28ProtocolDecoder(null);
+
+        verifyNull(decoder, text(
+                "\u00ff\u00ff*HBCR,OM,123456789123456,Q0,412,80#"));
+
+        verifyNull(decoder, text(
+                "\u00ff\u00ff*HBCR,OM,123456789123456,R0,0,55,1234,1497689816#"));
+
+        verifyPosition(decoder, text(
+                "\u00ff\u00ff*HBCR,OM,123456789123456,D0,0,124458.00,A,2237.7514,N,11408.6214,E,6,0.21,151216,10,M,A#"));
+
+    }
+
+}
diff --git a/test/org/traccar/protocol/Xrb28ProtocolEncoderTest.java b/test/org/traccar/protocol/Xrb28ProtocolEncoderTest.java
new file mode 100644
index 000000000..4b2ac2045
--- /dev/null
+++ b/test/org/traccar/protocol/Xrb28ProtocolEncoderTest.java
@@ -0,0 +1,39 @@
+package org.traccar.protocol;
+
+import org.junit.Test;
+import org.traccar.ProtocolTest;
+import org.traccar.model.Command;
+
+import static org.junit.Assert.assertEquals;
+
+public class Xrb28ProtocolEncoderTest extends ProtocolTest {
+
+    @Test
+    public void testEncodePositionPeriodic() {
+
+        Xrb28ProtocolEncoder encoder = new Xrb28ProtocolEncoder();
+        
+        Command command = new Command();
+        command.setDeviceId(1);
+        command.setType(Command.TYPE_POSITION_PERIODIC);
+        command.set(Command.KEY_FREQUENCY, 300);
+        
+        assertEquals("\u00ff\u00ff*HBCS,OM,123456789012345,D1,300#\n", encoder.encodeCommand(null, command));
+
+    }
+
+    @Test
+    public void testEncodeCustom() {
+
+        Xrb28ProtocolEncoder encoder = new Xrb28ProtocolEncoder();
+
+        Command command = new Command();
+        command.setDeviceId(1);
+        command.setType(Command.TYPE_CUSTOM);
+        command.set(Command.KEY_DATA, "S7,0,3,0,0,20,25");
+
+        assertEquals("\u00ff\u00ff*HBCS,OM,123456789012345,S7,0,3,0,0,20,25#\n", encoder.encodeCommand(null, command));
+
+    }
+
+}