Implement eSky ES610 protocol

6 files changed, 220 insertions, 0 deletions

diff --git a/setup/default.xml b/setup/default.xml
index edb3dd47d..0047949eb 100644
--- a/setup/default.xml
+++ b/setup/default.xml
@@ -236,5 +236,6 @@
     <entry key='owntracks.port'>5144</entry>
     <entry key='vtfms.port'>5145</entry>
     <entry key='tlv.port'>5146</entry>
+    <entry key='esky.port'>5147</entry>
 
 </properties>
diff --git a/src/org/traccar/protocol/EskyFrameDecoder.java b/src/org/traccar/protocol/EskyFrameDecoder.java
new file mode 100644
index 000000000..3175698fd
--- /dev/null
+++ b/src/org/traccar/protocol/EskyFrameDecoder.java
@@ -0,0 +1,39 @@
+/*
+ * Copyright 2017 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.jboss.netty.buffer.ChannelBuffer;
+import org.jboss.netty.channel.Channel;
+import org.jboss.netty.channel.ChannelHandlerContext;
+import org.jboss.netty.handler.codec.frame.FrameDecoder;
+
+public class EskyFrameDecoder extends FrameDecoder {
+
+    @Override
+    protected Object decode(
+            ChannelHandlerContext ctx, Channel channel, ChannelBuffer buf) throws Exception {
+
+        buf.readerIndex(buf.indexOf(buf.readerIndex(), buf.writerIndex(), (byte) 'E'));
+
+        int endIndex = buf.indexOf(buf.readerIndex() + 1, buf.writerIndex(), (byte) 'E');
+        if (endIndex > 0) {
+            return buf.readBytes(endIndex - buf.readerIndex());
+        } else {
+            return buf.readBytes(buf.readableBytes()); // assume full frame
+        }
+    }
+
+}
diff --git a/src/org/traccar/protocol/EskyProtocol.java b/src/org/traccar/protocol/EskyProtocol.java
new file mode 100644
index 000000000..4c1d11f7d
--- /dev/null
+++ b/src/org/traccar/protocol/EskyProtocol.java
@@ -0,0 +1,46 @@
+/*
+ * Copyright 2017 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.jboss.netty.bootstrap.ServerBootstrap;
+import org.jboss.netty.channel.ChannelPipeline;
+import org.jboss.netty.handler.codec.string.StringDecoder;
+import org.jboss.netty.handler.codec.string.StringEncoder;
+import org.traccar.BaseProtocol;
+import org.traccar.TrackerServer;
+
+import java.util.List;
+
+public class EskyProtocol extends BaseProtocol {
+
+    public EskyProtocol() {
+        super("esky");
+    }
+
+    @Override
+    public void initTrackerServers(List<TrackerServer> serverList) {
+        serverList.add(new TrackerServer(new ServerBootstrap(), getName()) {
+            @Override
+            protected void addSpecificHandlers(ChannelPipeline pipeline) {
+                pipeline.addLast("frameDecoder", new EskyFrameDecoder());
+                pipeline.addLast("stringEncoder", new StringEncoder());
+                pipeline.addLast("stringDecoder", new StringDecoder());
+                pipeline.addLast("objectDecoder", new EskyProtocolDecoder(EskyProtocol.this));
+            }
+        });
+    }
+
+}
diff --git a/src/org/traccar/protocol/EskyProtocolDecoder.java b/src/org/traccar/protocol/EskyProtocolDecoder.java
new file mode 100644
index 000000000..c12753881
--- /dev/null
+++ b/src/org/traccar/protocol/EskyProtocolDecoder.java
@@ -0,0 +1,92 @@
+/*
+ * Copyright 2017 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.jboss.netty.channel.Channel;
+import org.traccar.BaseProtocolDecoder;
+import org.traccar.DeviceSession;
+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 EskyProtocolDecoder extends BaseProtocolDecoder {
+
+    public EskyProtocolDecoder(EskyProtocol protocol) {
+        super(protocol);
+    }
+
+    private static final Pattern PATTERN = new PatternBuilder()
+            .text("EO;")                         // header
+            .number("d+;")                       // index
+            .number("(d+);")                     // imei
+            .text("R;")                          // data type
+            .number("(d+)").text("+")            // satellites
+            .number("(dd)(dd)(dd)")              // date
+            .number("(dd)(dd)(dd)").text("+")    // time
+            .number("(d+.d+)").text("+")         // latitude
+            .number("(d+.d+)").text("+")         // longitude
+            .number("(d+.d+)").text("+")         // speed
+            .number("(d+)").text("+")            // course
+            .text("0x").number("(d+)").text("+") // input
+            .number("(d+)").text("+")            // message type
+            .number("(d+)").text("+")            // odometer
+            .number("(d+)")                      // voltage
+            .any()
+            .compile();
+
+    @Override
+    protected Object decode(
+            Channel channel, SocketAddress remoteAddress, Object msg) throws Exception {
+
+        org.traccar.helper.PatternUtil.MatchResult matchResult =
+                org.traccar.helper.PatternUtil.checkPattern(PATTERN.pattern(), (String) msg);
+
+        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();
+        position.setProtocol(getProtocolName());
+        position.setDeviceId(deviceSession.getDeviceId());
+
+        position.set(Position.KEY_SATELLITES, parser.nextInt());
+
+        position.setValid(true);
+        position.setTime(parser.nextDateTime());
+        position.setLatitude(parser.nextDouble());
+        position.setLongitude(parser.nextDouble());
+        position.setSpeed(UnitsConverter.knotsFromMps(parser.nextDouble()));
+        position.setCourse(parser.nextDouble());
+
+        position.set(Position.KEY_INPUT, parser.nextHexInt());
+        position.set(Position.KEY_EVENT, parser.nextInt());
+        position.set(Position.KEY_ODOMETER, parser.nextInt());
+        position.set(Position.KEY_POWER, parser.nextInt());
+
+        return position;
+    }
+
+}
diff --git a/test/org/traccar/protocol/EskyFrameDecoderTest.java b/test/org/traccar/protocol/EskyFrameDecoderTest.java
new file mode 100644
index 000000000..34a984bb2
--- /dev/null
+++ b/test/org/traccar/protocol/EskyFrameDecoderTest.java
@@ -0,0 +1,24 @@
+package org.traccar.protocol;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.traccar.ProtocolTest;
+
+public class EskyFrameDecoderTest extends ProtocolTest {
+
+    @Test
+    public void testDecode() throws Exception {
+
+        EskyFrameDecoder decoder = new EskyFrameDecoder();
+
+        verifyFrame(
+                binary("454f3b303b3836343930363032393139363632363b523b302b3137303830383135353335322b302e30303030302b302e30303030302b302e30302b302b3078312b302b302b302b31323333"),
+                decoder.decode(null, null, binary("454f3b303b3836343930363032393139363632363b523b302b3137303830383135353335322b302e30303030302b302e30303030302b302e30302b302b3078312b302b302b302b31323333")));
+
+        verifyFrame(
+                binary("454f3b303b3836343930363032393139363632363b523b302b3137303830383135353335322b302e30303030302b302e30303030302b302e30302b302b3078312b302b302b302b31323333"),
+                decoder.decode(null, null, binary("454f3b303b3836343930363032393139363632363b523b302b3137303830383135353335322b302e30303030302b302e30303030302b302e30302b302b3078312b302b302b302b31323333454f3b303b3836343930363032393139363632363b523b302b3137303830383135353335322b302e30303030302b302e30303030302b302e30302b302b3078312b302b302b302b31323333")));
+
+    }
+
+}
diff --git a/test/org/traccar/protocol/EskyProtocolDecoderTest.java b/test/org/traccar/protocol/EskyProtocolDecoderTest.java
new file mode 100644
index 000000000..52dff971f
--- /dev/null
+++ b/test/org/traccar/protocol/EskyProtocolDecoderTest.java
@@ -0,0 +1,18 @@
+package org.traccar.protocol;
+
+import org.junit.Test;
+import org.traccar.ProtocolTest;
+
+public class EskyProtocolDecoderTest extends ProtocolTest {
+
+    @Test
+    public void testDecode() throws Exception {
+
+        EskyProtocolDecoder decoder = new EskyProtocolDecoder(new EskyProtocol());
+
+        verifyPosition(decoder, text(
+                "EO;0;864906029196626;R;0+170808155352+0.00000+0.00000+0.00+0+0x1+0+0+0+1233"));
+
+    }
+
+}