lcd_lib.h

Go to the documentation of this file.

//*****************************************************************************
//
// File Name  : 'lcd_lib.h'
// Title    : 8 and 4 bit LCd interface + mixed pins modes
// Author   : Scienceprog.com - Copyright (C) 2007
// Created    : 2007-03-29
// Revised    : 2011-12-13
// Version    : 2.0
// Target MCU : Atmel AVR series
//
// This code is distributed under the GNU Public License
//    which can be found at http://www.gnu.org/licenses/gpl.txt
//
//*****************************************************************************
#ifndef LCD_LIB
#define LCD_LIB

#include <inttypes.h>


//Uncomment one of these if
//LCD 4 bit interface is used (single port pins)
#define LCD_4BIT
//LCD 8 bit interface is used (single port pins)
//#define LCD_8BIT 
//LCD 4 bit interface is used (mixed port pins)
//#define LCD_4BIT_M 
//LCD 8 bit interface is used (mixed port pins)
//#define LCD_8BIT_M
//******************************************************

//progress bar usage (uncomment to use)
//#define USE_PROGBAR

//******************************************************

#define LCD_RS  0   //define MCU pin connected to LCD RS
#define LCD_RW  1   //define MCU pin connected to LCD R/W
#define LCD_E 2 //define MCU pin connected to LCD E
#define LCD_D0  0 //define MCU pin connected to LCD D0
#define LCD_D1  0 //define MCU pin connected to LCD D1
#define LCD_D2  0 //define MCU pin connected to LCD D2
#define LCD_D3  0 //define MCU pin connected to LCD D3
#define LCD_D4  4 //define MCU pin connected to LCD D4
#define LCD_D5  5 //define MCU pin connected to LCD D5
#define LCD_D6  6 //define MCU pin connected to LCD D6
#define LCD_D7  7 //define MCU pin connected to LCD D7

  

#if defined (LCD_4BIT_M) || defined (LCD_8BIT_M)
#define LDPRS PORTB   //RS pin assignment
#define LDDRS DDRB
#define LDPRW PORTD   //RW pin assignment
#define LDDRW DDRD
#define LDPE PORTD    //E pin assignment
#define LDDE DDRD
#define LDPD0 PORTC   //D0 pin assignment
#define LDDD0 DDRC
#define LDPD1 PORTD   //D1 pin assignment
#define LDDD1 DDRD
#define LDPD2 PORTC   //D2 pin assignment
#define LDDD2 DDRC
#define LDPD3 PORTB   //D3 pin assignment
#define LDDD3 DDRB
#define LDPD4 PORTD   //D4 pin assignment
#define LDDD4 DDRD
#define LDPD5 PORTC   //D5 pin assignment
#define LDDD5 DDRC
#define LDPD6 PORTD   //D6 pin assignment
#define LDDD6 DDRD
#define LDPD7 PORTB   //D7 pin assignment
#define LDDD7 DDRB
#endif

#if defined (LCD_4BIT) || defined (LCD_8BIT) //if aligned mode
#define LDP PORTA //define MCU port connected to LCD data pins
#define LCP PORTA //define MCU port connected to LCD control pins
#define LDDR DDRA //define MCU direction register for port connected to LCD data pins
#define LCDR DDRA //define MCU direction register for port connected to LCD control pins
#endif


#define LCD_CLR             0 //DB0: clear display
#define LCD_HOME            1 //DB1: return to home position
#define LCD_ENTRY_MODE      2 //DB2: set entry mode
#define LCD_ENTRY_INC       1 //DB1: increment
#define LCD_ENTRY_SHIFT     0 //DB2: shift
#define LCD_ON_CTRL         3 //DB3: turn lcd/cursor on
#define LCD_ON_DISPLAY      2 //DB2: turn display on
#define LCD_ON_CURSOR       1 //DB1: turn cursor on
#define LCD_ON_BLINK        0 //DB0: blinking cursor
#define LCD_MOVE            4 //DB4: move cursor/display
#define LCD_MOVE_DISP       3 //DB3: move display (0-> move cursor)
#define LCD_MOVE_RIGHT      2 //DB2: move right (0-> left)
#define LCD_FUNCTION        5 //DB5: function set
#define LCD_FUNCTION_8BIT   4 //DB4: set 8BIT mode (0->4BIT mode)
#define LCD_FUNCTION_2LINES 3 //DB3: two lines (0->one line)
#define LCD_FUNCTION_10DOTS 2 //DB2: 5x10 font (0->5x7 font)
#define LCD_CGRAM           6 //DB6: set CG RAM address
#define LCD_DDRAM           7 //DB7: set DD RAM address
// reading:
#define LCD_BUSY            7 //DB7: LCD is busy
#define LCD_LINES     2 //visible lines
#define LCD_LINE_LENGTH   16  //line length (in characters)
// cursor position to DDRAM mapping
#define LCD_LINE0_DDRAMADDR   0x00
#define LCD_LINE1_DDRAMADDR   0x40
#define LCD_LINE2_DDRAMADDR   0x14
#define LCD_LINE3_DDRAMADDR   0x54
// progress bar defines
#define PROGRESSPIXELS_PER_CHAR 6


void LCDsendChar(uint8_t);    //forms data ready to send to LCD
void LCDsendCommand(uint8_t); //forms data ready to send to LCD
void LCDinit(void);     //Initializes LCD
void LCDclr(void);        //Clears LCD
void LCDhome(void);     //LCD cursor home
void LCDstring(uint8_t*); //Outputs string to LCD
void LCDGotoXY(uint8_t, uint8_t); //Cursor to X Y position
void CopyStringtoLCD(const uint8_t*, uint8_t, uint8_t);//copies flash string to LCD at x,y
void LCDdefinechar(const uint8_t *,uint8_t);//write CHAR to LCD CGRAM 
void LCDshiftRight(uint8_t);  //shift by n characters Right
void LCDshiftLeft(uint8_t); //shift by n characters Left
void LCDcursorOn(void);   //Underline cursor ON
void LCDcursorOnBlink(void);  //Underline blinking cursor ON
void LCDcursorOFF(void);    //Cursor OFF
void LCDblank(void);      //LCD blank but not cleared
void LCDvisible(void);      //LCD visible
void LCDcursorLeft(uint8_t);  //Shift cursor left by n
void LCDcursorRight(uint8_t); //shif cursor right by n
// displays a horizontal progress bar at the current cursor location
// <progress> is the value the bargraph should indicate
// <maxprogress> is the value at the end of the bargraph
// <length> is the number of LCD characters that the bargraph should cover
//adapted from AVRLIB - displays progress only for 8 bit variables
void LCDprogressBar(uint8_t progress, uint8_t maxprogress, uint8_t length);


#endif