AVR Z-LINK®

EventHandler.java

Go to the documentation of this file.

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

import javax.comm.SerialPort;

import radioInterface.NewAssociationIndication;
import radioInterface.NewAssociationIndicationListener;
import radioInterface.NewDataIndication;
import radioInterface.NewDataIndicationListener;
import radioInterface.NewDisassociationIndication;
import radioInterface.NewDisassociationIndicationListener;
import radioInterface.RadioInterface;
import radioInterface.RadioInterfaceStartException;
import serialInterface.SerialPortUtilities;

import gui.ChatWindow;
import gui.ChatWindowEvent;
import gui.ChatWindowEventListener;
import gui.Dialogs;
import gui.MainFrame;
import gui.MainFrameEvent;
import gui.MainFrameEventListener;


public class EventHandler implements NewAssociationIndicationListener, NewDisassociationIndicationListener,
                                                                  NewDataIndicationListener, MainFrameEventListener, ChatWindowEventListener{
        
        private static final int RETRY_LIMIT = 4;
        private static final int MAX_DATA_LENGTH = 30;
        private MainFrame Main;
        private ChatWindow chat;
        private RadioInterface radio;
        
        private boolean isConnected;
        private boolean isCoordinator;
        private boolean networkStarted;
        
        public EventHandler( MainFrame MainTab, ChatWindow ChatTab ){
                
                this.Main = MainTab;
                this.chat = ChatTab;
                this.radio = null;
                
                isConnected = false;
                isCoordinator = false;
                networkStarted = false;
                
                //Setup eventsystem from MainFrame, ChatWindow and RadioInterface.
                this.Main.addMainFrameEventListener( this );
                this.chat.addChatWindowEventListener( this );
        }
        
        
        /*=============================== EVENT HANDLERS ==============================*/
        
        public void NewAssociationIndicationEvent( NewAssociationIndication newAssociation ){
                
                if( isCoordinator ){
                        
                        networkStarted = true;
                        chat.clearConversation( );
                        chat.enableMessageWindow( );
                }
                
                else{
                        Dialogs.showPlainMessage( Main, "End-devices are not supposed to be open for association!" );
                }
        }
        
        public void NewDisassociationIndicationEvent( NewDisassociationIndication newDisAssociation ){
                // TODO Auto-generated method stub
        }
        
        public void NewDataIndicationEvent( NewDataIndication newData ){
                
                //Append new data.
                chat.appendIncommingMessage( newData.getNewData( ) );
        }
        
        public void MainFrameEvent( MainFrameEvent event ) {
                
                //Extract event type
                int eventType = event.getEventType( );
                
                //Connect to radio plaform.
                if( eventType == MainFrameEvent.CONNECT ){
                        
                        Main.clearDebugMesasges( );
                        Main.appendDebugMessage( "EVENT: Connect" );
                        
                        //Not connected.
                        if( !isConnected ){
                                
                                Main.appendDebugMessage( "Not connected...initialize radio interface." );
                                
                                //Try to open a new radio interface.
                                if( initializeRadio( ) ){
                                        
                                        Main.appendDebugMessage( "Radio interface initialized." );
                                        
                                        //See if the radio platform responds.
                                        if( sendResetWithRetry( ) ){
                                                
                                                isConnected = true;
                                                networkStarted = false;
                                                
                                                //Configure radio platform with user options
                                                if( configureRadioPlatform( ) ){
                                                                
                                                        //Coordinator.
                                                        if( isCoordinator ){
                                                                
                                                                chat.clearConversation( );
                                                                
                                                                Main.appendDebugMessage( "Coordinator Started." );
                                                                chat.appendTextToConversation( "Network not started yet." );
                                                        }
                                                        
                                                        else{
                                                                
                                                                Main.appendDebugMessage( "End-device Started." );
                                                                networkStarted = true;
                                                                chat.clearConversation( );
                                                                chat.enableMessageWindow( );
                                                        }
                                                        
                                                        Main.addChatTab( chat );
                                                        radio.addNewAssociationIndicationListeners( this );
                                                        radio.addNewDataIndicationListeners( this );
                                                        radio.addNewDisassociationIndicationListeners( this );
                                                        radio.enableIndications( );
                                                }
                                                
                                                else{
                                                        
                                                        isConnected = false;
                                                        radio.disableIndications( );
                                                        radio.removeNewAssociationIndicationListeners( this );
                                                        radio.removeNewDataIndicationListeners( this );
                                                        radio.removeNewDisassociationIndicationListeners( this );
                                                        radio.terminateCommunication( );
                                                        
                                                        Main.appendDebugMessage( "Network configuration and start-up failed." );
                                                        Dialogs.showPlainMessage( Main, "Unable to start network." );
                                                }
                                        }
                                        
                                        else{
                                                
                                                radio.terminateCommunication( );
                                                
                                                Main.appendDebugMessage( "AT-Command AT+R failed. Check serial connection." );
                                                Dialogs.showPlainMessage( Main, "Please connect radio platform first." );
                                        }
                                }
                                
                                //Not possible to open interface.
                                else{
                                        
                                        Main.appendDebugMessage( "Something went wrong during initialization." );
                                        Dialogs.showPlainMessage( Main, "Radio Interface could not be started." +
                                        "\r\nPlease try to reconnect!" );
                                }
                        }
                        
                        //Already connected.
                        else{
                                
                                Main.appendDebugMessage( "Already connected." );
                                Dialogs.showPlainMessage( Main, "You are already connected." );
                        }
                }
                
                //Disconnect from radio platform.
                else if( eventType == MainFrameEvent.DISCONNECT ){
                        
                        Main.appendDebugMessage( "EVENT: Disconnect" );
                        
                        //Not connected.
                        if( isConnected == false ){
                                
                                Main.appendDebugMessage( "You are not connected." );
                                Dialogs.showPlainMessage( Main, "You are not connected." );
                        }
                        
                        //Disconnect
                        else{
                                
                                Main.appendDebugMessage( "You are connected...terminating RF link." );
                                Main.clearDebugMesasges( );
                                
                                isConnected = false;
                                isCoordinator = false;
                                networkStarted = false;
                                radio.terminateCommunication( );
                                
                                chat.disableMessageWindow( );
                                Main.closeChatTab( chat );
                        }
                }
                
                //Clear debug message window.
                else{
                        
                        Main.clearDebugMesasges( );
                }
        }

        public void ChatWindowEvent( ChatWindowEvent event ) {

                int eventType = event.getEventType( );
                String Message = event.getData( );
                
                //Send message
                if( ( eventType == ChatWindowEvent.ENTER ) || ( eventType == ChatWindowEvent.SEND ) ){
                        
                        //OK to send message if peer-to-peer connection is established.
                        if( networkStarted ){
                                
                                sendMessage( Message );
                        }
                        
                        else{
                                
                                Dialogs.showPlainMessage( Main, "Not possible to send data until connection is established.");
                        }
                }
                
                //Clear message window.
                else{
                        
                        chat.clearMessage( );
                }
        }
        
        /*=============================== HELPER FUNCTIONS ============================*/
        
        private boolean initializeRadio( ){
                
                //Find a serial port.
                SerialPort portToUse = Dialogs.chooseSerialPort( Main );
                //Proceed if a port was found, set baud rate.
                if( ( portToUse != null ) && ( SerialPortUtilities.setBaudRate( portToUse, 38400 ) ) ){
                        
                        Main.appendDebugMessage( "Serial Port: " + portToUse.getName() + " open." );
                        
                        try{
                                radio = new RadioInterface( portToUse );
                        }catch( RadioInterfaceStartException rise ){
                                
                                Main.appendDebugMessage( "Failed to open RadioInterface." );
                                rise.printStackTrace( );
                                portToUse.close( );
                                
                                return false;
                        }
                        
                        return true;
                }
                
                //Not able to initialize radio interface.
                else{
                        //Close serial port if it was opened.
                        if( portToUse != null ){
                                portToUse.close( );
                        }
                        
                        return false;
                }
        }
        
        private boolean sendResetWithRetry( ){
                
                int retryCount = 0;
                
                do{
                        
                        Main.appendDebugMessage( "Send AT+R." );
                        //No retry
                        if( radio.sendReset( ) ){
                                
                                Main.appendDebugMessage( "AT+R command successful." );
                                return true;
                        }
                        //Retry
                        else{
                                
                                int responseFromUser = Dialogs.showRetryMessage( Main );

                                //Retry
                                if( responseFromUser != 0 ){
                                        
                                        Main.appendDebugMessage( "AT+R command failed." );
                                        return false;
                                }       
                        }
                        
                        retryCount++;
                }
                while( retryCount < RETRY_LIMIT );
                
                Main.appendDebugMessage( "AT+R command failed." );
                Dialogs.showErrorMessage( Main, "Too many retries." );
                return false;           
        }
        
        private boolean configureRadioPlatform( ){
                
                String[ ] userOptions = Dialogs.showConfigurationDialog( Main );
                
                if( userOptions[ 2 ].equals( "EndDevice" ) ){
                
                        isCoordinator = false;
                }
                
                else{
                        
                        isCoordinator = true;
                }
                
                return sendConfigureWithRetry( userOptions[ 0 ], userOptions[ 1 ], userOptions[ 2 ] );
        }
        
        private boolean sendConfigureWithRetry( String channel, String panID, String deviceType ){
                
                int retryCount = 0;
                
                do{
                        
                        Main.appendDebugMessage( "Send AT+C." );
                        
                        //No retry
                        if( radio.sendConfigure( channel, panID, deviceType ) ){
                                
                                Main.appendDebugMessage( "AT+C command successful." );
                                return true;
                        }
                        //Retry
                        else{
                                
                                int responseFromUser = Dialogs.showRetryMessage( Main );

                                //Retry
                                if( responseFromUser != 0 ){
                                        
                                        Main.appendDebugMessage( "AT+C command failed." );
                                        return false;
                                }       
                        }
                        
                        retryCount++;
                }
                while( retryCount < RETRY_LIMIT );
                
                Main.appendDebugMessage( "AT+C command failed." );
                Dialogs.showErrorMessage( Main, "Too many retries." );
                return false;
        }
        
        public void sendMessage( String Message ){
                
                //Find length and check if possible to send...30 bytes.
                int dataLength = Message.length( );
                
                //Zero, do not send anything.
                if( dataLength == 0 ){
                
                        Dialogs.showErrorMessage( Main, "Pointless to send empty message." );
                }
                
                //Allowed length. Send data.
                else if( dataLength < MAX_DATA_LENGTH  ){
                        
                        if( sendData( Message ) ){
                                
                                chat.appendOutgoingMessage( Message );
                                chat.clearMessage( );
                        }
                }
                
                //Message to long. MAX 30 symbols.
                else{
                        
                        Dialogs.showErrorMessage( Main, "Message too long." );
                        chat.clearMessage( );
                }
        }
        
        private boolean sendData( String data ){
                
                int retryCount = 0;
                
                do{
                        
                        Main.appendDebugMessage( "Send AT+T. Message: ' " + data + " '" );
                        
                        //No retry
                        if( radio.sendData( data ) ){
                                
                                Main.appendDebugMessage( "AT+T command successful." );
                                return true;
                        }
                        //Retry
                        else{
                                
                                int responseFromUser = Dialogs.showRetryMessage( Main );

                                //Retry
                                if( responseFromUser != 0 ){
                                        
                                        Main.appendDebugMessage( "AT+T command failed." );
                                        return false;
                                }       
                        }
                        
                        retryCount++;
                }
                while( retryCount < RETRY_LIMIT );
                
                Main.appendDebugMessage( "AT+T command failed." );
                Dialogs.showErrorMessage( Main, "Too many retries." );
                return false;
        }       
}