Difference between revisions of "LCD"

(→‎LCD_GoToLine)
m
 
(82 intermediate revisions by 4 users not shown)
Line 5: Line 5:
  
 
==LCD_Init==   
 
==LCD_Init==   
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
{|{{Widget:LibCol}}
 
{{#Widget:LibTable}}
 
{{#Widget:LibTable}}
 
|-
 
|-
−
|Defination || '''void LCD_Init(uint8_t lcdMode, uint8_t lcdtype)'''
+
|Defination ||void LCD_Init ( uint8_t var_lcdMode_u8, uint8_t var_lcdNoOfLines_u8, uint8_t var_MaxCharsPerLine_u8)
 
|-
 
|-
−
| Input Arguments || uint8_t: required Mode 4/8-bit. uint8_t: Type of LCD used (16x2/16x1 etc)
+
| Input Arguments ||<br />
 +
*uint8_t: required Mode 4/8-bit <br />
 +
*uint8_t: Number of lines of LCD<br />
 +
*uint8_t: Number of Chars per line
 
|-
 
|-
 
| Return Value|| none
 
| Return Value|| none
 
|-
 
|-
−
| Description ||This function is used to initialize the lcd.*It initializes the LCD for selected mode(4/8-bit) and Type(16x2/16x1 etc)
+
| Description ||This function is used to initialize the lcd.<br />It initializes the LCD for selected mode(4/8-bit) and Type(16x2/16x1 etc)
 
|-
 
|-
−
| Usage ||  
+
| Usage ||LCD_Init(8,2,16) //Initialize 2x16 LCD in 8-bit Mode<br />LCD_Init(4,2,16) //Initialize 2x16 LCD in 4-bit Mode<br />LCD_Init(4,4,16) //Initialize 4x16 LCD in 8-bit Mode
 
|}
 
|}
  
 
==LCD_CmdWrite==   
 
==LCD_CmdWrite==   
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
{|{{Widget:LibCol}}
 
{{#Widget:LibTable}}
 
{{#Widget:LibTable}}
 
|-
 
|-
−
|Defination || '''void LCD_CmdWrite( uint8_t cmd)'''
+
|Defination || void LCD_CmdWrite( uint8_t var_lcdCmd_u8)
 
|-
 
|-
 
| Input Arguments || 8-bit command supported by LCD.
 
| Input Arguments || 8-bit command supported by LCD.
Line 29: Line 32:
 
| Return Value|| none
 
| Return Value|| none
 
|-
 
|-
−
| Description || This function sends a command to LCD. Some of the commonly used commands are defined in lcd.h. For more commands refer the data sheet and send the supported command. The behaviour is undefined if unsupported commands are sent.     
+
| Description ||This function sends a command to LCD.<br />Some of the commonly used commands are defined in lcd.h.<br />For more commands refer the data sheet.<br />The behaviour is undefined if unsupported commands are sent.     
 
|-
 
|-
 
| Usage ||   
 
| Usage ||   
−
|}
+
LCD_CmdWrite(0x0c);                                       //Sets display On and Cursor Off<br />
−
 
+
LCD_CmdWrite(CMD_DISPLAY_ON_CURSOR_OFF); //Recommended
−
==LCD_DataWrite==
+
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
−
{{#Widget:LibTable}}
+
−
|-
+
−
|Defination || '''static void lcd_DataWrite( uint8_t dat)'''
+
−
|-
+
−
| Input Arguments || uint8_t: 8-bit value to be sent to LCD.
+
−
|-
+
−
| Return Value|| none
+
−
|-
+
−
| Description ||This functions is used to send a byte of data to LCD.
+
−
|-
+
−
| Usage ||   
+
 
|}
 
|}
  
 
==LCD_Clear==               
 
==LCD_Clear==               
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
{|{{Widget:LibCol}}
 
{{#Widget:LibTable}}
 
{{#Widget:LibTable}}
 
|-
 
|-
−
|Defination || '''void LCD_Clear()'''
+
|Defination || void LCD_Clear()
 
|-
 
|-
 
| Input Arguments || none.
 
| Input Arguments || none.
Line 61: Line 51:
 
| Description ||This function clears the LCD and moves the cursor to beginning of first line
 
| Description ||This function clears the LCD and moves the cursor to beginning of first line
 
|-
 
|-
−
| Usage ||    
+
| Usage ||  
 +
LCD_Clear(); // Clears the lcd and sets the cursor to beginning of the first line.   
 
|}
 
|}
 +
 +
  
 
==LCD_GoToLine==         
 
==LCD_GoToLine==         
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
{|{{Widget:LibCol}}
 
{{#Widget:LibTable}}
 
{{#Widget:LibTable}}
 
|-
 
|-
−
|Defination || '''void LCD_GoToLine(uint8_t LineNumber)'''
+
|Defination || void LCD_GoToLine(uint8_t var_lineNumber_u8)
 
|-
 
|-
−
| Input Arguments || uint8_t: Line number.
+
| Input Arguments || uint8_t: Line number to move the cursor.
 
|-
 
|-
 
| Return Value|| none
 
| Return Value|| none
 
|-
 
|-
−
| Description ||This function moves the Cursor to beginning of the specified line. If the requested line number is out of range, it will not move the cursor.
+
| Description ||This function moves the Cursor to beginning of the specified line. If the requested line number is out of range, it will not move the cursor.<br />
 +
Note: The line numbers run from 1 to Maxlines.<br />To avoid the confusion the below enums has to be used for selecting lines.<br />For four line LCD the enums are as below:<br />
 +
*E_LcdLineOne<br />
 +
*E_LcdLineTwo<br />
 +
*E_LcdLineThree<br />
 +
*E_LcdLineFour
 
|-
 
|-
 
| Usage ||     
 
| Usage ||     
 +
LCD_GoToLine(1);                  //Moves the cursor to beginning of first line
 +
LCD_GoToLine(E_LcdLineOne); //Recommended usage
 
|}
 
|}
  
−
==LCD_GoToXY==
+
 
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
 
 +
 
 +
==LCD_GoToNextline==
 +
{|{{Widget:LibCol}}
 
{{#Widget:LibTable}}
 
{{#Widget:LibTable}}
 
|-
 
|-
−
|Defination ||  
+
|Defination || void  LCD_GoToNextLine()
 
|-
 
|-
−
| Input Arguments ||  
+
| Input Arguments || none
 
|-
 
|-
−
| Return Value||  
+
| Return Value|| none
 
|-
 
|-
−
| Description ||   
+
| Description ||  This function moves the Cursor to beginning of the next line.  If the cursor is on last line and NextLine command is issued then it will move the cursor to first line.
 
|-
 
|-
 
| Usage ||   
 
| Usage ||   
 +
LCD_GoToNextline();  //Moves the cursor to beginning of next line.
 
|}
 
|}
  
Line 97: Line 101:
  
  
−
==LCD_DisplayString==
+
==LCD_SetCursor==
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
{|{{Widget:LibCol}}
 
{{#Widget:LibTable}}
 
{{#Widget:LibTable}}
 
|-
 
|-
−
|Defination ||  
+
|Defination || void LCD_SetCursor(char var_lineNumber_u8,char var_charNumber_u8)
 
|-
 
|-
−
| Input Arguments ||  
+
| Input Arguments ||<br />
 +
*row: line number(line1=1, line2=2)<br />For 2line LCD the I/P argument should be either 1 or 2.<br />
 +
*col: char number.<br />For 16-char LCD the I/P argument should be between 0-15.
 
|-
 
|-
−
| Return Value||  
+
| Return Value|| none
 
|-
 
|-
−
| Description ||
+
| Description || This function moves the Cursor to specified position.<br />
 +
*Note:If the Input(Line/Char number) are out of range then no action will be taken
 
|-
 
|-
−
| Usage ||     
+
| Usage ||  
 +
LCD_SetCursor(1,10);     //Moves the cursor to 1st line 11th char.
 +
LCD_SetCursor(5,10);    //No action taken as line 5 is out of range
 
|}
 
|}
  
−
 
+
==LCD_DisplayChar==
−
 
+
{|{{Widget:LibCol}}
−
 
+
−
==LCD_ScrollMessage==
+
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
 
{{#Widget:LibTable}}
 
{{#Widget:LibTable}}
 
|-
 
|-
−
|Defination ||  
+
|Defination || void LCD_DisplayChar( char var_lcdData_u8)
 
|-
 
|-
−
| Input Arguments ||  
+
| Input Arguments || uint8_t: ASCII value of the char to be displayed.
 
|-
 
|-
−
| Return Value||  
+
| Return Value|| none
 
|-
 
|-
−
| Description ||
+
| Description ||This function sends a character to be displayed on LCD.<br />Any valid ascii value can be passed to display the respective character
 
|-
 
|-
−
| Usage ||     
+
| Usage ||  
 +
LCD_DisplayChar(65);     //Displays 'A' on LCD<br />
 +
LCD_DisplayChar(0x41);  //Displays 'A' on LCD <br />
 +
LCD_DisplayChar('A');    //Recommended usage
 
|}
 
|}
  
Line 133: Line 142:
  
  
−
==LCD_DisplayDecimalNumber==
+
==LCD_DisplayString==
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
{|{{Widget:LibCol}}
 
{{#Widget:LibTable}}
 
{{#Widget:LibTable}}
 
|-
 
|-
−
|Defination ||  
+
|Defination || void LCD_DisplayString(char *ptr_stringPointer_u8)
 
|-
 
|-
−
| Input Arguments ||  
+
| Input Arguments || char*:String(Address of the string) to be displayed.
 
|-
 
|-
−
| Return Value||  
+
| Return Value|| none
 
|-
 
|-
−
| Description ||
+
| Description ||This function is used to display the ASCII string on the lcd.
 
|-
 
|-
−
| Usage ||    
+
| Usage ||  
 +
<syntaxhighlight>
 +
void main()
 +
{
 +
  char myString[]={"hello, world"};
 +
  LCD_DisplayString(myString);
 +
  LCD_DisplayString("good morning");
 +
} 
 +
</syntaxhighlight>
 
|}
 
|}
  
−
 
+
==LCD_ScrollMessage==
−
 
+
{|{{Widget:LibCol}}
−
 
+
−
==LCD_DisplayHexNumber==
+
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
 
{{#Widget:LibTable}}
 
{{#Widget:LibTable}}
 
|-
 
|-
−
|Defination ||  
+
|Defination || void LCD_ScrollMessage(uint8_t var_lineNumber_u8, char *ptr_msgPointer_u8)
 
|-
 
|-
−
| Input Arguments ||  
+
| Input Arguments ||
 +
*uint8_t: Line number on which the message has to be scrolled
 +
*char *: pointer to the string to be scrolled
 
|-
 
|-
−
| Return Value||  
+
| Return Value|| none
 
|-
 
|-
−
| Description ||
+
| Description || This function scrolls the given message on the specified line.<br />If the specified line number is out of range then the message will be scrolled on first line.<br />
 +
*Note: Leave 7-8 spaces at the beginning and 1 space at the end of the message to be scrolled.
 
|-
 
|-
−
| Usage ||    
+
| Usage ||  
 +
LCD_ScrollMessage("          Welcome to embedded programming ");
 
|}
 
|}
  
Line 169: Line 187:
  
  
−
==LCD_DisplayBinaryNumber==
+
==LCD_DisplayNumber==
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
{|{{Widget:LibCol}}
 
{{#Widget:LibTable}}
 
{{#Widget:LibTable}}
 
|-
 
|-
−
|Defination ||  
+
|Defination || void LCD_DisplayNumber(NumericSystem_et e_typeOfNum_e8, uint32_t var_number_u32, uint8_t var_numOfDigitsToDisplay_u8)
 
|-
 
|-
 
| Input Arguments ||  
 
| Input Arguments ||  
 +
*NumericSystem_et: Specifies type of number ENUM_BINARY(2),ENUM_DECIMAL(10), ENUM_Hex(16)
 +
*uint32_t: Number to be displayed on the LCD.
 +
*uint8_t : Number of digits to be displayed
 
|-
 
|-
−
| Return Value||  
+
| Return Value|| none
 
|-
 
|-
 
| Description ||
 
| Description ||
 +
This function is used to display a max of 10digit decimal/Hex number OR specified number of bits for binary number.<br>
 +
1st parameter specifies type of number ENUM_BINARY(2),ENUM_DECIMAL(10), ENUM_Hex(16).<br>
 +
3rd parameter specifies the number of digits from the right side to be displayed.<br>
 +
The output for the input combinations is as below<br>
 +
Binary:   
 +
*(10,4) then 4-LSB will be displayed ie. 1010
 +
*(10,8) then 8-LSB will be displayed ie. 00001010
 +
*(10,2) then 2-LSB will be displayed ie. 10
 +
               
 +
Decimal:
 +
*(10,12345,4) then 4-digits ie. 2345 will be displayed
 +
*(ENUM_DECIMAL,12345,6) then 6-digits ie. 012345 will be displayed
 +
*(10,12345,C_DisplayDefaultDigits_U8) then 12345 will be displayed.\
 +
             
 +
Hex:
 +
*(16,0x12AB,3) then 3-digits ie. 2AB will be displayed
 +
*(ENUM_Hex,0x12AB,6) then 6-digits ie. 0012AB will be displayed
 +
*(ENUM_Hex,0x12AB,C_DisplayDefaultDigits_U8) then 12AB will be displayed.
 
|-
 
|-
−
| Usage ||    
+
| Usage ||  
 +
uint32_t decNumber = 123456;<br />
 +
LCD_DisplayDecimalNumber(decNumber,5); //Display last 5-digits of Number<br />
 +
LCD_DisplayDecimalNumber(12345,4);  //Display last 4-digits of number   
 
|}
 
|}
  
−
 
+
==LCD_Printf==
−
 
+
{|{{Widget:LibCol}}
−
 
+
−
==LCD_DisplayFloatNumber==  
+
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
+
 
{{#Widget:LibTable}}
 
{{#Widget:LibTable}}
 
|-
 
|-
−
|Defination ||  
+
|Defination || void LCD_Printf(const char *argList, ...)
 
|-
 
|-
−
| Input Arguments ||  
+
| Input Arguments || variable length arguments similar to printf
 
|-
 
|-
−
| Return Value||  
+
| Return Value|| none
 
|-
 
|-
−
| Description ||
+
| Description ||This function is similar to printf function in C. It takes the arguments with specified format and displays accordingly .
−
|-
+
The supported format specifiers are as below.
−
| Usage ||   
+
*%c: character
−
|}
+
  
 +
*%d: decimal(16bit)
  
 +
*%l: decimal(32-bit)
  
 +
*%b: binary(16-bit)
 +
 +
*%s: string
 +
 +
*%f: float
 +
 +
*%x: hexadecimal 
  
−
==LCD_Printf==
 
−
{| class="wikitable"  style="colspan:1; background-color:#4682B4;"
 
−
{{#Widget:LibTable}}
 
 
|-
 
|-
−
|Defination ||  
+
| Usage ||
−
|-
+
<syntaxhighlight>
−
| Input Arguments ||
+
void main()
−
|-
+
{
−
| Return Value||
+
uint16_t decNum=1234;//16-bit
−
|-
+
uint32_t longDec=12345678;//32-bit
−
| Description ||
+
float floatNum=1234.5678;
−
|-
+
uint16_t hexNum=0xABCD;
−
| Usage ||   
+
char myString[]={"hello, world};
 +
 
 +
LCD_Printf("%d %l %f %x %b %s",decNum,longDec,floatNum,hexNum,hexNum,myString);
 +
LCD_Printf("D:%d,L:%l,F=%f,H:%x,Str:%s",1234,12345678,123.456,0xAB,"hello");
 +
}
 +
 
 +
</syntaxhighlight> 
 
|}
 
|}
 +
 +
==Usage Guide==
 +
<html>
 +
<script src="https://gist.github.com/Amritach/f6623a13490f16d1ff6a.js"></script>
 +
</html>
 +
 +
{{DISQUS}}

Latest revision as of 18:08, 30 May 2015

LCD

LCD_Init

{{#Widget:LibTable}}
Defination void LCD_Init ( uint8_t var_lcdMode_u8, uint8_t var_lcdNoOfLines_u8, uint8_t var_MaxCharsPerLine_u8)
Input Arguments
  • uint8_t: required Mode 4/8-bit
  • uint8_t: Number of lines of LCD
  • uint8_t: Number of Chars per line
Return Value none
Description This function is used to initialize the lcd.
It initializes the LCD for selected mode(4/8-bit) and Type(16x2/16x1 etc)
Usage LCD_Init(8,2,16) //Initialize 2x16 LCD in 8-bit Mode
LCD_Init(4,2,16) //Initialize 2x16 LCD in 4-bit Mode
LCD_Init(4,4,16) //Initialize 4x16 LCD in 8-bit Mode

LCD_CmdWrite

{{#Widget:LibTable}}
Defination void LCD_CmdWrite( uint8_t var_lcdCmd_u8)
Input Arguments 8-bit command supported by LCD.
Return Value none
Description This function sends a command to LCD.
Some of the commonly used commands are defined in lcd.h.
For more commands refer the data sheet.
The behaviour is undefined if unsupported commands are sent.
Usage

LCD_CmdWrite(0x0c); //Sets display On and Cursor Off
LCD_CmdWrite(CMD_DISPLAY_ON_CURSOR_OFF); //Recommended

LCD_Clear

{{#Widget:LibTable}}
Defination void LCD_Clear()
Input Arguments none.
Return Value none.
Description This function clears the LCD and moves the cursor to beginning of first line
Usage

LCD_Clear(); // Clears the lcd and sets the cursor to beginning of the first line.


LCD_GoToLine

{{#Widget:LibTable}}
Defination void LCD_GoToLine(uint8_t var_lineNumber_u8)
Input Arguments uint8_t: Line number to move the cursor.
Return Value none
Description This function moves the Cursor to beginning of the specified line. If the requested line number is out of range, it will not move the cursor.

Note: The line numbers run from 1 to Maxlines.
To avoid the confusion the below enums has to be used for selecting lines.
For four line LCD the enums are as below:

  • E_LcdLineOne
  • E_LcdLineTwo
  • E_LcdLineThree
  • E_LcdLineFour
Usage

LCD_GoToLine(1); //Moves the cursor to beginning of first line LCD_GoToLine(E_LcdLineOne); //Recommended usage



LCD_GoToNextline

{{#Widget:LibTable}}
Defination void LCD_GoToNextLine()
Input Arguments none
Return Value none
Description This function moves the Cursor to beginning of the next line. If the cursor is on last line and NextLine command is issued then it will move the cursor to first line.
Usage

LCD_GoToNextline(); //Moves the cursor to beginning of next line.



LCD_SetCursor

{{#Widget:LibTable}}
Defination void LCD_SetCursor(char var_lineNumber_u8,char var_charNumber_u8)
Input Arguments
  • row: line number(line1=1, line2=2)
    For 2line LCD the I/P argument should be either 1 or 2.
  • col: char number.
    For 16-char LCD the I/P argument should be between 0-15.
Return Value none
Description This function moves the Cursor to specified position.
  • Note:If the Input(Line/Char number) are out of range then no action will be taken
Usage

LCD_SetCursor(1,10); //Moves the cursor to 1st line 11th char. LCD_SetCursor(5,10); //No action taken as line 5 is out of range

LCD_DisplayChar

{{#Widget:LibTable}}
Defination void LCD_DisplayChar( char var_lcdData_u8)
Input Arguments uint8_t: ASCII value of the char to be displayed.
Return Value none
Description This function sends a character to be displayed on LCD.
Any valid ascii value can be passed to display the respective character
Usage

LCD_DisplayChar(65); //Displays 'A' on LCD
LCD_DisplayChar(0x41); //Displays 'A' on LCD
LCD_DisplayChar('A'); //Recommended usage



LCD_DisplayString

{{#Widget:LibTable}}
Defination void LCD_DisplayString(char *ptr_stringPointer_u8)
Input Arguments char*:String(Address of the string) to be displayed.
Return Value none
Description This function is used to display the ASCII string on the lcd.
Usage 
 
void main()
{
   char myString[]={"hello, world"};
   LCD_DisplayString(myString);
   LCD_DisplayString("good morning");
}

LCD_ScrollMessage

{{#Widget:LibTable}}
Defination void LCD_ScrollMessage(uint8_t var_lineNumber_u8, char *ptr_msgPointer_u8)
Input Arguments
  • uint8_t: Line number on which the message has to be scrolled
  • char *: pointer to the string to be scrolled
Return Value none
Description This function scrolls the given message on the specified line.
If the specified line number is out of range then the message will be scrolled on first line.
  • Note: Leave 7-8 spaces at the beginning and 1 space at the end of the message to be scrolled.
Usage

LCD_ScrollMessage(" Welcome to embedded programming ");



LCD_DisplayNumber

{{#Widget:LibTable}}
Defination void LCD_DisplayNumber(NumericSystem_et e_typeOfNum_e8, uint32_t var_number_u32, uint8_t var_numOfDigitsToDisplay_u8)
Input Arguments
  • NumericSystem_et: Specifies type of number ENUM_BINARY(2),ENUM_DECIMAL(10), ENUM_Hex(16)
  • uint32_t: Number to be displayed on the LCD.
  • uint8_t : Number of digits to be displayed
Return Value none
Description

This function is used to display a max of 10digit decimal/Hex number OR specified number of bits for binary number.
1st parameter specifies type of number ENUM_BINARY(2),ENUM_DECIMAL(10), ENUM_Hex(16).
3rd parameter specifies the number of digits from the right side to be displayed.
The output for the input combinations is as below
Binary:

  • (10,4) then 4-LSB will be displayed ie. 1010
  • (10,8) then 8-LSB will be displayed ie. 00001010
  • (10,2) then 2-LSB will be displayed ie. 10

Decimal:

  • (10,12345,4) then 4-digits ie. 2345 will be displayed
  • (ENUM_DECIMAL,12345,6) then 6-digits ie. 012345 will be displayed
  • (10,12345,C_DisplayDefaultDigits_U8) then 12345 will be displayed.\

Hex:

  • (16,0x12AB,3) then 3-digits ie. 2AB will be displayed
  • (ENUM_Hex,0x12AB,6) then 6-digits ie. 0012AB will be displayed
  • (ENUM_Hex,0x12AB,C_DisplayDefaultDigits_U8) then 12AB will be displayed.
Usage

uint32_t decNumber = 123456;
LCD_DisplayDecimalNumber(decNumber,5); //Display last 5-digits of Number
LCD_DisplayDecimalNumber(12345,4); //Display last 4-digits of number

LCD_Printf

{{#Widget:LibTable}}
Defination void LCD_Printf(const char *argList, ...)
Input Arguments variable length arguments similar to printf
Return Value none
Description This function is similar to printf function in C. It takes the arguments with specified format and displays accordingly .

The supported format specifiers are as below.

  • %c: character
  • %d: decimal(16bit)
  • %l: decimal(32-bit)
  • %b: binary(16-bit)
  • %s: string
  • %f: float
  • %x: hexadecimal
Usage 
void main()
{
uint16_t decNum=1234;//16-bit
uint32_t longDec=12345678;//32-bit
float floatNum=1234.5678;
uint16_t hexNum=0xABCD;
char myString[]={"hello, world};
 
LCD_Printf("%d %l %f %x %b %s",decNum,longDec,floatNum,hexNum,hexNum,myString);
LCD_Printf("D:%d,L:%l,F=%f,H:%x,Str:%s",1234,12345678,123.456,0xAB,"hello");
}

Usage Guide

Retrieved from "https://exploreembedded.com/wiki/index.php?title=LCD&oldid=5794"