path: root/src/org/traccar/protocol/MeiligaoProtocolDecoder.java

/*
 * Copyright 2012 - 2016 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 org.jboss.netty.buffer.ChannelBuffer;
import org.jboss.netty.buffer.ChannelBuffers;
import org.jboss.netty.channel.Channel;
import org.traccar.BaseProtocolDecoder;
import org.traccar.Context;
import org.traccar.DeviceSession;
import org.traccar.helper.Checksum;
import org.traccar.helper.DateBuilder;
import org.traccar.helper.Parser;
import org.traccar.helper.PatternBuilder;
import org.traccar.model.Position;

import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.nio.charset.StandardCharsets;
import java.util.regex.Pattern;

public class MeiligaoProtocolDecoder extends BaseProtocolDecoder {

    public MeiligaoProtocolDecoder(MeiligaoProtocol protocol) {
        super(protocol);
    }

    private static final Pattern PATTERN = new PatternBuilder()
            .number("(dd)(dd)(dd).?(d+)?,")      // time
            .expression("([AV]),")               // validity
            .number("(d+)(dd.d+),")              // latitude
            .expression("([NS]),")
            .number("(d+)(dd.d+),")              // longitude
            .expression("([EW]),")
            .number("(d+.?d*)?,")                // speed
            .number("(d+.?d*)?,")                // course
            .number("(dd)(dd)(dd)")              // date (ddmmyy)
            .expression("[^\\|]*")
            .groupBegin()
            .number("|(d+.d+)?")                 // hdop
            .number("|(-?d+.?d*)?")              // altitude
            .number("|(xxxx)?")                  // state
            .groupBegin()
            .number("|(xxxx),(xxxx)")            // adc
            .number("(?:,(xxxx),(xxxx),(xxxx),(xxxx),(xxxx),(xxxx))?")
            .groupBegin()
            .number("|x{16}")                    // cell
            .number("|(xx)")                     // gsm
            .number("|(x{8})")                   // odometer
            .or()
            .number("|(x{9})")                   // odometer
            .groupBegin()
            .number("|(x{5,})")                  // rfid
            .groupEnd("?")
            .groupEnd("?")
            .groupEnd("?")
            .groupEnd("?")
            .any()
            .compile();

    private static final Pattern PATTERN_RFID = new PatternBuilder()
            .number("|(dd)(dd)(dd),")            // time
            .number("(dd)(dd)(dd),")             // Date (ddmmyy)
            .number("(d+)(dd.d+),")              // latitude
            .expression("([NS]),")
            .number("(d+)(dd.d+),")              // longitude
            .expression("([EW])")
            .compile();

    public static final int MSG_HEARTBEAT = 0x0001;
    public static final int MSG_SERVER = 0x0002;
    public static final int MSG_LOGIN = 0x5000;
    public static final int MSG_LOGIN_RESPONSE = 0x4000;

    public static final int MSG_POSITION = 0x9955;
    public static final int MSG_POSITION_LOGGED = 0x9016;
    public static final int MSG_ALARM = 0x9999;

    public static final int MSG_RFID = 0x9966;

    private DeviceSession identify(ChannelBuffer buf, Channel channel, SocketAddress remoteAddress) {
        StringBuilder builder = new StringBuilder();

        for (int i = 0; i < 7; i++) {
            int b = buf.readUnsignedByte();

            // First digit
            int d1 = (b & 0xf0) >> 4;
            if (d1 == 0xf) {
                break;
            }
            builder.append(d1);

            // Second digit
            int d2 = b & 0x0f;
            if (d2 == 0xf) {
                break;
            }
            builder.append(d2);
        }

        String id = builder.toString();

        if (id.length() == 14) {
            return getDeviceSession(channel, remoteAddress, id, id + Checksum.luhn(Long.parseLong(id)));
        } else {
            return getDeviceSession(channel, remoteAddress, id);
        }
    }

    private static void sendResponse(
            Channel channel, SocketAddress remoteAddress, ChannelBuffer id, int type, ChannelBuffer msg) {

        if (channel != null) {
            ChannelBuffer buf = ChannelBuffers.buffer(
                    2 + 2 + id.readableBytes() + 2 + msg.readableBytes() + 2 + 2);

            buf.writeByte('@');
            buf.writeByte('@');
            buf.writeShort(buf.capacity());
            buf.writeBytes(id);
            buf.writeShort(type);
            buf.writeBytes(msg);
            buf.writeShort(Checksum.crc16(Checksum.CRC16_CCITT_FALSE, buf.toByteBuffer()));
            buf.writeByte('\r');
            buf.writeByte('\n');

            channel.write(buf, remoteAddress);
        }
    }

    private String getMeiligaoServer(Channel channel) {
        String server = Context.getConfig().getString(getProtocolName() + ".server");
        if (server == null) {
            InetSocketAddress address = (InetSocketAddress) channel.getLocalAddress();
            server = address.getAddress().getHostAddress() + ":" + address.getPort();
        }
        return server;
    }
    
    private String decodeAlarm(short value) {
        switch (value) {
        case 0x01: return Position.ALARM_SOS;
        case 0x02: return Position.PREFIX_BUTTON + "B" + Position.ENDING_PRESSED;
        case 0x03: return Position.PREFIX_BUTTON + "C" + Position.ENDING_PRESSED;
        case 0x04: return Position.PREFIX_IO + "4" + Position.ENDING_ACTIVE;
        case 0x05: return Position.PREFIX_IO + "5" + Position.ENDING_ACTIVE;
        case 0x10: return Position.ALARM_LOW_BATTERY;
        case 0x11: return Position.ALARM_OVERSPEED;
        case 0x12: return Position.ALARM_MOVEMENT;
        case 0x13: return Position.ALARM_GEOFENCE_ENTER;
        case 0x14: return Position.ALARM_TRACKER_ON;
        case 0x15: return Position.ALARM_GPS_BLIND_ENTER;
        case 0x16: return Position.ALARM_GPS_BLIND_EXIT;
        case 0x31: return Position.ALARM_SOS + Position.ENDING_RELEASED;
        case 0x32: return Position.PREFIX_BUTTON + "B" + Position.ENDING_RELEASED;
        case 0x33: return Position.PREFIX_BUTTON + "C" + Position.ENDING_RELEASED;
        case 0x34: return Position.PREFIX_IO + "4" + Position.ENDING_INACTIVE;
        case 0x35: return Position.PREFIX_IO + "5" + Position.ENDING_INACTIVE;
        case 0x50: return Position.ALARM_POWER_OFF;
        case 0x53: return Position.ALARM_GPS_ANTENNA_CUT;
        default: return null;
        }
    }

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

        ChannelBuffer buf = (ChannelBuffer) msg;
        buf.skipBytes(2); // header
        buf.readShort(); // length
        ChannelBuffer id = buf.readBytes(7);
        int command = buf.readUnsignedShort();
        ChannelBuffer response;

        switch (command) {
            case MSG_LOGIN:
                if (channel != null) {
                    response = ChannelBuffers.wrappedBuffer(new byte[] {0x01});
                    sendResponse(channel, remoteAddress, id, MSG_LOGIN_RESPONSE, response);
                }
                return null;
            case MSG_HEARTBEAT:
                if (channel != null) {
                    response = ChannelBuffers.wrappedBuffer(new byte[] {0x01});
                    sendResponse(channel, remoteAddress, id, MSG_HEARTBEAT, response);
                }
                return null;
            case MSG_SERVER:
                if (channel != null) {
                    response = ChannelBuffers.copiedBuffer(
                            getMeiligaoServer(channel), StandardCharsets.US_ASCII);
                    sendResponse(channel, remoteAddress, id, MSG_SERVER, response);
                }
                return null;
            case MSG_POSITION:
            case MSG_POSITION_LOGGED:
            case MSG_ALARM:
            case MSG_RFID:
                break;
            default:
                return null;
        }

        Position position = new Position();
        position.setProtocol(getProtocolName());

        // Custom data
        if (command == MSG_ALARM) {
            String alarm = decodeAlarm(buf.readUnsignedByte());
            if (alarm != null) {
                position.set(Position.KEY_ALARM, alarm);
            }
        } else if (command == MSG_POSITION_LOGGED) {
            buf.skipBytes(6);
        }

        DeviceSession deviceSession = identify(id, channel, remoteAddress);
        if (deviceSession == null) {
            return null;
        }
        position.setDeviceId(deviceSession.getDeviceId());

        if (command == MSG_RFID) {
            for (int i = 0; i < 15; i++) {
                long rfid = buf.readUnsignedInt();
                if (rfid != 0) {
                    String card = String.format("%010d", rfid);
                    position.set("card" + (i + 1), card);
                    position.set(Position.KEY_RFID, card);
                }
            }
        }

        Pattern pattern;
        if (command == MSG_RFID) {
            pattern = PATTERN_RFID;
        } else {
            pattern = PATTERN;
        }

        Parser parser = new Parser(
                pattern, buf.toString(buf.readerIndex(), buf.readableBytes() - 4, StandardCharsets.US_ASCII));
        if (!parser.matches()) {
            return null;
        }

        if (command == MSG_RFID) {

            DateBuilder dateBuilder = new DateBuilder()
                    .setTime(parser.nextInt(), parser.nextInt(), parser.nextInt())
                    .setDateReverse(parser.nextInt(), parser.nextInt(), parser.nextInt());
            position.setTime(dateBuilder.getDate());

            position.setValid(true);
            position.setLatitude(parser.nextCoordinate());
            position.setLongitude(parser.nextCoordinate());

        } else {

            DateBuilder dateBuilder = new DateBuilder()
                    .setTime(parser.nextInt(), parser.nextInt(), parser.nextInt());
            if (parser.hasNext()) {
                dateBuilder.setMillis(parser.nextInt());
            }

            position.setValid(parser.next().equals("A"));
            position.setLatitude(parser.nextCoordinate());
            position.setLongitude(parser.nextCoordinate());

            if (parser.hasNext()) {
                position.setSpeed(parser.nextDouble());
            }

            if (parser.hasNext()) {
                position.setCourse(parser.nextDouble());
            }

            dateBuilder.setDateReverse(parser.nextInt(), parser.nextInt(), parser.nextInt());
            position.setTime(dateBuilder.getDate());

            position.set(Position.KEY_HDOP, parser.next());

            if (parser.hasNext()) {
                position.setAltitude(parser.nextDouble());
            }

            position.set(Position.KEY_STATUS, parser.next());

            for (int i = 1; i <= 8; i++) {
                if (parser.hasNext()) {
                    position.set(Position.PREFIX_ADC + i, parser.nextInt(16));
                }
            }

            if (parser.hasNext()) {
                position.set(Position.KEY_GSM, parser.nextInt(16));
            }

            if (parser.hasNext()) {
                position.set(Position.KEY_ODOMETER, parser.nextLong(16));
            }
            if (parser.hasNext()) {
                position.set(Position.KEY_ODOMETER, parser.nextLong(16));
            }

            if (parser.hasNext()) {
                position.set(Position.KEY_RFID, parser.nextInt(16));
            }

        }

        return position;
    }

}