diff options
Diffstat (limited to 'Java/com/phidgets/TextLCDPhidget.java')
| -rw-r--r-- | Java/com/phidgets/TextLCDPhidget.java | 278 |
1 files changed, 278 insertions, 0 deletions
diff --git a/Java/com/phidgets/TextLCDPhidget.java b/Java/com/phidgets/TextLCDPhidget.java new file mode 100644 index 0000000..ac4c500 --- /dev/null +++ b/Java/com/phidgets/TextLCDPhidget.java @@ -0,0 +1,278 @@ + +/* + * Copyright 2011 Phidgets Inc. All rights reserved. + */ + +package com.phidgets; +import java.util.Iterator; +import java.util.LinkedList; +import com.phidgets.event.*; +/** + * This class represents a Phidget Text LCD. All methods + * to control the Text LCD are implemented in this class. + * <p> + * The TextLCD Phidget consists of a Vacuum Fluorescent display that is capable of + * displaying Standard as well as custom characters in multiple rows. + * + * @author Phidgets Inc. + */ +public final class TextLCDPhidget extends Phidget +{ + public TextLCDPhidget () throws PhidgetException + { + super (create ()); + } + private static native long create () throws PhidgetException; + /** + * No screens attached. This is used with {@link #getScreenSize() getScreenSize} and {@link #setScreenSize(int) setScreenSize} + */ + public static final int PHIDGET_TEXTLCD_SCREEN_NONE = 1; + /** + * 1 row, 8 column screen. This is used with {@link #getScreenSize() getScreenSize} and {@link #setScreenSize(int) setScreenSize} + */ + public static final int PHIDGET_TEXTLCD_SCREEN_1x8 = 2; + /** + * 2 row, 8 column screen. This is used with {@link #getScreenSize() getScreenSize} and {@link #setScreenSize(int) setScreenSize} + */ + public static final int PHIDGET_TEXTLCD_SCREEN_2x8 = 3; + /** + * 1 row, 16 column screen. This is used with {@link #getScreenSize() getScreenSize} and {@link #setScreenSize(int) setScreenSize} + */ + public static final int PHIDGET_TEXTLCD_SCREEN_1x16 = 4; + /** + * 2 row, 16 column screen. This is used with {@link #getScreenSize() getScreenSize} and {@link #setScreenSize(int) setScreenSize} + */ + public static final int PHIDGET_TEXTLCD_SCREEN_2x16 = 5; + /** + * 4 row, 16 column screen. This is used with {@link #getScreenSize() getScreenSize} and {@link #setScreenSize(int) setScreenSize} + */ + public static final int PHIDGET_TEXTLCD_SCREEN_4x16 = 6; + /** + * 2 row, 20 column screen. This is used with {@link #getScreenSize() getScreenSize} and {@link #setScreenSize(int) setScreenSize} + */ + public static final int PHIDGET_TEXTLCD_SCREEN_2x20 = 7; + /** + * 4 row, 20 column screen. This is used with {@link #getScreenSize() getScreenSize} and {@link #setScreenSize(int) setScreenSize} + */ + public static final int PHIDGET_TEXTLCD_SCREEN_4x20 = 8; + /** + * 2 row, 24 column screen. This is used with {@link #getScreenSize() getScreenSize} and {@link #setScreenSize(int) setScreenSize} + */ + public static final int PHIDGET_TEXTLCD_SCREEN_2x24 = 9; + /** + * 1 row, 40 column screen. This is used with {@link #getScreenSize() getScreenSize} and {@link #setScreenSize(int) setScreenSize} + */ + public static final int PHIDGET_TEXTLCD_SCREEN_1x40 = 10; + /** + * 2 row, 40 column screen. This is used with {@link #getScreenSize() getScreenSize} and {@link #setScreenSize(int) setScreenSize} + */ + public static final int PHIDGET_TEXTLCD_SCREEN_2x40 = 11; + /** + * 4 row, 40 column screen. This is used with {@link #getScreenSize() getScreenSize} and {@link #setScreenSize(int) setScreenSize} + */ + public static final int PHIDGET_TEXTLCD_SCREEN_4x40 = 12; + /** + * Unknown screen size. This is used with {@link #getScreenSize() getScreenSize} and {@link #setScreenSize(int) setScreenSize} + */ + public static final int PHIDGET_TEXTLCD_SCREEN_UNKNOWN = 13; + /** + * Returns the number of rows available on the display. + * @return Number of rows + * @throws PhidgetException If this Phidget is not opened and attached. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native int getRowCount () throws PhidgetException; + /** + * Returns the number of columns (characters per row) available on the display. This value is + * the same for every row. + * @return Number of columns + * @throws PhidgetException If this Phidget is not opened and attached. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native int getColumnCount () throws PhidgetException; + /** + * Returns the number of screens supported by the TextLCD. Not all TextLCDs support this method. + * @return Number of screens. + * @throws PhidgetException If this Phidget is not opened and attached. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native int getScreenCount () throws PhidgetException; + /** + * Returns the active screen. Not all TextLCDs support this method. + * @return active screen + * @throws PhidgetException If this Phidget is not opened and attached, or screen is not supported. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native int getScreen () throws PhidgetException; + /** + * 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. Not all TextLCDs support this method. + * @param screen Screen + * @throws PhidgetException If this Phidget is not opened and attached, the screen number is out of range, or screen is not supported. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native void setScreen (int screen) throws PhidgetException; + + /** + * Returns the screen size for the active TextLCD display. The TextLCD Adapter supports a pre-defined set of screen sizes to choose from. + * By default, all screens are set to {@link #PHIDGET_TEXTLCD_SCREEN_NONE PHIDGET_TEXTLCD_SCREEN_NONE}. + * Not all TextLCDs support this method. + * <p> + * The possible values for screen size are {@link #PHIDGET_TEXTLCD_SCREEN_NONE PHIDGET_TEXTLCD_SCREEN_NONE}, + * {@link #PHIDGET_TEXTLCD_SCREEN_1x8 PHIDGET_TEXTLCD_SCREEN_1x8}, {@link #PHIDGET_TEXTLCD_SCREEN_2x8 PHIDGET_TEXTLCD_SCREEN_2x8}, + * {@link #PHIDGET_TEXTLCD_SCREEN_1x16 PHIDGET_TEXTLCD_SCREEN_1x16}, {@link #PHIDGET_TEXTLCD_SCREEN_2x16 PHIDGET_TEXTLCD_SCREEN_2x16}, + * {@link #PHIDGET_TEXTLCD_SCREEN_4x16 PHIDGET_TEXTLCD_SCREEN_4x16}, {@link #PHIDGET_TEXTLCD_SCREEN_2x20 PHIDGET_TEXTLCD_SCREEN_2x20}, + * {@link #PHIDGET_TEXTLCD_SCREEN_4x20 PHIDGET_TEXTLCD_SCREEN_4x20}, {@link #PHIDGET_TEXTLCD_SCREEN_2x24 PHIDGET_TEXTLCD_SCREEN_2x24}, + * {@link #PHIDGET_TEXTLCD_SCREEN_1x40 PHIDGET_TEXTLCD_SCREEN_1x40}, {@link #PHIDGET_TEXTLCD_SCREEN_2x40 PHIDGET_TEXTLCD_SCREEN_2x40}, + * {@link #PHIDGET_TEXTLCD_SCREEN_4x40 PHIDGET_TEXTLCD_SCREEN_4x40}, {@link #PHIDGET_TEXTLCD_SCREEN_UNKNOWN PHIDGET_TEXTLCD_SCREEN_UNKNOWN} + * <p> + * By default, all screens are set to {@link #PHIDGET_TEXTLCD_SCREEN_NONE PHIDGET_TEXTLCD_SCREEN_NONE} + * <p> + * @return screen size + * @throws PhidgetException If this Phidget is not opened and attached, or screen size is not supported. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native int getScreenSize () throws PhidgetException; + /** + * Sets the screen size for the active TextLCD display. The TextLCD Adapter supports a pre-defined set of screen sizes to choose from. + * This method must always be called when trying to write text to a display. + * Not all TextLCDs support this method. + * @param screenSize Screen size + * The possible values for screen size are {@link #PHIDGET_TEXTLCD_SCREEN_NONE PHIDGET_TEXTLCD_SCREEN_NONE}, + * {@link #PHIDGET_TEXTLCD_SCREEN_1x8 PHIDGET_TEXTLCD_SCREEN_1x8}, {@link #PHIDGET_TEXTLCD_SCREEN_2x8 PHIDGET_TEXTLCD_SCREEN_2x8}, + * {@link #PHIDGET_TEXTLCD_SCREEN_1x16 PHIDGET_TEXTLCD_SCREEN_1x16}, {@link #PHIDGET_TEXTLCD_SCREEN_2x16 PHIDGET_TEXTLCD_SCREEN_2x16}, + * {@link #PHIDGET_TEXTLCD_SCREEN_4x16 PHIDGET_TEXTLCD_SCREEN_4x16}, {@link #PHIDGET_TEXTLCD_SCREEN_2x20 PHIDGET_TEXTLCD_SCREEN_2x20}, + * {@link #PHIDGET_TEXTLCD_SCREEN_4x20 PHIDGET_TEXTLCD_SCREEN_4x20}, {@link #PHIDGET_TEXTLCD_SCREEN_2x24 PHIDGET_TEXTLCD_SCREEN_2x24}, + * {@link #PHIDGET_TEXTLCD_SCREEN_1x40 PHIDGET_TEXTLCD_SCREEN_1x40}, {@link #PHIDGET_TEXTLCD_SCREEN_2x40 PHIDGET_TEXTLCD_SCREEN_2x40}, + * {@link #PHIDGET_TEXTLCD_SCREEN_4x40 PHIDGET_TEXTLCD_SCREEN_4x40}, {@link #PHIDGET_TEXTLCD_SCREEN_UNKNOWN PHIDGET_TEXTLCD_SCREEN_UNKNOWN} + * <p> + * By default, all screens are set to {@link #PHIDGET_TEXTLCD_SCREEN_NONE PHIDGET_TEXTLCD_SCREEN_NONE} + * <p> + * @throws PhidgetException If this Phidget is not opened and attached, the screen number is out of range, or screen size is not supported. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native void setScreenSize (int screenSize) throws PhidgetException; + /** + * Returns the contrast of the display. This is the contrast of the entire display. + * @return Current contrast + * @throws PhidgetException If this Phidget is not opened and attached. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native int getContrast () throws PhidgetException; + /** + * Sets the contrast of the display. The valid range is 0-255. Changing the contrast can increase the readability + * of the display in certain viewing situation, such as at an odd angle. + * @param contrast New contrast to set + * @throws PhidgetException If this Phidget is not opened and attached, or the contrast value is out of range. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native void setContrast (int contrast) throws PhidgetException; + /** + * Returns the brightness of the display. This is the brightness of the backlight. Not all TextLCDs support this method. + * @return Current brightness + * @throws PhidgetException If this Phidget is not opened and attached. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached, or brightness is not supported. + */ + public native int getBrightness () throws PhidgetException; + /** + * Sets the brightness of the display. The valid range is 0-255. Changing the brightness can increase the readability of the display in certain viewing situation, such as at an odd angle. + * Not all TextLCDs support this method. + * @param brightness New brightness to set + * @throws PhidgetException If this Phidget is not opened and attached, or the brightness value is out of range, or brightness is not supported. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native void setBrightness (int brightness) throws PhidgetException; + /** + * Returns the status of the backlight. True indicated that the backlight is on, False indicated that it is off. + * The backlight is by default turned on. + * @return Status of the backlight + * @throws PhidgetException If this Phidget is not opened and attached. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native boolean getBacklight () throws PhidgetException; + /** + * Sets the status of the backlight. True turns the backlight on, False turns it off. + * The backlight is by default turned on. + * @param backlight New backlight state + * @throws PhidgetException If this Phidget is not opened and attached. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native void setBacklight (boolean backlight) throws PhidgetException; + /** + * Returns the status of the cursor. True turns the cursor is on, False turns it off. + * The cursor is an underscore which appears directly to the right of the last entered character + * on the display. The cursor is by default disabled. + * @return Status of the cursor + * @throws PhidgetException If this Phidget is not opened and attached. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native boolean getCursor () throws PhidgetException; + /** + * Sets the state of the cursor. True indicates that the cursor on, False indicates that it is off. + * The cursor is an underscore which appears directly to the right of the last entered character + * on the display. The cursor is by default disabled. + * @param cursor New cursor state + * @throws PhidgetException If this Phidget is not opened and attached, or if the cursor has not been set + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native void setCursor (boolean cursor) throws PhidgetException; + /** + * Returns the status of the cursor blink. True turns the cursor blink on, False turns it off. + * The cursor blink is an flashing box which appears directly to the right of the last entered character + * on the display, in the same spot as the cursor if it is enabled. The cursor blink is by default disabled. + * @return Status of the cursor blink + * @throws PhidgetException If this Phidget is not opened and attached. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native boolean getCursorBlink () throws PhidgetException; + /** + * Sets the state of the cursor blink. True indicates that the cursor blink is on, False indicates that it is off. + * The cursor blink is an flashing box which appears directly to the right of the last entered character + * on the display, in the same spot as the cursor if it is enabled. The cursor blink is by default disabled. + * @param cursorblink New cursor blink state + * @throws PhidgetException If this Phidget is not opened and attached, or if the cursor has not been set. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native void setCursorBlink (boolean cursorblink) throws PhidgetException; + /** + * Sets the display string of a certain row. + * @param index row + * @param text String + * @throws PhidgetException If this Phidget is not opened and attached, if the string is too long, or if the row is invalid. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native void setDisplayString (int index, String text) throws PhidgetException; + /** + * Sets the character to display at a certain row and column. + * @param row row + * @param column column + * @param character character + * @throws PhidgetException If this Phidget is not opened and attached, or if the row or column is invalid. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native void setDisplayCharacter (int row, int column, char character) throws PhidgetException; + /** + * Sets a custom character. You can set up to 8 custom characters, each one is completely defined by two integers, and gets + * stored in the character display until power is removed, whence they must be re-programmed. The characters lie in positions 8-15, and + * can be displayed by sending these codes to setDisplayString in amongst standard ASCII characters. See the TextLCD Java example for + * more information. + * @param index position ( 8-15 ) + * @param param1 first half of the character code + * @param param2 second half of the character code + * @throws PhidgetException If this Phidget is not opened and attached, or if the index is invalid. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native void setCustomCharacter (int index, int param1, int param2) throws PhidgetException; + /** + * 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/getting the screen size, + * and to re-initialize a display if it has become corrupted(display not working). Not all TextLCDs supported this method. + * @throws PhidgetException If this Phidget is not opened and attached, or initialize is not supported. + * See {@link com.phidgets.Phidget#open(int) open} for information on determining if a device is attached. + */ + public native void initialize () throws PhidgetException; + private final void enableDeviceSpecificEvents (boolean b) + { + } +} |