aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/org/traccar/protocol/HuaShengProtocolDecoder.java
blob: d020b5e440d2abbe5b327fcf6e033c3eff67d5a0 (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
/*
 * Copyright 2016 - 2023 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.session.DeviceSession;
import org.traccar.NetworkMessage;
import org.traccar.Protocol;
import org.traccar.helper.BitUtil;
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 org.traccar.model.WifiAccessPoint;

import java.net.SocketAddress;
import java.nio.charset.StandardCharsets;

public class HuaShengProtocolDecoder extends BaseProtocolDecoder {

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

    public static final int MSG_POSITION = 0xAA00;
    public static final int MSG_POSITION_RSP = 0xFF01;
    public static final int MSG_LOGIN = 0xAA02;
    public static final int MSG_LOGIN_RSP = 0xFF03;
    public static final int MSG_UPFAULT = 0xAA12;
    public static final int MSG_UPFAULT_RSP = 0xFF13;
    public static final int MSG_HSO_REQ = 0x0002;
    public static final int MSG_HSO_RSP = 0x0003;
    public static final int MSG_SET_REQ = 0xAA04;
    public static final int MSG_SET_RSP = 0xFF05;
    public static final int MSG_CTRL_REQ = 0xAA16;
    public static final int MSG_CTRL_RSP = 0xFF17;

    private void sendResponse(Channel channel, int type, int index, ByteBuf content) {
        if (channel != null) {
            ByteBuf response = Unpooled.buffer();
            response.writeByte(0xC0);
            response.writeShort(0x0100);
            response.writeShort(12 + (content != null ? content.readableBytes() : 0));
            response.writeShort(type);
            response.writeShort(0);
            response.writeInt(index);
            if (content != null) {
                response.writeBytes(content);
                content.release();
            }
            response.writeByte(0xC0);
            channel.writeAndFlush(new NetworkMessage(response, channel.remoteAddress()));
        }
    }

    private String decodeAlarm(int event) {
        return switch (event) {
            case 4 -> Position.ALARM_FATIGUE_DRIVING;
            case 6 -> Position.ALARM_SOS;
            case 7 -> Position.ALARM_BRAKING;
            case 8 -> Position.ALARM_ACCELERATION;
            case 9 -> Position.ALARM_CORNERING;
            case 10 -> Position.ALARM_ACCIDENT;
            case 16 -> Position.ALARM_REMOVING;
            default -> null;
        };
    }

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

        ByteBuf buf = (ByteBuf) msg;

        buf.skipBytes(1); // start marker
        buf.readUnsignedByte(); // flag
        buf.readUnsignedByte(); // reserved
        buf.readUnsignedShort(); // length

        int type = buf.readUnsignedShort();

        buf.readUnsignedShort(); // checksum
        int index = buf.readInt();

        if (type == MSG_LOGIN) {

            while (buf.readableBytes() > 4) {
                int subtype = buf.readUnsignedShort();
                int length = buf.readUnsignedShort() - 4;
                if (subtype == 0x0003) {
                    String imei = buf.readCharSequence(length, StandardCharsets.US_ASCII).toString();
                    DeviceSession deviceSession = getDeviceSession(channel, remoteAddress, imei);
                    if (deviceSession != null && channel != null) {
                        ByteBuf content = Unpooled.buffer();
                        content.writeByte(0); // success
                        sendResponse(channel, MSG_LOGIN_RSP, index, content);
                    }
                } else {
                    buf.skipBytes(length);
                }
            }

        } else if (type == MSG_HSO_REQ) {

            sendResponse(channel, MSG_HSO_RSP, index, null);

        } else if (type == MSG_UPFAULT) {

            return decodeFaultCodes(channel, remoteAddress, buf);

        } else if (type == MSG_POSITION) {

            return decodePosition(channel, remoteAddress, buf, index);

        }

        return null;
    }

    private Position decodeFaultCodes(
            Channel channel, SocketAddress remoteAddress, ByteBuf buf) {

        DeviceSession deviceSession = getDeviceSession(channel, remoteAddress);
        if (deviceSession == null) {
            return null;
        }

        Position position = new Position(getProtocolName());
        position.setDeviceId(deviceSession.getDeviceId());

        getLastLocation(position, null);

        buf.readUnsignedShort(); // type
        buf.readUnsignedShort(); // length

        StringBuilder codes = new StringBuilder();
        while (buf.readableBytes() > 2) {
            String value = ByteBufUtil.hexDump(buf.readSlice(2));
            int digit = Integer.parseInt(value.substring(0, 1), 16);
            char prefix = switch (digit >> 2) {
                default -> 'P';
                case 1 -> 'C';
                case 2 -> 'B';
                case 3 -> 'U';
            };
            codes.append(prefix).append(digit % 4).append(value.substring(1));
            if (buf.readableBytes() > 2) {
                codes.append(' ');
            }
        }

        position.set(Position.KEY_DTCS, codes.toString());

        return position;
    }

    private Position decodePosition(
            Channel channel, SocketAddress remoteAddress, ByteBuf buf, int index) {

        DeviceSession deviceSession = getDeviceSession(channel, remoteAddress);
        if (deviceSession == null) {
            return null;
        }

        Position position = new Position(getProtocolName());
        position.setDeviceId(deviceSession.getDeviceId());

        int status = buf.readUnsignedShort();

        position.setValid(BitUtil.check(status, 15));

        position.set(Position.KEY_STATUS, status);
        position.set(Position.KEY_IGNITION, BitUtil.check(status, 14));

        int event = buf.readUnsignedShort();
        position.set(Position.KEY_ALARM, decodeAlarm(event));
        position.set(Position.KEY_EVENT, event);

        String time = buf.readCharSequence(12, StandardCharsets.US_ASCII).toString();

        DateBuilder dateBuilder = new DateBuilder()
                .setYear(Integer.parseInt(time.substring(0, 2)))
                .setMonth(Integer.parseInt(time.substring(2, 4)))
                .setDay(Integer.parseInt(time.substring(4, 6)))
                .setHour(Integer.parseInt(time.substring(6, 8)))
                .setMinute(Integer.parseInt(time.substring(8, 10)))
                .setSecond(Integer.parseInt(time.substring(10, 12)));
        position.setTime(dateBuilder.getDate());

        position.setLongitude(buf.readInt() * 0.00001);
        position.setLatitude(buf.readInt() * 0.00001);

        position.setSpeed(UnitsConverter.knotsFromKph(buf.readUnsignedShort()));
        position.setCourse(buf.readUnsignedShort());
        position.setAltitude(buf.readUnsignedShort());

        buf.readUnsignedShort(); // odometer speed

        Network network = new Network();

        while (buf.readableBytes() > 4) {
            int subtype = buf.readUnsignedShort();
            int length = buf.readUnsignedShort() - 4;
            int endIndex = buf.readerIndex() + length;
            switch (subtype) {
                case 0x0001:
                    int coolantTemperature = buf.readUnsignedByte() - 40;
                    if (coolantTemperature <= 215) {
                        position.set(Position.KEY_COOLANT_TEMP, coolantTemperature);
                    }
                    int rpm = buf.readUnsignedShort();
                    if (rpm <= 65535) {
                        position.set(Position.KEY_RPM, rpm);
                    }
                    position.set("averageSpeed", buf.readUnsignedByte());
                    buf.readUnsignedShort(); // interval fuel consumption
                    position.set(Position.KEY_FUEL_CONSUMPTION, buf.readUnsignedShort() * 0.01);
                    position.set(Position.KEY_ODOMETER_TRIP, buf.readUnsignedShort());
                    position.set(Position.KEY_POWER, buf.readUnsignedShort() * 0.01);
                    position.set(Position.KEY_FUEL_LEVEL, buf.readUnsignedByte() * 0.4);
                    buf.readUnsignedInt(); // trip id
                    if (buf.readerIndex() < endIndex) {
                        position.set("adBlueLevel", buf.readUnsignedByte() * 0.4);
                    }
                    break;
                case 0x0005:
                    position.set(Position.KEY_RSSI, buf.readUnsignedByte());
                    position.set(Position.KEY_HDOP, buf.readUnsignedByte());
                    buf.readUnsignedInt(); // run time
                    break;
                case 0x0009:
                    position.set(Position.KEY_VIN, buf.readCharSequence(length, StandardCharsets.US_ASCII).toString());
                    break;
                case 0x0010:
                    position.set(Position.KEY_ODOMETER, Double.parseDouble(
                            buf.readCharSequence(length, StandardCharsets.US_ASCII).toString()) * 1000);
                    break;
                case 0x0011:
                    position.set(Position.KEY_HOURS, buf.readUnsignedInt() * 0.05);
                    break;
                case 0x0014:
                    position.set(Position.KEY_ENGINE_LOAD, buf.readUnsignedByte() / 255.0);
                    position.set("timingAdvance", buf.readUnsignedByte() * 0.5);
                    position.set("airTemp", buf.readUnsignedByte() - 40);
                    position.set("airFlow", buf.readUnsignedShort() * 0.01);
                    position.set(Position.KEY_THROTTLE, buf.readUnsignedByte() / 255.0);
                    break;
                case 0x0020:
                    String[] cells = buf.readCharSequence(
                            length, StandardCharsets.US_ASCII).toString().split("\\+");
                    for (String cell : cells) {
                        String[] values = cell.split("@");
                        network.addCellTower(CellTower.from(
                                Integer.parseInt(values[0]), Integer.parseInt(values[1]),
                                Integer.parseInt(values[2], 16), Long.parseLong(values[3], 16)));
                    }
                    break;
                case 0x0021:
                    String[] points = buf.readCharSequence(
                            length, StandardCharsets.US_ASCII).toString().split("\\+");
                    for (String point : points) {
                        String[] values = point.split("@");
                        network.addWifiAccessPoint(WifiAccessPoint.from(values[0], Integer.parseInt(values[1])));
                    }
                    break;
                default:
                    buf.skipBytes(length);
                    break;
            }
            buf.readerIndex(endIndex);
        }

        if (network.getCellTowers() != null || network.getWifiAccessPoints() != null) {
            position.setNetwork(network);
        }

        sendResponse(channel, MSG_POSITION_RSP, index, null);

        return position;
    }

}