aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/org/traccar/protocol/G1rusProtocolDecoder.java
blob: 24bd69d45ea57daffb23eaa2a3b8dfc263d09a14 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
package org.traccar.protocol;

import com.google.common.primitives.Ints;
import com.google.common.primitives.Longs;
import com.google.common.primitives.Shorts;
import io.netty.buffer.ByteBuf;
import io.netty.channel.Channel;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.traccar.BaseProtocolDecoder;
import org.traccar.Protocol;
import org.traccar.model.Position;
import org.traccar.session.ConnectionManager;
import org.traccar.session.DeviceSession;

import java.net.SocketAddress;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.LinkedList;
import java.util.List;

public class G1rusProtocolDecoder extends BaseProtocolDecoder {
    public G1rusProtocolDecoder(Protocol protocol) {
        super(protocol);
    }

    private static final Logger LOGGER = LoggerFactory.getLogger(ConnectionManager.class);

    /* Constants */
    private static final int G1RUS_HEAD_TAIL = 0xF8;

    private static final int G1RUS_TYPE_HEARTBEAT = 0;

    private static final int G1RUS_TYPE_BCD_MASK = 0b00111111;
    private static final int G1RUS_TYPE_REGULAR = 1;
    private static final int G1RUS_TYPE_SMS_FORWARD = 2;
    private static final int G1RUS_TYPE_SERIAL_PASS_THROUGH = 3;
    private static final int G1RUS_TYPE_MIXED = 4;

    private static final int G1RUS_TYPE_EVENT_MASK = 0b01000000;
    private static final int G1RUS_TYPE_NON_EVENT = 0;
    private static final int G1RUS_TYPE_EVENT = 1;

    private static final int G1RUS_TYPE_IMEI_MASK = 0b10000000;
    private static final int G1RUS_TYPE_IMEI_LONG = 0;
    private static final int G1RUS_TYPE_IMEI_SHORT = 1;

    private static final int G1RUS_DATA_SYS_MASK = 0b00000001;
    private static final int G1RUS_DATA_GPS_MASK = 0b00000010;
    private static final int G1RUS_DATA_GSM_MASK = 0b00000100;
    private static final int G1RUS_DATA_COT_MASK = 0b00001000;
    private static final int G1RUS_DATA_ADC_MASK = 0b00010000;
    private static final int G1RUS_DATA_DTT_MASK = 0b00100000;
    /* Reserved */
    private static final int G1RUS_DATA_ETD_MASK = 0b10000000;

    private static final int G1RUS_GPS_SIGN_MASK = 0b00000001;
    private static final int G1RUS_GPS_POS_MASK  = 0b00000010;
    private static final int G1RUS_GPS_SPD_MASK  = 0b00000100;
    private static final int G1RUS_GPS_AZTH_MASK = 0b00001000;
    private static final int G1RUS_GPS_ALT_MASK  = 0b00010000;
    private static final int G1RUS_GPS_HDOP_MASK = 0b00100000;
    private static final int G1RUS_GPS_VDOP_MASK = 0b01000000;
    private static final int G1RUS_GPS_STAT_MASK = 0b10000000;

    private static final int G1RUS_ADC_DATA_MASK = 0b0000111111111111;

    private static final int G1RUS_ESCAPE_CHAR = 0x1B;


    private short readUnsignedByteUnescaped(ByteBuf buf) {
        short first = buf.readUnsignedByte();
        if (first != G1RUS_ESCAPE_CHAR) {
            return first;
        } else { /* first == 0x1B */
            byte second = (byte) buf.readUnsignedByte();
            if (second == 0x00) {
                return first;
            } else { /* second == 0xE3 */
                return (short) 0xF8;
            }
        }
    }


    private void skipBytesUnescaped(ByteBuf buf, int howMany) {
        for (int i = 0; i < howMany; ++i) {
            readUnsignedByteUnescaped(buf);
        }
    }


    private void readBytesUnescaped(ByteBuf buf, byte[] to) {
        for (int i = 0; i < to.length; ++i) {
            to[i] = (byte) readUnsignedByteUnescaped(buf);
        }
    }

