AVR Z-LINK®

atParser.h File Reference

---

Detailed Description

Header file for the atParser.c.

Application note:

AVR414: User's Guide - ATAVRRZ502 - Accessory Kit

Documentation

For comprehensive code documentation, supported compilers, compiler settings and supported devices see readme.html

Author:

Atmel Corporation: http://www.atmel.com
Support email: avr@atmel.com

Name

Revision

1.2

RCSfile

ATInterface.h,v

Date

2006/09/15 17:02:19

Definition in file atParser.h.

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	DEVICE_TYPE_COORDINATOR   'C'
#define	DEVICE_TYPE_END_DEVICE   'E'
Functions
void	handleNewCommand (void)
	This function is called to handle a newly arrived AT command.

---

Define Documentation

#define DEVICE_TYPE_COORDINATOR   'C'

Definition at line 29 of file atParser.h.

Referenced by handleNewCommand().

#define DEVICE_TYPE_END_DEVICE   'E'

Definition at line 30 of file atParser.h.

Referenced by handleNewCommand().

---

Function Documentation

void handleNewCommand

(

void

)

This function is called to handle a newly arrived AT command.

When new data/a command is received through one of the serial interfaces (USART or USB) it must be parsed. The parsing procedure is done as follows:

1. extract AT command field from data buffer.
2. check if the received command is one of the four valid.
3. if valid:
   
   • check if it is possible to execute the command. That the current state is valid etc.
   • extract and check range of associated parameters. Return with DATA_CONVERSION_FAILED if the check failed.
   • start execution by calling one of the internal (static) members in this file.
4. if not valid:
   • return with error messsage (UNKNOWN_AT_COMMAND).

Definition at line 77 of file atParser.c.

References ATC, ATD, ATR, ATT, CHAT_CONNECTED, CHAT_IDLE, CHAT_RESET_PENDING, chatChannel, chatPANID, COORDINATOR, DATA_CONVERSION_FAILED, DEVICE_TYPE_COORDINATOR, DEVICE_TYPE_END_DEVICE, END_DEVICE, getATCommand(), getParameterNumber(), htoi16(), htoi8(), INCONSISTENT_STATE, INVALID_REQUEST, PARAMETER_1, PARAMETER_2, PARAMETER_3, role, sendERROR(), sendMsg(), startNetworkOperation(), state, stopNetworkOperation(), stringCompare(), UNKNOWN_AT_COMMAND, and UNKNOWN_DEVICE_TYPE.

Referenced by main().

                             {

        uint8_t *ATCommand;
        uint8_t *msg;
        uint8_t msgLength;
        uint8_t deviceType;
        
        //Read new AT-Command from the receive buffer.
        ATCommand = getATCommand( );
        
        //Check if the received command is known.

        //Start network operation.
        if( stringCompare( ATCommand, ATC ) ){
                
                //Ensure that this function is only called after reset.
                if( state != CHAT_IDLE ){
                        
                        sendERROR( INVALID_REQUEST );
                        return;
                }

                //Extract and check channel to chat on.
                if( !htoi8( getParameterNumber( PARAMETER_1 ), &chatChannel  ) ){
                
                        //Error occured during conversion.      Send error message and end.
                        sendERROR( DATA_CONVERSION_FAILED );
                        return;
                }
                
                //Extract and check PANID.
                if( !htoi16( getParameterNumber( PARAMETER_2 ), &chatPANID ) ){
                
                        //Error occured during conversion.      Send error message and end.
                        sendERROR( DATA_CONVERSION_FAILED );
                        return;
                }               
                
                //Read device type. Will be checked below.
                deviceType = *( getParameterNumber( PARAMETER_3 ) );
                
                
                //Check if desired device type equals coordinator.
                if( deviceType == DEVICE_TYPE_COORDINATOR ){

                        role = COORDINATOR;
                }
                
                //Check if desired device type equals end-device.
                else if( deviceType == DEVICE_TYPE_END_DEVICE ){
                        
                        role = END_DEVICE;
                }
                
                //This is not a valid device type.
                else{
                
                        sendERROR( UNKNOWN_DEVICE_TYPE );
                        return;
                }
                
                //It is now safe to start opertaion on current channel and PANID.
                startNetworkOperation( chatChannel );
        }
        
        //Stop network...disassociation procedure.              
        else if( stringCompare( ATCommand, ATD ) ){

                stopNetworkOperation( );                                
        }
        
        //Reset.                
        else if( stringCompare( ATCommand, ATR ) ){
        
                //wpan_init( );
                wpan_mlme_reset_request( true );
                state = CHAT_RESET_PENDING;
        }
        
        //Send data.            
        else if( stringCompare( ATCommand, ATT ) ){
                
                //Important that messages are not sent without being connected.
                if( state  != CHAT_CONNECTED ){
                
                        sendERROR( INCONSISTENT_STATE );
                        return;
                }

                //Extract and check length of data.
                if( !htoi8( getParameterNumber( PARAMETER_1 ), &msgLength ) ){
                
                        //Error occured during conversion.      Send error message and end.
                        sendERROR( DATA_CONVERSION_FAILED );
                        return;
                }

                //Extract the data it self. No checks will be done.
                msg = getParameterNumber( PARAMETER_2 );
                sendMsg( msgLength, msg );
        }
        
        //Received an AT command that is not supported.         
        else{

                sendERROR( UNKNOWN_AT_COMMAND );
        }
}

Here is the call graph for this function: