aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/org/traccar/protocol/LaipacProtocolDecoder.java
blob: 13451f7988e4de1039acadf5b865e8130038915b (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
/*
 * Copyright 2013 - 2019 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.channel.Channel;
import org.traccar.BaseProtocolDecoder;
import org.traccar.Context;
import org.traccar.DeviceSession;
import org.traccar.NetworkMessage;
import org.traccar.Protocol;
import org.traccar.helper.Checksum;
import org.traccar.helper.DateBuilder;
import org.traccar.helper.Parser;
import org.traccar.helper.PatternBuilder;
import org.traccar.model.CellTower;
import org.traccar.model.Network;
import org.traccar.model.Position;

import java.net.SocketAddress;
import java.util.regex.Pattern;

public class LaipacProtocolDecoder extends BaseProtocolDecoder {

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

    public static final String DEFAULT_DEVICE_PASSWORD = "00000000";

    private static final Pattern PATTERN_EAVSYS = new PatternBuilder()
            .text("$EAVSYS,")
            .expression("([^,]+),")              // identifier
            .expression("([0-9]+),")             // iccid
            .expression("([^,]*),")              // reserved
            .expression("([^,]*),")              // reserved
            .text("0x")
            .number("(xx)")                      // product type
            .number("(dd)(dd)(dd)")              // firmware version (major, minor, revision)
            .text("*")
            .number("(xx)")                      // checksum
            .compile();

    private static final Pattern PATTERN_AVRMC = new PatternBuilder()
            .text("$AVRMC,")
            .expression("([^,]+),")              // identifier
            .number("(dd)(dd)(dd),")             // time (hhmmss)
            .expression("([AVRPavrp]),")         // validity
            .number("(dd)(dd.d+),")              // latitude
            .expression("([NS]),")               // latitude hemisphere
            .number("(ddd)(dd.d+),")             // longitude
            .number("([EW]),")                   // longitude hemisphere
            .number("(d+.d+),")                  // speed
            .number("(d+.d+),")                  // course
            .number("(dd)(dd)(dd),")             // date (ddmmyy)
            .expression("([0-9A-Za-z]),")        // event code
            .expression("([\\d.]+),")            // battery voltage
            .number("(d+),")                     // current mileage
            .number("(d),")                      // gps status
            .number("(d+),")                     // adc1
            .number("(d+)")                      // adc2
            .number(",(xxxx|x)")                 // lac | lac+cid = 0
            .number("(xxxx),")                   // cid | nothing
            .number("(ddd|d)")                   // mcc | mcc+mnc = 0
            .number("(ddd)")                     // mnc | nothing
            .optional(4)
            .expression(",([^*]*)")              // anything remaining (be forward compatible)
            .optional(1)
            .text("*")
            .number("(xx)")                      // checksum
            .compile();

    private String decodeAlarm(String event) {
        switch (event) {
            case "Z":
                return Position.ALARM_LOW_BATTERY;
            case "Y":
                return Position.ALARM_TOW;
            case "X":
                return Position.ALARM_GEOFENCE_ENTER;
            case "T":
                return Position.ALARM_TAMPERING;
            case "H":
                return Position.ALARM_POWER_OFF;
            case "8":
                return Position.ALARM_SHOCK;
            case "7":
            case "4":
                return Position.ALARM_GEOFENCE_EXIT;
            case "6":
                return Position.ALARM_OVERSPEED;
            case "5":
                return Position.ALARM_POWER_CUT;
            case "3":
                return Position.ALARM_SOS;
            default:
                return null;
        }
    }

    private String decodeEvent(String event, Position position) {

        if (event.length() == 1) {
            char inputStatus = event.charAt(0);
            if (inputStatus >= 'A' && inputStatus <= 'D') {
                int inputStatusInt = inputStatus - 'A';
                position.set(Position.PREFIX_IN + 1, inputStatusInt & 1);
                position.set(Position.PREFIX_IN + 2, inputStatusInt & 2);
                return null;
            }
        }

        return event;
    }

    private void sendEventResponse(
            String event, String devicePassword, Channel channel, SocketAddress remoteAddress) {

        String responseCode = null;

        switch (event) {
            case "3":
                responseCode = "d";
                break;
            case "S":
            case "T":
                responseCode = "t";
                break;
            case "X":
            case "4":
                responseCode = "x";
                break;
            case "Y":
                responseCode = "y";
                break;
            case "Z":
                responseCode = "z";
                break;
            default:
                break;
        }

        if (responseCode != null) {
            String response = "$AVCFG," + devicePassword + "," + responseCode;
            response += Checksum.nmea(response) + "\r\n";
            channel.writeAndFlush(new NetworkMessage(response, remoteAddress));
        }

    }

    private void sendAcknowledge(
            String status, String event, String checksum, Channel channel, SocketAddress remoteAddress) {

        if (Character.isLowerCase(status.charAt(0))) {
            String response = "$EAVACK," + event + "," + checksum;
            response += Checksum.nmea(response) + "\r\n";
            channel.writeAndFlush(new NetworkMessage(response, remoteAddress));
        }

    }

    protected Object decodeEavsys(
            String sentence, Channel channel, SocketAddress remoteAddress) {

        Parser parser = new Parser(PATTERN_EAVSYS, 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());

        if (!getLastLocation(position, null)) {
            return null;
        }

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

        String unused = parser.next();
        unused = parser.next();

        int hardware = parser.nextHexInt();
        position.set(Position.KEY_VERSION_HW,
            (hardware == 0x12) ? "SF-Lite" : (hardware == 0x52) ? "S911 Lola" : null);
        position.set(Position.KEY_VERSION_FW, String.format("%d.%02d.%02d",
            parser.nextInt(), parser.nextInt(), parser.nextInt()));

        return position;
    }

    protected Object decodeAvrmc(
            String sentence, Channel channel, SocketAddress remoteAddress) {

        Parser parser = new Parser(PATTERN_AVRMC, 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());
        DateBuilder dateBuilder = new DateBuilder()
                .setTime(parser.nextInt(0), parser.nextInt(0), parser.nextInt(0));

        String status = parser.next();
        String upperCaseStatus = status.toUpperCase();
        position.setValid(upperCaseStatus.equals("A") || upperCaseStatus.equals("R") || upperCaseStatus.equals("P"));
        position.set(Position.KEY_STATUS, status);

        position.setLatitude(parser.nextCoordinate());
        position.setLongitude(parser.nextCoordinate());
        position.setSpeed(parser.nextDouble(0));
        position.setCourse(parser.nextDouble(0));

        dateBuilder.setDateReverse(parser.nextInt(0), parser.nextInt(0), parser.nextInt(0));
        position.setTime(dateBuilder.getDate());

        String event = parser.next();
        position.set(Position.KEY_ALARM, decodeAlarm(event));
        position.set(Position.KEY_EVENT, decodeEvent(event, position));
        position.set(Position.KEY_BATTERY, Double.parseDouble(parser.next().replaceAll("\\.", "")) * 0.001);
        position.set(Position.KEY_ODOMETER, parser.nextDouble() * 1000);
        position.set(Position.KEY_GPS, parser.nextInt());
        position.set(Position.PREFIX_ADC + 1, parser.nextDouble() * 0.001);
        position.set(Position.PREFIX_ADC + 2, parser.nextDouble() * 0.001);

        Integer lac = parser.nextHexInt();
        Integer cid = parser.nextHexInt();
        Integer mcc = parser.nextInt();
        Integer mnc = parser.nextInt();
        if (lac != null && cid != null && mcc != null && mnc != null) {
            position.setNetwork(new Network(CellTower.from(mcc, mnc, lac, cid)));
        }

        String unused = parser.next();

        String checksum = parser.next();

        if (channel != null) {

            sendAcknowledge(status, event, checksum, channel, remoteAddress);

            String devicePassword = Context.getIdentityManager()
                .getDevicePassword(deviceSession.getDeviceId(), DEFAULT_DEVICE_PASSWORD);
            sendEventResponse(event, devicePassword, channel, remoteAddress);
        }

        return position;
    }

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

        String sentence = (String) msg;

        if (sentence.startsWith("$ECHK")) {
            if (channel != null) {
                channel.writeAndFlush(new NetworkMessage(sentence + "\r\n", remoteAddress));
            }
        } else if (sentence.startsWith("$EAVSYS")) {
            return decodeEavsys(sentence, channel, remoteAddress);
        } else if (sentence.startsWith("$AVRMC")) {
            return decodeAvrmc(sentence, channel, remoteAddress);
        }

        return null;
    }

}