Implement M2C 2020 protocol

setup/default.xml

@@ -225,5 +225,6 @@
     <entry key='sigfox.port'>5154</entry>
     <entry key='t57.port'>5155</entry>
     <entry key='spot.port'>5156</entry>
+    <entry key='m2c.port'>5157</entry>
 
 </properties>

src/org/traccar/protocol/M2cProtocol.java

@@ -0,0 +1,47 @@
+/*
+ * 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.CharacterDelimiterFrameDecoder;
+import org.traccar.TrackerServer;
+
+import java.util.List;
+
+public class M2cProtocol extends BaseProtocol {
+
+    public M2cProtocol() {
+        super("m2c");
+    }
+
+    @Override
+    public void initTrackerServers(List<TrackerServer> serverList) {
+        serverList.add(new TrackerServer(new ServerBootstrap(), getName()) {
+            @Override
+            protected void addSpecificHandlers(ChannelPipeline pipeline) {
+                pipeline.addLast("frameDecoder", new CharacterDelimiterFrameDecoder(32 * 1024, ']'));
+                pipeline.addLast("stringDecoder", new StringDecoder());
+                pipeline.addLast("stringEncoder", new StringEncoder());
+                pipeline.addLast("objectDecoder", new M2cProtocolDecoder(M2cProtocol.this));
+            }
+        });
+    }
+
+}

src/org/traccar/protocol/M2cProtocolDecoder.java

@@ -0,0 +1,131 @@
+/*
+ * 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.LinkedList;
+import java.util.List;
+import java.util.regex.Pattern;
+
+public class M2cProtocolDecoder extends BaseProtocolDecoder {
+
+    public M2cProtocolDecoder(M2cProtocol protocol) {
+        super(protocol);
+    }
+
+    private static final Pattern PATTERN = new PatternBuilder()
+            .text("#M2C,")
+            .expression("[^,]+,")                // model
+            .expression("[^,]+,")                // firmware
+            .number("d+,")                       // protocol
+            .number("(d+),")                     // imei
+            .number("(d+),")                     // index
+            .expression("([LH]),")               // archive
+            .number("d+,")                       // priority
+            .number("(d+),")                     // event
+            .number("(dd)(dd)(dd),")             // date (yymmdd)
+            .number("(dd)(dd)(dd),")             // time (hhmmss)
+            .number("(-?d+.d+),")                // latitude
+            .number("(-?d+.d+),")                // longitude
+            .number("(-?d+),")                   // altitude
+            .number("(d+),")                     // course
+            .number("(d+.d+),")                  // speed
+            .number("(d+),")                     // satellites
+            .number("(d+),")                     // odometer
+            .number("(d+),")                     // input
+            .number("(d+),")                     // output
+            .number("(d+),")                     // power
+            .number("(d+),")                     // battery
+            .number("(d+),")                     // adc 1
+            .number("(d+),")                     // adc 2
+            .number("(d+.?d*),")                 // temperature
+            .any()
+            .compile();
+
+    private Position decodePosition(Channel channel, SocketAddress remoteAddress, String line) {
+
+        Parser parser = new Parser(PATTERN, line);
+        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_INDEX, parser.nextInt());
+
+        if (parser.next().equals("H")) {
+            position.set(Position.KEY_ARCHIVE, true);
+        }
+
+        position.set(Position.KEY_EVENT, parser.nextInt());
+
+        position.setValid(true);
+        position.setTime(parser.nextDateTime());
+        position.setLatitude(parser.nextDouble());
+        position.setLongitude(parser.nextDouble());
+        position.setAltitude(parser.nextInt());
+        position.setCourse(parser.nextInt());
+        position.setSpeed(UnitsConverter.knotsFromKph(parser.nextDouble()));
+
+        position.set(Position.KEY_SATELLITES, parser.nextInt());
+        position.set(Position.KEY_ODOMETER, parser.nextLong());
+        position.set(Position.KEY_INPUT, parser.nextInt());
+        position.set(Position.KEY_OUTPUT, parser.nextInt());
+        position.set(Position.KEY_POWER, parser.nextInt() * 0.001);
+        position.set(Position.KEY_BATTERY, parser.nextInt() * 0.001);
+        position.set(Position.PREFIX_ADC + 1, parser.nextInt());
+        position.set(Position.PREFIX_ADC + 2, parser.nextInt());
+        position.set(Position.PREFIX_TEMP + 1, parser.nextDouble());
+
+        return position;
+    }
+
+    @Override
+    protected Object decode(
+            Channel channel, SocketAddress remoteAddress, Object msg) throws Exception {
+
+        String sentence = (String) msg;
+        sentence = sentence.substring(1); // remove start symbol
+
+        List<Position> positions = new LinkedList<>();
+        for (String line : sentence.split("\r\n")) {
+            if (!line.isEmpty()) {
+                Position position = decodePosition(channel, remoteAddress, line);
+                if (position != null) {
+                    positions.add(position);
+                }
+            }
+        }
+
+        return positions;
+    }
+
+}

test/org/traccar/protocol/M2cProtocolDecoderTest.java

@@ -0,0 +1,27 @@
+package org.traccar.protocol;
+
+import org.junit.Test;
+import org.traccar.ProtocolTest;
+
+public class M2cProtocolDecoderTest extends ProtocolTest {
+
+    @Test
+    public void testDecode() throws Exception {
+
+        M2cProtocolDecoder decoder = new M2cProtocolDecoder(new M2cProtocol());
+
+        verifyPositions(decoder, text(
+                "[#M2C,2020,P1.B1.H3.F9.R1,102,864547034433966,1,L,0,20,171221,062016,28.647552,77.192841,0,0,0.0,0,0,64,255,11983,0,0,0,0.0,0,0,0,404,4,1F6,4D77,31,0*7524\r\n",
+                "#M2C,2020,P1.B1.H3.F9.R1,102,864547034433966,2,L,0,20,171221,062019,28.647552,77.192841,0,0,0.0,0,0,64,255,11983,0,0,0,0.0,0,0,0,404,4,1F6,4D77,31,0*7528\r\n",
+                "#M2C,2020,P1.B1.H3.F9.R1,102,864547034433966,3,L,0,20,171221,062024,28.647552,77.192841,0,0,0.0,0,0,64,255,16292,0,0,0,0.0,0,0,0,404,4,1F6,4D77,31,0*7523\r\n"));
+
+        verifyPositions(decoder, text(
+                "[#M2C,2020,P1.B1.H1.F1.R1,101,862462038980016,2,L,1,100,170704,074933,28.647556,77.192940,900,194,0.0,0,0,0,255,11942,0,0,0,0,0,0,0,0,30068,5051,0,0,1*8159\r\n"));
+
+        verifyPositions(decoder, text(
+                "[#M2C,2020,P1.B1.H1.F1.R1,101,862462038980016,7,L,0,31,170704,075905,28.647615,77.192970,300,260,0.0,6,7,3,255,11967,0,12,0,0,0,0,0,0,19500,5051,0,27,1*8234\r\n",
+                "#M2C,2020,P1.B1.H1.F1.R1,101,862462038980016,8,L,0,33,170704,075905,28.647615,77.192970,300,260,0.0,6,7,0,255,11942,0,12,0,0,0,0,0,0,20300,5051,0,27,1*8217\r\n"));
+
+    }
+
+}