aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/org/traccar/protocol/FifotrackProtocolDecoder.java
blob: a9d77b46e535088b2e3cc91b64e92c483520c157 (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
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
/*
 * Copyright 2016 - 2021 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.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.Channel;
import org.traccar.BaseProtocolDecoder;
import org.traccar.session.DeviceSession;
import org.traccar.NetworkMessage;
import org.traccar.Protocol;
import org.traccar.helper.BitUtil;
import org.traccar.helper.Checksum;
import org.traccar.helper.Parser;
import org.traccar.helper.PatternBuilder;
import org.traccar.helper.UnitsConverter;
import org.traccar.model.CellTower;
import org.traccar.model.Network;
import org.traccar.model.Position;
import org.traccar.model.WifiAccessPoint;

import java.net.SocketAddress;
import java.nio.charset.StandardCharsets;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;
import java.util.regex.Pattern;

public class FifotrackProtocolDecoder extends BaseProtocolDecoder {

    private ByteBuf photo;

    public FifotrackProtocolDecoder(Protocol protocol) {
        super(protocol);
    }

    private static final Pattern PATTERN = new PatternBuilder()
            .text("$$")
            .number("d+,")                       // length
            .number("(d+),")                     // imei
            .number("x+,")                       // index
            .expression("[^,]+,")                // type
            .number("(d+)?,")                    // alarm
            .number("(dd)(dd)(dd)")              // date (yymmdd)
            .number("(dd)(dd)(dd),")             // time (hhmmss)
            .number("([AV]),")                   // validity
            .number("(-?d+.d+),")                // latitude
            .number("(-?d+.d+),")                // longitude
            .number("(d+),")                     // speed
            .number("(d+),")                     // course
            .number("(-?d+),")                   // altitude
            .number("(d+),")                     // odometer
            .number("d+,")                       // runtime
            .number("(x+),")                     // status
            .number("(x+)?,")                    // input
            .number("(x+)?,")                    // output
            .number("(d+)|")                     // mcc
            .number("(d+)|")                     // mnc
            .number("(x+)|")                     // lac
            .number("(x+),")                     // cid
            .number("([x|]+)")                   // adc
            .expression(",([^,]+)")              // rfid
            .expression(",([^*]*)").optional(2)  // sensors
            .any()
            .compile();

    private static final Pattern PATTERN_NEW = new PatternBuilder()
            .text("$$")
            .number("d+,")                       // length
            .number("(d+),")                     // imei
            .number("(x+),")                     // index
            .text("A03,")                        // type
            .number("(d+)?,")                    // alarm
            .number("(dd)(dd)(dd)")              // date (yymmdd)
            .number("(dd)(dd)(dd),")             // time (hhmmss)
            .number("(d+)|")                     // mcc
            .number("(d+)|")                     // mnc
            .number("(x+)|")                     // lac
            .number("(x+),")                     // cid
            .number("(d+.d+),")                  // battery
            .number("(d+),")                     // battery level
            .number("(x+),")                     // status
            .groupBegin()
            .text("0,")                          // gps location
            .number("([AV]),")                   // validity
            .number("(d+),")                     // speed
            .number("(d+),")                     // satellites
            .number("(-?d+.d+),")                // latitude
            .number("(-?d+.d+)")                 // longitude
            .or()
            .text("1,")                          // wifi location
            .expression("([^*]+)")               // wifi
            .groupEnd()
            .text("*")
            .number("xx")                        // checksum
            .compile();

    private static final Pattern PATTERN_PHOTO = new PatternBuilder()
            .text("$$")
            .number("d+,")                       // length
            .number("(d+),")                     // imei
            .any()
            .number(",(d+),")                    // length
            .expression("([^*]+)")               // photo id
            .text("*")
            .number("xx")
            .compile();

    private static final Pattern PATTERN_PHOTO_DATA = new PatternBuilder()
            .text("$$")
            .number("d+,")                       // length
            .number("(d+),")                     // imei
            .number("x+,")                       // index
            .expression("[^,]+,")                // type
            .expression("([^,]+),")              // photo id
            .number("(d+),")                     // offset
            .number("(d+),")                     // size
            .compile();

    private static final Pattern PATTERN_RESULT = new PatternBuilder()
            .text("$$")
            .number("d+,")                       // length
            .number("(d+),")                     // imei
            .any()
            .expression(",([A-Z]+)")             // result
            .text("*")
            .number("xx")
            .compile();

    private void sendResponse(Channel channel, SocketAddress remoteAddress, String imei, String content) {
        if (channel != null) {
            int length = 1 + imei.length() + 1 + content.length();
            String response = String.format("##%02d,%s,%s*", length, imei, content);
            response += Checksum.sum(response) + "\r\n";
            channel.writeAndFlush(new NetworkMessage(response, remoteAddress));
        }
    }

    private void requestPhoto(Channel channel, SocketAddress remoteAddress, String imei, String file) {
        String content = "1,D06," + file + "," + photo.writerIndex() + "," + Math.min(1024, photo.writableBytes());
        sendResponse(channel, remoteAddress, imei, content);
    }

    private String decodeAlarm(Integer alarm) {
        if (alarm != null) {
            switch (alarm) {
                case 2:
                    return Position.ALARM_SOS;
                case 14:
                    return Position.ALARM_LOW_POWER;
                case 15:
                    return Position.ALARM_POWER_CUT;
                case 16:
                    return Position.ALARM_POWER_RESTORED;
                case 17:
                    return Position.ALARM_LOW_BATTERY;
                case 18:
                    return Position.ALARM_OVERSPEED;
                case 20:
                    return Position.ALARM_GPS_ANTENNA_CUT;
                case 21:
                    return Position.ALARM_VIBRATION;
                case 23:
                    return Position.ALARM_ACCELERATION;
                case 24:
                    return Position.ALARM_BRAKING;
                case 27:
                    return Position.ALARM_FATIGUE_DRIVING;
                case 30:
                case 32:
                    return Position.ALARM_JAMMING;
                case 33:
                    return Position.ALARM_GEOFENCE_EXIT;
                case 34:
                    return Position.ALARM_GEOFENCE_ENTER;
                case 35:
                    return Position.ALARM_IDLE;
                case 40:
                case 41:
                    return Position.ALARM_TEMPERATURE;
                default:
                    return null;
            }
        }
        return null;
    }


    private Object decodeLocationNew(
            Channel channel, SocketAddress remoteAddress, String sentence) {

        Parser parser = new Parser(PATTERN_NEW, sentence);
        if (!parser.matches()) {
            return null;
        }

        String imei = parser.next();
        DeviceSession deviceSession = getDeviceSession(channel, remoteAddress, imei);
        if (deviceSession == null) {
            return null;
        }

        String index = parser.next();

        Position position = new Position(getProtocolName());
        position.setDeviceId(deviceSession.getDeviceId());

        position.set(Position.KEY_ALARM, decodeAlarm(parser.nextInt()));

        position.setDeviceTime(parser.nextDateTime());

        Network network = new Network();
        network.addCellTower(CellTower.from(
                parser.nextInt(), parser.nextInt(), parser.nextHexInt(), parser.nextHexInt()));

        position.set(Position.KEY_BATTERY, parser.nextDouble());
        position.set(Position.KEY_BATTERY_LEVEL, parser.nextInt());
        position.set(Position.KEY_STATUS, parser.nextHexInt());

        if (parser.hasNext(5)) {

            position.setValid(parser.next().equals("A"));
            position.setFixTime(position.getDeviceTime());
            position.set(Position.KEY_SATELLITES, parser.nextInt());
            position.setSpeed(UnitsConverter.knotsFromKph(parser.nextInt()));
            position.setLatitude(parser.nextDouble());
            position.setLongitude(parser.nextDouble());

        } else {

            String[] points = parser.next().split("\\|");
            for (String point : points) {
                String[] wifi = point.split(":");
                String mac = wifi[0].replaceAll("(..)", "$1:");
                network.addWifiAccessPoint(WifiAccessPoint.from(
                        mac.substring(0, mac.length() - 1), Integer.parseInt(wifi[1])));
            }

        }

        position.setNetwork(network);

        DateFormat dateFormat = new SimpleDateFormat("yyMMddHHmmss");
        dateFormat.setTimeZone(TimeZone.getTimeZone("UTC"));
        String response = index + ",A03," + dateFormat.format(new Date());
        sendResponse(channel, remoteAddress, imei, response);

        return position;
    }

    private Object decodeLocation(
            Channel channel, SocketAddress remoteAddress, String sentence) {

        Parser parser = new Parser(PATTERN, sentence);
        if (!parser.matches()) {
            return null;
        }

        DeviceSession deviceSession = getDeviceSession(channel, remoteAddress, parser.next());
        if (deviceSession == null) {
            return null;
        }

        Position position = new Position(getProtocolName());
        position.setDeviceId(deviceSession.getDeviceId());

        position.set(Position.KEY_ALARM, decodeAlarm(parser.nextInt()));

        position.setTime(parser.nextDateTime());

        position.setValid(parser.next().equals("A"));
        position.setLatitude(parser.nextDouble());
        position.setLongitude(parser.nextDouble());
        position.setSpeed(UnitsConverter.knotsFromKph(parser.nextInt()));
        position.setCourse(parser.nextInt());
        position.setAltitude(parser.nextInt());

        position.set(Position.KEY_ODOMETER, parser.nextLong());

        long status = parser.nextHexLong();
        position.set(Position.KEY_RSSI, BitUtil.between(status, 3, 8));
        position.set(Position.KEY_SATELLITES, BitUtil.from(status, 28));
        position.set(Position.KEY_STATUS, status);

        position.set(Position.KEY_INPUT, parser.nextHexInt());
        position.set(Position.KEY_OUTPUT, parser.nextHexInt());

        position.setNetwork(new Network(CellTower.from(
                parser.nextInt(), parser.nextInt(), parser.nextHexInt(), parser.nextHexInt())));

        String[] adc = parser.next().split("\\|");
        for (int i = 0; i < adc.length; i++) {
            position.set(Position.PREFIX_ADC + (i + 1), Integer.parseInt(adc[i], 16));
        }

        if (parser.hasNext()) {
            String rfid = parser.next();
            if (rfid.matches("\\p{XDigit}+")) {
                position.set(Position.KEY_DRIVER_UNIQUE_ID, String.valueOf(Integer.parseInt(rfid, 16)));
            } else {
                position.set("driverLicense", rfid);
            }
        }

        if (parser.hasNext()) {
            String[] sensors = parser.next().split("\\|");
            for (int i = 0; i < sensors.length; i++) {
                position.set(Position.PREFIX_IO + (i + 1), sensors[i]);
            }
        }

        return position;
    }

    private Object decodeResult(
            Channel channel, SocketAddress remoteAddress, String sentence) {

        Parser parser = new Parser(PATTERN_RESULT, sentence);
        if (!parser.matches()) {
            return null;
        }

        DeviceSession deviceSession = getDeviceSession(channel, remoteAddress, parser.next());
        if (deviceSession == null) {
            return null;
        }

        Position position = new Position(getProtocolName());
        position.setDeviceId(deviceSession.getDeviceId());

        position.set(Position.KEY_RESULT, parser.next());

        return position;
    }

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

        ByteBuf buf = (ByteBuf) msg;
        int typeIndex = buf.indexOf(buf.readerIndex(), buf.writerIndex(), (byte) ',') + 1;
        typeIndex = buf.indexOf(typeIndex, buf.writerIndex(), (byte) ',') + 1;
        typeIndex = buf.indexOf(typeIndex, buf.writerIndex(), (byte) ',') + 1;
        String type = buf.toString(typeIndex, 3, StandardCharsets.US_ASCII);

        if (type.startsWith("B")) {

            return decodeResult(channel, remoteAddress, buf.toString(StandardCharsets.US_ASCII));

        } else if (type.equals("D05")) {

            String sentence = buf.toString(StandardCharsets.US_ASCII);
            Parser parser = new Parser(PATTERN_PHOTO, sentence);
            if (parser.matches()) {
                String imei = parser.next();
                int length = parser.nextInt();
                String photoId = parser.next();
                photo = Unpooled.buffer(length);
                requestPhoto(channel, remoteAddress, imei, photoId);
            }

        } else if (type.equals("D06")) {

            if (photo == null) {
                return null;
            }
            int dataIndex = buf.indexOf(typeIndex + 4, buf.writerIndex(), (byte) ',') + 1;
            dataIndex = buf.indexOf(dataIndex, buf.writerIndex(), (byte) ',') + 1;
            dataIndex = buf.indexOf(dataIndex, buf.writerIndex(), (byte) ',') + 1;
            String sentence = buf.toString(buf.readerIndex(), dataIndex, StandardCharsets.US_ASCII);
            Parser parser = new Parser(PATTERN_PHOTO_DATA, sentence);
            if (parser.matches()) {
                String imei = parser.next();
                String photoId = parser.next();
                parser.nextInt(); // offset
                parser.nextInt(); // size
                buf.readerIndex(dataIndex);
                buf.readBytes(photo, buf.readableBytes() - 3); // ignore checksum
                if (photo.isWritable()) {
                    requestPhoto(channel, remoteAddress, imei, photoId);
                } else {
                    Position position = new Position(getProtocolName());
                    position.setDeviceId(getDeviceSession(channel, remoteAddress, imei).getDeviceId());
                    getLastLocation(position, null);
                    position.set(Position.KEY_IMAGE, writeMediaFile(imei, photo, "jpg"));
                    photo.release();
                    photo = null;
                    return position;
                }
            }

        } else if (type.equals("A03")) {

            return decodeLocationNew(channel, remoteAddress, buf.toString(StandardCharsets.US_ASCII));

        } else {

            return decodeLocation(channel, remoteAddress, buf.toString(StandardCharsets.US_ASCII));

        }

        return null;
    }

}