Latest revision as of 18:09, 30 May 2015

GLCD

Defination	void GLCD_Init ()
Input Arguments	none
Return Value	none
Description	This function is used to initialize the glcd.
Usage	GLCD_Init() //Initialize GLCD

Defination	void GLCD_CmdWrite( uint8_t var_lcdCmd_u8)
Input Arguments	8-bit command supported by GLCD.
Return Value	none
Description	This function sends a command to GLCD. Some of the commonly used commands are defined in glcd.h. For more commands refer the data sheet. The behaviour is undefined if unsupported commands are sent.
Usage	GLCD_CmdWrite(0xB8); //Sets cursor to first line GLCD_CmdWrite(FirstLineNumberAddress); //Recommended

Defination	void GLCD_Clear()
Input Arguments	none.
Return Value	none.
Description	This function clears the GLCD and moves the cursor to beginning of first line
Usage	GLCD_Clear(); // Clears the lcd and sets the cursor to beginning of the first line.

Defination	void GLCD_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 GLCD the enums are as below: E_LcdLineOne E_LcdLineTwo E_LcdLineThree E_LcdLineFour
Usage	GLCD_GoToLine(1); //Moves the cursor to beginning of first line GLCD_GoToLine(E_LcdLineOne); //Recommended usage

Defination	void GLCD_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	GLCD_GoToNextline(); //Moves the cursor to beginning of next line.

Defination	void GLCD_SetCursor(char var_lineNumber_u8,char var_charNumber_u8)
Input Arguments	row: line number(line1=1, line2=2) For 2line GLCD the I/P argument should be either 1 or 2. col: char number. For 16-char GLCD 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	GLCD_SetCursor(1,10); //Moves the cursor to 1st line 11th char. GLCD_SetCursor(5,10); //No action taken as line 5 is out of range

Defination	void GLCD_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 GLCD. Any valid ascii value can be passed to display the respective character
Usage	GLCD_DisplayChar(65); //Displays 'A' on GLCD GLCD_DisplayChar(0x41); //Displays 'A' on GLCD GLCD_DisplayChar('A'); //Recommended usage

Defination	void GLCD_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"}; GLCD_DisplayString(myString); GLCD_DisplayString("good morning"); }

Defination	void GLCD_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	GLCD_ScrollMessage(" Welcome to embedded programming ");

Defination	void GLCD_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 GLCD. 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; GLCD_DisplayDecimalNumber(decNumber,5); //Display last 5-digits of Number GLCD_DisplayDecimalNumber(12345,4); //Display last 4-digits of number

Defination	void GLCD_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}; GLCD_Printf("%d %l %f %x %b %s",decNum,longDec,floatNum,hexNum,hexNum,myString); GLCD_Printf("D:%d,L:%l,F=%f,H:%x,Str:%s",1234,12345678,123.456,0xAB,"hello"); }

@@ Line 267: / Line 267: @@
 ==Usage Guide==
 <html>
-<script src="https://gist.github.com/Amritach/f6623a13490f16d1ff6a.js"></script>
+<script src="https://gist.github.com/Amritach/d383ab80738c7177ad79.js"></script>
 </html>
+{{DISQUS}}