aboutsummaryrefslogtreecommitdiff
path: root/src/org/traccar/protocol/BlackKiteProtocolDecoder.java
blob: 4f63dbafa1d92682762f2a9ee5615f51c92cdcce (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
/*
 * Copyright 2015 Vijay Kumar (vijaykumar@zilogic.com)
 *
 * Based on GalileoProtocolDecoder.java
 * Copyright 2013 - 2014 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.net.SocketAddress;
import java.nio.ByteOrder;
import java.nio.charset.Charset;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.jboss.netty.buffer.ChannelBuffer;
import org.jboss.netty.buffer.ChannelBuffers;
import org.jboss.netty.channel.Channel;
import org.traccar.BaseProtocolDecoder;
import org.traccar.helper.Log;
import org.traccar.helper.BitUtil;
import org.traccar.model.Event;
import org.traccar.model.Position;


class DecodeError extends Exception {
    public DecodeError(String message) {
	super(message);
    }
}


public class BlackKiteProtocolDecoder extends BaseProtocolDecoder {

    public BlackKiteProtocolDecoder(BlackKiteProtocol protocol) {
        super(protocol);
    }

    private static final int TAG_IMEI = 0x03;
    private static final int TAG_DATE = 0x20;
    private static final int TAG_COORDINATES = 0x30;
    private static final int TAG_SPEED_COURSE = 0x33;
    private static final int TAG_ALTITUDE = 0x34;
    private static final int TAG_STATUS = 0x40;
    private static final int TAG_DIGITAL_OUTPUTS = 0x45;
    private static final int TAG_DIGITAL_INPUTS = 0x46;
    private static final int TAG_INPUT_VOLTAGE1 = 0x50;
    private static final int TAG_INPUT_VOLTAGE2 = 0x51;
    private static final int TAG_INPUT_VOLTAGE3 = 0x52;
    private static final int TAG_INPUT_VOLTAGE4 = 0x53;
    private static final int TAG_XT1 = 0x60;
    private static final int TAG_XT2 = 0x61;
    private static final int TAG_XT3 = 0x62;
    
    private static final Map<Integer, Integer> tagLengthMap = new HashMap<>();
    
    static {
        tagLengthMap.put(TAG_IMEI, 15);
	tagLengthMap.put(TAG_DATE, 4);
        tagLengthMap.put(TAG_COORDINATES, 9);
	tagLengthMap.put(TAG_SPEED_COURSE, 4);
	tagLengthMap.put(TAG_ALTITUDE, 2);
	tagLengthMap.put(TAG_STATUS, 2);
	tagLengthMap.put(TAG_DIGITAL_INPUTS, 2);
	tagLengthMap.put(TAG_DIGITAL_OUTPUTS, 2);
	tagLengthMap.put(TAG_INPUT_VOLTAGE1, 2);
	tagLengthMap.put(TAG_INPUT_VOLTAGE2, 2);
	tagLengthMap.put(TAG_INPUT_VOLTAGE3, 2);
	tagLengthMap.put(TAG_INPUT_VOLTAGE4, 2);
	tagLengthMap.put(TAG_XT1, 16);
	tagLengthMap.put(TAG_XT2, 16);
	tagLengthMap.put(TAG_XT3, 16);
    }

    private static int getTagLength(int tag) throws DecodeError {
	Integer length = tagLengthMap.get(tag);
	if (length == null)
	    throw new DecodeError(String.format("invalid tag '%d'", tag));

	return length;
    }

    private void sendReply(Channel channel, int checksum) {
        ChannelBuffer reply = ChannelBuffers.directBuffer(ByteOrder.LITTLE_ENDIAN, 3);
        reply.writeByte(0x02);
        reply.writeShort((short) checksum);
        if (channel != null) {
            channel.write(reply);
        }
    }

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

        ChannelBuffer buf = (ChannelBuffer) msg;
        
        buf.readUnsignedByte(); // header
        int length = (buf.readUnsignedShort() & 0x7fff) + 3;
        
        List<Position> positions = new LinkedList<Position>();
        Set<Integer> tags = new HashSet<Integer>();
        boolean hasLocation = false;
        Position position = new Position();
        position.setProtocol(getProtocolName());
        
        while (buf.readerIndex() < length) {

            // Check if new message started
            int tag = buf.readUnsignedByte();
            if (tags.contains(tag)) {
                if (hasLocation && position.getFixTime() != null) {
                    positions.add(position);
                }
                tags.clear();
                hasLocation = false;
                position = new Position();
            }
            tags.add(tag);
            
            switch (tag) {

                case TAG_IMEI:
                    String imei = buf.toString(buf.readerIndex(), 15, Charset.defaultCharset());
                    buf.skipBytes(imei.length());
                    identify(imei, channel);
                    break;

                case TAG_DATE:
                    position.setTime(new Date(buf.readUnsignedInt() * 1000));
                    break;
                    
                case TAG_COORDINATES:
                    hasLocation = true;
                    position.setValid((buf.readUnsignedByte() & 0xf0) == 0x00);
                    position.setLatitude(buf.readInt() / 1000000.0);
                    position.setLongitude(buf.readInt() / 1000000.0);
                    break;
                    
                case TAG_SPEED_COURSE:
                    position.setSpeed(buf.readUnsignedShort() * 0.0539957);
                    position.setCourse(buf.readUnsignedShort() * 0.1);
                    break;
                    
                case TAG_ALTITUDE:
                    position.setAltitude(buf.readShort());
                    break;
                                       
                case TAG_STATUS:
                    int status = buf.readUnsignedShort();
		    position.set(Event.KEY_IGNITION, BitUtil.check(status, 9));
		    position.set(Event.KEY_ALARM, BitUtil.check(status, 15));
                    position.set(Event.KEY_VBATT, BitUtil.check(status, 2));
                    break;
                    
                case TAG_DIGITAL_INPUTS:
		    int input = buf.readUnsignedShort();
		    for (int i = 0; i < 16; i++)
			position.set(Event.PREFIX_IO + (i + 1), BitUtil.check(input, i));
                    break;

                case TAG_DIGITAL_OUTPUTS:
		    int output = buf.readUnsignedShort();
		    for (int i = 0; i < 16; i++)
			position.set(Event.PREFIX_IO + (i + 17), BitUtil.check(output, i));
                    break;
                                        
                case TAG_INPUT_VOLTAGE1:
		    position.set(Event.PREFIX_ADC + 1, buf.readUnsignedShort() / 1000.0);
                    break;
                    
                case TAG_INPUT_VOLTAGE2:
		    position.set(Event.PREFIX_ADC + 2, buf.readUnsignedShort() / 1000.0);
                    break;
                                        
                case TAG_INPUT_VOLTAGE3:
		    position.set(Event.PREFIX_ADC + 3, buf.readUnsignedShort() / 1000.0);
                    break;

                case TAG_INPUT_VOLTAGE4:
		    position.set(Event.PREFIX_ADC + 4, buf.readUnsignedShort() / 1000.0);
                    break;
                   
                default:
		    try {
			buf.skipBytes(getTagLength(tag));
		    } catch (DecodeError e) {
			Log.warning("Error decoding packet: " + e.getMessage());
			return null;
		    }
                    break;
                    
            }
        }
        if (hasLocation && position.getFixTime() != null) {
            positions.add(position);
        }
        
        if (!hasDeviceId()) {
            Log.warning("Unknown device");
            return null;
        }

        sendReply(channel, buf.readUnsignedShort());

        for (Position p : positions) {
            p.setDeviceId(getDeviceId());
        }

        if (positions.isEmpty()) {
            return null;
        }
        return positions;
    }

}