    private void readBytesUnescaped(ByteBuf buf, byte[] to, int dstIndex, int length) {
        for (int i = dstIndex; i < length; ++i) {
            to[i] = (byte) readUnsignedByteUnescaped(buf);
        }
    }


    private int readUnsignedShortUnescaped(ByteBuf buf) {
        byte[] shortBuf = new byte[2];
        readBytesUnescaped(buf, shortBuf);
        return Shorts.fromByteArray(shortBuf);
    }


    private int readIntUnescaped(ByteBuf buf) {
        byte[] intBuf = new byte[4];
        readBytesUnescaped(buf, intBuf);
        return Ints.fromByteArray(intBuf);
    }


    private void decodeSYSSub(ByteBuf buf) {
        LOGGER.info("<SYS>");

        skipBytesUnescaped(buf, 1); /* Total length */

        /* NOTE: assuming order:
         * Device name -> Firmware version -> Hardware version.
         * TODO: actually check it.
         */

        /* Device name */
        short devNameLen = readUnsignedByteUnescaped(buf);
        byte[] devName = new byte[devNameLen & 0xF];
        readBytesUnescaped(buf, devName);
        String devNameString = new String(devName);
        LOGGER.info("Device name: " + devNameString);

        /* Firmware version */
        short firmwareLen = readUnsignedByteUnescaped(buf);
        byte[] firmware = new byte[firmwareLen & 0xF];
        readBytesUnescaped(buf, firmware);
        String firmwareString = new String(firmware);
        LOGGER.info("Firmware version: " + firmwareString);

        /* Hardware version */
        short hardwareLen = readUnsignedByteUnescaped(buf);
        byte[] hardware = new byte[hardwareLen & 0xF];
        readBytesUnescaped(buf, hardware);
        String hardwareString = new String(hardware);
        LOGGER.info("Hardware version: " + hardwareString);

        LOGGER.info("</SYS>");
    }


    private void decodeGPSSub(ByteBuf buf, Position position) {
        LOGGER.info("<GPS>");

        skipBytesUnescaped(buf, 1); /* Total length */

        int subMask = readUnsignedShortUnescaped(buf);
        if ((subMask & G1RUS_GPS_SIGN_MASK) == G1RUS_GPS_SIGN_MASK) {
            skipBytesUnescaped(buf, 1);
        }
        if ((subMask & G1RUS_GPS_POS_MASK) == G1RUS_GPS_POS_MASK) {
            byte[] pos_buf = new byte[4];
            readBytesUnescaped(buf, pos_buf);
            position.setLatitude((float) Ints.fromByteArray(pos_buf) / 1000000);
            LOGGER.info("Latitude: " + position.getLatitude());

            readBytesUnescaped(buf, pos_buf);
            position.setLongitude((float) Ints.fromByteArray(pos_buf) / 1000000);
            LOGGER.info("Longitude: " + position.getLongitude());
        }
        if ((subMask & G1RUS_GPS_SPD_MASK) == G1RUS_GPS_SPD_MASK) {
            position.setSpeed(readUnsignedShortUnescaped(buf));
            LOGGER.info("Speed: " + position.getSpeed());
        }
        if ((subMask & G1RUS_GPS_AZTH_MASK) == G1RUS_GPS_AZTH_MASK) {
            position.setCourse(readUnsignedShortUnescaped(buf));
            LOGGER.info("Course: " + position.getCourse());
        }
        if ((subMask & G1RUS_GPS_ALT_MASK) == G1RUS_GPS_ALT_MASK) {
            position.setAltitude(readUnsignedShortUnescaped(buf));
            LOGGER.info("Altitude: " + position.getAltitude());
        }
        if ((subMask & G1RUS_GPS_HDOP_MASK) == G1RUS_GPS_HDOP_MASK) {
            skipBytesUnescaped(buf, 2);
        }
        if ((subMask & G1RUS_GPS_VDOP_MASK) == G1RUS_GPS_VDOP_MASK) {
            skipBytesUnescaped(buf, 2);
        }

        LOGGER.info("</GPS>");
    }


    private int getADValue(int rawValue) {
        final int AD_MIN = -10;
        final int AD_MAX = 100;

        return rawValue * (AD_MAX - AD_MIN) / 4096 + AD_MIN;
    }


