lejos.hardware.port.UARTPort Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lejos-ev3-api Show documentation
leJOS (pronounced like the Spanish word "lejos" for "far") is a tiny Java Virtual Machine. In 2013 it was ported to the LEGO EV3 brick.
The newest version!
package lejos.hardware.port;


public interface UARTPort extends IOPort, BasicSensorPort
{
    public static final int UART_RAW_MODE = -1;

    /**
     * read a single byte from the device
     * @return the byte value
     */
    public byte getByte();

    /**
     * read a number of bytes from the device
     * @param vals byte array to accept the data
     * @param offset offset at which to store the data
     * @param len number of bytes to read
     */
    public void getBytes(byte [] vals, int offset, int len);

    /**
     * read a single short from the device.
     * @return the short value
     */
    public int getShort();
   
    /**
     * read a number of shorts from the device
     * @param vals short array to accept the data
     * @param offset offset at which to store the data
     * @param len number of shorts to read
     */
    public void getShorts(short [] vals, int offset, int len);

    /**
     * Get the string name of the specified mode.

     * TODO: Make other mode data available.
     * @param mode mode to lookup
     * @return String version of the mode name
     */
    public String getModeName(int mode);

    /**
     * Return the current sensor reading to a string. 
     */
    public String toString();

    /**
     * Initialise the attached sensor and set it to the required operating mode.

     * Note: This method is not normally needed as the sensor will be initialised
     * when it is opened. However it may be of use if the sensor needs to be reset
     * or in other cases.
     * @param mode target mode
     * @return true if ok false if error
     */
    boolean initialiseSensor(int mode);

    /**
     * Reset the attached sensor. Following this the sensor must be initialised
     * before it can be used.
     */
    void resetSensor();

    /**
     * Write bytes to the sensor
     * @param buffer bytes to be written
     * @param offset offset to the start of the write
     * @param len length of the write
     * @return number of bytes written
     */
    int write(byte[] buffer, int offset, int len);
    
    /**
     * Read bytes from the uart port. If no bytes are available return 0.

     * Note: The port must have been set into RAW mode to use this method.
     * @param buffer The buffer to store the read bytes
     * @param offset The offset at which to start storing the bytes
     * @param len The maximum number of bytes to read
     * @return The actual number of bytes read
     */
    public int rawRead(byte[] buffer, int offset, int len);

    /**
     * Attempt to write a series of bytes to the uart port. This call
     * is non-blocking if there is no space in the write buffer a count
     * of 0 is returned.
     * Note: The port must have been set into RAW mode before attempting
     * to use the method.
     * @param buffer The buffer containing the bytes to write
     * @param offset The offset of the first byte
     * @param len The number of bytes to attempt to write
     * @return The actual number of bytes written
     */
    public int rawWrite(byte[] buffer, int offset, int len);
    
    /**
     * Set the bit rate of the port when operating in RAW mode.
     * @param bitRate The new bit rate
     */
    public void setBitRate(int bitRate);

}