LTlib LaurTec Library  4.0.1
Open Source C Library for Microchip Microcontrollers based on XC8 Compiler
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
LCD_44780_I2C.h File Reference
#include <ctype.h>
#include "LTlib.h"

Go to the source code of this file.

Macros

#define MCP23008
 
#define DEVICE_ADDRESS_H   0x00
 
#define DEVICE_ADDRESS_L   0x00
 
#define LCD_D0   0b00000001
 
#define LCD_D1   0b00000010
 
#define LCD_D2   0b00000100
 
#define LCD_D3   0b00001000
 
#define LCD_E   0b00010000
 
#define LCD_RW   0b00100000
 
#define LCD_RS   0b01000000
 
#define LCD_LED   0b10000000
 
#define LEFT   0b00000000
 
#define RIGHT   0b00000100
 
#define LCD_LEFT   0b00000000
 
#define LCD_RIGHT   0b00000100
 
#define TURN_ON_CURSOR   0b00000010
 
#define TURN_OFF_CURSOR   0b00000000
 
#define LCD_TURN_ON_CURSOR   0b00000010
 
#define LCD_TURN_OFF_CURSOR   0b00000000
 
#define BLINKING_ON   0b00000001
 
#define BLINKING_OFF   0b00000000
 
#define LCD_BLINKING_ON   0b00000001
 
#define LCD_BLINKING_OFF   0b00000000
 
#define ZERO_CLEANING_ON   0x01
 
#define ZERO_CLEANING_OFF   0x00
 
#define LCD_ZERO_CLEANING_ON   0x01
 
#define LCD_ZERO_CLEANING_OFF   0x00
 
#define TURN_ON_LED_LCD   0b00000000
 
#define TURN_OFF_LED_LCD   0b10000000
 
#define LCD_TURN_ON_LED   0b00000000
 
#define LCD_TURN_OFF_LED   0b10000000
 
#define TURN_ON_LED_LCD   0b10000000
 
#define TURN_OFF_LED_LCD   0b00000000
 
#define LCD_TURN_ON_LED   0b10000000
 
#define LCD_TURN_OFF_LED   0b00000000
 
#define BUS_DATA_RATE_LCD   100
 
#define LCD_BUS_DATA_RATE   100
 
#define BUS_DATA_RATE_LCD   200
 
#define LCD_BUS_DATA_RATE   200
 
#define enable_pulse_LCD   LCD_enable_pulse
 
#define send_command_LCD   LCD_send_command
 
#define home_LCD   LCD_home
 
#define shift_LCD   LCD_shift
 
#define shift_cursor_LCD   LCD_shift_cursor
 
#define goto_line_LCD   LCD_goto_line
 
#define goto_xy_LCD   LCD_goto_xy
 
#define write_char_LCD   LCD_write_char
 
#define write_message_LCD   LCD_write_message
 
#define write_string_LCD   LCD_write_string
 
#define write_integer_LCD   LCD_write_integer
 
#define clear_LCD   LCD_clear
 
#define cursor_LCD   LCD_cursor
 
#define backlight_LCD   LCD_backlight
 
#define initialize_LCD   LCD_initialize
 

Functions

void LCD_enable_pulse (void)
 
void LCD_send_command (unsigned char data)
 
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 goto_line_LCD (unsigned char line)
 
void goto_xy_LCD (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 (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)
 

Macro Definition Documentation

#define backlight_LCD   LCD_backlight

Definition at line 385 of file LCD_44780_I2C.h.

#define BLINKING_OFF   0b00000000

Definition at line 155 of file LCD_44780_I2C.h.

#define BLINKING_ON   0b00000001

Definition at line 154 of file LCD_44780_I2C.h.

#define BUS_DATA_RATE_LCD   100

Definition at line 196 of file LCD_44780_I2C.h.

#define BUS_DATA_RATE_LCD   200

Definition at line 196 of file LCD_44780_I2C.h.

#define clear_LCD   LCD_clear

Definition at line 356 of file LCD_44780_I2C.h.

#define cursor_LCD   LCD_cursor

Definition at line 371 of file LCD_44780_I2C.h.

#define DEVICE_ADDRESS_H   0x00

Definition at line 123 of file LCD_44780_I2C.h.

#define DEVICE_ADDRESS_L   0x00

Definition at line 124 of file LCD_44780_I2C.h.

#define enable_pulse_LCD   LCD_enable_pulse

Definition at line 212 of file LCD_44780_I2C.h.

#define goto_line_LCD   LCD_goto_line

Definition at line 272 of file LCD_44780_I2C.h.

#define goto_xy_LCD   LCD_goto_xy

Definition at line 286 of file LCD_44780_I2C.h.

#define home_LCD   LCD_home

Definition at line 232 of file LCD_44780_I2C.h.

#define initialize_LCD   LCD_initialize

Definition at line 398 of file LCD_44780_I2C.h.

#define LCD_BLINKING_OFF   0b00000000

Definition at line 157 of file LCD_44780_I2C.h.

#define LCD_BLINKING_ON   0b00000001

Definition at line 156 of file LCD_44780_I2C.h.

#define LCD_BUS_DATA_RATE   100

Definition at line 197 of file LCD_44780_I2C.h.

#define LCD_BUS_DATA_RATE   200

Definition at line 197 of file LCD_44780_I2C.h.

#define LCD_D0   0b00000001

Definition at line 132 of file LCD_44780_I2C.h.

#define LCD_D1   0b00000010

Definition at line 133 of file LCD_44780_I2C.h.

#define LCD_D2   0b00000100

Definition at line 134 of file LCD_44780_I2C.h.

#define LCD_D3   0b00001000

Definition at line 135 of file LCD_44780_I2C.h.

#define LCD_E   0b00010000

Definition at line 136 of file LCD_44780_I2C.h.

#define LCD_LED   0b10000000

Definition at line 139 of file LCD_44780_I2C.h.

#define LCD_LEFT   0b00000000

Definition at line 146 of file LCD_44780_I2C.h.

#define LCD_RIGHT   0b00000100

Definition at line 147 of file LCD_44780_I2C.h.

#define LCD_RS   0b01000000

Definition at line 138 of file LCD_44780_I2C.h.

#define LCD_RW   0b00100000

Definition at line 137 of file LCD_44780_I2C.h.

#define LCD_TURN_OFF_CURSOR   0b00000000

Definition at line 152 of file LCD_44780_I2C.h.

#define LCD_TURN_OFF_LED   0b10000000

Definition at line 182 of file LCD_44780_I2C.h.

#define LCD_TURN_OFF_LED   0b00000000

Definition at line 182 of file LCD_44780_I2C.h.

#define LCD_TURN_ON_CURSOR   0b00000010

Definition at line 151 of file LCD_44780_I2C.h.

#define LCD_TURN_ON_LED   0b00000000

Definition at line 181 of file LCD_44780_I2C.h.

#define LCD_TURN_ON_LED   0b10000000

Definition at line 181 of file LCD_44780_I2C.h.

#define LCD_ZERO_CLEANING_OFF   0x00

Definition at line 162 of file LCD_44780_I2C.h.

#define LCD_ZERO_CLEANING_ON   0x01

Definition at line 161 of file LCD_44780_I2C.h.

#define LEFT   0b00000000

Definition at line 144 of file LCD_44780_I2C.h.

#define MCP23008

Definition at line 97 of file LCD_44780_I2C.h.

#define RIGHT   0b00000100

Definition at line 145 of file LCD_44780_I2C.h.

#define send_command_LCD   LCD_send_command

Definition at line 224 of file LCD_44780_I2C.h.

#define shift_cursor_LCD   LCD_shift_cursor

Definition at line 261 of file LCD_44780_I2C.h.

#define shift_LCD   LCD_shift

Definition at line 246 of file LCD_44780_I2C.h.

#define TURN_OFF_CURSOR   0b00000000

Definition at line 150 of file LCD_44780_I2C.h.

#define TURN_OFF_LED_LCD   0b10000000

Definition at line 180 of file LCD_44780_I2C.h.

#define TURN_OFF_LED_LCD   0b00000000

Definition at line 180 of file LCD_44780_I2C.h.

#define TURN_ON_CURSOR   0b00000010

Definition at line 149 of file LCD_44780_I2C.h.

#define TURN_ON_LED_LCD   0b00000000

Definition at line 179 of file LCD_44780_I2C.h.

#define TURN_ON_LED_LCD   0b10000000

Definition at line 179 of file LCD_44780_I2C.h.

#define write_char_LCD   LCD_write_char

Definition at line 297 of file LCD_44780_I2C.h.

#define write_integer_LCD   LCD_write_integer

Definition at line 348 of file LCD_44780_I2C.h.

#define write_message_LCD   LCD_write_message

Definition at line 317 of file LCD_44780_I2C.h.

#define write_string_LCD   LCD_write_string

Definition at line 329 of file LCD_44780_I2C.h.

#define ZERO_CLEANING_OFF   0x00

Definition at line 160 of file LCD_44780_I2C.h.

#define ZERO_CLEANING_ON   0x01

Definition at line 159 of file LCD_44780_I2C.h.

Function Documentation

void goto_line_LCD ( unsigned char  line)

This function locates the LCD cursor on the selected line. Tested on 20x4 16x2 LCD displays.

Parameters
lineSpecify the number of the line [1,2,3,4]
Warning
It might not work with all the LCD Displays.
void goto_xy_LCD ( 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.
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 library.

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 274 of file LCD_44780.c.

References data_buffer, I2C_device_address, LCD_LED, LCD_TURN_ON_LED, MCP2300x_set_port_value(), and PCF8574_write_data().

void LCD_clear ( void  )

This Function cleans the LCD display.

Definition at line 256 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_BLINK_ON, LCD_BLINK_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 library.

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 265 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 48 of file LCD_44780.c.

References data_buffer, delay_ms(), I2C_device_address, LCD_E, MCP2300x_set_port_value(), and PCF8574_write_data().

void LCD_home ( void  )

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

Definition at line 73 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 282 of file LCD_44780.c.

References data_buffer, delay_ms(), delay_set_quartz(), DEVICE_ADDRESS_H, DEVICE_ADDRESS_L, I2C_device_address, LCD_BLINKING_OFF, LCD_BUS_DATA_RATE, LCD_clear(), LCD_cursor(), LCD_D0_TRIS, LCD_D1_TRIS, LCD_D2_TRIS, LCD_D3_TRIS, LCD_E, LCD_E_TRIS, LCD_LED_TRIS, LCD_RS, LCD_RS_TRIS, LCD_RW, LCD_RW_TRIS, LCD_send_command(), LCD_TURN_OFF_CURSOR, MCP2300x_initialize(), MCP2300x_set_port_direction(), MCP2300x_set_port_value(), PCF8574_initialize(), PCF8574_write_data(), and PIN_AS_OUTPUT.

void LCD_send_command ( unsigned char  data)

This function generates the Enable pulse.

Parameters
dataData to be sent [0..255]
Warning
This function is a Private one. It should not be used by the user.

Definition at line 78 of file LCD_44780_I2C.c.

References data_buffer, I2C_device_address, LCD_enable_pulse(), MCP2300x_set_port_value(), and PCF8574_write_data().

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 library.

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 83 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 writting 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 library.

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 97 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 144 of file LCD_44780.c.

References data_buffer, I2C_device_address, LCD_RS, LCD_send_command(), MCP2300x_set_port_value(), and PCF8574_write_data().

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

This function writes an integer to the LCD display. The integer is converted to string.

Parameters
valueIt is integer that must be written to the LCD display.
numeber_of_digitsIt specifies the number of shown digit [0-5]. 0: Left Justified 1-5: Right Justified with n digit
zero_cleaningIt specifies whether the left zero must be removed [LCD_ZERO_CLEANING_ON, LCD_ZERO_CLEANING_OFF].
Note
If you set a number of digit less than required the digit will be lost starting from the less significant digit. Minus is like a digit.
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 write_string_LCD () function.

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 173 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 rom use write_message_LCD ().

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 193 of file LCD_44780.c.

References LCD_write_char().