Phidget TextLCD
[Specific Phidgets]


Typedefs
typedef struct _CPhidgetTextLCD *	CPhidgetTextLCDHandle
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 }
Functions
int	CPhidgetTextLCD_create (CPhidgetTextLCDHandle *phid)
int	CPhidgetTextLCD_getRowCount (CPhidgetTextLCDHandle phid, int *count)
int	CPhidgetTextLCD_getColumnCount (CPhidgetTextLCDHandle phid, int *count)
int	CPhidgetTextLCD_getBacklight (CPhidgetTextLCDHandle phid, int *backlightState)
int	CPhidgetTextLCD_setBacklight (CPhidgetTextLCDHandle phid, int backlightState)
int	CPhidgetTextLCD_getBrightness (CPhidgetTextLCDHandle phid, int *brightness)
int	CPhidgetTextLCD_setBrightness (CPhidgetTextLCDHandle phid, int brightness)
int	CPhidgetTextLCD_getContrast (CPhidgetTextLCDHandle phid, int *contrast)
int	CPhidgetTextLCD_setContrast (CPhidgetTextLCDHandle phid, int contrast)
int	CPhidgetTextLCD_getCursorOn (CPhidgetTextLCDHandle phid, int *cursorState)
int	CPhidgetTextLCD_setCursorOn (CPhidgetTextLCDHandle phid, int cursorState)
int	CPhidgetTextLCD_getCursorBlink (CPhidgetTextLCDHandle phid, int *cursorBlinkState)
int	CPhidgetTextLCD_setCursorBlink (CPhidgetTextLCDHandle phid, int cursorBlinkState)
int	CPhidgetTextLCD_setCustomCharacter (CPhidgetTextLCDHandle phid, int index, int var1, int var2)
int	CPhidgetTextLCD_setDisplayCharacter (CPhidgetTextLCDHandle phid, int index, int column, unsigned char character)
int	CPhidgetTextLCD_setDisplayString (CPhidgetTextLCDHandle phid, int index, char *displayString)
int	CPhidgetTextLCD_getScreenCount (CPhidgetTextLCDHandle phid, int *count)
int	CPhidgetTextLCD_getScreen (CPhidgetTextLCDHandle phid, int *screenIndex)
int	CPhidgetTextLCD_setScreen (CPhidgetTextLCDHandle phid, int screenIndex)
int	CPhidgetTextLCD_getScreenSize (CPhidgetTextLCDHandle phid, CPhidgetTextLCD_ScreenSize *screenSize)
int	CPhidgetTextLCD_setScreenSize (CPhidgetTextLCDHandle phid, CPhidgetTextLCD_ScreenSize screenSize)
int	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.

Typedef Documentation

typedef struct _CPhidgetTextLCD* CPhidgetTextLCDHandle

A Phidget TextLCD handle

Enumeration Type Documentation

enum CPhidgetTextLCD_ScreenSize

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)

Function Documentation

int CPhidgetTextLCD_create ( CPhidgetTextLCDHandle * phid )

Creates a Phidget TextLCD handle.

Parameters:

phid

A pointer to an unallocated Phidget TextLCD handle.

int CPhidgetTextLCD_getRowCount	(	CPhidgetTextLCDHandle	phid,
		int *	count
	)

Gets the number of rows supported by this display.

Parameters:

	phid	An attached phidget text lcd handle.
	count	The row count.

int CPhidgetTextLCD_getColumnCount	(	CPhidgetTextLCDHandle	phid,
		int *	count
	)

Gets the number of columns per supported by this display.

Parameters:

	phid	An attached phidget text lcd handle.
	count	The Column count.

int CPhidgetTextLCD_getBacklight	(	CPhidgetTextLCDHandle	phid,
		int *	backlightState
	)

Gets the state of the backlight.

Parameters:

	phid	An attached phidget text lcd handle.
	backlightState	The backlight state. Possible values are PTRUE and PFALSE.

int CPhidgetTextLCD_setBacklight	(	CPhidgetTextLCDHandle	phid,
		int	backlightState
	)

Sets the state of the backlight.

Parameters:

	phid	An attached phidget text lcd handle.
	backlightState	The backlight state. Possible values are PTRUE and PFALSE.

int CPhidgetTextLCD_getBrightness	(	CPhidgetTextLCDHandle	phid,
		int *	brightness
	)

Gets the brightness of the backlight. Not supported on all TextLCDs

Parameters:

	phid	An attached phidget text lcd handle.
	brightness	The backlight brightness (0-255).

