Classes | Defines | Enumerations | Functions
Phidget TextLCD
Specific Phidgets
Collaboration diagram for Phidget TextLCD:

Classes

struct  CPhidgetTextLCDInfo

Defines

#define HD44780_CLEAR_DISPLAY   0x01
#define HD44780_CURSOR_BLINK_ON   0x01
#define HD44780_CURSOR_HOME   0x02
#define HD44780_CURSOR_ON   0x02
#define HD44780_DISPLAY_CNTRL   0x08
#define HD44780_DISPLAY_ON   0x04
#define HD44780_SET_CGRAM_ADDR   0x40
#define HD44780_SET_DDRAM_ADDR   0x80
#define TEXTLCD_BACKLIGHT_PACKET   0x11
#define TEXTLCD_CGRAM_ADDR(x)   (x << 3)
#define TEXTLCD_COMMAND_MODE   0x01
#define TEXTLCD_CONTRAST_PACKET   0x12
#define TEXTLCD_CURSOR_PACKET   0x00
#define TEXTLCD_DATA_MODE   0x02
#define TEXTLCD_ESCAPE_CHAR   0x00
#define TEXTLCD_INIT_PACKET   0x13
#define TEXTLCD_MAXCOLS   40
#define TEXTLCD_MAXROWS   2
#define TEXTLCD_MAXSCREENS   2
#define TEXTLCD_SCREEN(x)   (x << 5)

Enumerations

enum  CPhidgetTextLCD_ScreenSize {
  PHIDGET_TEXTLCD_SCREEN_NONE = 1, 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,
  PHIDGET_TEXTLCD_SCREEN_UNKNOWN, PHIDGET_TEXTLCD_SCREEN_NONE = 1, 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, PHIDGET_TEXTLCD_SCREEN_UNKNOWN
}

Functions

PHIDGET21_API int CCONV CPhidgetTextLCD_initialize (CPhidgetTextLCDHandle phid)

Detailed Description

These calls are specific to the Phidget Text LCD object. See your device's User Guide for more specific API details, technical information, and revision details. The User Guide, along with other resources, can be found on the product page for your device.

Define Documentation

#define HD44780_CLEAR_DISPLAY   0x01

Definition at line 191 of file cphidgettextlcd.h.

#define HD44780_CURSOR_BLINK_ON   0x01

Definition at line 198 of file cphidgettextlcd.h.

#define HD44780_CURSOR_HOME   0x02

Definition at line 192 of file cphidgettextlcd.h.

#define HD44780_CURSOR_ON   0x02

Definition at line 197 of file cphidgettextlcd.h.

#define HD44780_DISPLAY_CNTRL   0x08

Definition at line 195 of file cphidgettextlcd.h.

#define HD44780_DISPLAY_ON   0x04

Definition at line 196 of file cphidgettextlcd.h.

#define HD44780_SET_CGRAM_ADDR   0x40

Definition at line 200 of file cphidgettextlcd.h.

#define HD44780_SET_DDRAM_ADDR   0x80

Definition at line 201 of file cphidgettextlcd.h.

#define TEXTLCD_BACKLIGHT_PACKET   0x11

Definition at line 179 of file cphidgettextlcd.h.

#define TEXTLCD_CGRAM_ADDR (   x)    (x << 3)

Definition at line 184 of file cphidgettextlcd.h.

#define TEXTLCD_COMMAND_MODE   0x01

Definition at line 187 of file cphidgettextlcd.h.

#define TEXTLCD_CONTRAST_PACKET   0x12

Definition at line 180 of file cphidgettextlcd.h.

#define TEXTLCD_CURSOR_PACKET   0x00

Definition at line 178 of file cphidgettextlcd.h.

#define TEXTLCD_DATA_MODE   0x02

Definition at line 188 of file cphidgettextlcd.h.

#define TEXTLCD_ESCAPE_CHAR   0x00

Definition at line 186 of file cphidgettextlcd.h.

#define TEXTLCD_INIT_PACKET   0x13

Definition at line 181 of file cphidgettextlcd.h.

#define TEXTLCD_MAXCOLS   40

Definition at line 175 of file cphidgettextlcd.h.

#define TEXTLCD_MAXROWS   2

Definition at line 174 of file cphidgettextlcd.h.

#define TEXTLCD_MAXSCREENS   2

Definition at line 176 of file cphidgettextlcd.h.

#define TEXTLCD_SCREEN (   x)    (x << 5)

Definition at line 183 of file cphidgettextlcd.h.

Enumeration Type Documentation

