gnu.io.RS485 Maven / Gradle / Ivy

Go to download
/*
 * Copyright 1997-2009 by Trent Jarvi and others
 * Copyright 1998 Kevin Hester, [email protected]
 * Copyright 2016 Fraunhofer ISE and others
 *
 * This file is part of jRxTx.
 * jRxTx is a fork of RXTX originally maintained by Trent Jarvi.
 *
 * jRxTx is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * jRxTx 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with jRxTx.  If not, see .
 *
 */
package gnu.io;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.TooManyListenersException;

final class RS485 extends RS485Port {

    static {
        System.loadLibrary("rxtxRS485");
        Initialize();
    }

    /** Initialize the native library */
    private native static void Initialize();

    /** Actual RS485Port wrapper class */

    /** Open the named port */
    public RS485(String name) throws PortInUseException {
        fd = open(name);
    }

    private native int open(String name) throws PortInUseException;

    /** File descriptor */
    private int fd;

    /** DSR flag **/
    static boolean dsrFlag = false;

    /** Output stream */
    private final RS485OutputStream out = new RS485OutputStream();

    @Override
    public OutputStream getOutputStream() {
        return out;
    }

    @Override
    public OutputStream outputStream() {
        return out;
    }

    /** Input stream */
    private final RS485InputStream in = new RS485InputStream();

    @Override
    public InputStream getInputStream() {
        return in;
    }

    @Override
    public InputStream inputStream() {
        return in;
    }

    /** Set the RS485Port parameters */
    @Override
    public void setRS485PortParams(int b, int d, int s, int p) throws UnsupportedCommOperationException {
        nativeSetRS485PortParams(b, d, s, p);
        speed = b;
        dataBits = d;
        stopBits = s;
        parity = p;
    }

    /** Set the native RS485 port parameters */
    private native void nativeSetRS485PortParams(int speed, int dataBits, int stopBits, int parity)
            throws UnsupportedCommOperationException;

    /** Line speed in bits-per-second */
    private int speed = 9600;

    @Override
    public int getBaudRate() {
        return speed;
    }

    /** Data bits port parameter */
    private int dataBits = DATABITS_8;

    @Override
    public int getDataBits() {
        return dataBits;
    }

    /** Stop bits port parameter */
    private int stopBits = RS485Port.STOPBITS_1;

    @Override
    public int getStopBits() {
        return stopBits;
    }

    /** Parity port parameter */
    private int parity = RS485Port.PARITY_NONE;

    @Override
    public int getParity() {
        return parity;
    }

    /** Flow control */
    private int flowmode = RS485Port.FLOWCONTROL_NONE;

    @Override
    public void setFlowControlMode(int flowcontrol) {
        try {
            setflowcontrol(flowcontrol);
        } catch (IOException e) {
            e.printStackTrace();
            return;
        }
        flowmode = flowcontrol;
    }

    @Override
    public int getFlowControlMode() {
        return flowmode;
    }

    native void setflowcontrol(int flowcontrol) throws IOException;

    /*
     * linux/drivers/char/n_hdlc.c? FIXME [email protected]
     */
    /**
     * Receive framing control
     */
    @Override
    public void enableReceiveFraming(int f) throws UnsupportedCommOperationException {
        throw new UnsupportedCommOperationException("Not supported");
    }

    @Override
    public void disableReceiveFraming() {
    }

    @Override
    public boolean isReceiveFramingEnabled() {
        return false;
    }

    @Override
    public int getReceiveFramingByte() {
        return 0;
    }

    /** Receive timeout control */
    private int timeout = 0;

    public native int NativegetReceiveTimeout();

    public native boolean NativeisReceiveTimeoutEnabled();

    public native void NativeEnableReceiveTimeoutThreshold(int time, int threshold, int InputBuffer);

    @Override
    public void disableReceiveTimeout() {
        enableReceiveTimeout(0);
    }

    @Override
    public synchronized int commPortTimeout() {
        return this.timeout;
    }

    @Override
    public void enableReceiveTimeout(int time) {
        if (time >= 0) {
            timeout = time;
            NativeEnableReceiveTimeoutThreshold(time, threshold, InputBuffer);
        }
        else {
            System.out.println("Invalid timeout");
        }
    }

