AVR Z-LINK®

SerialPortUtilities.java

Go to the documentation of this file.

/* This file has been prepared for Doxygen automatic documentation generation.*/
package serialInterface;

import java.util.Enumeration;
import java.util.TooManyListenersException;
import java.util.Vector;

import javax.comm.CommPortIdentifier;
import javax.comm.PortInUseException;
import javax.comm.SerialPort;
import javax.comm.SerialPortEventListener;
import javax.comm.UnsupportedCommOperationException;


public class SerialPortUtilities{


        public static Vector<String> getSerialPortNames( ){
                
                Vector<String> serialPortNames = new Vector<String>( ); 
                Enumeration availablePorts = CommPortIdentifier.getPortIdentifiers( );
                
                //Run through list of available ports
                for( ; availablePorts.hasMoreElements( ); ){
                        
                        CommPortIdentifier currentPort = (CommPortIdentifier)availablePorts.nextElement ( );
                        
                        //Only add ports that is of type serial port and those not already in use.
                        if( ( currentPort.getPortType( ) == CommPortIdentifier.PORT_SERIAL ) &&
                                        ( currentPort.isCurrentlyOwned( ) == false ) ){
                                
                                serialPortNames.add( currentPort.getName( ) );
                        }
                }
                
                return serialPortNames;
        }
        
        public static SerialPort connectToSerialPort( String serialPortName ){
                
                //Get identifiers.
                Enumeration availablePorts = CommPortIdentifier.getPortIdentifiers( );
                SerialPort ret = null;
                
                //Loop through the list of CommPortIdentifiers.
                for( ; availablePorts.hasMoreElements( ); ){
                        
                        CommPortIdentifier currentPort = ( CommPortIdentifier )availablePorts.nextElement ( );
                        
                        String currentPortName = ( String )currentPort.getName( );
                        
                        //Found a match; try to open and if possible return.
                        if( currentPortName.equals( serialPortName ) ){
                                
                                try{
                                        ret = ( SerialPort )currentPort.open( "AVR SerialPortLibrary" , 200 );
                                }catch( PortInUseException piue ){
                                        
                                        piue.printStackTrace( );
                                        ret = null;
                                }
                                
                                break;
                        }
                }
                
                return ret;
        }
        
        public static boolean setBaudRate( SerialPort portToConfigure, final int BAUD_RATE ){
                
                try{
                        portToConfigure.setSerialPortParams( BAUD_RATE, SerialPort.DATABITS_8, SerialPort.STOPBITS_1,
                                                                                                  SerialPort.PARITY_NONE );
                }catch( UnsupportedCommOperationException ucoe ){
                        
                        ucoe.printStackTrace( );
                        return false;
                }
                
                return true;
        }
        
        public static boolean addSerialEventListener( SerialPort portToAddListener, SerialPortEventListener listener ){

                try{
                        portToAddListener.addEventListener( listener );
                }catch( TooManyListenersException tmle ){

                        tmle.printStackTrace( );
                        return false;
                }
                
                //Set the listener trig on DataAvailable events.
                portToAddListener.notifyOnDataAvailable( true );
                
                return true;
        }
}