PIC18 LaurTec Library  3.3.1
Open Source C Library for PIC18 Microcontrollers based on C18 - XC8 Compilers
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
LCD_44780.c File Reference
#include "LCD_44780.h"

Go to the source code of this file.

Functions

void LCD_enable_pulse (void)
 
void LCD_send_command (unsigned char D3, unsigned char D2, unsigned char D1, unsigned char D0)
 
void LCD_home (void)
 
void LCD_shift (unsigned char shift, unsigned char number_of_shift)
 
void LCD_shift_cursor (unsigned char shift, unsigned char number_of_shift)
 
void LCD_goto_line (unsigned char line)
 
void LCD_goto_xy (unsigned char x, unsigned char y)
 
void LCD_write_char (unsigned char value)
 
void LCD_write_message (const rom unsigned char *buffer)
 
void LCD_write_string (unsigned char *buffer)
 
void LCD_write_integer (signed int value, unsigned char number_of_digits, unsigned char zero_cleaning)
 
void LCD_clear (void)
 
void LCD_cursor (unsigned char active, unsigned char blinking)
 
void LCD_backlight (unsigned char active)
 
void LCD_initialize (unsigned char quartz_frequency)
 

Function Documentation

void LCD_backlight ( unsigned char  active)

This function controls the backligth LED.

Parameters
activeActivate the LED backlight [LCD_TURN_ON_LED, LCD_TURN_OFF_LED]
blinkingLet the cursor blink [LCD_BLINKING_ON, LCD_BLINKING_OFF]
Note
You must use the constant LCD_TURN_ON_LED, LCD_TURN_OFF_LED to ensure the compatibility with LCD_44780_I2C library.

Definition at line 275 of file LCD_44780.c.

References LCD_LED.

void LCD_clear ( void  )

This Function cleans the LCD display.

Definition at line 257 of file LCD_44780.c.

References LCD_send_command().

void LCD_cursor ( unsigned char  active,
unsigned char  blinking 
)

This function controls the cursor option (blinking, active)

Parameters
activeActivate the cursor, showing it or not [LCD_TURN_ON_CURSOR, LCD_TURN_OFF_CURSOR]
blinkingLet the cursor blink [LCD_BLINKING_ON, LCD_BLINKING_OFF]
Note
You must use the constant LCD_TURN_ON_CURSOR, LCD_TURN_OFF_CURSOR, LCD_BLINKING_ON, LCD_BLINKING_OFF to ensure the compatibility with LCD_44780_I2C library.

Definition at line 266 of file LCD_44780.c.

References LCD_send_command().

void LCD_enable_pulse ( void  )

This function generates the Enable pulse.

Warning
This function is a Private one. It should not be used by the user.

Definition at line 49 of file LCD_44780.c.

References delay_ms(), and LCD_E.

void LCD_goto_line ( unsigned char  line)

This function locates the LCD cursor on the selected line.

Parameters
lineSpecify the number of the line [1,2,3,4]
Warning
It might not work with all the LCD Displays. Tested on 20x4 16x2 LCD displays.

Definition at line 111 of file LCD_44780.c.

References LCD_send_command().

void LCD_goto_xy ( unsigned char  x,
unsigned char  y 
)

This function locates the LCD cursor to an arbitrary X Y location. Y represents the line number from top.

Parameters
xIt Specifies horizontal position
yIt Specifies vertical position (line number)
Warning
It might not work with all the LCD Displays. Tested on 20x4 16x2 LCD displays.

Definition at line 136 of file LCD_44780.c.

References LCD_goto_line(), LCD_shift_cursor(), and RIGHT.

void LCD_home ( void  )

This function locates the cursor at home location. First line first character.

Definition at line 74 of file LCD_44780.c.

References LCD_send_command().

void LCD_initialize ( unsigned char  quartz_frequency)

This function initializes the LCD to work in 4 bit modality.

Parameters
quartz_frequencyQuartz freq. expressed in MHz used to run the CPU.
Note
You must properly set the microcontroller pins using the TRISx registers The library requires the delay library to be included.

Definition at line 283 of file LCD_44780.c.

References delay_ms(), delay_set_quartz(), LCD_clear(), LCD_cursor(), LCD_E, LCD_RS, LCD_RW, and LCD_send_command().

void LCD_send_command ( unsigned char  bit_3,
unsigned char  bit_2,
unsigned char  bit_1,
unsigned char  bit_0 
)

This function generates the Enable pulse.

Parameters
bit_0bit 0 of the data bus (4 bit modality)
bit_1bit 1 of the data bus (4 bit modality)
bit_2bit 2 of the data bus (4 bit modality)
bit_3bit 3 of the data bus (4 bit modality)
Warning
This function is a Private one. It should not be used by the user.

Definition at line 61 of file LCD_44780.c.

References LCD_D0, LCD_D1, LCD_D2, LCD_D3, and LCD_enable_pulse().

void LCD_shift ( unsigned char  shift,
unsigned char  number_of_shift 
)

This function shifts the LCD screen on the left or right.

Parameters
shiftSpecify where the shift should be [LCD_LEFT, LCD_RIGHT].
number_of_shiftSpecify the number of times the shift is executed.
Note
Use the constants LEFT, RIGHT to specify the direction to ensure the compatibility with LCD_44780_I2C library.

Definition at line 84 of file LCD_44780.c.

References LCD_send_command().

void LCD_shift_cursor ( unsigned char  shift,
unsigned char  number_of_shift 
)

This function shifts the LCD cursor on the left or right. The position of the cursor is where the next writing will be performed.

Parameters
shiftSpecify where the shift should be [LCD_LEFT, LCD_RIGHT].
number_of_shiftSpecify the number of times the shift is executed.
Note
Use the constants LEFT, RIGHT to specify the direction to ensure the compatibility with LCD_44780_I2C library.

Definition at line 98 of file LCD_44780.c.

References LCD_send_command().

void LCD_write_char ( unsigned char  value)

This function writes a char to the LCD display. (e.g LCD_write_char ('a'); )

Parameters
valueSpecify the character to be sent [0-128 ASCII code].
Note
The function accept ASCII integer or constants 'a'..'z'.

Definition at line 145 of file LCD_44780.c.

References LCD_RS, and LCD_send_command().

void LCD_write_integer ( signed int  value,
unsigned char  number_of_digits,
unsigned char  zero_cleaning 
)

Definition at line 210 of file LCD_44780.c.

References LCD_write_string(), and ZERO_CLEANING_ON.

void LCD_write_message ( const rom unsigned char *  buffer)

This function writes a const string to the LCD display, e.g LCD_write_message("Hello"); .

Parameters
bufferIs a const string written in rom (is not an array).
Note
The function accepts strings written in rom (constant), it does not accept array. To write arrays refers the LCD_write_string () function.

Definition at line 174 of file LCD_44780.c.

References LCD_write_char(), and LCD_write_message().

void LCD_write_string ( unsigned char *  buffer)

This function writes an array of char to the LCD display, terminated with /0 .

Parameters
bufferIt is an array of char terminated with /0 .
Note
The function accepts strings within an array. To use const array within flash use LCD_write_message ().

Definition at line 194 of file LCD_44780.c.

References LCD_write_char().