    @Override
    public boolean isReceiveTimeoutEnabled() {
        return (NativeisReceiveTimeoutEnabled());
    }

    @Override
    public int getReceiveTimeout() {
        return (NativegetReceiveTimeout());
    }

    /** Receive threshold control */

    private int threshold = 0;

    @Override
    public void enableReceiveThreshold(int thresh) {
        if (thresh >= 0) {
            threshold = thresh;
            NativeEnableReceiveTimeoutThreshold(timeout, threshold, InputBuffer);
        }
        else /* invalid thresh */
        {
            System.out.println("Invalid Threshold");
        }
    }

    @Override
    public void disableReceiveThreshold() {
        enableReceiveThreshold(0);
    }

    @Override
    public int getReceiveThreshold() {
        return threshold;
    }

    @Override
    public boolean isReceiveThresholdEnabled() {
        return (threshold > 0);
    }

    /** Input/output buffers */
    /**
     * FIXME I think this refers to FOPEN(3)/SETBUF(3)/FREAD(3)/FCLOSE(3) [email protected]
     * 
     * These are native stubs...
     */
    private int InputBuffer = 0;
    private int OutputBuffer = 0;

    @Override
    public void setInputBufferSize(int size) {
        InputBuffer = size;
    }

    @Override
    public int getInputBufferSize() {
        return (InputBuffer);
    }

    @Override
    public void setOutputBufferSize(int size) {
        OutputBuffer = size;
    }

    @Override
    public int getOutputBufferSize() {
        return (OutputBuffer);
    }

    /** Line status methods */
    @Override
    public native boolean isDTR();

    @Override
    public native void setDTR(boolean state);

    @Override
    public native void setRTS(boolean state);

    private native void setDSR(boolean state);

    @Override
    public native boolean isCTS();

    @Override
    public native boolean isDSR();

    @Override
    public native boolean isCD();

    @Override
    public native boolean isRI();

    @Override
    public native boolean isRTS();

    /** Write to the port */
    @Override
    public native void sendBreak(int duration);

    private native void writeByte(int b) throws IOException;

    private native void writeArray(byte b[], int off, int len) throws IOException;

    private native void drain() throws IOException;

    /** RS485 read methods */
    private native int nativeavailable() throws IOException;

    private native int readByte() throws IOException;

    private native int readArray(byte b[], int off, int len) throws IOException;

    /** RS485 Port Event listener */
    private RS485PortEventListener SPEventListener;

    /** Thread to monitor data */
    private MonitorThread monThread;

    /** Process RS485PortEvents */
    native void eventLoop();

    private int dataAvailable = 0;

    public void sendEvent(int event, boolean state) {
        switch (event) {
        case RS485PortEvent.DATA_AVAILABLE:
            dataAvailable = 1;
            if (monThread.Data) {
                break;
            }
            return;
        case RS485PortEvent.OUTPUT_BUFFER_EMPTY:
            if (monThread.Output) {
                break;
            }
            return;
        /*
         * if( monThread.DSR ) break; return; if (isDSR()) { if (!dsrFlag) { dsrFlag = true; RS485PortEvent e = new
         * RS485PortEvent(this, RS485PortEvent.DSR, !dsrFlag, dsrFlag ); } } else if (dsrFlag) { dsrFlag = false;
         * RS485PortEvent e = new RS485PortEvent(this, RS485PortEvent.DSR, !dsrFlag, dsrFlag ); }
         */
        case RS485PortEvent.CTS:
            if (monThread.CTS) {
                break;
            }
            return;
        case RS485PortEvent.DSR:
            if (monThread.DSR) {
                break;
            }
            return;
        case RS485PortEvent.RI:
            if (monThread.RI) {
                break;
            }
            return;
        case RS485PortEvent.CD:
            if (monThread.CD) {
                break;
            }
            return;
        case RS485PortEvent.OE:
            if (monThread.OE) {
                break;
            }
            return;
        case RS485PortEvent.PE:
            if (monThread.PE) {
                break;
            }
            return;
        case RS485PortEvent.FE:
            if (monThread.FE) {
                break;
            }
            return;
        case RS485PortEvent.BI:
            if (monThread.BI) {
                break;
            }
            return;
        default:
            System.err.println("unknown event:" + event);
            return;
        }
        RS485PortEvent e = new RS485PortEvent(this, event, !state, state);
        if (SPEventListener != null) {
            SPEventListener.RS485Event(e);
        }
    }

