aboutsummaryrefslogtreecommitdiff
path: root/src/org/traccar/protocol/Avl08ProtocolDecoder.java
blob: a01771c3523269e435f588be793a964f6fc3d0f1 (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
/*
 * Copyright 2012 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.util.Calendar;
import java.util.TimeZone;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.jboss.netty.channel.Channel;
import org.jboss.netty.channel.ChannelHandlerContext;
import org.traccar.GenericProtocolDecoder;
import org.traccar.helper.Log;
import org.traccar.model.DataManager;
import org.traccar.model.Position;

/**
 * AVL-08 tracker protocol decoder
 */
public class Avl08ProtocolDecoder extends GenericProtocolDecoder {

    /**
     * Initialize
     */
    public Avl08ProtocolDecoder(DataManager dataManager) {
        super(dataManager);
    }

    /**
     * Regular expressions pattern
     */
    static private Pattern pattern = Pattern.compile(
            "\\$\\$.{2}" +               // Length
            "(\\d{15})\\|" +             // IMEI
            "(.{2})" +                   // Alarm Type
            "\\$GPRMC," +
            "(\\d{2})(\\d{2})(\\d{2}).(\\d{3})," + // Time (HHMMSS.SSS)
            "([AV])," +                  // Validity
            "(\\d{2})(\\d{2}.\\d{4})," + // Latitude (DDMM.MMMM)
            "([NS])," +
            "(\\d{3})(\\d{2}.\\d{4})," + // Longitude (DDDMM.MMMM)
            "([EW])," +
            "(\\d+.\\d{2})?," +          // Speed
            "(\\d+.\\d{2})?," +          // Course
            "(\\d{2})(\\d{2})(\\d{2}),[^\\|]*\\|" + // Date (DDMMYY)
            "(\\d+.\\d)\\|(\\d+.\\d)\\|(\\d+.\\d)\\|" + // Dilution of precision
            "(\\d{12})\\|" +             // Status
            "(\\d{14})\\|" +             // Clock
            "(\\d{8})\\|" +              // Voltage
            "(\\d{8})\\|" +              // ADC
            "(.{8})\\|" +                // Cell
            "(.\\d{3})\\|" +             // Temperature
            "(\\d+.\\d{4})\\|" +         // Mileage
            "(\\d{4})\\|" +              // Serial
            "(.{10})?\\|?" +             // RFID
            ".+"); // TODO: Use non-capturing group

    /**
     * Decode message
     */
    protected Object decode(
            ChannelHandlerContext ctx, Channel channel, Object msg)
            throws Exception {

        // Parse message
        String sentence = (String) msg;
        Matcher parser = pattern.matcher(sentence);
        if (!parser.matches()) {
            return null;
        }

        // Create new position
        Position position = new Position();
        StringBuilder extendedInfo = new StringBuilder("<protocol>avl08</protocol>");

        Integer index = 1;

        // Get device by IMEI
        String imei = parser.group(index++);
        try {
            position.setDeviceId(getDataManager().getDeviceByImei(imei).getId());
        } catch(Exception error) {
            Log.warning("Unknown device - " + imei);
            return null;
        }

        // Alarm type
        extendedInfo.append("<alarm>");
        extendedInfo.append(parser.group(index++));
        extendedInfo.append("</alarm>");

        // Time
        Calendar time = Calendar.getInstance(TimeZone.getTimeZone("UTC"));
        time.clear();
        time.set(Calendar.HOUR, Integer.valueOf(parser.group(index++)));
        time.set(Calendar.MINUTE, Integer.valueOf(parser.group(index++)));
        time.set(Calendar.SECOND, Integer.valueOf(parser.group(index++)));
        time.set(Calendar.MILLISECOND, Integer.valueOf(parser.group(index++)));

        // Validity
        position.setValid(parser.group(index++).compareTo("A") == 0 ? true : false);

        // Latitude
        Double latitude = Double.valueOf(parser.group(index++));
        latitude += Double.valueOf(parser.group(index++)) / 60;
        if (parser.group(index++).compareTo("S") == 0) latitude = -latitude;
        position.setLatitude(latitude);

        // Longitude
        Double lonlitude = Double.valueOf(parser.group(index++));
        lonlitude += Double.valueOf(parser.group(index++)) / 60;
        if (parser.group(index++).compareTo("W") == 0) lonlitude = -lonlitude;
        position.setLongitude(lonlitude);

        // Altitude
        position.setAltitude(0.0);

        // Speed
        position.setSpeed(Double.valueOf(parser.group(index++)));

        // Course
        String course = parser.group(index++);
        if (course != null) {
            position.setCourse(Double.valueOf(course));
        } else {
            position.setCourse(0.0);
        }

        // Date
        time.set(Calendar.DAY_OF_MONTH, Integer.valueOf(parser.group(index++)));
        time.set(Calendar.MONTH, Integer.valueOf(parser.group(index++)) - 1);
        time.set(Calendar.YEAR, 2000 + Integer.valueOf(parser.group(index++)));
        position.setTime(time.getTime());

        // Dilution of precision
        extendedInfo.append("<pdop>");
        extendedInfo.append(parser.group(index++).replaceFirst ("^0*(?![\\.$])", ""));
        extendedInfo.append("</pdop>");
        extendedInfo.append("<hdop>");
        extendedInfo.append(parser.group(index++).replaceFirst ("^0*(?![\\.$])", ""));
        extendedInfo.append("</hdop>");
        extendedInfo.append("<vdop>");
        extendedInfo.append(parser.group(index++).replaceFirst ("^0*(?![\\.$])", ""));
        extendedInfo.append("</vdop>");

        // Status
        extendedInfo.append("<status>");
        extendedInfo.append(parser.group(index++));
        extendedInfo.append("</status>");

        // Real time clock
        extendedInfo.append("<clock>");
        extendedInfo.append(parser.group(index++));
        extendedInfo.append("</clock>");

        // Voltage
        String voltage = parser.group(index++);
        position.setPower(Double.valueOf(voltage.substring(1, 4)) / 100);
        extendedInfo.append("<voltage>");
        extendedInfo.append(voltage);
        extendedInfo.append("</voltage>");

        // ADC
        extendedInfo.append("<adc>");
        extendedInfo.append(parser.group(index++));
        extendedInfo.append("</adc>");

        // Cell
        extendedInfo.append("<cell>");
        extendedInfo.append(parser.group(index++));
        extendedInfo.append("</cell>");

        // Temperature
        extendedInfo.append("<temperature>");
        extendedInfo.append(parser.group(index++));
        extendedInfo.append("</temperature>");

        // Mileage
        extendedInfo.append("<mileage>");
        extendedInfo.append(parser.group(index++));
        extendedInfo.append("</mileage>");

        // Serial
        extendedInfo.append("<serial>");
        extendedInfo.append(parser.group(index++).replaceFirst ("^0*", ""));
        extendedInfo.append("</serial>");

        // RFID
        String rfid = parser.group(index++);
        if (rfid != null) {
            extendedInfo.append("<rfid>");
            extendedInfo.append(rfid);
            extendedInfo.append("</rfid>");
        }

        // Extended info
        position.setExtendedInfo(extendedInfo.toString());

        return position;
    }

}