    private void decodeADCSub(ByteBuf buf, Position position) {
        LOGGER.info("<ADC>");

        skipBytesUnescaped(buf, 1);

        /* NOTE: assuming order:
         * External battery voltage -> Backup battery voltage -> Device temperature voltage.
         * TODO: actually check this.
         */

        int externalVoltage = readUnsignedShortUnescaped(buf) & G1RUS_ADC_DATA_MASK;
        LOGGER.info("External voltage: " + getADValue(externalVoltage) + "V [" + externalVoltage + "]");

        int backupVoltage = readUnsignedShortUnescaped(buf) & G1RUS_ADC_DATA_MASK;
        LOGGER.info("Backup voltage: " + getADValue(backupVoltage) + "V [" + backupVoltage + "]");
        position.set(Position.KEY_BATTERY, getADValue(backupVoltage));

        int temperature = readUnsignedShortUnescaped(buf) & G1RUS_ADC_DATA_MASK;
        LOGGER.info("Device temperature: " + getADValue(temperature) + "°C [" + temperature + "]");
        position.set(Position.KEY_DEVICE_TEMP, getADValue(temperature));

        LOGGER.info("</ADC>");
    }


    private Position decodeRegular(Channel channel, SocketAddress remoteAddress, ByteBuf buf, long imei, short packetType) {
        int timestamp_ = readIntUnescaped(buf);
        long timestamp = (946684800 + timestamp_) * 1000L; /* Convert received time to proper UNIX timestamp */
        LOGGER.info("Date and time: " + new SimpleDateFormat("yyyy.MM.dd HH:mm:ss").format(new Date(timestamp)));

        if ((packetType & G1RUS_TYPE_EVENT_MASK) != G1RUS_TYPE_NON_EVENT) {
            skipBytesUnescaped(buf, 1); /* Event ID */
        }

        DeviceSession deviceSession = null;
        Position position = null;

        int dataUploadingMask = readUnsignedShortUnescaped(buf);
        if ((dataUploadingMask & G1RUS_DATA_SYS_MASK) == G1RUS_DATA_SYS_MASK) {
            decodeSYSSub(buf);
        }
        if ((dataUploadingMask & G1RUS_DATA_GPS_MASK) == G1RUS_DATA_GPS_MASK) {
            deviceSession = getDeviceSession(channel, remoteAddress, String.valueOf(imei));
            if (deviceSession == null) {
                return null;
            }
            position = new Position(getProtocolName());
            position.setDeviceId(deviceSession.getDeviceId());
            position.setTime(new Date(timestamp));

            decodeGPSSub(buf, position);
        }
        if ((dataUploadingMask & G1RUS_DATA_GSM_MASK) == G1RUS_DATA_GSM_MASK) {
            skipBytesUnescaped(buf, readUnsignedByteUnescaped(buf));
        }
        if ((dataUploadingMask & G1RUS_DATA_COT_MASK) == G1RUS_DATA_COT_MASK) {
            skipBytesUnescaped(buf, readUnsignedByteUnescaped(buf));
        }
        if ((dataUploadingMask & G1RUS_DATA_ADC_MASK) == G1RUS_DATA_ADC_MASK) {
            if (deviceSession == null) {
                skipBytesUnescaped(buf, readUnsignedByteUnescaped(buf));
            } else {
                decodeADCSub(buf, position);
            }
        }
        if ((dataUploadingMask & G1RUS_DATA_DTT_MASK) == G1RUS_DATA_DTT_MASK) {
            skipBytesUnescaped(buf, readUnsignedByteUnescaped(buf));
        }
        if ((dataUploadingMask & G1RUS_DATA_ETD_MASK) == G1RUS_DATA_ETD_MASK) {
            skipBytesUnescaped(buf, readUnsignedByteUnescaped(buf));
        }

        return position;
    }


    private Object decodeSMSForward(ByteBuf buf) {
        return null;
    }


    private Object decodeSerialPassThrough(ByteBuf buf) {
        return null;
    }