int CPhidgetTextLCD_setBrightness	(	CPhidgetTextLCDHandle	phid,
		int	brightness
	)

Sets the brightness of the backlight. Not supported on all TextLCDs

Parameters:

	phid	An attached phidget text lcd handle.
	brightness	The backlight brightness (0-255).

int CPhidgetTextLCD_getContrast	(	CPhidgetTextLCDHandle	phid,
		int *	contrast
	)

Gets the last set contrast value.

Parameters:

	phid	An attached phidget text lcd handle.
	contrast	The contrast (0-255).

int CPhidgetTextLCD_setContrast	(	CPhidgetTextLCDHandle	phid,
		int	contrast
	)

Sets the last set contrast value.

Parameters:

	phid	An attached phidget text lcd handle.
	contrast	The contrast (0-255).

int CPhidgetTextLCD_getCursorOn	(	CPhidgetTextLCDHandle	phid,
		int *	cursorState
	)

Gets the cursor visible state.

Parameters:

	phid	An attached phidget text lcd handle.
	cursorState	The state of the cursor.

int CPhidgetTextLCD_setCursorOn	(	CPhidgetTextLCDHandle	phid,
		int	cursorState
	)

Sets the cursor visible state.

Parameters:

	phid	An attached phidget text lcd handle.
	cursorState	The state of the cursor.

int CPhidgetTextLCD_getCursorBlink	(	CPhidgetTextLCDHandle	phid,
		int *	cursorBlinkState
	)

Gets the cursor blink state.

Parameters:

	phid	An attached phidget text lcd handle.
	cursorBlinkState	The cursor blink state.

int CPhidgetTextLCD_setCursorBlink	(	CPhidgetTextLCDHandle	phid,
		int	cursorBlinkState
	)

Sets the cursor blink state.

Parameters:

	phid	An attached phidget text lcd handle.
	cursorBlinkState	The cursor blink state.

int CPhidgetTextLCD_setCustomCharacter	(	CPhidgetTextLCDHandle	phid,
		int	index,
		int	var1,
		int	var2
	)

Sets a custom character. See the product manual for more information.

Parameters:

	phid	An attached phidget text lcd handle.
	index	The custom character index (8-15).
	var1	The first part of the custom character.
	var2	The second part of the custom character.

int CPhidgetTextLCD_setDisplayCharacter	(	CPhidgetTextLCDHandle	phid,
		int	index,
		int	column,
		unsigned char	character
	)

Sets a single character on the display.

Parameters:

	phid	An attached phidget text lcd handle.
	index	The row index.
	column	The column index.
	character	The character to display.

int CPhidgetTextLCD_setDisplayString	(	CPhidgetTextLCDHandle	phid,
		int	index,
		char *	displayString
	)

Sets a row on the display.

Parameters:

	phid	An attached phidget text lcd handle.
	index	The row index.
	displayString	The string to display. Make sure this is not longer then CPhidgetTextLCD_getColumnCount.

int CPhidgetTextLCD_getScreenCount	(	CPhidgetTextLCDHandle	phid,
		int *	count
	)

Gets the number of Display supported by this TextLCD

Parameters:

	phid	An attached phidget text lcd handle.
	count	The Screen count.

int CPhidgetTextLCD_getScreen	(	CPhidgetTextLCDHandle	phid,
		int *	screenIndex
	)

Gets the active screen.

Parameters:

	phid	An attached phidget text lcd handle.
	screenIndex	The active screen.

int CPhidgetTextLCD_setScreen	(	CPhidgetTextLCDHandle	phid,
		int	screenIndex
	)

Sets the active screen. This is the screen that all subsequent API calls will apply to.

Parameters:

	phid	An attached phidget text lcd handle.
	screenIndex	The active screen.

int CPhidgetTextLCD_getScreenSize	(	CPhidgetTextLCDHandle	phid,
		CPhidgetTextLCD_ScreenSize *	screenSize
	)

Gets the screen size.

Parameters:

	phid	An attached phidget text lcd handle.
	screenSize	The screen size.

int CPhidgetTextLCD_setScreenSize	(	CPhidgetTextLCDHandle	phid,
		CPhidgetTextLCD_ScreenSize	screenSize
	)

Sets the active screen size. Only supported on the TextLCD Adapter.

Parameters:

	phid	An attached phidget text lcd handle.
	screenSize	The screen size.

int CPhidgetTextLCD_initialize ( CPhidgetTextLCDHandle phid )

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.

Parameters:

phid

An attached phidget text lcd handle.

Phidget TextLCD [Specific Phidgets]

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Phidget TextLCD
[Specific Phidgets]