Component - Character LCD (CharLCD) V1.50 Datasheet.pdf

®
PSoC Creator™ Component Datasheet
Character LCD
1.50
Features
 Implements the industry-standard Hitachi HD44780 LCD display driver chip
protocol



Requires only seven I/O pins on one I/O port
Contains built-in character editor to create user-defined custom characters
Supports horizontal and vertical bar graphs
General Description
The Character LCD component contains a set of library routines that enable simple use of one,
two, or four-line LCD modules that follow the Hitachi 44780 standard 4-bit interface. The
component provides APIs to implement horizontal and vertical bar graphs, or you can create and
display your own custom characters.
When to Use a Character LCD
Use the Character LCD component to display text data to the user of the product or to a
developer during design and debug.
Input/Output Connections
This section describes the various input and output connections available for the Character LCD.
LCD_Port – Pin Editor
The LCD uses seven consecutive pins of a physical port. To place the Character LCD onto your
desired port, use the Design-Wide Resources Pin Editor. The Pin Editor allows you to place this
component’s digital port on any free output port.
Note The seven pins can be placed to start at either Pin 1 or Pin 0 of the selected port, but may
not span ports. These pins are for the exclusive use of the LCD port and cannot be used for any
other purpose.
No direct access to the Character LCD’s port is needed as the software APIs manage all reads
and writes for you. The pin connections between an LCD module and a PSoC logical port are
detailed in Functional Description.
Cypress Semiconductor Corporation • 198 Champion Court • San Jose, CA 95134-1709 • 408-943-2600
Document Number: 001-61960 Rev. *C
Revised September 26, 2011
Character LCD
®
PSoC Creator™ Component Datasheet
Component Parameters
Drag a Character LCD component onto your design and double-click it to open the Configure
dialog.
Parameters
LCD Custom Character Set
This parameter enables the selection of the following options:



None (Default) – Do not do anything with custom characters.

