Add Cellocator protocol

5 files changed, 282 insertions, 0 deletions

diff --git a/default.cfg b/default.cfg
index 163ded6cd..3ede240d7 100644
--- a/default.cfg
+++ b/default.cfg
@@ -193,4 +193,8 @@
     <entry key='vt300.enable'>true</entry>
     <entry key='vt300.port'>5032</entry>
 
+    <!-- Cellocator server configuration -->
+    <entry key='cellocator.enable'>true</entry>
+    <entry key='cellocator.port'>5033</entry>
+
 </properties>
diff --git a/src/org/traccar/ServerManager.java b/src/org/traccar/ServerManager.java
index bf6e7afca..39e6a8330 100644
--- a/src/org/traccar/ServerManager.java
+++ b/src/org/traccar/ServerManager.java
@@ -138,6 +138,7 @@ public class ServerManager {
         initTlt2hServer("tlt2h");
         initSyrusServer("syrus");
         initVt300Server("vt300");
+        initCellocatorServer("cellocator");
 
         // Initialize web server
         if (Boolean.valueOf(properties.getProperty("http.enable"))) {
@@ -717,4 +718,18 @@ public class ServerManager {
         }
     }
 
+    private void initCellocatorServer(String protocol) throws SQLException {
+        if (isProtocolEnabled(properties, protocol)) {
+            TrackerServer server = new TrackerServer(this, new ServerBootstrap(), protocol) {
+                @Override
+                protected void addSpecificHandlers(ChannelPipeline pipeline) {
+                    pipeline.addLast("frameDecoder", new CellocatorFrameDecoder());
+                    pipeline.addLast("objectDecoder", new CellocatorProtocolDecoder(ServerManager.this));
+                }
+            };
+            server.setEndianness(ByteOrder.LITTLE_ENDIAN);
+            serverList.add(server);
+        }
+    }
+
 }