enum CPhidgetTextLCD_ScreenSize

Gets the number of rows supported by this display.

Parameters:
phidAn attached phidget text lcd handle.
countThe row count. Gets the number of columns per supported by this display.
phidAn attached phidget text lcd handle.
countThe Column count. Gets the state of the backlight.
phidAn attached phidget text lcd handle.
backlightStateThe backlight state. Possible values are PTRUE and PFALSE. Sets the state of the backlight.
phidAn attached phidget text lcd handle.
backlightStateThe backlight state. Possible values are PTRUE and PFALSE. Gets the brightness of the backlight. Not supported on all TextLCDs
phidAn attached phidget text lcd handle.
brightnessThe backlight brightness (0-255). Sets the brightness of the backlight. Not supported on all TextLCDs
phidAn attached phidget text lcd handle.
brightnessThe backlight brightness (0-255). Gets the last set contrast value.
phidAn attached phidget text lcd handle.
contrastThe contrast (0-255). Sets the last set contrast value.
phidAn attached phidget text lcd handle.
contrastThe contrast (0-255). Gets the cursor visible state.
phidAn attached phidget text lcd handle.
cursorStateThe state of the cursor. Sets the cursor visible state.
phidAn attached phidget text lcd handle.
cursorStateThe state of the cursor. Gets the cursor blink state.
phidAn attached phidget text lcd handle.
cursorBlinkStateThe cursor blink state. Sets the cursor blink state.
phidAn attached phidget text lcd handle.
cursorBlinkStateThe cursor blink state. Sets a custom character. See the product manual for more information.
phidAn attached phidget text lcd handle.
indexThe custom character index (8-15).
var1The first part of the custom character.
var2The second part of the custom character. Sets a single character on the display.
phidAn attached phidget text lcd handle.
indexThe row index.
columnThe column index.
characterThe character to display. Sets a row on the display.
phidAn attached phidget text lcd handle.
indexThe row index.
displayStringThe string to display. Make sure this is not longer then CPhidgetTextLCD_getColumnCount. The Phidget TextLCD Adapter supports these screen sizes
Enumerator:
PHIDGET_TEXTLCD_SCREEN_NONE 

no screen attached

PHIDGET_TEXTLCD_SCREEN_1x8 

1 row, 8 column screen

PHIDGET_TEXTLCD_SCREEN_2x8 

2 row, 8 column screen

PHIDGET_TEXTLCD_SCREEN_1x16 

1 row, 16 column screen

PHIDGET_TEXTLCD_SCREEN_2x16 

2 row, 16 column screen

PHIDGET_TEXTLCD_SCREEN_4x16 

4 row, 16 column screen

PHIDGET_TEXTLCD_SCREEN_2x20 

2 row, 20 column screen

PHIDGET_TEXTLCD_SCREEN_4x20 

4 row, 20 column screen

PHIDGET_TEXTLCD_SCREEN_2x24 

2 row, 24 column screen

PHIDGET_TEXTLCD_SCREEN_1x40 

1 row, 40 column screen

PHIDGET_TEXTLCD_SCREEN_2x40 

2 row, 40 column screen

PHIDGET_TEXTLCD_SCREEN_4x40 

4 row, 40 column screen (special case, requires both screen connections)

PHIDGET_TEXTLCD_SCREEN_UNKNOWN 
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 
PHIDGET_TEXTLCD_SCREEN_UNKNOWN 

Definition at line 114 of file cphidgettextlcd.h.

Function Documentation

PHIDGET21_API int CCONV CPhidgetTextLCD_initialize ( CPhidgetTextLCDHandle  phid)

Gets the number of Display supported by this TextLCD

Parameters:
phidAn attached phidget text lcd handle.
countThe Screen count. Gets the active screen.
phidAn attached phidget text lcd handle.
screenIndexThe active screen. Sets the active screen. This is the screen that all subsequent API calls will apply to.
phidAn attached phidget text lcd handle.
screenIndexThe active screen. Gets the screen size.
phidAn attached phidget text lcd handle.
screenSizeThe screen size. Sets the active screen size. Only supported on the TextLCD Adapter.
phidAn attached phidget text lcd handle.
screenSizeThe screen size. Initializes the active screen. Only supported on the TextLCD adapter. This should be called if a screen is attached after power up, or to clear the screen after setting the size.
phidAn attached phidget text lcd handle.

Definition at line 1120 of file cphidgettextlcd.c.


pedal_monitor
Author(s): Pedro Mendes
autogenerated on Fri Jun 6 2014 18:37:22