    /** Add an event listener */
    @Override
    public void addEventListener(RS485PortEventListener lsnr) throws TooManyListenersException {
        if (SPEventListener != null) {
            throw new TooManyListenersException();
        }
        SPEventListener = lsnr;
        monThread = new MonitorThread();
        monThread.start();
    }

    /** Remove the RS485 port event listener */
    @Override
    public void removeEventListener() {
        SPEventListener = null;
        if (monThread != null) {
            monThread.interrupt();
            monThread = null;
        }
    }

    @Override
    public void notifyOnDataAvailable(boolean enable) {
        monThread.Data = enable;
    }

    @Override
    public void notifyOnOutputEmpty(boolean enable) {
        monThread.Output = enable;
    }

    @Override
    public void notifyOnCTS(boolean enable) {
        monThread.CTS = enable;
    }

    @Override
    public void notifyOnDSR(boolean enable) {
        monThread.DSR = enable;
    }

    @Override
    public void notifyOnRingIndicator(boolean enable) {
        monThread.RI = enable;
    }

    @Override
    public void notifyOnCarrierDetect(boolean enable) {
        monThread.CD = enable;
    }

    @Override
    public void notifyOnOverrunError(boolean enable) {
        monThread.OE = enable;
    }

    @Override
    public void notifyOnParityError(boolean enable) {
        monThread.PE = enable;
    }

    @Override
    public void notifyOnFramingError(boolean enable) {
        monThread.FE = enable;
    }

    @Override
    public void notifyOnBreakInterrupt(boolean enable) {
        monThread.BI = enable;
    }

    /** Close the port */
    private native void nativeClose();

    @Override
    public void close() {
        setDTR(false);
        setDSR(false);
        nativeClose();
        super.close();
        fd = 0;
    }

    /** Finalize the port */
    @Override
    protected void finalize() {
        if (fd > 0) {
            close();
        }
    }

    /** Inner class for RS485OutputStream */
    class RS485OutputStream extends OutputStream {
        @Override
        public void write(int b) throws IOException {
            writeByte(b);
        }

        @Override
        public void write(byte b[]) throws IOException {
            writeArray(b, 0, b.length);
        }

        @Override
        public void write(byte b[], int off, int len) throws IOException {
            writeArray(b, off, len);
        }

        @Override
        public void flush() throws IOException {
            drain();
        }
    }

    /** Inner class for RS485InputStream */
    class RS485InputStream extends InputStream {
        @Override
        public int read() throws IOException {
            dataAvailable = 0;
            return readByte();
        }

        @Override
        public int read(byte b[]) throws IOException {
            return read(b, 0, b.length);
        }

        @Override
        public int read(byte b[], int off, int len) throws IOException {
            dataAvailable = 0;
            int i = 0, Minimum = 0;
            int intArray[] = { b.length, InputBuffer, len };
            /*
             * find the lowest nonzero value timeout and threshold are handled on the native side see
             * NativeEnableReceiveTimeoutThreshold in RS485Imp.c
             */
            while (intArray[i] == 0 && i < intArray.length) {
                i++;
            }
            Minimum = intArray[i];
            while (i < intArray.length) {
                if (intArray[i] > 0) {
                    Minimum = Math.min(Minimum, intArray[i]);
                }
                i++;
            }
            Minimum = Math.min(Minimum, threshold);
            if (Minimum == 0) {
                Minimum = 1;
            }
            int Available = available();
            int Ret = readArray(b, off, Minimum);
            return Ret;
        }

        @Override
        public int available() throws IOException {
            return nativeavailable();
        }
    }

    class MonitorThread extends Thread {
        /**
         * Note: these have to be separate boolean flags because the RS485PortEvent constants are NOT bit-flags, they
         * are just defined as integers from 1 to 10 -DPL
         */
        private boolean CTS = false;
        private boolean DSR = false;
        private boolean RI = false;
        private boolean CD = false;
        private boolean OE = false;
        private boolean PE = false;
        private boolean FE = false;
        private boolean BI = false;
        private boolean Data = false;
        private boolean Output = false;

        MonitorThread() {
            setDaemon(true);
        }

        @Override
        public void run() {
            eventLoop();
        }
    }
}