AVR Z-LINK®

atParser.c File Reference

---

Detailed Description

This file implements the textual AT interface.

The handleNewCommand() is called whenever a new AT command has been indicated by polling of the dataAvailable( ). Rest of the function members in this file are internal (static) and will only be called by handleNewCommand().

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.c,v

Date

2006/09/15 17:02:19

Definition in file atParser.c.

#include <stdbool.h>
#include <stdint.h>
#include "compiler.h"
#include "ieee_const.h"
#include "ieee_types.h"
#include "wpan_mac.h"
#include "chat.h"
#include "atParser.h"
#include "serialPortHAL.h"
#include "utilities.h"

Include dependency graph for atParser.c:

Go to the source code of this file.

Functions
void	handleNewCommand (void)
	This function is called to handle a newly arrived AT command.
static void	sendMsg (uint8_t msgLength, uint8_t *msg)
	This function will send the supplied data to the other end of the link.
static void	startNetworkOperation (uint8_t channelToScan)
	This function will send an mlme_scan.request.
static void	stopNetworkOperation (void)
	This function defines the procedure for terminate a network.
Variables
unsigned char __flash	ATC [] = "AT+C"
unsigned char __flash	ATD [] = "AT+D"
	The AT+C string.
unsigned char __flash	ATR [] = "AT+R"
	The AT+D string.
unsigned char __flash	ATT [] = "AT+T"
	The AT+R string.
uint8_t	chatChannel = DEFAULT_CHANNEL
	The AT+C string.
uint16_t	chatPANID = DEFAULT_PANID
chatRole_t	role = UNDEFINED
chatState_t	state = CHAT_IDLE

---

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:

static void sendMsg	(	uint8_t	msgLength,
		uint8_t *	msg
	)			[static]

This function will send the supplied data to the other end of the link.

In advance of the call to this function the correct state and data length has been verified. Then it is safe to use the mcps_data.request directly. This primitive will send the data to the other peer in the link.

Parameters:

	msgLength	Length of data/message to send in bytes.
	msg	Pointer to the actual payload.

Definition at line 230 of file atParser.c.

References chatPANID, COORD_SHORT_ADDRESS, COORDINATOR, END_DEVICE_SHORT_ADDRESS, EVENT_BUFFER_FULL, INVALID_REQUEST, MAX_MSG_LENGTH, role, and sendERROR().

Referenced by handleNewCommand().

                                                      {
        
        //Setup address and PAN information.
        wpan_mcpsdata_addr_t addr_info;
    addr_info.SrcAddrMode = WPAN_ADDRMODE_SHORT;
    addr_info.DstAddrMode = WPAN_ADDRMODE_SHORT;
        addr_info.SrcPANId = chatPANID;
        addr_info.DstPANId = chatPANID;
        
        //Check length of message.
        if( !( msgLength <= MAX_MSG_LENGTH ) ){
                
                sendERROR( INVALID_REQUEST );
                return;
        }
        

        //Coordinator.
        if( role  == COORDINATOR ){
        
                addr_info.SrcAddr = COORD_SHORT_ADDRESS;
                addr_info.DstAddr = END_DEVICE_SHORT_ADDRESS;   
        }
        
        //End-device.
        else{
        
                addr_info.SrcAddr = END_DEVICE_SHORT_ADDRESS;
                addr_info.DstAddr = COORD_SHORT_ADDRESS;        
        }


        if( wpan_mcps_data_request( &addr_info, 0x01, WPAN_TXOPT_ACK, msg, msgLength ) ){
                
                ;                       
        }
          
        else{
                
                sendERROR( EVENT_BUFFER_FULL );  
        }
}

Here is the call graph for this function:

static void startNetworkOperation

(

uint8_t

channelToScan

)

[static]

This function will send an mlme_scan.request.

The mlme_scan.request will initiate the steps needed to establish/start a new peer-to-peer link (Coordinator), the process to become the other peer (End-device) in this link (associate).

Parameters:

channelToScan

Channel to start the new network on, or to associate to.

Definition at line 197 of file atParser.c.

References CHAT_ACTIVE_SCAN_PENDING, chatChannel, SCANDURATION, and state.

Referenced by handleNewCommand().

                                                          {

        uint32_t channelMask = 1UL;
        
        //Generate channel mask as defined in MLME_SCAN_request.
        channelMask = channelMask << chatChannel;

        //Issue an active scan on the given channel for a define period.
        wpan_mlme_scan_request( MLME_SCAN_TYPE_ACTIVE, channelMask,
                                                        SCANDURATION );

        state = CHAT_ACTIVE_SCAN_PENDING;
}

static void stopNetworkOperation

(

void

)

[static]

This function defines the procedure for terminate a network.

Not implemented yet. Is not supported by the GUI application.

Definition at line 216 of file atParser.c.

Referenced by handleNewCommand().

                                        {

        
}

---

Variable Documentation

unsigned char __flash ATC[] = "AT+C"

Definition at line 45 of file atParser.c.

Referenced by handleNewCommand().

unsigned char __flash ATD[] = "AT+D"

The AT+C string.

Definition at line 46 of file atParser.c.

Referenced by handleNewCommand().

unsigned char __flash ATR[] = "AT+R"

The AT+D string.

Definition at line 47 of file atParser.c.

Referenced by handleNewCommand().

unsigned char __flash ATT[] = "AT+T"

The AT+R string.

Definition at line 48 of file atParser.c.

Referenced by handleNewCommand().

uint8_t chatChannel = DEFAULT_CHANNEL

The AT+C string.

Definition at line 50 of file atParser.c.

Referenced by handleNewCommand(), startNetworkOperation(), usr_mlme_scan_conf(), and usr_mlme_set_conf().

uint16_t chatPANID = DEFAULT_PANID

Definition at line 51 of file atParser.c.

Referenced by handleNewCommand(), sendMsg(), usr_mlme_scan_conf(), and usr_mlme_set_conf().

chatRole_t role = UNDEFINED

Definition at line 53 of file atParser.c.

Referenced by handleNewCommand(), sendMsg(), and usr_mlme_scan_conf().

chatState_t state = CHAT_IDLE

Definition at line 52 of file atParser.c.

Referenced by handleNewCommand(), startNetworkOperation(), usr_mcps_data_ind(), usr_mlme_associate_conf(), usr_mlme_associate_ind(), usr_mlme_comm_status_ind(), usr_mlme_reset_conf(), usr_mlme_scan_conf(), usr_mlme_set_conf(), and usr_mlme_start_conf().