com.pi4j.io.serial.Serial Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pi4j-core Show documentation
Show all versions of pi4j-core Show documentation
Pi4J Java API & Runtime Library
package com.pi4j.io.serial;
/*
* #%L
* **********************************************************************
* ORGANIZATION : Pi4J
* PROJECT : Pi4J :: Java Library (Core)
* FILENAME : Serial.java
*
* This file is part of the Pi4J project. More information about
* this project can be found here: http://www.pi4j.com/
* **********************************************************************
* %%
* Copyright (C) 2012 - 2015 Pi4J
* %%
* This program 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 3 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 Lesser Public License for more details.
*
* You should have received a copy of the GNU General Lesser Public
* License along with this program. If not, see
* .
* #L%
*/
/**
* This interface provides a set of functions for 'Serial' communication.
*
*
* Before using the Pi4J library, you need to ensure that the Java VM in configured with access to
* the following system libraries:
*
* - pi4j
* - wiringPi
*
* This library depends on the wiringPi native system library. (developed by
* Gordon Henderson @ http://wiringpi.com/)
*
*
*
* @see com.pi4j.io.serial.SerialFactory
* @see com.pi4j.io.serial.SerialDataEvent
* @see com.pi4j.io.serial.SerialDataListener
*
* @see http://www.pi4j.com/
* @author Robert Savage (http://www.savagehomeautomation.com)
*/
@SuppressWarnings("unused")
public interface Serial {
/**
* The default hardware COM port provided via the Raspberry Pi GPIO header.
*
* @see #open(String, int)
*/
public static final String DEFAULT_COM_PORT = "/dev/ttyAMA0";
public static final int DEFAULT_MONITOR_INTERVAL = 100; // milliseconds
/**
* This method is call to open a serial port for communication.
*
* @see #DEFAULT_COM_PORT
*
* @param device The device address of the serial port to access. You can use constant
* 'DEFAULT_COM_PORT' if you wish to access the default serial port provided via the
* GPIO header.
* @param baudRate The baud rate to use with the serial port.
*
* @throws SerialPortException Exception thrown on any error.
*/
public void open(String device, int baudRate) throws SerialPortException;
/**
* This method is called to close a currently open open serial port.
*/
public void close() throws IllegalStateException;
/**
* This method is called to determine if the serial port is already open.
*
* @see #open(String, int)
* @return a value of 'true' is returned if the serial port is already open.
*/
public boolean isOpen();
/**
* This method is called to determine if the serial port is already closed.
*
* @see #open(String, int)
* @return a value of 'true' is returned if the serial port is already in the closed state.
*/
public boolean isClosed();
/**
* This method is called to immediately flush the serial data transmit buffer and force any
* pending data to be sent to the serial port immediately.
*/
public void flush() throws IllegalStateException;
/**
* This method will read the next character available from the serial port receive buffer.
*
* NOTE: If a serial data listener has been implemented and registered with this class, then
* this method should not be called directly. A background thread will be running to collect
* received data from the serial port receive buffer and the received data will be available on
* via the event.
*
*
* @return next available character in the serial data buffer
*/
public char read() throws IllegalStateException;
/**
* This method is called to submit a single character of data to the serial port transmit
* buffer.
*
* @param data A single character to be transmitted.
*/
public void write(char data) throws IllegalStateException;
/**
* This method is called to submit a character array of data to the serial port transmit buffer.
*
* @param data A character array of data to be transmitted.
*/
public void write(char data[]) throws IllegalStateException;
/**
* This method is called to submit a single byte of data to the serial port transmit buffer.
*
* @param data A single byte to be transmitted.
*/
public void write(byte data) throws IllegalStateException;
/**
* This method is called to submit a byte array of data to the serial port transmit buffer.
*
* @param data A byte array of data to be transmitted.
*/
public void write(byte data[]) throws IllegalStateException;
/**
* This method is called to submit a string of data to the serial port transmit buffer.
*
* @param data A string of data to be transmitted.
*/
public void write(String data) throws IllegalStateException;
/**
* This method is called to submit a string of data with trailing CR + LF characters to the
* serial port transmit buffer.
*
* @param data A string of data to be transmitted.
*/
public void writeln(String data) throws IllegalStateException;
/**
* This method is called to submit a string of formatted data to the serial port transmit
* buffer.
*
* @param data A string of formatted data to be transmitted.
* @param args A series of arguments that can be included for the format string variable
* replacements.
*/
public void write(String data, String... args) throws IllegalStateException;
/**
* This method is called to submit a string of formatted data with trailing CR + LF characters
* to the serial port transmit buffer.
*
* @param data A string of formatted data to be transmitted.
* @param args A series of arguments that can be included for the format string variable
* replacements.
*/
public void writeln(String data, String... args) throws IllegalStateException;
/**
* This method is called to determine if and how many bytes are available on the serial received
* data buffer.
*
* @return The number of available bytes pending in the serial received buffer is returned.
*/
public int availableBytes() throws IllegalStateException;
/**
*
* Java consumer code can call this method to register itself as a listener for serial data
* events.
*
*
* @see com.pi4j.io.serial.SerialDataListener
* @see com.pi4j.io.serial.SerialDataEvent
*
* @param listener A class instance that implements the SerialListener interface.
*/
public void addListener(SerialDataListener... listener);
/**
* Java consumer code can call this method to unregister itself as a listener for serial data
* events.
*
* @see com.pi4j.io.serial.SerialDataListener
* @see com.pi4j.io.serial.SerialDataEvent
*
* @param listener A class instance that implements the SerialListener interface.
*/
public void removeListener(SerialDataListener... listener);
/**
* This method returns TRUE if the serial interface has been shutdown.
*
* @return shutdown state
*/
public boolean isShutdown();
/**
* This method can be called to forcefully shutdown all serial data monitoring threads.
*/
public void shutdown();
/**
* This method returns the serial data receive monitor delay interval in milliseconds.
* @return interval milliseconds
*/
public int getMonitorInterval();
/**
* This method set the serial data receive monitor delay interval in milliseconds.
*
* @param interval number of milliseconds
*/
public void setMonitorInterval(int interval);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy