aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/org/traccar/protocol/KhdProtocolDecoder.java
blob: 371b0f71c03f96a5db935d359f3d756c3442ecdc (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
/*
 * Copyright 2014 - 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.ByteBufUtil;
import io.netty.buffer.Unpooled;
import io.netty.channel.Channel;
import org.traccar.BaseProtocolDecoder;
import org.traccar.DeviceSession;
import org.traccar.NetworkMessage;
import org.traccar.Protocol;
import org.traccar.helper.BcdUtil;
import org.traccar.helper.BitUtil;
import org.traccar.helper.Checksum;
import org.traccar.helper.DateBuilder;
import org.traccar.helper.UnitsConverter;
import org.traccar.model.CellTower;
import org.traccar.model.Network;
import org.traccar.model.Position;

import java.net.SocketAddress;

public class KhdProtocolDecoder extends BaseProtocolDecoder {

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

    private String[] readIdentifiers(ByteBuf buf) {
        String[] identifiers = new String[2];

        identifiers[0] = ByteBufUtil.hexDump(buf, buf.readerIndex(), 4);

        int b1 = buf.readUnsignedByte();
        int b2 = buf.readUnsignedByte() - 0x80;
        int b3 = buf.readUnsignedByte() - 0x80;
        int b4 = buf.readUnsignedByte();
        identifiers[1] = String.format("%02d%02d%02d%02d", b1, b2, b3, b4);

        return identifiers;
    }

    public static final int MSG_LOGIN = 0xB1;
    public static final int MSG_CONFIRMATION = 0x21;
    public static final int MSG_ON_DEMAND = 0x81;
    public static final int MSG_POSITION_UPLOAD = 0x80;
    public static final int MSG_POSITION_REUPLOAD = 0x8E;
    public static final int MSG_ALARM = 0x82;
    public static final int MSG_ADMIN_NUMBER = 0x83;
    public static final int MSG_SEND_TEXT = 0x84;
    public static final int MSG_REPLY = 0x85;
    public static final int MSG_SMS_ALARM_SWITCH = 0x86;
    public static final int MSG_PERIPHERAL = 0xA3;

    private void decodeAlarmStatus(Position position, byte[] status) {
        if (BitUtil.check(status[0], 4)) {
            position.set(Position.KEY_ALARM, Position.ALARM_LOW_POWER);
        } else if (BitUtil.check(status[0], 6)) {
            position.set(Position.KEY_ALARM, Position.ALARM_GEOFENCE_EXIT);
        } else if (BitUtil.check(status[0], 7)) {
            position.set(Position.KEY_ALARM, Position.ALARM_GEOFENCE_ENTER);
        } else if (BitUtil.check(status[1], 0)) {
            position.set(Position.KEY_ALARM, Position.ALARM_SOS);
        } else if (BitUtil.check(status[1], 1)) {
            position.set(Position.KEY_ALARM, Position.ALARM_OVERSPEED);
        } else if (BitUtil.check(status[1], 3)) {
            position.set(Position.KEY_ALARM, Position.ALARM_POWER_CUT);
        } else if (BitUtil.check(status[1], 6)) {
            position.set(Position.KEY_ALARM, Position.ALARM_TOW);
        } else if (BitUtil.check(status[1], 7)) {
            position.set(Position.KEY_ALARM, Position.ALARM_DOOR);
        } else if (BitUtil.check(status[2], 2)) {
            position.set(Position.KEY_ALARM, Position.ALARM_TEMPERATURE);
        } else if (BitUtil.check(status[2], 4)) {
            position.set(Position.KEY_ALARM, Position.ALARM_TAMPERING);
        }  else if (BitUtil.check(status[2], 6)) {
            position.set(Position.KEY_ALARM, Position.ALARM_FATIGUE_DRIVING);
        } else if (BitUtil.check(status[2], 7)) {
            position.set(Position.KEY_ALARM, Position.ALARM_IDLE);
        } else if (BitUtil.check(status[6], 3)) {
            position.set(Position.KEY_ALARM, Position.ALARM_VIBRATION);
        } else if (BitUtil.check(status[6], 4)) {
            position.set(Position.KEY_ALARM, Position.ALARM_BRAKING);
        } else if (BitUtil.check(status[6], 5)) {
            position.set(Position.KEY_ALARM, Position.ALARM_ACCELERATION);
        } else if (BitUtil.check(status[6], 6)) {
            position.set(Position.KEY_ALARM, Position.ALARM_CORNERING);
        } else if (BitUtil.check(status[6], 7)) {
            position.set(Position.KEY_ALARM, Position.ALARM_ACCIDENT);
        }
    }

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

        ByteBuf buf = (ByteBuf) msg;

        buf.skipBytes(2); // header
        int type = buf.readUnsignedByte();
        buf.readUnsignedShort(); // size

        if (type == MSG_LOGIN || type == MSG_ADMIN_NUMBER || type == MSG_SEND_TEXT
                || type == MSG_SMS_ALARM_SWITCH || type == MSG_POSITION_REUPLOAD) {

            ByteBuf response = Unpooled.buffer();
            response.writeByte(0x29);
            response.writeByte(0x29); // header
            response.writeByte(MSG_CONFIRMATION);
            response.writeShort(5); // size
            response.writeByte(buf.getByte(buf.writerIndex() - 2));
            response.writeByte(type);
            response.writeByte(buf.writerIndex() > 9 ? buf.getByte(9) : 0); // 10th byte
            response.writeByte(Checksum.xor(response.nioBuffer()));
            response.writeByte(0x0D); // ending

            if (channel != null) {
                channel.writeAndFlush(new NetworkMessage(response, remoteAddress));
            }

        }

        if (type == MSG_ON_DEMAND || type == MSG_POSITION_UPLOAD || type == MSG_POSITION_REUPLOAD
                || type == MSG_ALARM || type == MSG_REPLY || type == MSG_PERIPHERAL) {

            Position position = new Position(getProtocolName());

            DeviceSession deviceSession = getDeviceSession(channel, remoteAddress, readIdentifiers(buf));
            if (deviceSession == null) {
                return null;
            }
            position.setDeviceId(deviceSession.getDeviceId());

            DateBuilder dateBuilder = new DateBuilder()
                    .setYear(BcdUtil.readInteger(buf, 2))
                    .setMonth(BcdUtil.readInteger(buf, 2))
                    .setDay(BcdUtil.readInteger(buf, 2))
                    .setHour(BcdUtil.readInteger(buf, 2))
                    .setMinute(BcdUtil.readInteger(buf, 2))
                    .setSecond(BcdUtil.readInteger(buf, 2));
            position.setTime(dateBuilder.getDate());

            position.setLatitude(BcdUtil.readCoordinate(buf));
            position.setLongitude(BcdUtil.readCoordinate(buf));
            position.setSpeed(UnitsConverter.knotsFromKph(BcdUtil.readInteger(buf, 4)));
            position.setCourse(BcdUtil.readInteger(buf, 4));
            position.setValid((buf.readUnsignedByte() & 0x80) != 0);

            if (type != MSG_ALARM) {

                int odometer = buf.readUnsignedMedium();
                if (BitUtil.to(odometer, 16) > 0) {
                    position.set(Position.KEY_ODOMETER, odometer);
                } else if (odometer > 0) {
                    position.set(Position.KEY_FUEL_LEVEL, BitUtil.from(odometer, 16));
                }

                position.set(Position.KEY_STATUS, buf.readUnsignedInt());

                buf.readUnsignedShort();
                buf.readUnsignedByte();
                buf.readUnsignedByte();
                buf.readUnsignedByte();
                buf.readUnsignedByte();
                buf.readUnsignedByte();

                position.set(Position.KEY_RESULT, buf.readUnsignedByte());

                if (type == MSG_PERIPHERAL) {

                    buf.readUnsignedShort(); // data length

                    int dataType = buf.readUnsignedByte();

                    buf.readUnsignedByte(); // content length

                    switch (dataType) {
                        case 0x01:
                            position.set(Position.KEY_FUEL_LEVEL,
                                    buf.readUnsignedByte() * 100 + buf.readUnsignedByte());
                            break;
                        case 0x02:
                            position.set(Position.PREFIX_TEMP + 1,
                                    buf.readUnsignedByte() * 100 + buf.readUnsignedByte());
                            break;
                        case 0x18:
                            for (int i = 1; i <= 4; i++) {
                                double value = buf.readUnsignedShort();
                                if (value > 0x0000 && value < 0xFFFF) {
                                    position.set("fuel" + i, value / 0xFFFE);
                                }
                            }
                            break;
                        case 0x23:
                            Network network = new Network();
                            int count = buf.readUnsignedByte();
                            for (int i = 0; i < count; i++) {
                                network.addCellTower(CellTower.from(
                                        buf.readUnsignedShort(), buf.readUnsignedByte(),
                                        buf.readUnsignedShort(), buf.readUnsignedShort(), buf.readUnsignedByte()));
                            }
                            if (count > 0) {
                                position.setNetwork(network);
                            }
                            break;
                        default:
                            break;
                    }

                }

            }  else {

                buf.readUnsignedByte(); // overloaded state
                buf.readUnsignedByte(); // logging status

                byte[] alarmStatus = new byte[8];
                buf.readBytes(alarmStatus);

                decodeAlarmStatus(position, alarmStatus);

            }

            return position;

        }

        return null;
    }

}