User Defined –Create custom characters and API to manipulate them.
Vertical Bargraph – Generate custom characters and API to manipulate a vertical bar graph.
Horizontal Bargraph – Generate custom characters and API to manipulate a horizontal bar
graph.
After the component has loaded in the characters, the LCD_Char_PutChar() function and the
custom character constants (from the header file) can be used to display them.
Page 2 of 15
Document Number: 001-61960 Rev. *C
®
PSoC Creator™ Component Datasheet
Character LCD
Conversion Routines
Selecting the Include ASCII to Number Conversion Routines option adds several API
functions to the generated code. (Refer to the API table or function descriptions for more
information about these routines.)
Custom Character Editor
The Custom Character Editor makes user-defined character sets easy to create through the
use of a GUI. Each of the 8 characters can be up to 5x8 pixels, though some hardware may not
display more than the top 5x7.
To use the Custom Character Editor, select User Defined as the option for the LCD Custom
Character Set. Then, click on the thumbnail of the character you want to edit.
To toggle a pixel in your character, click on the chosen pixel in the enlarged character view. You
may also click and drag to toggle multiple pixels.
After creating a custom character set, the GUI will generate a look-up array of eight custom
characters. Then the look-up array can be loaded to a LCD module. By default, the
LCD_Char_Start() routine loads custom characters if any were selected or created.
The component’s functionality allows you to create custom character sets in the code and load
them at run time. In that case, the last loaded character set overwrites the previous one and
becomes active. To restore the original custom character set that you created using the
component’s GUI, you must add the following line to the top of your source code “extern
uint8 const CYCODE LCD_Char_customFonts[];” . At run time,
LCD_Char_LoadCustomFonts() can use that code as a parameter to load the original character
set to the LCD module.
Figure 1 shows a custom character encoded into an 8-byte custom character lookup array row.
Figure 1. Custom Character Encoding
As shown in the diagram, each row of a character is encoded as a single byte, from which only
the five least-significant bits are used. The top row of the first character is encoded in the first
Document Number: 001-61960 Rev. *C
Page 3 of 15
®
Character LCD
PSoC Creator™ Component Datasheet
byte of the custom font array. The next row of the first character is the second byte in the array.
The first row of the second character is the ninth byte in the array, and so on. The entire custom
font array consists of eight custom characters, creating a total array size of 64 bytes.
Resources
API Memory (Bytes)
Configuration
Digital Blocks
Flash
RAM
Pins (per External I/O)
None
0
685
3
7
Vertical
0
1276
3
7
Horizontal
0
1276
3
7
User Defined
0
823
3
7
None + Conversion Routines
0
932
3
7
Application Programming Interface
Application Programming Interface (API) routines allow you to configure the component using
software. The following table lists and describes the interface to each function together with
related constants provided by the “include” files. The subsequent sections cover each function in
more detail.
By default, PSoC Creator assigns the instance name “LCD_Char_1” to the first instance of a
component in a given project. You can rename it to any unique value that follows the syntactic
rules for identifiers. The instance name becomes the prefix of every global function name,
variable, and constant symbol. For readability, the instance name used in the following table is
“LCD_Char.”
Functions
Description
LCD_Char_Start()
Starts the module and loads custom character set to LCD if it was defined.
LCD_Char_Stop()
Turns off the LCD
LCD_Char_DisplayOn()
Turns on the LCD module’s display
LCD_Char_DisplayOff()
Turns off the LCD module’s display
LCD_Char_PrintString()
Prints a null-terminated string to the screen, character by character
LCD_Char_PutChar()
Sends a single character to the LCD module data register at the current position.
LCD_Char_Position()
Sets the cursor’s position to match the row and column supplied
LCD_Char_WriteData()
Writes a single byte of data to the LCD module data register
LCD_Char_WriteControl()
Writes a single-byte instruction to the LCD module control register
LCD_Char_ClearDisplay()
Clears the data from the LCD module’s screen
Page 4 of 15
Document Number: 001-61960 Rev. *C
®
PSoC Creator™ Component Datasheet
Functions
Character LCD
Description
LCD_Char_IsReady()
Polls LCD until the ready bit is set
LCD_Char_Sleep()
Prepares component for entering sleep mode
LCD_Char_Wakeup()
Restores components configuration and turns on the LCD
LCD_Char_Init()
Performs initialization required for component’s normal work
LCD_Char_Enable()
Turns on the display
LCD_Char_SaveConfig()
Empty API provided to store any required data prior entering to a Sleep mode.
LCD_Char_RestoreConfig()
Empty API provided to restore saved data after exiting a Sleep mode.
The following optional functions are included, when needed, if a user-selected custom font is
selected. The LCD_Char_LoadCustomFonts()function comes with every custom font set,
whether it is user-defined or PSoC Creator generated. The LCD_Char_LoadCustomFonts()
function can be used to load the user-defined or the bar graph characters into the LCD
hardware. If loading custom fonts created by the tool, you will need to import a pointer to the
custom font to your project prior to using this function (refer to the description of
LCD_Char_LoadCustomFonts()). By default, the LCD_Char_Init() routine loads the userselected custom font. The draw bar graph commands are generated when a bar graph is
selected and enable the easy, dynamic adjustment of bar graphs.
Optional Custom Font Functions
Description
LCD_Char_LoadCustomFonts()
Loads custom characters into the LCD module
LCD_Char_DrawHorizontalBG()
Draws a horizontal bar graph. Only available when a bar graph character set
has been selected.
LCD_Char_DrawVerticalBG()
Draws a vertical bar graph. Only available when a bar graph character set
has been selected.
The following optional functions are included when needed by your selection:
Optional Number to ASCII
Conversion Routines
Description
LCD_Char_PrintInt8()
Prints a two-ASCII-character hex representation of the 8-bit value to the
Character LCD module.
LCD_Char_PrintInt16()
Prints a four-ASCII-character hex representation of the 16-bit value to the
Character LCD module.
LCD_Char_PrintNumber()
Prints the decimal value of a 16-bit value as left-justified ASCII characters
Document Number: 001-61960 Rev. *C
Page 5 of 15
®
Character LCD
PSoC Creator™ Component Datasheet
void LCD_Char_Start(void)
Description:
This function initializes the LCD hardware module as follows:




