com.pi4j.io.serial.SerialDataWriter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of osgi.enroute.iot.pi.provider Show documentation
Show all versions of osgi.enroute.iot.pi.provider Show documentation
This bundle wraps Pi4j (http://pi4j.com) that wraps the native code Wiring Pi (http://wiringpi.com). It wraps these libraries to make them OSGi friendly and allow them to work together with the OSGi enRoute IoT circuit library (osgi.enroute.iot.circuit). The bundle will first use Pi4J to detect on what hardware it runs. If it runs on an appropriate type, it will register a component that can be configured with Metatype. The Metatype defines a full blown configuration template for all the Pi's functions. The GPIO's are registered as components for the circuit. Regardless of the success of the configuration, this bundle will also register a GpioController service, which is the main Pi4J class.
The newest version!
package com.pi4j.io.serial;
/*
* #%L
* **********************************************************************
* ORGANIZATION : Pi4J
* PROJECT : Pi4J :: Java Library (Core)
* FILENAME : SerialDataWriter.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%
*/
import java.io.IOException;
import java.io.InputStream;
import java.nio.ByteBuffer;
import java.nio.CharBuffer;
import java.nio.charset.Charset;
import java.util.Collection;
public interface SerialDataWriter {
// ----------------------------------------
// WRITE OPERATIONS
// ----------------------------------------
/**
* Sends an array of bytes to the serial port/device identified by the given file descriptor.
*
* @param data
* A ByteBuffer of data to be transmitted.
* @param offset
* The starting index (inclusive) in the array to send from.
* @param length
* The number of bytes from the byte array to transmit to the serial port.
*/
public void write(byte[] data, int offset, int length) throws IllegalStateException, IOException;
/**
* Sends one of more bytes to the serial device identified by the given file descriptor.
*
* @param data
* One or more bytes (or an array) of data to be transmitted. (variable-length-argument)
*/
public void write(byte ... data) throws IllegalStateException, IOException;
/**
* Sends one of more bytes arrays to the serial device identified by the given file descriptor.
*
* @param data
* One or more byte arrays of data to be transmitted. (variable-length-argument)
*/
public void write(byte[] ... data) throws IllegalStateException, IOException;
/**
* Read the content of byte buffer and write the data to the serial port transmit buffer.
* (The buffer is read from the current position up to the 'limit' value, not the 'capacity'. You may need to
* rewind() or flip() the byte buffer if you have just written to it.)
*
* @param data
* A ByteBuffer of data to be transmitted.
*/
public void write(ByteBuffer... data) throws IllegalStateException, IOException;
/**
* Read content from an input stream of data and write it to the serial port transmit buffer.
*
* @param input
* An InputStream of data to be transmitted
*/
public void write(InputStream input) throws IllegalStateException, IOException;
/**
* Sends an array of characters to the serial port/device identified by the given file descriptor.
*
* @param charset
* The character set to use for encoding/decoding bytes to/from text characters
* @param data
* An array of chars to be decoded into bytes and transmitted.
* @param offset
* The starting index (inclusive) in the array to send from.
* @param length
* The number of characters from the char array to transmit to the serial port.
*/
public void write(Charset charset, char[] data, int offset, int length) throws IllegalStateException, IOException;
/**
* Sends an array of characters to the serial port/device identified by the given file descriptor.
*
* @param charset
* The character set to use for encoding/decoding bytes to/from text characters
* @param data
* One or more characters (or an array) of data to be transmitted. (variable-length-argument)
*/
public void write(Charset charset, char ... data) throws IllegalStateException, IOException;
/**
* Sends an array of ASCII characters to the serial port/device identified by the given file descriptor.
*
* @param data
* One or more ASCII characters (or an array) of data to be transmitted. (variable-length-argument)
*/
public void write(char ... data) throws IllegalStateException, IOException;
/**
* Sends one or more CharBuffers to the serial port/device identified by the given file descriptor.
*
* @param charset
* The character set to use for encoding/decoding bytes to/from text characters
* @param data
* One or more CharBuffers (or an array) of data to be transmitted. (variable-length-argument)
*/
public void write(Charset charset, CharBuffer... data) throws IllegalStateException, IOException;
/**
* Sends one or more ASCII CharBuffers to the serial port/device identified by the given file descriptor.
*
* @param data
* One or more ASCII CharBuffers (or an array) of data to be transmitted. (variable-length-argument)
*/
public void write(CharBuffer ... data) throws IllegalStateException, IOException;
/**
* Sends one or more string objects to the serial port/device identified by the given file descriptor.
*
* @param charset
* The character set to use for encoding/decoding bytes to/from text characters
* @param data
* One or more string objects (or an array) of data to be transmitted. (variable-length-argument)
*/
public void write(Charset charset, CharSequence ... data) throws IllegalStateException, IOException;
/**
* Sends one or more ASCII string objects to the serial port/device identified by the given file descriptor.
*
* @param data
* One or more ASCII string objects (or an array) of data to be transmitted. (variable-length-argument)
*/
public void write(CharSequence ... data) throws IllegalStateException, IOException;
/**
* Sends a collection of string objects to the serial port/device identified by the given file descriptor.
*
* @param charset
* The character set to use for encoding/decoding bytes to/from text characters
* @param data
* A collection of string objects (or an array) of data to be transmitted. (variable-length-argument)
*/
public void write(Charset charset, Collection data) throws IllegalStateException, IOException;
/**
* Sends a collection of ASCII string objects to the serial port/device identified by the given file descriptor.
*
* @param data
* A collection of string objects (or an array) of data to be transmitted. (variable-length-argument)
*/
public void write(Collection data) throws IllegalStateException, IOException;
/**
* Sends one or more string objects each appended with a line terminator (CR+LF) to the serial port/device.
*
* @param charset
* The character set to use for encoding/decoding bytes to/from text characters
* @param data
* One or more string objects (or an array) of data to be transmitted. (variable-length-argument)
*/
public void writeln(Charset charset, CharSequence ... data) throws IllegalStateException, IOException;
/**
* Sends one or more ASCII string objects each appended with a line terminator (CR+LF) to the serial port/device.
*
* @param data
* One or more ASCII string objects (or an array) of data to be transmitted. (variable-length-argument)
*/
public void writeln(CharSequence ... data) throws IllegalStateException, IOException;
/**
* Sends a collection of string objects each appended with a line terminator (CR+LF) to the serial port/device.
*
* @param charset
* The character set to use for encoding/decoding bytes to/from text characters
* @param data
* A collection of string objects (or an array) of data to be transmitted. (variable-length-argument)
*/
public void writeln(Charset charset, Collection data) throws IllegalStateException, IOException;
/**
* Sends a collection of ASCII string objects each appended with a line terminator (CR+LF) to the serial port/device.
*
* @param data
* A collection of ASCII string objects (or an array) of data to be transmitted. (variable-length-argument)
*/
public void writeln(Collection data) throws IllegalStateException, IOException;
}