AVR C Library
Revision as of 17:01, 22 October 2013 by Rupali (Talk | contribs)

Introduction

Overview:

This manual is designed to help embedded programmers and students, rapidly exploit the Avr(Atmega)-Controller for embedded applications. This manual has been targeted at embedded systems programmers and Students who have basic knowledge of Avr(Atmega32/Avr) architecture and C-Language.

This manual provides the reference to all the library functions which are grouped under respective .c file. 

  1. The .c files convention is as per the peripherals. The peripherals (lcd, keypad..) are connected to default PORTs which can be connect to required  PORTs by changing the #defines .

Reference:

  1.     It is recommended to go through the below reference documents and datasheets before interfacing any peripherals.

1. The Avr Microcontroller and Embedded Systems by Muhammad Ali Mazidi. 2. Atmega32 DataSheet. 3. Embedded C by Michael J Pont . 4. Any of the 16x2 lcd datasheet. 5. RTC-DS1307 from Dallas Semiconductors.


Feedback:

Suggestions for additions and improvements in code and documentation are always welcome. Please send your feedback via e-mail to feedback@xplorelabz.com

Disclaimer:

The libraries have been tested for Atmega16 on different development boards. We strongly believe that the library works on any Atmega boards. However, Xplore Labz disclaims any kind of hardware failure resulting out of usage of libraries, directly or indirectly. Documentation may be subject to change without prior notice.

The usage of tools and software demonstrated in the document are for educational purpose only, all rights pertaining to these belong to the respective owners. Users must ensure license terms are adhered to, for any use of the demonstrated software.

GNU GENERAL PUBLIC LICENSE: The library code in this document is licensed under GNU General Public License (GPL) Copyright (C) 2012. 

  1. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

Since the library is licensed free of charge, there is no warranty for the libraries and the entire risk of the quality and performance is with the user.

Errors and omissions should be reported to feedback@xplorelabz.com




ADC

  1.                                    Avr ADC library
  • Filename: adc.c
  • Controller: Atmega8/16/32/128
  • Oscillator: 11.0592 MHz
  • Author: XploreLabz
  • website: www.xplorelabz.com
  • Reference:Atmega32 dataSheet 
  1. #include<avr/io.h>
  2. #include <util/delay.h>
  3. #include "adc.h"


ADC_Init()

  • Description :This function initializes the ADC control registers
  • I/P Arguments: none
  • Return value: none 
  1. void ADC_Init()
  2.  {
  3.    ADCSRA=0x81;  //Enable ADC , sampling freq=osc_freq/2
  4.    ADMUX=0x00;   //Result right justified, select channel zero
  5.   }


