Class BrickletLCD20x4


  • public class BrickletLCD20x4
    extends Device
    20x4 character alphanumeric display with blue backlight
    • Constructor Detail

      • BrickletLCD20x4

        public BrickletLCD20x4​(java.lang.String uid,
                               IPConnection ipcon)
        Creates an object with the unique device ID \c uid. and adds it to the IP Connection \c ipcon.
    • Method Detail

      • writeLine

        public void writeLine​(short line,
                              short position,
                              java.lang.String text)
                       throws TinkerforgeException
        Writes text to a specific line with a specific position. The text can have a maximum of 20 characters. For example: (0, 7, "Hello") will write *Hello* in the middle of the first line of the display. The display uses a special charset that includes all ASCII characters except backslash and tilde. The LCD charset also includes several other non-ASCII characters, see the `charset specification <https://github.com/Tinkerforge/lcd-20x4-bricklet/raw/master/datasheets/standard_charset.pdf>`__ for details. The Unicode example above shows how to specify non-ASCII characters and how to translate from Unicode to the LCD charset.
        Throws:
        TinkerforgeException
      • setConfig

        public void setConfig​(boolean cursor,
                              boolean blinking)
                       throws TinkerforgeException
        Configures if the cursor (shown as "_") should be visible and if it should be blinking (shown as a blinking block). The cursor position is one character behind the the last text written with writeLine(short, short, String).
        Throws:
        TinkerforgeException
      • setCustomCharacter

        public void setCustomCharacter​(short index,
                                       short[] character)
                                throws TinkerforgeException
        The LCD 20x4 Bricklet can store up to 8 custom characters. The characters consist of 5x8 pixels and can be addressed with the index 0-7. To describe the pixels, the first 5 bits of 8 bytes are used. For example, to make a custom character "H", you should transfer the following: * ``character[0] = 0b00010001`` (decimal value 17) * ``character[1] = 0b00010001`` (decimal value 17) * ``character[2] = 0b00010001`` (decimal value 17) * ``character[3] = 0b00011111`` (decimal value 31) * ``character[4] = 0b00010001`` (decimal value 17) * ``character[5] = 0b00010001`` (decimal value 17) * ``character[6] = 0b00010001`` (decimal value 17) * ``character[7] = 0b00000000`` (decimal value 0) The characters can later be written with writeLine(short, short, String) by using the characters with the byte representation 8 ("\\x08" or "\\u0008") to 15 ("\\x0F" or "\\u000F"). You can play around with the custom characters in Brick Viewer version since 2.0.1. Custom characters are stored by the LCD in RAM, so they have to be set after each startup. .. versionadded:: 2.0.1$nbsp;(Plugin)
        Throws:
        TinkerforgeException
      • setDefaultText

        public void setDefaultText​(short line,
                                   java.lang.String text)
                            throws TinkerforgeException
        Sets the default text for lines 0-3. The max number of characters per line is 20. The default text is shown on the LCD, if the default text counter expires, see setDefaultTextCounter(int). .. versionadded:: 2.0.2$nbsp;(Plugin)
        Throws:
        TinkerforgeException
      • setDefaultTextCounter

        public void setDefaultTextCounter​(int counter)
                                   throws TinkerforgeException
        Sets the default text counter. This counter is decremented each ms by the LCD firmware. If the counter reaches 0, the default text (see setDefaultText(short, String)) is shown on the LCD. This functionality can be used to show a default text if the controlling program crashes or the connection is interrupted. A possible approach is to call setDefaultTextCounter(int) every minute with the parameter 1000*60*2 (2 minutes). In this case the default text will be shown no later than 2 minutes after the controlling program crashes. A negative counter turns the default text functionality off. .. versionadded:: 2.0.2$nbsp;(Plugin)
        Throws:
        TinkerforgeException
      • getDefaultTextCounter

        public int getDefaultTextCounter()
                                  throws TinkerforgeException
        Returns the current value of the default text counter. .. versionadded:: 2.0.2$nbsp;(Plugin)
        Throws:
        TinkerforgeException
      • getIdentity

        public Device.Identity getIdentity()
                                    throws TinkerforgeException
        Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier. The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'. The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|
        Specified by:
        getIdentity in class Device
        Throws:
        TinkerforgeException