AVR Z-LINK®

RadioInterface.java

Go to the documentation of this file.

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

import java.util.Timer;

import javax.comm.SerialPort;
import javax.swing.event.EventListenerList;

import serialInterface.SerialStream;
import serialInterface.SerialStreamEvent;
import serialInterface.SerialStreamException;
import serialInterface.SerialStreamListener;


public class RadioInterface implements SerialStreamListener{
        
        private SerialStream io;
        private SerialPort openPort;
        private boolean IndicationsEnabled;
        private boolean CommandTimedOut;
        
        private EventListenerList NewAssociationIndicationListeners = new EventListenerList( );
        private EventListenerList NewDisassociationIndicationListeners = new EventListenerList( );
        private EventListenerList NewDataIndicationListeners = new EventListenerList( );
        
        
        /*
         * Time to wait blocking until a response should be available from the radio platform.
         */
        private int ResponseTimeOut = 5000;
        
        
        public RadioInterface( SerialPort portToUse ) throws RadioInterfaceStartException{
                
                try{
                        this.io = new SerialStream( portToUse );
                }catch( SerialStreamException sse ){

                        sse.printStackTrace( );
                        throw new RadioInterfaceStartException( "ERROR: Could not start the Radio Interface." );
                }
                
                this.openPort = portToUse;
                io.addSerialStreamEventListener( this );
                IndicationsEnabled = false;
                CommandTimedOut = false;
        }
        
        
        public void terminateCommunication( ){
                
                this.openPort.close( );
        }
        
        
        public boolean sendReset( ){
                
                return sendCommandToRadio( "AT+R", "OK" );
        }
        
        
        public boolean sendConfigure( String channel, String panID, String deviceType ) {
                
                //Coordinator
                if( deviceType.equals( "Coordinator" ) ){
                        
                        return sendCommandToRadio( "AT+C: " + channel + "," + panID + "," + 'C', "OK" );
                }
                //End Device    
                else{
                        
                        return sendCommandToRadio( "AT+C: " + channel + "," + panID + "," + 'E'
                                         , "OK" );
                }       
        }
        
        
        public boolean sendData( String data ){
                
                return sendCommandToRadio( "AT+T: " + Integer.toHexString( data.length( ) ).toUpperCase( ) + ',' + 
                                data, "OK" );
        }
        
        
        public boolean sendDisAssociate( ){
                
                return sendCommandToRadio( "AT+D", "OK" );
        }
        
        
        public void enableIndications( ){
                
                io.enableSerialStreamEvents( );
                IndicationsEnabled = true;
        }
        
        
        public void disableIndications( ){
                
                io.disableSerialStreamEvents( );
                IndicationsEnabled = false;
        }
        
        
        private boolean sendCommandToRadio( String cmd, String commandResponse ){
                
                CommandTimedOut = false;
                
                //Setup timer.
                Timer timer = new Timer( );
                TimeOut timerThread = new TimeOut( );
                timerThread.setCaller( this );
                timer.schedule( timerThread, ResponseTimeOut, ResponseTimeOut );
                
                //Send command to radio.
                io.sendData( cmd );
                
                //Wait for response to arrive or time-out. Blocking loop.
                for( ; ( io.getData( ) == null ) && ( !CommandTimedOut ); );
                
                //Stop timer.
                timer.cancel( );
                
                //Command timed out.
                if( CommandTimedOut ){
                        
                        return false;
                }
                
                else{
                        
                        //System.out.println( "Received from radio platform: " + io.getData() );
                        if( io.getData().equals( commandResponse ) ){
                                
                                return true;
                        }
                        
                        else{
                                
                                return false;
                        }
                }
        }

        
        public void setCommandTimedOut( ){
                CommandTimedOut = true;
        }
        
        
        public void SerialStreamEvent( SerialStreamEvent serialStreamEvent ){
                
                int i, ii;
                String response = serialStreamEvent.getResponse(  );
                String dataLength;
                
                //Events enabled.
                if( IndicationsEnabled ){
                        
                        //The received string has the correct preamble.
                        if( response.charAt( 0 ) == '+' ){
                                
                                //Read next character to find what type
                                //of indication this is.
                                switch( response.charAt( 1 ) ){
                                        
                                        //New Association Indication.
                                        case 'N':
                                                
                                                fireNewAssociationIndicationListeners( new NewAssociationIndication( ) );
                                                break;
                                                
                                        //New Disassociation Indication.
                                        case 'D':
                                                
                                                fireNewDisassociationIndicationListeners( new NewDisassociationIndication( ) );
                                                break;

                                        //New Data Indication.
                                        case 'T':
                                                
                                                //Loop through char 4 to 6 (length is worst case 3 chars).
                                                for( ii = 4; ( ii <= 6 );ii++ ){
                                                        
                                                        //Break as soon as the argument ends.
                                                        if( response.charAt( ii ) == ',' ){
                                                                
                                                                break;
                                                        }
                                                }
                                                   
                                                dataLength = response.substring( 4, ii );
                                                
                                                //Convert to integer representation
                                                i = Integer.parseInt( dataLength );
                                                
                                                //Extract "real" data
                                                ii++;
                                                String subMsg = response.substring( ii, ii+i );
                                                
                                                fireNewDataIndicationListeners( new NewDataIndication( subMsg, i ) );
                                                break;

                                        default:
                                                break;
                                }
                        }
                }
        }
        
        
        public void addNewAssociationIndicationListeners( NewAssociationIndicationListener naiListener ){

                NewAssociationIndicationListeners.add( NewAssociationIndicationListener.class, naiListener );
        }
        
        
        public void removeNewAssociationIndicationListeners( NewAssociationIndicationListener naiListener ){
                NewAssociationIndicationListeners.remove( NewAssociationIndicationListener.class, naiListener );
        }
        
        
        protected void fireNewAssociationIndicationListeners( NewAssociationIndication newDataEvent ){
                
                Object[ ] listeners = NewAssociationIndicationListeners.getListenerList( );
                int numberOfListeners = listeners.length;
                
                for( int i = 0; i < numberOfListeners; i+=2 ){
                        
                        if( listeners[ i ] == NewAssociationIndicationListener.class ){
                                ( (NewAssociationIndicationListener)listeners[ i + 1 ] ).NewAssociationIndicationEvent( newDataEvent );
                        }
                }
        }
        
        
        public void addNewDisassociationIndicationListeners( NewDisassociationIndicationListener ndiListener ){

                NewDisassociationIndicationListeners.add( NewDisassociationIndicationListener.class, ndiListener );
        }
        
        
        public void removeNewDisassociationIndicationListeners( NewDisassociationIndicationListener ndiListener ){
                NewDisassociationIndicationListeners.remove( NewDisassociationIndicationListener.class, ndiListener );
        }
        
        
        protected void fireNewDisassociationIndicationListeners( NewDisassociationIndication newDataEvent ){
                
                Object[ ] listeners = NewAssociationIndicationListeners.getListenerList( );
                int numberOfListeners = listeners.length;
                
                for( int i = 0; i < numberOfListeners; i+=2 ){
                        
                        if( listeners[ i ] == NewAssociationIndicationListener.class ){
                                ( (NewDisassociationIndicationListener)listeners[ i + 1 ] ).NewDisassociationIndicationEvent( newDataEvent );
                        }
                }
        }
        
        
        public void addNewDataIndicationListeners( NewDataIndicationListener ndiListener ){

                NewDataIndicationListeners.add( NewDataIndicationListener.class, ndiListener );
        }
        
        
        public void removeNewDataIndicationListeners( NewDataIndicationListener ndiListener ){
                NewDataIndicationListeners.remove( NewDataIndicationListener.class, ndiListener );
        }
        
        
        protected void fireNewDataIndicationListeners( NewDataIndication newDataEvent ){
                
                Object[ ] listeners = NewAssociationIndicationListeners.getListenerList( );
                int numberOfListeners = listeners.length;
                
                for( int i = 0; i < numberOfListeners; i+=2 ){
                        
                        if( listeners[ i ] == NewAssociationIndicationListener.class ){
                                ( (NewDataIndicationListener)listeners[ i + 1 ] ).NewDataIndicationEvent( newDataEvent );
                        }
                }
        }
}