org.bidib.jbidibc.BidibCommand Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jbidibc-tools Show documentation
jBiDiB jbidibc Tools POM
There is a newer version: 2.0.25
package org.bidib.jbidibc;

import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.concurrent.Callable;

import org.bidib.jbidibc.core.BidibFactory;
import org.bidib.jbidibc.core.BidibInterface;
import org.bidib.jbidibc.core.MessageListener;
import org.bidib.jbidibc.core.NodeListener;
import org.bidib.jbidibc.core.node.listener.TransferListener;
import org.bidib.jbidibc.messages.ConnectionListener;
import org.bidib.jbidibc.messages.exception.PortNotFoundException;
import org.bidib.jbidibc.messages.exception.PortNotOpenedException;
import org.bidib.jbidibc.messages.helpers.Context;
import org.bidib.jbidibc.messages.helpers.DefaultContext;
import org.bidib.jbidibc.rxtx.RxtxSerialBidib;
import org.bidib.jbidibc.simulation.comm.SimulationBidib;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import picocli.CommandLine;
import picocli.CommandLine.Command;
import picocli.CommandLine.Option;
import picocli.CommandLine.ParameterException;
import uk.org.lidalia.sysoutslf4j.context.LogLevel;
import uk.org.lidalia.sysoutslf4j.context.SysOutOverSLF4J;

@Command(separator = "=")
public abstract class BidibCommand implements Callable {
    private static final Logger LOGGER = LoggerFactory.getLogger(BidibCommand.class);

    @Option(names = {
        "-port" }, description = "Port to use, e.g. COM1. For simulation purposes use 'sim' to start the simulation.", required = true)
    private String portName;

    private Set transferListeners = new LinkedHashSet();

    private BidibInterface instance;

    protected String getPortName() {
        return portName;
    }

    /**
     * @return the connected BiDiB instance of {@code null} if connection is not established
     */
    protected BidibInterface getBidib() {
        return instance;
    }

    protected BidibCommand() {
        // redirect System.out and System.error calls to SLF4J
        SysOutOverSLF4J.sendSystemOutAndErrToSLF4J(LogLevel.INFO, LogLevel.WARN);
    }

    protected void openPort(String portName, Context context) throws PortNotFoundException, PortNotOpenedException {

        if (context == null) {
            // logger create empty context
            context = new DefaultContext();
        }

        transferListeners.add(new TransferListener() {

            @Override
            public void sendStopped() {
                // no implementation
            }

            @Override
            public void sendStarted() {
                // no implementation
            }

            @Override
            public void receiveStopped() {
                // no implementation
            }

            @Override
            public void receiveStarted() {
                // no implementation
            }

            @Override
            public void ctsChanged(boolean cts, boolean manualEvent) {
                // no implementation
            }
        });

        BidibInterface bidib = null;
        if (portName.toLowerCase().startsWith("sim")) {
            LOGGER.info("Create simulation instance of bidib.");
            bidib = SimulationBidib.createInstance(context);
        }
        else {
            LOGGER.info("Create RXTX instance of bidib.");
            bidib = BidibFactory.createBidib(RxtxSerialBidib.class.getName(), context);
        }

        bidib.open(portName, new ConnectionListener() {
            @Override
            public void opened(String port) {
                // no implementation
            }

            @Override
            public void closed(String port) {
                // no implementation
            }

            @Override
            public void status(String messageKey, final Context context) {
                // no implementation
            }

            @Override
            public void stall(boolean stall) {
                // no implementation
            }
        }, Collections. emptySet(), Collections. emptySet(), transferListeners, context);

        instance = bidib;
    }

    protected void releaseBidib() {

        if (instance != null) {
            instance.close();
        }

        instance = null;
    }

    /**
     * Execute the command
     * 
     * @return the exit code
     */
    @Override
    public abstract Integer call();

    public static void run(BidibCommand command, String[] args) {

        int exitCode = -1;

        try {
            CommandLine commandLine = new CommandLine(command);
            exitCode = commandLine.execute(args);
        }
        catch (ParameterException ex) {
            LOGGER.warn("Execution of " + command.getClass().getSimpleName() + " command failed: " + ex.getMessage());
        }
        System.exit(exitCode);
    }

}