ADC_StartConversion()

  • Description  :This function does the ADC conversioin for the Selected Channel and returns the converted 10bit result
  • I/P Arguments: char(channel number)
  • Return value : int(10 bit ADC result) 


  1.  
  2. unsigned int ADC_StartConversion(unsigned char channel)
  3.  {
  4.    ADMUX=channel;         
  5.    _delay_ms(5);           
  6.    ADCSRA=0xc1;           
  7.    while((ADCSRA & (1<<ADIF)==0); 
  8.     return(ADCW);
  9.  }

LCD_8_bit Mode

  1.                        AVR LCD library for 8-bit mode
  • Filename: lcd_8_bit.c
  • Controller: Atmega Family(8,16,32,64,128)
  • Oscillator: 11.0592 MHz
  • Author: XploreLabz
  • website: www.xplorelabz.com

Note:

  • Pin connection for LCD display in 8-bit mode is as shown below.By default the LCD is connected to PORTB(databus) and PORTD(controlbus).
  • The code can be modified to connect the LCD to any of the PORTs by changing the "#define".
  • io.h contains the defnition of all ports and SFRs delay.h contains the in built delay routines(us and ms routines). 
  1. #include <avr\io.h>
  2. #include <util\delay.h>
  3.  
  4. #include "lcd.h"
  5.  
  6. #define databus_direction DDRC      //  LCD databus Direction Configuration
  7. #define controlbus_direction DDRD  //  LCD Control bus Direction Configuration
  8.  
  9. #define databus	PORTC             //	LCD databus connected to PORTB
  10. #define control_bus PORTD        //	LCD Control bus connected to PORTD
  11.  
  12. #define rs 5                    // Register select pin connected 6th bit(D5) Control bus
  13. #define rw 6                   // Read Write pin connected to 7th bit(D6) Control bus
  14. #define en 7                  // Enable pin connected to 8th bit(D7) Control bus
  15.  
  16.  
  17. /* 16x2 LCD Specification */
  18. #define LCDMaxLines 2
  19. #define LCDMaxChars 16
  20. #define LineOne 0x80
  21. #define LineTwo 0xc0
  22.  
  23. #define BlankSpace ' '


LCD_Init()

  • Description  :This function is used to initialize the lcd in 8-bit mode
  • Function name: LCD_Init()
  • I/P Arguments: none.
  • Return value : none 


  1. void LCD_Init()
  2. {
  3.     _delay_ms(50);
  4.    databus_direction = 0xff;   // Configure both databus and controlbus as output
  5.    controlbus_direction = 0xff;
  6.    LCD_CmdWrite(0x38);   // LCD 2lines, 5*7 matrix
  7.    LCD_CmdWrite(0x0E);	// Display ON cursor ON
  8.    LCD_CmdWrite(0x01);	// Clear the LCD
  9.    LCD_CmdWrite(0x80);	// Move the Cursor to First line First Position
  10. }

LCD_Clear()

  • Description  :This function clears the LCD and moves the cursor to first Position
  • I/P Arguments: none.
  • Return value : none 


  1. void LCD_Clear()
  2. {
  3.    LCD_CmdWrite(0x01);	// Clear the LCD and go to First line First Position
  4.    LCD_CmdWrite(LineOne);
  5. }


LCD_GoToLineOne()

  • Description  :This function moves the Cursor to First line First Position
  • I/P Arguments: none
  • Return value : none 


  1. void LCD_GoToLineOne()
  2. {
  3.    LCD_CmdWrite(LineOne);	// Move the Cursor to First line First Position
  4. }

LCD_GoToLineTwo()

  • Description  :This function moves the Cursor to Second line First Position
  • I/P Arguments: none
  • Return value : none 


  1. void LCD_GoToLineTwo()
  2. {
  3.    LCD_CmdWrite(LineTwo);	// Move the Cursor to Second line First Position
  4. }

LCD_GoToXY()

  • Description  :This function moves the Cursor to specified position
  • I/P Arguments: char row,char col
    • row -> line number(line1=0, line2=1),For 2line LCD the I/P argument should be either 0 or 1.
    • col -> char number.For 16-char LCD the I/P argument should be betwen 0-15.
  • Return value : none 


  1. void LCD_GoToXY(char row, char col)
  2. {
  3.    char pos;
  4.  
  5.     if(row<LCDMaxLines)
  6.       {
  7. 		 pos= LineOne | (row << 6); // take the line number
  8. 		                            //row0->pos=0x80  row1->pos=0xc0
  9.  
  10. 	    if(col<LCDMaxChars)
  11. 		   pos= pos+col;            //take the char number
  12. 		                            //now pos points to the given XY pos
  13.  
  14. 		 LCD_CmdWrite(pos);	       // Move the Cursor to specified Position
  15.        }
  16. }

LCD_CmdWrite()

  • Description :This function sends a command to LCD in the following steps.
    • step1: Send the I/P command to LCD.
    • step2: Select the Control Register by making RS low.
    • step3: Select Write operation making RW low.
    • step4: Send a High-to-Low pulse on Enable PIN with some delay_us.
  • I/P Arguments: 8-bit command supported by LCD.
  • Return value : none 


  1. void LCD_CmdWrite( char cmd)
  2. {
  3.  
  4.     databus=cmd;             // Send the command to LCD
  5.     control_bus &=~(1<<rs);  // Select the Command Register by pulling RS LOW
  6.     control_bus &=~(1<<rw);  // Select the Write Operation  by pulling RW LOW
  7.     control_bus |=1<<en;     // Send a High-to-Low Pusle at Enable Pin
  8.    _delay_us(1);
  9.    control_bus &=~(1<<en);
  10.    _delay_ms(1);
  11. }

LCD_DataWrite()

  • Description:This function sends a character to be displayed on LCD in the following steps.
    • step1: Send the character to LCD.
    • step2: Select the Data Register by making RS high.
    • step3: Select Write operation making RW low.
    • step4: Send a High-to-Low pulse on Enable PIN with some delay_us.
  • I/P Arguments: ASCII value of the char to be displayed.
  • Return value : none 


  1. void LCD_DataWrite( char dat)
  2. {
  3.  
  4.     databus=dat;            // Send the data to LCD
  5.     control_bus |=1<<rs;	// Select the Data Register by pulling RS HIGH
  6.     control_bus &=~(1<<rw);	// Select the Write Operation  by pulling RW LOW
  7.     control_bus |=1<<en;	// Send a High-to-Low Pusle at Enable Pin
  8. 	_delay_us(1);
  9.     control_bus &=~(1<<en);
  10.     _delay_ms(1);
  11.  
  12. }

LCD_DisplayString()

  • Description  :This function is used to display the ASCII string on the lcd.
  1. The string_ptr points to the first char of the string and traverses till the end(NULL CHAR).
  2. Each time a char is sent to LCD_DataWrite funtion to display.
  • I/P Arguments: String(Address of the string) to be displayed.
  • Return value : None 
  1. void LCD_DisplayString(char *string_ptr)
  2. {
  3.    while(*string_ptr)
  4.     LCD_DataWrite(*string_ptr++);
  5.  }

LCD_DisplayNumber()

  • Description  :This function is used to display a 5-digit integer(0-65535).
    • ex:
  1. if the number is 12345 then 12345 is displayed.
  2. if the number is 123 then 00123 is displayed.
  • Function name: LCD_DisplayNumber()
  • I/P Arguments: unsigned int.
  • Return value : none


Lcd displaynumber.png 

  1. void LCD_DisplayNumber(unsigned int num)
  2. {
  3.    LCD_DataWrite((num/10000)+0x30);
  4.    num=num%10000;
  5.  
  6.    LCD_DataWrite((num/1000)+0x30);
  7.    num=num%1000;
  8.  
  9.    LCD_DataWrite((num/100)+0x30);
  10.    num=num%100;
  11.  
  12.    LCD_DataWrite((num/10)+0x30);
  13.  
  14.    LCD_DataWrite((num%10)+0x30);
  15.  
  16.  }

LCD_ScrollMessage()

  • Description  :This function scrolls the given message on the first line.""
  1. 16 chars are displayed at atime.
  2. Pointer is incremented to skip a char each time to give the illusion of moving chars.
  3. If the chars are less than 16, then the BlankSpaces are displayed.
  • I/P Arguments: char *msg_ptr 
  1. (msg_ptr -> pointer to the string to be scrolled)
  • Return value : none 


  1. void LCD_ScrollMessage(char *msg_ptr)
  2. {
  3.   unsigned char i,j;
  4.   LCD_CmdWrite(0x0c);			 //Disable the Cursor
  5.   for(i=0;msg_ptr[i];i++)        //Loop to display the complete string
  6.     {                            //each time 16 chars are displayed and
  7.                                  //pointer is incremented to point to next char
  8.  
  9.       LCD_GoToLineOne();                   //Move the Cursor to first line
  10.  
  11.       for(j=0;j<LCDMaxChars && msg_ptr[i+j];j++) //loop to Display first 16 Chars
  12. 	    LCD_DataWrite(msg_ptr[i+j]);                 //or till Null char
  13.  
  14. 	  for(j=j; j<LCDMaxChars; j++)               //If the chars are below 16
  15.         LCD_DataWrite(BlankSpace);              //then display blank spaces
  16.  
  17.        _delay_ms(500);
  18.     }
  19.    LCD_CmdWrite(0x0E);			  //Enable the Cursor
  20. }

LCD_DisplayRtcTime()

  • Description  :This function display hour,min,sec read from DS1307.
  • I/P Arguments: char hour,char min,char sec(hour,min,sec should be packed BCD format,as read from DS1307)
  • Return value : none

Lcd rtctime.png 

  1. void LCD_DisplayRtcTime(char hour,char min,char sec)
  2. {
  3.     LCD_DataWrite(((hour>>4) & 0x0f) + 0x30);
  4.     LCD_DataWrite((hour & 0x0f) + 0x30);
  5.     LCD_DataWrite(':');
  6.  
  7.     LCD_DataWrite(((min>>4) & 0x0f) + 0x30);
  8. 	LCD_DataWrite((min & 0x0f) + 0x30);
  9.     LCD_DataWrite(':');
  10.  
  11.     LCD_DataWrite(((sec>>4) & 0x0f) + 0x30);
  12. 	LCD_DataWrite((sec & 0x0f) + 0x30);
  13.  
  14.  }

LCD_DisplayRtcDate()

  • Description  :This function display day,month,year read from DS1307.
  • I/P Arguments: char day,char month,char year(day,month,year should be packed BCD format,as read from DS1307)
  • Return value : none

Lcd rtcdate.png 

  1. void LCD_DisplayRtcDate(char day,char month,char year)
  2.  {
  3.      LCD_DataWrite(((day>>4) & 0x0f) + 0x30);
  4.      LCD_DataWrite((day & 0x0f) + 0x30);
  5.      LCD_DataWrite('/');
  6.  
  7.      LCD_DataWrite(((month>>4) & 0x0f) + 0x30);
  8.  	 LCD_DataWrite((month & 0x0f) + 0x30);
  9.      LCD_DataWrite('/');
  10.  
  11.      LCD_DataWrite(((year>>4) & 0x0f) + 0x30);
  12.  	LCD_DataWrite((year & 0x0f) + 0x30);
  13.  
  14.  }
Retrieved from "https://exploreembedded.com/wiki/index.php?title=AVR_C_Library&oldid=60"