aboutsummaryrefslogtreecommitdiff
path: root/src/org/traccar/protocol/AplicomProtocolDecoder.java
blob: 102c7e90d303a2f466af43bc49b5092a677f9858 (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
/*
 * Copyright 2013 - 2015 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.ArrayList;
import java.util.Date;

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.Context;
import org.traccar.helper.ChannelBufferTools;
import org.traccar.helper.UnitsConverter;
import org.traccar.model.Event;
import org.traccar.model.Position;

public class AplicomProtocolDecoder extends BaseProtocolDecoder {

    public AplicomProtocolDecoder(String protocol) {
        super(protocol);
    }

    private static final long IMEI_BASE_TC65_V20 = 0x1437207000000L;
    private static final long IMEI_BASE_TC65_V28 = 358244010000000L;
    private static final long IMEI_BASE_TC65I_V11 = 0x14143B4000000L;

    private static long imeiFromUnitId(long unitId) {
        if(unitId == 0) {
            return 0L;
        } else if(unitId < 0x1000000) {
            // Assume TC65i.
            long imei = IMEI_BASE_TC65I_V11 + unitId;
            if(validateImei(imei)) {
                return imei;
            }
            
            // No? Maybe it's TC65 v2.8?
            imei = IMEI_BASE_TC65_V28 + ((unitId + 0xA8180) & 0xFFFFFF);
            if(validateImei(imei)) {
                return imei;
            }
            
            // Still no match? How about TC65 v2.0?
            imei = IMEI_BASE_TC65_V20 + unitId;
            if(validateImei(imei)) {
                return imei;
            }
        } else {
            // Unit ID is full IMEI, just check it.
            if(validateImei(unitId)) {
                return unitId;
            }
        }
        
        return unitId;
    }
    
    private static boolean validateImei(long imei2) {

        int checksum = 0;
        long remain = imei2;

        // Iterate through all meaningful digits.
        for (int i = 0; remain != 0; i++) {
            // Extract the rightmost digit, that is, compute
            // imei modulo 10 (or remainder of imei / 10).
            int digit = (int) (remain % 10);

            // For each even-positioned digit, calculate the value
            // to be added to sum: Double the digit and then sum up
            // the digits of the result.
            // Example: 7 -> 2*7 = 14 -> 1 + 4 = 5
            if (0 != (i % 2)) {
                digit = digit * 2;
                if (digit >= 10) {
                    digit = digit - 9;
                }
            }
            checksum = checksum + digit;

            // Remove the rightmost digit as it's already processed.
            remain = remain / 10;
        }

        // The IMEI is valid if the calculated checksum is dividable by 10.
        return 0 == (checksum % 10);
    }
    
    private static final int DEFAULT_SELECTOR = 0x0002FC;

    private static final int EVENT_DATA = 119;

    @Override
    protected Object decode(
            ChannelHandlerContext ctx, Channel channel, Object msg)
            throws Exception {

        ChannelBuffer buf = (ChannelBuffer) msg;

        buf.readUnsignedByte(); // marker
        int version = buf.readUnsignedByte();
        if ((version & 0x80) != 0) {
            buf.skipBytes(4); // unit id high
        }

        String imei = String.valueOf(imeiFromUnitId(buf.readUnsignedMedium()));

        buf.readUnsignedShort(); // length

        // Selector
        int selector = DEFAULT_SELECTOR; // default selector
        if ((version & 0x40) != 0) {
            selector = buf.readUnsignedMedium();
        }

        // Create new position
        Position position = new Position();
        position.setProtocol(getProtocol());
        if (!identify(imei)) {
            return null;
        }

        position.setDeviceId(getDeviceId());

        // Event
        int event = buf.readUnsignedByte();
        position.set(Event.KEY_EVENT, event);
        buf.readUnsignedByte();

        // Validity
        if ((selector & 0x0008) != 0) {
            position.setValid((buf.readUnsignedByte() & 0x40) != 0);
        } else {
            return null; // no location data
        }

        // Time
        if ((selector & 0x0004) != 0) {
            buf.skipBytes(4); // snapshot time
        }

        // Location
        if ((selector & 0x0008) != 0) {
            position.setTime(new Date(buf.readUnsignedInt() * 1000));
            position.setLatitude(buf.readInt() / 1000000.0);
            position.setLongitude(buf.readInt() / 1000000.0);
            position.set(Event.KEY_SATELLITES, buf.readUnsignedByte());
        }

        // Speed and heading
        if ((selector & 0x0010) != 0) {
            position.setSpeed(UnitsConverter.knotsFromKph(buf.readUnsignedByte()));
            buf.readUnsignedByte(); // maximum speed
            position.setCourse(buf.readUnsignedByte() * 2.0);
        }

        // Input
        if ((selector & 0x0040) != 0) {
            position.set(Event.KEY_INPUT, buf.readUnsignedByte());
        }
        
        // ADC
        if ((selector & 0x0020) != 0) {
            position.set(Event.PREFIX_ADC + 1, buf.readUnsignedShort());
            position.set(Event.PREFIX_ADC + 2, buf.readUnsignedShort());
            position.set(Event.PREFIX_ADC + 3, buf.readUnsignedShort());
            position.set(Event.PREFIX_ADC + 4, buf.readUnsignedShort());
        }

        // Power
        if ((selector & 0x8000) != 0) {
            position.set(Event.KEY_POWER, buf.readUnsignedShort() / 1000.0);
            position.set(Event.KEY_BATTERY, buf.readUnsignedShort());
        }
        
        // Pulse rate 1
        if ((selector & 0x10000) != 0) {
            buf.readUnsignedShort();
            buf.readUnsignedInt();
        }
        
        // Pulse rate 2
        if ((selector & 0x20000) != 0) {
            buf.readUnsignedShort();
            buf.readUnsignedInt();
        }

        // Trip 1
        if ((selector & 0x0080) != 0) {
            position.set("trip1", buf.readUnsignedInt());
        }

        // Trip 2
        if ((selector & 0x0100) != 0) {
            position.set("trip2", buf.readUnsignedInt());
        }

        // Output
        if ((selector & 0x0040) != 0) {
            position.set(Event.KEY_OUTPUT, buf.readUnsignedByte());
        }
        
        // Button
        if ((selector & 0x0200) != 0) {
            buf.skipBytes(6);
        }
        
        // Keypad
        if ((selector & 0x0400) != 0) {
            buf.readUnsignedByte();
        }
        
        // Altitude
        if ((selector & 0x0800) != 0) {
            position.setAltitude(buf.readShort());
        }

        // Snapshot counter
        if ((selector & 0x2000) != 0) {
            buf.readUnsignedShort();
        }

        // State flags
        if ((selector & 0x4000) != 0) {
            buf.skipBytes(8);
        }

        // Event specific data
        if ((selector & 0x1000) != 0) {
            switch (event) {
                case 2:
                case 40:
                    buf.readUnsignedByte();
                    break;
                case 9:
                    buf.readUnsignedMedium();
                    break;
                case 31:
                case 32:
                    buf.readUnsignedShort();
                    break;
                case 38:
                    buf.skipBytes(4 * 9);
                    break;
                case 113:
                    buf.readUnsignedInt();
                    buf.readUnsignedByte();
                    break;
                case 121:
                case 142:
                    buf.readLong();
                    break;
                case 130:
                    buf.readUnsignedInt(); // incorrect
                    break;
            }
        }

        // CAN data
        if (buf.readable() && (selector & 0x1000) != 0 && event == EVENT_DATA &&
            Boolean.parseBoolean(Context.getProps().getProperty(getProtocol() + ".can"))) {

            buf.readUnsignedMedium(); // packet identifier
            buf.readUnsignedByte(); // version
            int count = buf.readUnsignedByte();
            buf.readUnsignedByte(); // batch count
            buf.readUnsignedShort(); // selector bit
            buf.readUnsignedInt(); // timestamp

            buf.skipBytes(8);

            ArrayList<ChannelBuffer> values = new ArrayList<ChannelBuffer>(count);

            for (int i = 0; i < count; i++) {
                values.add(buf.readBytes(8));
            }

            for (int i = 0; i < count; i++) {
                ChannelBuffer value = values.get(i);
                switch (buf.readInt()) {
                    case 0x40C:
                        position.set("suction-temperature1", ChannelBuffers.swapShort(value.readShort()) * 0.1);
                        position.set("suction-temperature2", ChannelBuffers.swapShort(value.readShort()) * 0.1);
                        position.set("suction-temperature3", ChannelBuffers.swapShort(value.readShort()) * 0.1);
                        position.set("evaporator-fan", ChannelBuffers.swapShort(value.readShort()));
                        break;
                    case 0x50C:
                        position.set("evaporator-temperature1", ChannelBuffers.swapShort(value.readShort()) * 0.1);
                        position.set("evaporator-temperature2", ChannelBuffers.swapShort(value.readShort()) * 0.1);
                        position.set("evaporator-temperature3", ChannelBuffers.swapShort(value.readShort()) * 0.1);
                        break;
                    case 0x20D:
                        position.set("diesel-rpm", ChannelBuffers.swapShort(value.readShort()));
                        position.set("diesel-temperature", ChannelBuffers.swapShort(value.readShort()) * 0.1);
                        position.set(Event.KEY_BATTERY, ChannelBuffers.swapShort(value.readShort()) * 0.01);
                        position.set("air-temperature", ChannelBuffers.swapShort(value.readShort()) * 0.1);
                        break;
                    case 0x30D:
                        position.set(Event.KEY_ALARM, ChannelBufferTools.readHexString(value, 16));
                        break;
                    case 0x40D:
                        position.set("cold-unit-status", ChannelBufferTools.readHexString(value, 16));
                        break;
                    case 0x50D:
                        position.set("coolant-pressure", ChannelBuffers.swapShort(value.readShort()) * 0.1);
                        position.set("suction-pressure", ChannelBuffers.swapShort(value.readShort()) * 0.1);
                        break;
                }
            }
        }

        return position;
    }

}