    private void printPacketType(short packetType) {
        LOGGER.info("Packet type: " + (packetType == G1RUS_TYPE_HEARTBEAT ? "HEARTBEAT" :
                    "[" + ((packetType & G1RUS_TYPE_IMEI_MASK) == G1RUS_TYPE_IMEI_LONG ? "IMEI_LONG" : "IMEI_SHORT") + "]" +
                    "[" + ((packetType & G1RUS_TYPE_EVENT_MASK) == G1RUS_TYPE_NON_EVENT ? "NON-EVENT" : "EVENT") + "]" +
                    "[" + ((packetType & G1RUS_TYPE_BCD_MASK) == G1RUS_TYPE_REGULAR ? "REGULAR" : (packetType & G1RUS_TYPE_BCD_MASK) == G1RUS_TYPE_SMS_FORWARD ? "SMS FORWARD" : (packetType & G1RUS_TYPE_BCD_MASK) == G1RUS_TYPE_SERIAL_PASS_THROUGH ? "PASS THROUGH" : (packetType & G1RUS_TYPE_BCD_MASK) == G1RUS_TYPE_MIXED ? "MIXED PACKED" : "RESERVED/INVALID") + "]"));
    }


    @Override
    protected Object decode(Channel channel, SocketAddress remoteAddress, Object msg) throws Exception {
        ByteBuf buf = (ByteBuf) msg;

        if (buf.readUnsignedByte() != G1RUS_HEAD_TAIL) {
            return null;
        }

        LOGGER.info("Protocol version: " + readUnsignedByteUnescaped(buf));

        short packetType = readUnsignedByteUnescaped(buf);
        printPacketType(packetType);

        byte[] imei = new byte[8];
        readBytesUnescaped(buf, imei, 0, 7);
        long imei_long = Longs.fromByteArray(imei);
        LOGGER.info("IMEI: " + imei_long);

        List<Position> positions = null;

        if (packetType == G1RUS_TYPE_HEARTBEAT) {
            return null;
        } else if ((packetType & G1RUS_TYPE_BCD_MASK) == G1RUS_TYPE_REGULAR) {
            positions = new LinkedList<>();
            Position position = decodeRegular(channel, remoteAddress, buf, imei_long, packetType);
            if (position != null) {
                positions.add(position);
            }
        } else if ((packetType & G1RUS_TYPE_BCD_MASK) == G1RUS_TYPE_SMS_FORWARD) {
            return decodeSMSForward(buf);
        } else if ((packetType & G1RUS_TYPE_BCD_MASK) == G1RUS_TYPE_SERIAL_PASS_THROUGH) {
            return decodeSerialPassThrough(buf);
        } else if ((packetType & G1RUS_TYPE_BCD_MASK) == G1RUS_TYPE_MIXED) {
            positions = new LinkedList<>();

            while (buf.readableBytes() > 5) {
                int subPacketLength = readUnsignedShortUnescaped(buf);
                short subPacketType = readUnsignedByteUnescaped(buf);
                printPacketType(subPacketType);

                if ((subPacketType & G1RUS_TYPE_BCD_MASK) == G1RUS_TYPE_REGULAR) {
                    Position position = decodeRegular(channel, remoteAddress, buf, imei_long, subPacketType);
                    if (position != null) {
                        positions.add(position);
                    }
                } else {
                    skipBytesUnescaped(buf, subPacketLength - 1);
                }
                /* else if ((subPacketType & G1RUS_TYPE_BCD_MASK) == G1RUS_TYPE_SMS_FORWARD) {
                    skipBytesUnescaped(buf, subPacketLength - 1);
                    *//*decodeSMSForward(buf);*//*
                } else if ((subPacketType & G1RUS_TYPE_BCD_MASK) == G1RUS_TYPE_SERIAL_PASS_THROUGH) {
                    skipBytesUnescaped(buf, subPacketLength - 1);
                    *//*decodeSerialPassThrough(buf);*//*
                }*/
            }
        } else {
            LOGGER.error("Unknown packet type!");
        }

        skipBytesUnescaped(buf, 2); /* CRC */ /* TODO: actually check it */
        short tail = buf.readUnsignedByte();
        if (tail == G1RUS_HEAD_TAIL) {
            LOGGER.info("Tail: OK");
        } else {
            LOGGER.error("Tail: FAIL!");
        }

        return positions;
    }
}