ReadEcuCodesAction.java

/*
 * RomRaider Open-Source Tuning, Logging and Reflashing
 * Copyright (C) 2006-2014 RomRaider.com
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

package com.romraider.logger.ecu.ui.swing.menubar.action;

import static javax.swing.JOptionPane.ERROR_MESSAGE;
import static javax.swing.JOptionPane.INFORMATION_MESSAGE;
import static javax.swing.JOptionPane.OK_OPTION;
import static javax.swing.JOptionPane.WARNING_MESSAGE;
import static javax.swing.JOptionPane.YES_NO_OPTION;
import static javax.swing.JOptionPane.showConfirmDialog;
import static javax.swing.JOptionPane.showMessageDialog;

import java.awt.event.ActionEvent;

import com.romraider.logger.ecu.EcuLogger;
import com.romraider.swing.menubar.action.AbstractAction;

public final class ReadEcuCodesAction extends AbstractAction {
    public ReadEcuCodesAction(EcuLogger logger) {
        super(logger);
    }

    public final void actionPerformed(ActionEvent actionEvent) {
        if (logger.getDtcodesEmpty()) {
            final String wrongDefVersion = "To read diagnostic codes the " +
                    "Logger requires a logger definfition\n" +
                    "XML file containing compatible DTC parameter definitions.\n" +
                    "Use the Help menu 'Update Logger Definition' item to\n" +
                    "go online and download the latest logger definition.\n";
            showMessageDialog(logger,
                    wrongDefVersion,
                    "Definition Error", ERROR_MESSAGE);
        }
        else if (!logger.isEcuInit()) {
            final String notInit = "To read diagnostic codes the " +
                    "Logger must first intialize with the\n" + 
                    logger.getTarget() +
                    ". Press the Restart button to connect with the Logger then\n" +
                    "try reading the codes again.\n";
            showMessageDialog(logger,
                    notInit,
                    "Not Initialized", ERROR_MESSAGE);
        }
        else {
            final boolean logging = logger.isLogging();
            if (showConfirmation() == OK_OPTION) {
                if (logging) logger.stopLogging();
                readEcu();
                if (logging) logger.startLogging();
            }
        }
    }

    private final int showConfirmation() {
        return showConfirmDialog(
                logger, 
                "Do you want to read the " + logger.getTarget() + 
                " diagnostic codes?", 
                "Read " + logger.getTarget() + " diagnostic codes", 
                YES_NO_OPTION, WARNING_MESSAGE);
    }

    private final void readEcu() {
        final int result = doRead();
        if (result == -1) {
            showMessageDialog(
                    logger, 
                    "No diagnostic codes set.", "Read Success",
                    INFORMATION_MESSAGE);
        }
        else if (result == 0) {
            showMessageDialog(
                    logger, 
                    "Error reading " + logger.getTarget() + " diagnostic codes.\n" + 
                    "Check the following:\n" + 
                    "* Logger has successfully conencted to the ECU\n" +
                    "* Correct COM port is selected (if not Openport 2)\n" +
                    "* Cable is connected properly\n* Ignition is ON\n* " + 
                    "* Logger definition XML file is up to date", 
                    "Error Read " + logger.getTarget(), ERROR_MESSAGE);
        }
    }

    private int doRead() {
        try {
            return logger.readEcuCodes();
        } catch (Exception e) {
            logger.reportError(
                    "Error performing " + logger.getTarget() + " codes read", e);
            return 0;
        }
    }
}