Enables 4-bit interface
Clears the display
Enables auto cursor increment
Resets the cursor to start position
It also loads a custom character set to LCD if it was defined in the customizer's GUI.
Parameters:
None
Return Value:
None
Side Effects:
None
void LCD_Char_Stop(void)
Description:
Turns off the display of the LCD screen.
Parameters:
None
Return Value:
None
Side Effects:
None
void LCD_Char_PrintString(char8 * string)
Description:
Write a null-terminated string of characters to the screen beginning at the current cursor
location.
Parameters:
char8 * string: Null-terminated array of ASCII characters to be displayed on the LCD
module’s screen.
Return Value:
None
Side Effects:
None
void LCD_Char_PutChar(char8 character)
Description:
Writes an individual character to the screen at the current cursor location. Used to display
custom characters through their named values. (LCD_Char_CUSTOM_0() through
LCD_Char_CUSTOM_7().
Parameters:
char8 character: ASCII character to be displayed on the LCD module’s screen.
Return Value:
None
Side Effects:
None
Page 6 of 15
Document Number: 001-61960 Rev. *C
®
PSoC Creator™ Component Datasheet
Character LCD
void LCD_Char_Position(uint8 row, uint8 column)
Description:
Moves the cursor to the location specified by arguments row and column.
Parameters:
uint8 row: The row number at which to position the cursor. Minimum value is zero.
uint8 column: The column number at which to position the cursor. Minimum value is zero.
Return Value:
None
Side Effects:
None
void LCD_Char_WriteData(uint8 dByte)
Description:
Writes data to the LCD RAM in the current position. Upon write completion, the position is
incremented or decremented depending on the entry mode specified.
Parameters:
dByte: A byte value to be written to the LCD module.
Return Value:
None
Side Effects:
None
Document Number: 001-61960 Rev. *C
Page 7 of 15
®
Character LCD
PSoC Creator™ Component Datasheet
void LCD_Char_WriteControl(uint8 cByte)
Description:
Writes a command byte to the LCD module. Different LCD models can have their own
commands. Review the specific LCD datasheet for commands valid for that model.
Parameters:
cByte: 8-bit value representing the command to be loaded into the command register of the
LCD module. Valid command parameters are specified in the table below:
Value
Description
LCD_Char_CLEAR_DISPLAY
Clear display
LCD_Char_RESET_CURSOR_POSITION
LCD_Char_CURSOR_HOME
Return cursor and LCD to home
position
LCD_Char_CURSOR_LEFT
Set left cursor move direction
LCD_Char_CURSOR_RIGHT
Set right cursor move direction
LCD_Char_DISPLAY_CURSOR_ON
Enable display and cursor
LCD_Char_DISPLAY_ON_CURSOR_OFF
Enable display, cursor off
LCD_Char_CURSOR_WINK
Enable display, cursor off, set cursor
wink
LCD_Char_CURSOR_BLINK
Enable display and cursor, set cursor
blink
LCD_Char_CURSOR_SH_LEFT
Move cursor/Shift display left
LCD_Char_CURSOR_SH_RIGHT
Move cursor/shift display right
LCD_Char_DISPLAY_2_LINES_5x10
Set display to be 2 lines 10 characters
Return Value:
None
Side Effects:
None
void LCD_Char_ClearDisplay(void)
Description:
Clears the contents of the screen and resets the cursor location to be row and column zero.
It calls LCD_Char_WriteControl() with the appropriate argument to activate the display.
Parameters:
None
Return Value:
None
Side Effects:
Cursor position reset to 0,0.
Page 8 of 15
Document Number: 001-61960 Rev. *C
®
PSoC Creator™ Component Datasheet
Character LCD
void LCD_Char_IsReady(void)
Description:
Polls LCD until the ready bit is set
Parameters:
None
Return Value:
None
Side Effects:
Changes pins to HI-Z.
void LCD_Char_DisplayOff(void)
Description:
Turns the display off, but does not reset the LCD module in any way. It calls function
LCD_Char_WriteControl() with the appropriate argument to deactivate the display.
Parameters:
None
Return Value:
None
Side Effects:
None
void LCD_Char_DisplayOn(void)
Description:
Turns the display on, without initializing it. It calls function LCD_Char_WriteControl() with the
appropriate argument to activate the display.
Parameters:
None
Return Value:
None
Side Effects:
None
void LCD_Char_Sleep(void)
Description:
This is the preferred routine to prepare the component for sleep. The LCD_Char_Sleep()
routine saves the current component state. Then it calls the LCD_Char_Stop() function and
calls LCD_Char_SaveConfig() to save the hardware configuration.
Call the LCD_Char_Sleep() function before calling the CyPmSleep() or the CyPmHibernate()
function. Refer to the PSoC Creator System Reference Guide for more information about
power management functions.
Parameters:
None
Return Value:
None
Side Effects:
Doesn't change component pins’ drive modes. Use Port Component APIs for that purpose.
Because Character LCD is an interface component that has its own protocol, you need to
reinitialize the component after you have saved or restored component pin states.
Document Number: 001-61960 Rev. *C
Page 9 of 15
®
Character LCD
PSoC Creator™ Component Datasheet
void LCD_Char_Wakeup(void)
Description:
Restores component’s configuration and turns on the LCD.
Parameters:
None
Return Value:
None
Side Effects:
None
void LCD_Char_Init(void)
Description:
Performs initialization required for the component's normal work. LCD_Char_Init() also loads
the custom character set if it was defined in the Configure dialog.
Parameters:
None
Return Value:
None
Side Effects:
None
void LCD_Char_Enable(void)
Description:
Turns on the display.
Parameters:
None
Return Value:
None
Side Effects:
None
void LCD_Char_SaveConfig(void)
Description:
Empty API provided to store any required data prior to entering Sleep mode.
Parameters:
None
Return Value:
None
Side Effects:
None
void LCD_Char_RestoreConfig(void)
Description:
Empty API provided to restore saved data after exiting Sleep mode.
Parameters:
None
Return Value:
None
Side Effects:
None
Page 10 of 15
Document Number: 001-61960 Rev. *C
®
PSoC Creator™ Component Datasheet
Character LCD
void LCD_Char_LoadCustomFonts(const uint8 * customData)
Description:
Loads eight custom characters (bar graph or user-defined fonts) into the LCD module to use
the custom fonts during runtime. Only available if a custom character set was selected in the
customizer.
Parameters:
Const uint8 * customData: Pointer to the head of an array of bytes. Array should be 64 bytes
long as 5x8 characters require 8 bytes per character.
Return Value:
None
Side Effects:
Overwrites any previous custom characters that may have been stored in the LCD module.
void LCD_Char_DrawHorizontalBG(uint8 row, uint8 column, uint8
maxCharacters, uint8 value)
Description:
Draws a horizontal bar graph. Only available if a horizontal or vertical bar graph was
selected.
Parameters:
uint8 row: The row of the first character in the bar graph.
uint8 column: The column of the first character in the bar graph.
uint8 maxCharacters: Number of whole characters the bar graph consumes. Represents
height or width depending upon the bar graph selection. Each character is 5 pixels wide and
8 pixels high.
uint8 value: Number of shaded pixels to draw. May not exceed total pixel length (height) of
the bar graph.
Return Value:
None
Side Effects:
None
void LCD_Char_DrawVerticalBG(uint8 row, uint8 column, uint8
maxCharacters, uint8 value)
Description:
Draws a vertical bar graph. Only available if a horizontal or vertical bar graph was selected.
Parameters:
uint8 row: The row of the first character in the bar graph.
uint8 column: The column of the first character in the bar graph.
uint8 maxCharacters: Number of whole characters the bar graph consumes. Represents
height or width depending upon the bar graph selection. Each character is 5 pixels wide and
8 pixels high.
uint8 value: Number of shaded pixels to draw. May not exceed total pixel length (height) of
the bar graph.
Return Value:
None
Side Effects:
None
Document Number: 001-61960 Rev. *C
Page 11 of 15
®
Character LCD
PSoC Creator™ Component Datasheet
void LCD_Char_PrintInt8(uint8 value)
Description:
Prints a two-ASCII-character representation of the 8-bit value to the Character LCD module.
Parameters:
uint8 value: The 8-bit value to be printed in hexadecimal ASCII characters.
Return Value:
None
Side Effects:
None
void LCD_Char_PrintInt16(uint16 value)
Description:
Prints a four-ASCII-character representation of the 16-bit value to the Character LCD
module.
Parameters:
uint16 value: The 16-bit value to be printed in hexadecimal ASCII characters.
Return Value:
None
Side Effects:
None
void LCD_Char_PrintNumber(uint16 value)
Description:
Prints the decimal value of a 16-bit value as left-justified ASCII characters.
Parameters:
uint16 value: The 16-bit value to be printed in ASCII characters as a decimal number.
Return Value:
None
Side Effects:
None
Sample Firmware Source Code
PSoC Creator provides many example projects that include schematics and example code in the
Find Example Project dialog. For component-specific examples, open the dialog from the
Component Catalog or an instance of the component in a schematic. For general examples,
open the dialog from the Start Page or File menu. As needed, use the Filter Options in the
dialog to narrow the list of projects available to select.
Refer to the “Find Example Project” topic in the PSoC Creator Help for more information.
Functional Description
The LCD module provides a visual display for alphanumeric characters as well as limited custom
fonts. The APIs configure the PSoC device as necessary to easily interface between the
standard Hitachi LCD display driver and the PSoC device.
The following table describes the LCD logical port pin to physical LCD module pin mapping. The
LCD’s Logical port can be mapped to start on the first or second physical pin of a port; it may not
Page 12 of 15
Document Number: 001-61960 Rev. *C
®
PSoC Creator™ Component Datasheet
Character LCD
span ports. That is, LogicalPort_0 could theoretically be Port 2, Pin 0 or Port 2, Pin 1. Using the
pin editor to force the LCD logical port to begin at pin 0 improves efficiency by reducing the
number of shifts required to align data for a write.
Logical Port Pin
LCD Module Pin
Description
LCDPort_0
DB4
Data Bit 0
LCDPort_1
DB5
Data Bit 1
LCDPort_2
DB6
Data Bit 2
LCDPort_3
DB7
Data Bit 3
LCDPort_4
E
LCD Enable (strobe to confirm new data available)
LCDPort_5
RS
Register Select (select data or control input data)
LCDPort_6
R/!W
Read/not Write (toggle for polling the ready bit of the LCD)
Figure 2. Pin Editor Diagram
+5V
Hitachi
Compatable
LCD
-1. Vss
-2. Vcc
-3. Vee
10k
-4. RS
-5. R/!W
-6. E
Micro Controller
Core
7
-11. DB4
-12. DB5
-13. DB6
-14. DB7
The LCD_Char_Position() function manages display addressing as follows. Row zero, column
zero is in the upper left corner with the column number increasing to the right. In a four-line
display, writing beyond column 19 of row 0 can result in row 2 being corrupted because the
addressing maps row 0, column 20 to row 2, column 0. This is not an issue in the standard 2x16
Hitachi module.
Document Number: 001-61960 Rev. *C
Page 13 of 15
®
Character LCD
PSoC Creator™ Component Datasheet
Figure 3. 2x16 Hitachi LCD Module
Component Changes
This section lists the major changes in the component from the previous versions.
Version
Description of Changes
Reason for Changes / Impact
1.50.c
Added instruction to datasheet to restore
default customer font set
1.50.b
Removed void LCD_Char_WriteControl(uint8
command) API.
void LCD_Char_WriteControl(uint8 command) API
was described twice in the API section, so the extra
description was deleted.
Removed a note about the necessity of calling
LCD_Char_LoadCustomFonts() from the
description of LCD_Char_DrawHorizontalBG()
and LCD_Char_DrawVerticalBG() APIs.
Now there is no need to call
LCD_Char_LoadCustomFonts() prior using
LCD_Char_DrawHorizontalBG() or
LCD_Char_DrawVerticalBG() as it is done in the
component’s LCD_Char_Start() routine.
Updated LCD_Char_WriteData(),
LCD_Char_WriteControl(), and
LCD_Char_Sleep() API's description in the
datasheet
There was no description of parameters in function
LCD_Char_WriteData(), so the appropriate
description was added. The description of
LCD_Char_Sleep() was very poor so it was updated
with more details. The description of
LCD_Char_WriteControl() were extended with details
of possible input parameter values.
1.50.a
Minor datasheet edits and updates
1.50
Added LCD_Char_Sleep(),
LCD_Char_Wakeup(), LCD_Char_Enable(),
LCD_Char_Init(), LCD_Char_SaveConfig(),
LCD_Char_RestoreConfig() APIs.
To support low power modes and provide common
interfaces for most components.
Added new API file - CharLCD_PM.c which
contains declaration of Sleep mode APIs.
To support low power modes.
Added a call to
LCD_Char_LoadCustomFonts() in the
LCD_Char_Init() API.
The selected custom font in the Configure dialog is
automatically loaded the first time LCD_Char_Start()
is called in the project.
Page 14 of 15
Document Number: 001-61960 Rev. *C
®
PSoC Creator™ Component Datasheet
Version
Description of Changes
Character LCD
Reason for Changes / Impact
1.40
Added an additional delay into the initialization
sequence of the LCD_Char_Start() function in
order to meet the timing requirements for the
display.
Prevents failures in initialization that were present
when running the system at high frequencies.
1.30
Replaced Digital Port component with a Pins
component in the Char LCD schematic.
Old Digital Port was deprecated and was replaced
with the new Pins component.
Added description of IsReady function.
There was no mention about LCD_Char_IsReady() in
the old version of datasheet.
Deleted the function LCD_Char_DelayUS()
and replaced it with LCD_Char_CyDelay() or
LCD_Char_IsReady().
This was to address a timing issue with the
component which caused some failures.
1.20.a
Added information to the component that
advertizes its compatibility with silicon
revisions.
The tool reports an error/warning if the component is
used on incompatible silicon. If this happens, update
to a revision that supports your target device.
1.20
Updated Symbol
To comply with corporate standard.
1.10.a
Added information to the component that
advertizes its compatibility with silicon
revisions.
The tool reports an error/warning if the component is
used on incompatible silicon. If this happens, update
to a revision that supports your target device.
1.10
Various updates from version 0.2
0.2 version was included with alpha builds, but was
not a completely functional component.
© Cypress Semiconductor Corporation, 2010-2011. The information contained herein is subject to change without notice. Cypress Semiconductor Corporation assumes no responsibility for the
use of any circuitry other than circuitry embodied in a Cypress product. Nor does it convey or imply any license under patent or other rights. Cypress products are not warranted nor intended to
be used for medical, life support, life saving, critical control or safety applications, unless pursuant to an express written agreement with Cypress. Furthermore, Cypress does not authorize its
products for use as critical components in life-support systems where a malfunction or failure may reasonably be expected to result in significant injury to the user. The inclusion of Cypress
products in life-support systems application implies that the manufacturer assumes all risk of such use and in doing so indemnifies Cypress against all charges.
PSoC® is a registered trademark, and PSoC Creator™ and Programmable System-on-Chip™ are trademarks of Cypress Semiconductor Corp. All other trademarks or registered trademarks
referenced herein are property of the respective corporations.
Any Source Code (software and/or firmware) is owned by Cypress Semiconductor Corporation (Cypress) and is protected by and subject to worldwide patent protection (United States and
foreign), United States copyright laws and international treaty provisions. Cypress hereby grants to licensee a personal, non-exclusive, non-transferable license to copy, use, modify, create
derivative works of, and compile the Cypress Source Code and derivative works for the sole purpose of creating custom software and or firmware in support of licensee product to be used only in
conjunction with a Cypress integrated circuit as specified in the applicable agreement. Any reproduction, modification, translation, compilation, or representation of this Source Code except as
specified above is prohibited without the express written permission of Cypress.
Disclaimer: CYPRESS MAKES NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Cypress reserves the right to make changes without further notice to the materials described herein.
Cypress does not assume any liability arising out of the application or use of any product or circuit described herein. Cypress does not authorize its products for use as critical components in lifesupport systems where a malfunction or failure may reasonably be expected to result in significant injury to the user. The inclusion of Cypress’ product in a life-support systems application
implies that the manufacturer assumes all risk of such use and in doing so indemnifies Cypress against all charges.
Use may be limited by and subject to the applicable Cypress software license agreement.
Document Number: 001-61960 Rev. *C
Page 15 of 15
Similar pages