/* * Copyright 2012 - 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.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.Parser; import org.traccar.helper.PatternBuilder; import org.traccar.model.CellTower; import org.traccar.model.Network; import org.traccar.model.Position; import java.net.SocketAddress; import java.nio.charset.StandardCharsets; import java.util.regex.Pattern; public class UproProtocolDecoder extends BaseProtocolDecoder { public UproProtocolDecoder(Protocol protocol) { super(protocol); } private static final Pattern PATTERN_HEADER = new PatternBuilder() .text("*") .expression("(..20)") // head .expression("([01])") // ack .number("(d+),") // device id .expression("(.)") // type .expression("(.)") // subtype .any() .compile(); private static final Pattern PATTERN_LOCATION = new PatternBuilder() .number("(dd)(dd)(dd)") // time (hhmmss) .number("(dd)(dd)(dddd)") // latitude .number("(ddd)(dd)(dddd)") // longitude .number("(d)") // flags .number("(dd)") // speed .number("(dd)") // course .number("(dd)(dd)(dd)") // date (ddmmyy) .compile(); private void decodeLocation(Position position, String data) { Parser parser = new Parser(PATTERN_LOCATION, data); if (parser.matches()) { DateBuilder dateBuilder = new DateBuilder() .setTime(parser.nextInt(0), parser.nextInt(0), parser.nextInt(0)); position.setLatitude(parser.nextCoordinate(Parser.CoordinateFormat.DEG_MIN_MIN)); position.setLongitude(parser.nextCoordinate(Parser.CoordinateFormat.DEG_MIN_MIN)); int flags = parser.nextInt(0); position.setValid(!BitUtil.check(flags, 0)); if (!BitUtil.check(flags, 1)) { position.setLatitude(-position.getLatitude()); } if (!BitUtil.check(flags, 2)) { position.setLongitude(-position.getLongitude()); } position.setSpeed(parser.nextInt(0) * 2); position.setCourse(parser.nextInt(0) * 10); dateBuilder.setDateReverse(parser.nextInt(0), parser.nextInt(0), parser.nextInt(0)); position.setTime(dateBuilder.getDate()); } } private String decodeAlarm(int alarm) { if (BitUtil.check(alarm, 2)) { return Position.ALARM_TAMPERING; } return null; } @Override protected Object decode( Channel channel, SocketAddress remoteAddress, Object msg) throws Exception { ByteBuf buf = (ByteBuf) msg; if (buf.getByte(buf.readerIndex()) != '*') { return null; } int headerIndex = buf.indexOf(buf.readerIndex(), buf.writerIndex(), (byte) '&'); if (headerIndex < 0) { headerIndex = buf.writerIndex(); } String header = buf.readSlice(headerIndex - buf.readerIndex()).toString(StandardCharsets.US_ASCII); Parser parser = new Parser(PATTERN_HEADER, header); if (!parser.matches()) { return null; } String head = parser.next(); boolean reply = parser.next().equals("1"); DeviceSession deviceSession = getDeviceSession(channel, remoteAddress, parser.next()); if (deviceSession == null) { return null; } Position position = new Position(getProtocolName()); position.setDeviceId(deviceSession.getDeviceId()); Network network = new Network(); String type = parser.next(); String subtype = parser.next(); if (reply && channel != null) { channel.writeAndFlush(new NetworkMessage("*" + head + "Y" + type + subtype + "#", remoteAddress)); } while (buf.readableBytes() > 1) { buf.readByte(); // skip delimiter byte dataType = buf.readByte(); int delimiterIndex = buf.indexOf(buf.readerIndex(), buf.writerIndex(), (byte) '&'); if (delimiterIndex < 0) { delimiterIndex = buf.indexOf(buf.readerIndex(), buf.writerIndex(), (byte) '#'); if (delimiterIndex < 0) { delimiterIndex = buf.writerIndex(); } } ByteBuf data = buf.readSlice(delimiterIndex - buf.readerIndex()); int mcc = 0, mnc = 0, count; String stringValue; switch (dataType) { case 'A' -> decodeLocation(position, data.toString(StandardCharsets.US_ASCII)); case 'B' -> position.set(Position.KEY_STATUS, data.toString(StandardCharsets.US_ASCII)); case 'C' -> { long odometer = 0; while (data.isReadable()) { odometer <<= 4; odometer += data.readByte() - (byte) '0'; } position.set(Position.KEY_ODOMETER, odometer * 2 * 1852 / 3600); } case 'F' -> position.setSpeed( Integer.parseInt(data.readSlice(4).toString(StandardCharsets.US_ASCII)) * 0.1); case 'G' -> position.setAltitude( Integer.parseInt(data.readSlice(6).toString(StandardCharsets.US_ASCII)) * 0.1); case 'I' -> { stringValue = data.toString(StandardCharsets.US_ASCII); count = Integer.parseInt(stringValue.substring(0, 1)); if (stringValue.length() == 6 + count * 10) { mcc = Integer.parseInt(stringValue.substring(1, 4)); mnc = Integer.parseInt(stringValue.substring(4, 6)); for (int i = 0; i < count; i++) { int offset = 6 + i * 10; network.addCellTower(CellTower.from( mcc, mnc, Integer.parseInt(stringValue.substring(offset, offset + 4), 16), Integer.parseInt(stringValue.substring(offset + 4, offset + 8), 16), Integer.parseInt(stringValue.substring(offset + 8, offset + 10)))); } } } case 'J' -> { if (data.readableBytes() == 6) { char index = (char) data.readUnsignedByte(); int status = data.readUnsignedByte(); double value = Integer.parseInt(data.readSlice(4).toString(StandardCharsets.US_ASCII)) * 0.1; if (BitUtil.check(status, 0)) { value = -value; } position.set(Position.PREFIX_TEMP + index, value); } } case 'K' -> position.set("statusExtended", data.toString(StandardCharsets.US_ASCII)); case 'M' -> { if (data.readableBytes() == 3) { position.set(Position.KEY_BATTERY_LEVEL, Integer.parseInt(data.readSlice(3).toString(StandardCharsets.US_ASCII)) * 0.1); } else if (data.readableBytes() == 4) { char index = (char) data.readUnsignedByte(); data.readUnsignedByte(); // status position.set( "humidity" + index, Integer.parseInt(data.readSlice(2).toString(StandardCharsets.US_ASCII))); } } case 'N' -> position.set(Position.KEY_RSSI, Integer.parseInt(data.readSlice(2).toString(StandardCharsets.US_ASCII))); case 'O' -> position.set(Position.KEY_SATELLITES, Integer.parseInt(data.readSlice(2).toString(StandardCharsets.US_ASCII))); case 'P' -> { if (data.readableBytes() >= 16) { position.setNetwork(new Network(CellTower.from( Integer.parseInt(data.readSlice(4).toString(StandardCharsets.US_ASCII)), Integer.parseInt(data.readSlice(4).toString(StandardCharsets.US_ASCII)), Integer.parseInt(data.readSlice(4).toString(StandardCharsets.US_ASCII), 16), Integer.parseInt(data.readSlice(4).toString(StandardCharsets.US_ASCII), 16)))); } } case 'Q' -> { if (!head.startsWith("HQ")) { position.set("obdPid", ByteBufUtil.hexDump(data)); } } case 'R' -> { if (head.startsWith("HQ")) { position.set(Position.KEY_RSSI, Integer.parseInt(data.readSlice(2).toString(StandardCharsets.US_ASCII))); position.set(Position.KEY_SATELLITES, Integer.parseInt(data.readSlice(2).toString(StandardCharsets.US_ASCII))); } else { position.set("odbTravel", ByteBufUtil.hexDump(data)); } } case 'S' -> position.set("obdTraffic", ByteBufUtil.hexDump(data)); case 'T' -> { if (data.readableBytes() == 2) { position.set(Position.KEY_BATTERY_LEVEL, Integer.parseInt(data.toString(StandardCharsets.US_ASCII))); } } case 'V' -> position.set(Position.KEY_POWER, Integer.parseInt(data.readSlice(4).toString(StandardCharsets.US_ASCII)) * 0.1); case 'W' -> position.set(Position.KEY_ALARM, decodeAlarm(Integer.parseInt(data.readSlice(2).toString(StandardCharsets.US_ASCII)))); case 'X' -> { String[] cells = data.toString(StandardCharsets.US_ASCII).split(";"); if (!cells[0].startsWith("(")) { for (int i = 0; i < cells.length; i++) { String[] values = cells[i].split(","); int index = 0; if (i == 0) { mcc = Integer.parseInt(values[index++]); mnc = Integer.parseInt(values[index++]); } network.addCellTower(CellTower.from( mcc, mnc, Integer.parseInt(values[index++]), Integer.parseInt(values[index++]), Integer.parseInt(values[index]))); } position.setNetwork(network); } } case 'Y' -> { stringValue = data.toString(StandardCharsets.US_ASCII); count = Integer.parseInt(stringValue.substring(0, 1)); if (stringValue.length() == 6 + count * 14) { mcc = Integer.parseInt(stringValue.substring(1, 4)); mnc = Integer.parseInt(stringValue.substring(4, 6)); for (int i = 0; i < count; i++) { int offset = 6 + i * 14; network.addCellTower(CellTower.from( mcc, mnc, Integer.parseInt(stringValue.substring(offset, offset + 4), 16), Long.parseLong(stringValue.substring(offset + 4, offset + 12), 16), Integer.parseInt(stringValue.substring(offset + 12, offset + 14), 16))); } } else { position.set(Position.KEY_POWER, Integer.parseInt(data.readSlice(5).toString(StandardCharsets.US_ASCII)) * 0.001); } } case 'b' -> { if (data.readableBytes() > 3) { position.set("serial", data.toString(StandardCharsets.US_ASCII).substring(3)); } } case 'd' -> position.set(Position.PREFIX_ADC + 1, Integer.parseInt(data.toString(StandardCharsets.US_ASCII)) / 100.0); } } if (network.getCellTowers() != null || network.getWifiAccessPoints() != null) { position.setNetwork(network); } if (position.getLatitude() == 0 || position.getLongitude() == 0) { if (position.getAttributes().isEmpty()) { return null; } getLastLocation(position, position.getDeviceTime()); } return position; } }