1204 User Guide: Difference between revisions

From Phidgets Support
No edit summary
No edit summary
 
(27 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOINDEX__
<metadesc>The PhidgetTextLCD Adapter is a dual channel LCD controller that is compatible with HD44780 LCD modules. Connects to your computer via USB.</metadesc>
[[Category:UserGuide]]
[[Category:UserGuide]]
{{UserguideTOC|1204.jpg|1204}}
==Getting Started==
==Getting Started==
{{UGIntro|1204}}
*[{{SERVER}}/products.php?product_id=1204 1204 TextLCD Adapter]
*USB cable and computer
*{{CT|LCDScreen|LCD Screen}} and cable


===Checking the Contents===
{{UGbox|
'''You should have received:'''
* A PhidgetTextLCD Adapter
* A mini-USB cable
* Mounting hardware kit
|
'''In order to test your new Phidget you will also need:'''
* An LCD
* An LCD cable
||}}


===Connecting the Pieces===
Next, you will need to connect the pieces:
{{UGbox|
[[Image:1204_0_Connecting_the_Hardware.jpg|500px|right|link=]]
#Connect your LCD to the Adapter using your LCD cable. The connector can be difficult to push in on both ends- If it isn't going in, try pushing a little bit harder.
# Connect the LCD screen to the adapter using the LCD cable.
#Connect the PhidgetTextLCD Adapter to your computer using the Mini-USB cable.
# Connect the TextLCD adapter to the computer using a USB cable.
|
[[image:1204 0 Connecting the Hardware.jpg|400px|link=]]
||}}


===Testing Using Windows 2000 / XP / Vista / 7===
<br clear="all">
{{UGIntroDone|1204}}


{{UGwin}}
==Using the 1204==
{{UGcontrolpanel|1204}}


===Running Phidgets Sample Program===
{{ugTextLCDScreenSize|1204|Text LCD}}


{{UGwin2|'''TextLCD-full'''}}
{{ugUsingYourOwnProgram|1204}}


{{UGbox6|
==Technical Details==
Double Click on the [[File:Ph.jpg|link=]] icon to activate the Phidget Control Panel and make sure that the '''PhidgetTextLCD Adapter''' is properly attached  to your PC. 
===Introduction===
|[[File:1204_0_Control_Panel_Screen.jpg|400px|link=]]
Liquid Crystal Displays are display devices used to convey information through arrangements of pixels. Graphic and Text LCDs are the most common types available for electronic products. The 1204 supports the following screen sizes (lines x characters): 1x8, 2x8, 1x16, 2x16, 4x16, 2x20, 4x20, 2x24, 1x40, 2x40, 4x40. Please note that your program has no way of automatically detecting the size of the attached screen, so you need to set the screen size with call from {{Phidget22API}} in order to have text strings display properly.
|
'''LCD Display Tab'''
#Double Click on '''PhidgetTextLCD Adapter''' in the Phidget Control Panel to bring up TextLCD-full and check that the box labelled Attached contains the word True.
#Choose the screen.
#Select the screen size.
#Click on Initialize to set-up and clear the display.
#Click on the Backlight box. The screen will light up.
#Click on the Cursor box. A “dash” cursor will appear on the screen.
#Click on the Cursor Blink box. A square blinking cursor will appear on the screen.
#You can increase or decrease the LCD contrast by moving the pointer in the Contrast slider box.
#You can increase or decrease the LED Brightness by moving the pointer in the Brightness slider box.
#You can type your message to be displayed on the LCD screen.
#To make your own characters, click on the Custom Characters Tab.
|
[[File:1204 0 TextLCD Screen.jpg|link=|300px]]
|'''Custom Characters Tab'''
#Draw your custom character.
#Select the memory location (you can store up to 8 characters in location 0 to 7).
#Select the screen.
#Store the custom character in the memory location.
#The stored values are shown in the boxes.  The algorithm is described in the Technical Section of the manual. You can see your custom character by typing \0 (in the case of Memory Location 0) in one of the text boxes on the “LCD Display” tab.
|
[[image:1204 0 TextLCD Custom Characters Screen.jpg|link=|300px]]
}}


===Testing Using Mac OS X===
===Connector===
Below is a pinout diagram for the connector on the 1204, with descriptions of each pin. Remember to use the end of the cable with the larger connector with the 1204 if you want the wire colors to be consistent with the diagram.


{{UGmac| | }}
[[File:1204-pinout.jpg|link=|300px|center]]
{|class = "wikitable"
| align="center" style="background:#f0f0f0;"|'''Pin'''
| align="center" style="background:#f0f0f0;"|'''Description '''
|-
|align=center| A
|align=center| LED Anode (+)
|-
|align=center| K
|align=center| LED Cathode (-)
|-
|align=center| VSS
|align=center| Board Ground
|-
|align=center| VDD
|align=center| Supply Voltage (5V)
|-
|align=center| VO
|align=center| LCD Operating Voltage
|-
|align=center| RS
|align=center| Register Selector
|-
|align=center| R/W
|align=center| Read/Write Signal
|-
|align=center| DB0-DB7
|align=center| Data Bus Lines
|}


===Using Linux===
===Text LCDs===
[[image:lcd display.png|center|1000px|link=|center]]


{{UGlinux}}


===Using Windows Mobile / CE 5.0 / CE 6.0===
Text LCDs display full text strings set in software. Since text characters are defined from the ASCII standard library, other ASCII standard set characters and glyphs can also be sent to the text LCD. This can be done easily by using unicode characters within your text string.  In C#, this may look something like this:


{{UGce}}
<source lang=cpp>
tLCD.WriteText(LCDFont.Dimensions_5x8, 0, 0, "Apple starts with \u0041");
</source>


==Technical Details==
The four parameters of the WriteText method are as follows:
===Introduction===
* The font type, which will always be the one above for the 1204 because it's the only font it supports
* The horizontal position of the text within the line
* The vertical position of the text (which line)
* The text to be printed


Liquid Crystal Displays are display devices used to convey information through arrangements of pixels.  Graphic and Text LCDs are the most common types available for electronic products.  The 1204 supports  the following screen sizes (lines x characters): 1x8, 2x8, 1x16, 2x16, 4x16, 2x20, 4x20, 2x24, 1x40, 2x40, 4x40.
In this example, the string \u indicates that a unicode character follows, and the unicode character 0041 represents the capital letter A (you can also reference it with '\x41', which is the same character in hexadecimal).  After the LCD converts the unicode character, the above example would cause the LCD screen to read {{Code|Apple starts with A}}.  A chart of all ASCII standard set character codes is available [[LCD Character Display Guide#Character Chart|here]].


===Text LCDs===
===Custom Characters===
[[image:lcd display.png|center|1000px|link=]]


Custom characters can also be generated for the 1204.  A custom character can be any arrangement of pixels within the space allotted for a single character. Single characters are made up of pixels arranged in a grid 5 pixels wide by 8 pixels high. Once generated, custom characters can be stored in any one of eight volatile memory locations on the PhidgetTextLCD, and can be recalled with a simple API command from software. Custom characters are designed by creating a byte array of ones and zeroes, like this:


Text LCDs display full text strings set in software. Since text characters are defined from the ASCII standard library, other ASCII standard set characters and glyphs can also be sent to the text LCD.  This can be done easily by using unicode characters within your text string.  In C#, this may look something like this:
<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=cpp>
<source lang=cpp>
tLCD.rows[0].DisplayString = "Apple starts with \u0041";
Byte[] heart = new Byte[] {
0,0,0,0,0,
0,1,0,1,0,
1,1,1,1,1,
1,1,1,1,1,
0,1,1,1,0,
0,0,1,0,0,
0,0,0,0,0,
0,0,0,0,0 };
</source>
</source>
</font>
</div>
In this example, the string \u indicates that a unicode character follows, and the unicode character 0041 (which references the hexadecimal character code 0x41) represents the capital letter A.  After the LCD converts the unicode character, the above example would cause the LCD screen to read Apple starts with A.  A chart of all ASCII standard set character codes is available [[LCD Character Display Primer#ASCII Chart|here]].


===Custom Characters===
The above bitmap creates a character that looks like a heart. In order to use this bitmap on your screen, you have to assign it to a memory location and use it in a WriteText call.
[[image:Lcdpixelarrangment.png|right|150px|link=]]


Custom characters can also be generated for the PhidgetTextLCD.  A custom character can be any arrangement of pixels within the space allotted for a single character.  Single characters are made up of pixels arranged in a grid 5 pixels wide by 8 pixels high.  Once generated, custom characters can be stored in any one of eight volatile memory locations on the PhidgetTextLCD, and can be recalled with a simple API command from software. When custom characters are designed, a formula is used to change the pixel design into a pair of numerical values.  The first value relates to the design of the top 4 rows of the character, and the second value relates to the design of the bottom 4 rows of the character.  Unlike the unicode characters used in the Special Characters section above, the calculated number is not in hexadecimal format but is an integer value up to six characters in length.  The calculation for custom characters can be done by hand, or can be completed for you by using the form available at www.phidgets.com/documentation/customchar.html.  Done by hand, each integer value represents the sum of two to the power of each individual on-pixel’s location within that integer-value’s half of the character.  Pixels not turned on are valued at zero.  For example, a custom character happy-face with pixels 6, 8, 11 and 13 in the upper half turned on, pixels 1, 3, 6, 8, 11, 12 and 13 in the lower half turned on, and all other pixels turned off, would result in the following integer values.
[[image:Lcdcustomcharmap.png|link=]]
These two values are then stored in one of eight memory locations (CG-RAM 0 to 7) on the PhidgetTextLCD by using
the Set Custom Character method in software.  In C#, this may look something like this:
<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=cpp>
<source lang=cpp>
tLCD.customCharacters[0].setCustomCharacter(10560, 14666)
tLcd.SetCharacterBitmap(LCDFont.Dimensions_5x8, "\x1", heart);
tLcd.WriteText(LCDFont.Dimensions_5x8, 0, 0, "Heart: \x1");
</source>
</source>
</font>
</div>
Once stored, characters can be recalled into a text string by either using the unicode value for the location as referenced in the ASCII chart (Appendix A) or by using the String Code method from the API.  Examples in C# of both methods are shown below:
<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=cpp>
tLCD.rows[0].DisplayString = "I am happy \u0008";
</source>
</font>
</div>
<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=cpp>
tLCD.rows[0].DisplayString = "I am happy " + tLCD.customCharacters[0].StringCode;
</source>
</font>
</div>
<br clear="all>
==API==
{{UGapih}}
===Enums===
enum {
:PHIDGET_TEXTLCD_SCREEN_NONE,
:PHIDGET_TEXTLCD_SCREEN_1x8,
:PHIDGET_TEXTLCD_SCREEN_2x8,
:PHIDGET_TEXTLCD_SCREEN_1x16,
:PHIDGET_TEXTLCD_SCREEN_2x16,
:PHIDGET_TEXTLCD_SCREEN_4x16,
:PHIDGET_TEXTLCD_SCREEN_2x20,
:PHIDGET_TEXTLCD_SCREEN_4x20,
:PHIDGET_TEXTLCD_SCREEN_2x24,
:PHIDGET_TEXTLCD_SCREEN_1x40,
:PHIDGET_TEXTLCD_SCREEN_2x40,
:PHIDGET_TEXTLCD_SCREEN_4x40,
}  ScreenSizes
This is a list of the supported screen sizes. The 4x40 screen is a special case because it requires both of the enable lines - so when it is attached, it must be setup on screen 0, and screen 1 cannot be used.
===Properties===
{{UGapi|int Screen [get,set]|Gets / sets the active screen. All other API calls depend on this being called first to select the screen that subsequent calls affect. When making calls from multiple threads, selecting the screen should be synchronized with setting screen properties in order to avoid having messages go to the wrong display.}}
{{UGapi|int RowCount [get]|Returns the number of rows of text supported by the active TextLCD display. This will depend on the set screen size, and defaults to 0.}}
{{UGapi|int ColumnCount [get]|Returns the number of columns of text per row supported by the active TextLCD display. This will depend on the set screen size, and defaults to 0.}}
{{UGapi|int ScreenCount [get] : Constant <nowiki>=</nowiki> 2|Returns the number of screens supported by the TextLCD.}}
{{UGapi|ScreenSizes ScreenSize [get,set]|Gets / sets the screen size for the active TextLCD display. The TextLCD Adapter supports a pre-defined set ofscreen sizes to choose from. By default, both screens are set to PHIDGET_TEXTLCD_SCREEN_NONE, and this function must always be called before trying to write text to a display.}}
{{UGapi|bool Backlight [get,set]|Gets / sets the state of the active TextLCD display backlight. The backlight is disabled by default when the TextLCD is first plugged in.}}
{{UGapi|int Brightness [get,set]|Gets / sets the brightness of the active TextLCD backlight. The default brightness is 255 (100%). The valid brightness range is 0-255 (0%-100%).}}
{{UGapi|int Contrast [get,set]|Gets / sets the contrast of the active TextLCD display. The required contrast will vary greatly between different LCDs, so this will have to be set specifically for whatever LCDs are selected.}}
{{UGapi|bool CursorOn [get,set]|Gets / sets the state of the cursor on the active TextLCD display. When enabled, a cursor (displayed as an underline) will be displayed on the last row written to, at the end of the written text. By default, this is disabled.}}
{{UGapi|bool CursorBlink [get,set]|Gets / sets the state of the cursor blink on the active TextLCD display. When enabled, a flashing box appears on the last row written to, at the end of the written text. By default, this is disabled.}}
{{UGapi|string DisplayString(int rowIndex) [set]|Displays text on the selected row of the active TextLCD display. If the string is shorter then the ColumnCount, it is padded out with spaces - thus completely clearing any previously displayed text.}}
{{UGapi|char DisplayCharacter(int rowIndex, int columIndex) [set]|Displays a singled character on the specified row at the specified column index of the active TextLCD display. This will not affect any of the other characters already being displayed.}}


===Functions===
The above code causes the string {{Code|Heart: ♥}} to display on the screen. You can store up to eight characters at the same time; one character in each of the locations {{Code|\x1}} to {{Code|\x8}}. If you set a character to location {{Code|\x9}}, it will be the same as setting {{Code|\x1}}. Likewise, {{Code|\xA}} will set {{Code|\x2}}, and so on for {{Code|\xB}}, {{Code|\xC}}, etc.
{{UGapi|void setCustomCharacter(int index, int value1, int value2)|Sets up a custom character at the selected index on the active TextLCD display. Valid index range is 0-7 for .Net and Python and 8-15 for all other languages; this allows for 8 custom characters. These custom characters can be displayed by passing their character code (0-7) or (8-15) as part of a DisplayString. For determining the value1 and value2, see the technical section.}}
{{UGapi|void initialize()|Initializes the active TextLCD display. This runs an initialization routine which sets up and clears the display. This can be used for activating a display that was plugged in after the TextLCD Adapter was attached, to clear the display after setting / changing the screen size, and to re-initialize a display if it has become corrupted (display won’t work anymore).}}


==Product History==
{{UGnext|}}
{{UGhist}}
{{UGrow|August 2011 |0 |100 |Product Release, requires phidget21 2.1.8+ }}

Latest revision as of 16:31, 1 June 2023


Getting Started

Welcome to the 1204 user guide! In order to get started, make sure you have the following hardware on hand:


Next, you will need to connect the pieces:

1204 0 Connecting the Hardware.jpg
  1. Connect the LCD screen to the adapter using the LCD cable.
  2. Connect the TextLCD adapter to the computer using a USB cable.


Now that you have everything together, let's start using the 1204!

Using the 1204

Phidget Control Panel

In order to demonstrate the functionality of the 1204, the Phidget Control Panel running on a Windows machine will be used.


The Phidget Control Panel is available for use on both macOS and Windows machines.

Windows

To open the Phidget Control Panel on Windows, find the Ph.jpg icon in the taskbar. If it is not there, open up the start menu and search for Phidget Control Panel

Windows PhidgetTaskbar.PNG

macOS

To open the Phidget Control Panel on macOS, open Finder and navigate to the Phidget Control Panel in the Applications list. Double click on the Ph.jpg icon to bring up the Phidget Control Panel.


For more information, take a look at the getting started guide for your operating system:


Linux users can follow the getting started with Linux guide and continue reading here for more information about the 1204.

First Look

After plugging the 1204 into your computer and opening the Phidget Control Panel, you will see something like this:

1204 Panel.jpg


The Phidget Control Panel will list all connected Phidgets and associated objects, as well as the following information:

  • Serial number: allows you to differentiate between similar Phidgets.
  • Channel: allows you to differentiate between similar objects on a Phidget.
  • Version number: corresponds to the firmware version your Phidget is running. If your Phidget is listed in red, your firmware is out of date. Update the firmware by double-clicking the entry.


The Phidget Control Panel can also be used to test your device. Double-clicking on an object will open an example.

Text LCD

Double-click on the LCD object, labelled Text LCD, in order to run the example:

1204 TextLCD Example.jpg


General information about the selected object will be displayed at the top of the window. You can also experiment with the following functionality:

  • Select a screen size that suits your LCD screen with the Screen Size drop-down menu.
  • Write in the Display text text boxes, your input will be mirrored on the LCD screen.
  • Drag the Contrast and Brightness sliders to a level where you can clearly see the text on the screen.
  • Toggle the Cursor and Cursor Blink checkbox to view the current cursor position on the LCD screen.
  • Toggle Custom Characters to show an example of the 1204 using bitmaps.
  • Use the Clear button to clear the screen.


Using Your Own Program

You are now ready to start writing your own code for the device. The best way to do that is to start from our Code Samples.

Select your programming language of choice from the drop-down list to get an example for your device. You can use the options provided to further customize the example to best suit your needs.

Code Sample Choose Language.png


Once you have your example, you will need to follow the instructions on the page for your programming language to get it running. To find these instructions, select your programming language from the Programming Languages page.

Technical Details

Introduction

Liquid Crystal Displays are display devices used to convey information through arrangements of pixels. Graphic and Text LCDs are the most common types available for electronic products. The 1204 supports the following screen sizes (lines x characters): 1x8, 2x8, 1x16, 2x16, 4x16, 2x20, 4x20, 2x24, 1x40, 2x40, 4x40. Please note that your program has no way of automatically detecting the size of the attached screen, so you need to set the screen size with call from Phidget22 API in order to have text strings display properly.

Connector

Below is a pinout diagram for the connector on the 1204, with descriptions of each pin. Remember to use the end of the cable with the larger connector with the 1204 if you want the wire colors to be consistent with the diagram.

1204-pinout.jpg
Pin Description
A LED Anode (+)
K LED Cathode (-)
VSS Board Ground
VDD Supply Voltage (5V)
VO LCD Operating Voltage
RS Register Selector
R/W Read/Write Signal
DB0-DB7 Data Bus Lines

Text LCDs

Lcd display.png


Text LCDs display full text strings set in software. Since text characters are defined from the ASCII standard library, other ASCII standard set characters and glyphs can also be sent to the text LCD. This can be done easily by using unicode characters within your text string. In C#, this may look something like this: 

tLCD.WriteText(LCDFont.Dimensions_5x8, 0, 0, "Apple starts with \u0041");

The four parameters of the WriteText method are as follows:

  • The font type, which will always be the one above for the 1204 because it's the only font it supports
  • The horizontal position of the text within the line
  • The vertical position of the text (which line)
  • The text to be printed

In this example, the string \u indicates that a unicode character follows, and the unicode character 0041 represents the capital letter A (you can also reference it with '\x41', which is the same character in hexadecimal). After the LCD converts the unicode character, the above example would cause the LCD screen to read Apple starts with A. A chart of all ASCII standard set character codes is available here.

Custom Characters

Custom characters can also be generated for the 1204. A custom character can be any arrangement of pixels within the space allotted for a single character. Single characters are made up of pixels arranged in a grid 5 pixels wide by 8 pixels high. Once generated, custom characters can be stored in any one of eight volatile memory locations on the PhidgetTextLCD, and can be recalled with a simple API command from software. Custom characters are designed by creating a byte array of ones and zeroes, like this: 

	Byte[] heart = new Byte[] {
		0,0,0,0,0,
		0,1,0,1,0,
		1,1,1,1,1,
		1,1,1,1,1,
		0,1,1,1,0,
		0,0,1,0,0,
		0,0,0,0,0,
		0,0,0,0,0 };

The above bitmap creates a character that looks like a heart. In order to use this bitmap on your screen, you have to assign it to a memory location and use it in a WriteText call. 

	tLcd.SetCharacterBitmap(LCDFont.Dimensions_5x8, "\x1", heart);
	tLcd.WriteText(LCDFont.Dimensions_5x8, 0, 0, "Heart: \x1");

The above code causes the string Heart: ♥ to display on the screen. You can store up to eight characters at the same time; one character in each of the locations \x1 to \x8. If you set a character to location \x9, it will be the same as setting \x1. Likewise, \xA will set \x2, and so on for \xB, \xC, etc.

What to do Next

  • Programming Languages - Find your preferred programming language here and learn how to write your own code with Phidgets!
  • Phidget Programming Basics - Once you have set up Phidgets to work with your programming environment, we recommend you read our page on to learn the fundamentals of programming with Phidgets.


Retrieved from "https://www.phidgets.com/docs/index.php?title=1204_User_Guide&oldid=33656"