diff --git a/src/org/traccar/protocol/CellocatorFrameDecoder.java b/src/org/traccar/protocol/CellocatorFrameDecoder.java
new file mode 100644
index 000000000..cddb33d52
--- /dev/null
+++ b/src/org/traccar/protocol/CellocatorFrameDecoder.java
@@ -0,0 +1,70 @@
+/*
+ * Copyright 2013 Anton Tananaev (anton.tananaev@gmail.com)
+ *
+ * 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 CellocatorFrameDecoder extends FrameDecoder {
+
+    private static final int MESSAGE_MINIMUM_LENGTH = 15;
+    
+    @Override
+    protected Object decode(
+            ChannelHandlerContext ctx,
+            Channel channel,
+            ChannelBuffer buf) throws Exception {
+        
+        // Check minimum length
+        int available = buf.readableBytes();
+        if (available < MESSAGE_MINIMUM_LENGTH) {
+            return null;
+        }
+
+        // Size depending on message type
+        int length = 0;
+        switch (buf.getUnsignedByte(4))
+        {
+            case CellocatorProtocolDecoder.MSG_CLIENT_STATUS:
+                length = 70;
+                break;
+            case CellocatorProtocolDecoder.MSG_CLIENT_PROGRAMMING:
+                length = 31;
+                break;
+            case CellocatorProtocolDecoder.MSG_CLIENT_SERIAL_LOG:
+                length = 70;
+                break;
+            case CellocatorProtocolDecoder.MSG_CLIENT_SERIAL:
+                if (available >= 19) {
+                    length = 19 + buf.getUnsignedShort(16);
+                }
+                break;
+            case CellocatorProtocolDecoder.MSG_CLIENT_MODULAR:
+                length = 15 + buf.getUnsignedByte(13);
+                break;
+        }
+
+        // Read packet
+        if (length > 0 && available >= length) {
+            return buf.readBytes(length + 2);
+        }
+        
+        return null;
+    }
+
+}
diff --git a/src/org/traccar/protocol/CellocatorProtocolDecoder.java b/src/org/traccar/protocol/CellocatorProtocolDecoder.java
new file mode 100644
index 000000000..aabda6f51
--- /dev/null
+++ b/src/org/traccar/protocol/CellocatorProtocolDecoder.java
@@ -0,0 +1,172 @@
+/*
+ * Copyright 2013 Anton Tananaev (anton.tananaev@gmail.com)
+ *
+ * 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 java.nio.ByteOrder;
+import java.util.Calendar;
+import java.util.TimeZone;
+import org.jboss.netty.buffer.ChannelBuffer;
+import org.jboss.netty.buffer.ChannelBuffers;
+import org.jboss.netty.channel.Channel;
+import org.jboss.netty.channel.ChannelHandlerContext;
+import org.traccar.BaseProtocolDecoder;
+import org.traccar.ServerManager;
+import org.traccar.helper.Log;
+import org.traccar.model.Position;
+
+public class CellocatorProtocolDecoder extends BaseProtocolDecoder {
+
+    public CellocatorProtocolDecoder(ServerManager serverManager) {
+        super(serverManager);
+    }
+
+    private String readImei(ChannelBuffer buf) {
+        int b = buf.readUnsignedByte();
+        StringBuilder imei = new StringBuilder();
+        imei.append(b & 0x0F);
+        for (int i = 0; i < 7; i++) {
+            b = buf.readUnsignedByte();
+            imei.append((b & 0xF0) >> 4);
+            imei.append(b & 0x0F);
+        }
+        return imei.toString();
+    }
+    
+    static final int MSG_CLIENT_STATUS = 0;
+    static final int MSG_CLIENT_PROGRAMMING = 3;
+    static final int MSG_CLIENT_SERIAL_LOG = 7;
+    static final int MSG_CLIENT_SERIAL = 8;
+    static final int MSG_CLIENT_MODULAR = 9;
+
+    private static final int MSG_SERVER_ACKNOWLEDGE = 4;
+    
+    private byte commandCount;
+    
+    private void sendReply(Channel channel, long deviceId, byte packetNumber) {
+        ChannelBuffer reply = ChannelBuffers.directBuffer(ByteOrder.LITTLE_ENDIAN, 28);
+        reply.writeByte('M');
+        reply.writeByte('C');
+        reply.writeByte('G');
+        reply.writeByte('P');
+        reply.writeByte(MSG_SERVER_ACKNOWLEDGE);
+        reply.writeInt((int) deviceId);
+        reply.writeByte(commandCount++);
+        reply.writeInt(0); // authentication code
+        reply.writeByte(0);
+        reply.writeByte(packetNumber);
+        reply.writeZero(10);
+
+        byte checksum = 0;
+        for (int i = 4; i < 27; i++) {
+            checksum += reply.getByte(i);
+        }
+        reply.writeByte(checksum);
+
+        if (channel != null) {
+            channel.write(reply);
+        }
+    }
+    
+    @Override
+    protected Object decode(
+            ChannelHandlerContext ctx, Channel channel, Object msg)
+            throws Exception {
+
+        ChannelBuffer buf = (ChannelBuffer) msg;
+
+        buf.skipBytes(4); // system code
+        int type = buf.readUnsignedByte();
+        long deviceId = buf.readUnsignedInt();
+        
+        if (type != MSG_CLIENT_SERIAL) {
+            buf.readUnsignedShort(); // communication control
+        }
+        byte packetNumber = buf.readByte();
+
+        // Send reply
+        sendReply(channel, deviceId, packetNumber);
+
+        // Parse location
+        if (type == MSG_CLIENT_STATUS) {
+            Position position = new Position();
+            StringBuilder extendedInfo = new StringBuilder("<protocol>cellocator</protocol>");
+            
+            // Device identifier
+            try {
+                position.setDeviceId(getDataManager().getDeviceByImei(String.valueOf(deviceId)).getId());
+            } catch(Exception error) {
+                Log.warning("Unknown device - " + deviceId);
+                return null;
+            }
+            
+            buf.readUnsignedByte(); // hardware version
+            buf.readUnsignedByte(); // software version
+            buf.readUnsignedByte(); // protocol version
+
+            // Status
+            extendedInfo.append("<status>");
+            extendedInfo.append(buf.getUnsignedByte(buf.readerIndex()) & 0x0f);
+            extendedInfo.append("</status>");
+            
+            int operator = (buf.readUnsignedByte() & 0xf0) << 4;
+            operator += buf.readUnsignedByte();
+            
+            buf.readUnsignedByte(); // reason data
+            buf.readUnsignedByte(); // reason
+            buf.readUnsignedByte(); // mode
+            buf.readUnsignedInt(); // IO
+            
+            operator <<= 8;
+            operator += buf.readUnsignedByte();
+            extendedInfo.append("<operator>").append(operator).append("</operator>");
+            
+            buf.readUnsignedInt(); // ADC
+            buf.readUnsignedMedium(); // milage
+            buf.skipBytes(6); // multi-purpose data
+            
+            buf.readUnsignedShort(); // gps fix
+            buf.readUnsignedByte(); // location status
+            buf.readUnsignedByte(); // mode 1
+            buf.readUnsignedByte(); // mode 2
+
+            position.setValid(buf.readUnsignedByte() >= 3); // satellites
+
+            // Location data
+            position.setLongitude(buf.readInt() / Math.PI * 180 / 100000000);
+            position.setLatitude(buf.readInt() / Math.PI * 180 / 100000000.0);
+            position.setAltitude(buf.readInt() * 0.01);
+            position.setSpeed(buf.readInt() * 0.01 * 1.943844);
+            position.setCourse(buf.readUnsignedShort() / Math.PI * 180.0 / 1000.0);
+            
+            // Time
+            Calendar time = Calendar.getInstance(TimeZone.getTimeZone("UTC"));
+            time.clear();
+            time.set(Calendar.SECOND, buf.readUnsignedByte());
+            time.set(Calendar.MINUTE, buf.readUnsignedByte());
+            time.set(Calendar.HOUR, buf.readUnsignedByte());
+            time.set(Calendar.DAY_OF_MONTH, buf.readUnsignedByte());
+            time.set(Calendar.MONTH, buf.readUnsignedByte() - 1);
+            time.set(Calendar.YEAR, buf.readUnsignedShort());
+            position.setTime(time.getTime());
+
+            position.setExtendedInfo(extendedInfo.toString());
+            return position;
+        }
+
+        return null;
+    }
+
+}
diff --git a/test/org/traccar/protocol/CellocatorProtocolDecoderTest.java b/test/org/traccar/protocol/CellocatorProtocolDecoderTest.java
new file mode 100644
index 000000000..f1128a93a
--- /dev/null
+++ b/test/org/traccar/protocol/CellocatorProtocolDecoderTest.java
@@ -0,0 +1,21 @@
+package org.traccar.protocol;
+
+import java.nio.ByteOrder;
+import org.jboss.netty.buffer.ChannelBuffers;
+import static org.junit.Assert.assertNotNull;
+import org.junit.Test;
+
+public class CellocatorProtocolDecoderTest {
+
+    @Test
+    public void testDecode() throws Exception {
+
+        CellocatorProtocolDecoder decoder = new CellocatorProtocolDecoder(null);
+        decoder.setDataManager(new TestDataManager());
+
+        byte[] buf1 = {0x4D,0x43,0x47,0x50,0x00,0x06,0x00,0x00,0x00,0x08,0x1A,0x02,0x02,0x12,0x04,0x00,0x00,0x00,0x21,0x00,0x62,0x30,0x00,0x00,0x00,0x6B,0x00,(byte)0xE1,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,(byte)0xE5,(byte)0xA1,0x00,0x04,0x02,0x06,0x61,0x4E,(byte)0xA3,0x03,0x18,0x1A,0x57,0x03,0x4E,0x12,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x15,0x25,0x07,0x14,0x03,(byte)0xD6,0x07,0x49};
+        assertNotNull(decoder.decode(null, null, ChannelBuffers.wrappedBuffer(ByteOrder.LITTLE_ENDIAN, buf1)));
+
+    }
+
+}