Visual Basic .NET - LCD 128x64 Bricklet¶

This is the description of the Visual Basic .NET API bindings for the LCD 128x64 Bricklet. General information and technical specifications for the LCD 128x64 Bricklet are summarized in its hardware description.

An installation guide for the Visual Basic .NET API bindings is part of their general description.

Examples¶

The example code below is Public Domain (CC0 1.0).

Hello World¶

Download (ExampleHelloWorld.vb)

Imports System
Imports Tinkerforge

Module ExampleHelloWorld
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your LCD 128x64 Bricklet

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim lcd As New BrickletLCD128x64(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Clear display
        lcd.ClearDisplay()

        ' Write "Hello World" starting from upper left corner of the screen
        lcd.WriteLine(0, 0, "Hello World")

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Big Font¶

Download (ExampleBigFont.vb)

Imports System
Imports Tinkerforge

Module ExampleBigFont
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your LCD 128x64 Bricklet

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim lcd As New BrickletLCD128x64(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Clear display
        lcd.ClearDisplay()

        ' Write "Hello World" with big 24x32 font
        lcd.DrawText(0, 0, BrickletLCD128x64.FONT_24X32, BrickletLCD128x64.COLOR_BLACK, _
                     "24x32")

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Pixel Matrix¶

Download (ExamplePixelMatrix.vb)

Imports System
Imports System.Math
Imports Tinkerforge

Module ExamplePixelMatrix
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your LCD 128x64 Bricklet
    Const WIDTH As Integer = 128
    Const HEIGHT As Integer = 64

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim lcd As New BrickletLCD128x64(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Clear display
        lcd.ClearDisplay()

        ' Draw checkerboard pattern
        Dim pixels() As Boolean = New Boolean(HEIGHT*WIDTH) {}

        For row As Integer = 0 To HEIGHT - 1
            For column As Integer = 0 To WIDTH - 1
                pixels(row*WIDTH + column) = (row \ 8) Mod 2 = (column \ 8) Mod 2
            Next column
        Next row

        lcd.WritePixels(0, 0, WIDTH-1, HEIGHT-1, pixels)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Scribble¶

Download (ExampleScribble.vb)

Imports System
Imports System.Drawing
Imports System.Math
Imports System.Threading
Imports Tinkerforge

Module ExampleScribble
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your LCD 128x64 Bricklet
    Const WIDTH As Integer = 128
    Const HEIGHT As Integer = 64

    Sub DrawImage(ByRef lcd As BrickletLCD128x64, ByVal bitmap As Bitmap)
        Dim pixels() As Boolean = New Boolean(HEIGHT*WIDTH) {}

        For row As Integer = 0 To HEIGHT - 1
            For column As Integer = 0 To WIDTH - 1
                pixels(row*WIDTH + column) = bitmap.GetPixel(column, row).GetBrightness() > 0
            Next column
        Next row

        lcd.WritePixels(0, 0, WIDTH-1, HEIGHT-1, pixels)
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim lcd As New BrickletLCD128x64(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Clear display
        lcd.ClearDisplay()

        ' Draw rotating line
        Dim bitmap As New Bitmap(WIDTH, HEIGHT)
        Dim originX As Integer = WIDTH \ 2
        Dim originY As Integer = HEIGHT \ 2
        Dim length As Integer = HEIGHT \ 2 - 2
        Dim angle As Integer = 0

        Console.WriteLine("Press enter to exit")

        While Not Console.KeyAvailable
            Dim radians As Double = Math.PI * angle / 180.0
            Dim x As Integer = Convert.ToInt32(Math.Floor(originX + length * Math.Cos(radians)))
            Dim y As Integer = Convert.ToInt32(Math.Floor(originY + length * Math.Sin(radians)))

            Using g As Graphics = Graphics.FromImage(bitmap)
                g.FillRectangle(Brushes.Black, 0, 0, WIDTH, HEIGHT)
                g.DrawLine(Pens.White, originX, originY, x, y)
            End Using

            DrawImage(lcd, bitmap)
            Thread.Sleep(25)

            angle += 1
        End While

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Touch¶

Download (ExampleTouch.vb)

Imports System
Imports Tinkerforge

Module ExampleTouch
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your LCD 128x64 Bricklet

    ' Callback subroutine for touch position callback
    Sub TouchPositionCB(ByVal sender As BrickletLCD128x64, ByVal pressure As Integer, _
                        ByVal x As Integer, ByVal y As Integer, ByVal age As Long)
        Console.WriteLine("Pressure: " + pressure.ToString())
        Console.WriteLine("X: " + x.ToString())
        Console.WriteLine("Y: " + y.ToString())
        Console.WriteLine("Age: " + age.ToString())
        Console.WriteLine("")
    End Sub

    ' Callback subroutine for touch gesture callback
    Sub TouchGestureCB(ByVal sender As BrickletLCD128x64, ByVal gesture As Byte, _
                       ByVal duration As Long, ByVal pressureMax As Integer, _
                       ByVal xStart As Integer, ByVal xEnd As Integer, _
                       ByVal yStart As Integer, ByVal yEnd As Integer, _
                       ByVal age As Long)
        If gesture = BrickletLCD128x64.GESTURE_LEFT_TO_RIGHT Then
            Console.WriteLine("Gesture: Left To Right")
        Else If gesture = BrickletLCD128x64.GESTURE_RIGHT_TO_LEFT Then
            Console.WriteLine("Gesture: Right To Left")
        Else If gesture = BrickletLCD128x64.GESTURE_TOP_TO_BOTTOM Then
            Console.WriteLine("Gesture: Top To Bottom")
        Else If gesture = BrickletLCD128x64.GESTURE_BOTTOM_TO_TOP Then
            Console.WriteLine("Gesture: Bottom To Top")
        End If

        Console.WriteLine("Duration: " + duration.ToString())
        Console.WriteLine("Pressure Max: " + pressureMax.ToString())
        Console.WriteLine("X Start: " + xStart.ToString())
        Console.WriteLine("X End: " + xEnd.ToString())
        Console.WriteLine("Y Start: " + yStart.ToString())
        Console.WriteLine("Y End: " + yEnd.ToString())
        Console.WriteLine("Age: " + age.ToString())
        Console.WriteLine("")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim lcd As New BrickletLCD128x64(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Register touch position callback to subroutine TouchPositionCB
        AddHandler lcd.TouchPositionCallback, AddressOf TouchPositionCB

        ' Register touch gesture callback to subroutine TouchGestureCB
        AddHandler lcd.TouchGestureCallback, AddressOf TouchGestureCB

        ' Set period for touch position callback to 0.1s (100ms)
        lcd.SetTouchPositionCallbackConfiguration(100, True)

        ' Set period for touch gesture callback to 0.1s (100ms)
        lcd.SetTouchGestureCallbackConfiguration(100, True)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

GUI¶

Download (ExampleGUI.vb)

Imports System
Imports Tinkerforge

Module ExampleGUI
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your LCD 128x64 Bricklet

    ' Callback subroutine for GUI button pressed callback
    Sub GUIButtonPressedCB(ByVal sender As BrickletLCD128x64, ByVal index As Byte, _
                           ByVal pressed As Boolean)
        Console.WriteLine("Index: " + index.ToString())
        Console.WriteLine("Pressed: " + pressed.ToString())
        Console.WriteLine("")
    End Sub

    ' Callback subroutine for GUI slider value callback
    Sub GUISliderValueCB(ByVal sender As BrickletLCD128x64, ByVal index As Byte, _
                         ByVal value As Byte)
        Console.WriteLine("Index: " + index.ToString())
        Console.WriteLine("Value: " + value.ToString())
        Console.WriteLine("")
    End Sub

    ' Callback subroutine for GUI tab selected callback
    Sub GUITabSelectedCB(ByVal sender As BrickletLCD128x64, ByVal index As Short)
        Console.WriteLine("Index: " + index.ToString())
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim lcd As New BrickletLCD128x64(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Register GUI button pressed callback to subroutine GUIButtonPressedCB
        AddHandler lcd.GUIButtonPressedCallback, AddressOf GUIButtonPressedCB

        ' Register GUI slider value callback to subroutine GUISliderValueCB
        AddHandler lcd.GUISliderValueCallback, AddressOf GUISliderValueCB

        ' Register GUI tab selected callback to subroutine GUITabSelectedCB
        AddHandler lcd.GUITabSelectedCallback, AddressOf GUITabSelectedCB

        ' Clear display
        lcd.ClearDisplay()
        lcd.RemoveAllGUI()

        ' Add GUI elements: Button, Slider and Graph with 60 data points
        lcd.SetGUIButton(0, 0, 0, 60, 20, "button")
        lcd.SetGUISlider(0, 0, 30, 60, BrickletLCD128x64.DIRECTION_HORIZONTAL, 50)
        lcd.SetGUIGraphConfiguration(0, BrickletLCD128x64.GRAPH_TYPE_LINE, 62, 0, 60, _
                                     52, "X", "Y")

        ' Add a few data points (the remaining points will be 0)
        lcd.SetGUIGraphData(0, _
                            new Byte(){20, 40, 60, 80, 100, 120, 140, 160, 180, 200, 220, 240})

        ' Add 5 text tabs without and configure it for click and swipe without auto-redraw
        lcd.SetGUITabConfiguration(BrickletLCD128x64.CHANGE_TAB_ON_CLICK_AND_SWIPE, _
                                   False)
        lcd.SetGUITabText(0, "Tab A")
        lcd.SetGUITabText(1, "Tab B")
        lcd.SetGUITabText(2, "Tab C")
        lcd.SetGUITabText(3, "Tab D")
        lcd.SetGUITabText(4, "Tab E")

        ' Set period for GUI button pressed callback to 0.1s (100ms)
        lcd.SetGUIButtonPressedCallbackConfiguration(100, True)

        ' Set period for GUI slider value callback to 0.1s (100ms)
        lcd.SetGUISliderValueCallbackConfiguration(100, True)

        ' Set period for GUI tab selected callback to 0.1s (100ms)
        lcd.SetGUITabSelectedCallbackConfiguration(100, True)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

API¶

Since Visual Basic .NET does not support multiple return values directly, we use the ByRef keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.

Basic Functions¶

Class BrickletLCD128x64(ByVal uid As String, ByVal ipcon As IPConnection)¶

Creates an object with the unique device ID uid:

Dim lcd128x64 As New BrickletLCD128x64("YOUR_DEVICE_UID", ipcon)

This object can then be used after the IP Connection is connected.

Sub BrickletLCD128x64.WritePixels(ByVal xStart As Byte, ByVal yStart As Byte, ByVal xEnd As Byte, ByVal yEnd As Byte, ByVal pixels() As Boolean)¶

Parameters:	xStart – Type: Byte, Range: [0 to 127] yStart – Type: Byte, Range: [0 to 63] xEnd – Type: Byte, Range: [0 to 127] yEnd – Type: Byte, Range: [0 to 63] pixels – Type: Boolean Array, Length: variable

Writes pixels to the specified window.

The pixels are written into the window line by line top to bottom and each line is written from left to right.

If automatic draw is enabled (default) the pixels are directly written to the screen. Only pixels that have actually changed are updated on the screen, the rest stays the same.

If automatic draw is disabled the pixels are written to an internal buffer and the buffer is transferred to the display only after DrawBufferedFrame() is called. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Automatic draw can be configured with the SetDisplayConfiguration() function.

Function BrickletLCD128x64.ReadPixels(ByVal xStart As Byte, ByVal yStart As Byte, ByVal xEnd As Byte, ByVal yEnd As Byte) As Boolean()¶

Parameters:	xStart – Type: Byte, Range: [0 to 127] yStart – Type: Byte, Range: [0 to 63] xEnd – Type: Byte, Range: [0 to 127] yEnd – Type: Byte, Range: [0 to 63]
Returns:	pixels – Type: Boolean Array, Length: variable

Reads pixels from the specified window.

The pixels are read from the window line by line top to bottom and each line is read from left to right.

If automatic draw is enabled (default) the pixels that are read are always the same that are shown on the display.

If automatic draw is disabled the pixels are read from the internal buffer (see DrawBufferedFrame()).

Automatic draw can be configured with the SetDisplayConfiguration() function.

Sub BrickletLCD128x64.ClearDisplay()¶

Clears the complete content of the display.

If automatic draw is enabled (default) the pixels are directly cleared.

If automatic draw is disabled the the internal buffer is cleared and the buffer is transferred to the display only after DrawBufferedFrame() is called. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Automatic draw can be configured with the SetDisplayConfiguration() function.

Sub BrickletLCD128x64.WriteLine(ByVal line As Byte, ByVal position As Byte, ByVal text As String)¶

Parameters:	line – Type: Byte, Range: [0 to 7] position – Type: Byte, Range: [0 to 21] text – Type: String, Length: up to 22

Writes text to a specific line with a specific position.

For example: (1, 10, "Hello") will write Hello in the middle of the second line of the display.

The display uses a special 5x7 pixel charset. You can view the characters of the charset in Brick Viewer.

If automatic draw is enabled (default) the text is directly written to the screen. Only pixels that have actually changed are updated on the screen, the rest stays the same.

If automatic draw is disabled the text is written to an internal buffer and the buffer is transferred to the display only after DrawBufferedFrame() is called. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Automatic draw can be configured with the SetDisplayConfiguration() function.

This function is a 1:1 replacement for the function with the same name in the LCD 20x4 Bricklet. You can draw text at a specific pixel position and with different font sizes with the DrawText() function.

Sub BrickletLCD128x64.DrawBufferedFrame(ByVal forceCompleteRedraw As Boolean)¶

Parameters:	forceCompleteRedraw – Type: Boolean

Draws the currently buffered frame. Normally each call of WritePixels() and WriteLine() draws directly onto the display. If you turn automatic draw off (SetDisplayConfiguration()), the data is written in an internal buffer and only transferred to the display by calling this function. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Set the force complete redraw to true to redraw the whole display instead of only the changed parts. Normally it should not be necessary to set this to true. It may only become necessary in case of stuck pixels because of errors.

Sub BrickletLCD128x64.GetTouchPosition(ByRef pressure As Integer, ByRef x As Integer, ByRef y As Integer, ByRef age As Long)¶

Output Parameters:	pressure – Type: Integer, Range: [0 to 300] x – Type: Integer, Range: [0 to 127] y – Type: Integer, Range: [0 to 63] age – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1]

Returns the last valid touch position:

Pressure: Amount of pressure applied by the user
X: Touch position on x-axis
Y: Touch position on y-axis
Age: Age of touch press (how long ago it was)

Sub BrickletLCD128x64.GetTouchGesture(ByRef gesture As Byte, ByRef duration As Long, ByRef pressureMax As Integer, ByRef xStart As Integer, ByRef yStart As Integer, ByRef xEnd As Integer, ByRef yEnd As Integer, ByRef age As Long)¶

Output Parameters:

Output Parameters:	gesture – Type: Byte, Range: See constants duration – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1] pressureMax – Type: Integer, Range: [0 to 300] xStart – Type: Integer, Range: [0 to 127] yStart – Type: Integer, Range: [0 to 63] xEnd – Type: Integer, Range: [0 to 127] yEnd – Type: Integer, Range: [0 to 63] age – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1]

gesture – Type: Byte, Range: See constants
duration – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1]
pressureMax – Type: Integer, Range: [0 to 300]
xStart – Type: Integer, Range: [0 to 127]
yStart – Type: Integer, Range: [0 to 63]
xEnd – Type: Integer, Range: [0 to 127]
yEnd – Type: Integer, Range: [0 to 63]
age – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1]

Returns one of four touch gestures that can be automatically detected by the Bricklet.

The gestures are swipes from left to right, right to left, top to bottom and bottom to top.

Additionally to the gestures a vector with a start and end position of the gesture is provided. You can use this vector do determine a more exact location of the gesture (e.g. the swipe from top to bottom was on the left or right part of the screen).

The age parameter corresponds to the age of gesture (how long ago it was).

The following constants are available for this function:

For gesture:

BrickletLCD128x64.GESTURE_LEFT_TO_RIGHT = 0
BrickletLCD128x64.GESTURE_RIGHT_TO_LEFT = 1
BrickletLCD128x64.GESTURE_TOP_TO_BOTTOM = 2
BrickletLCD128x64.GESTURE_BOTTOM_TO_TOP = 3

Sub BrickletLCD128x64.DrawLine(ByVal positionXStart As Byte, ByVal positionYStart As Byte, ByVal positionXEnd As Byte, ByVal positionYEnd As Byte, ByVal color As Boolean)¶

Parameters:	positionXStart – Type: Byte, Range: [0 to 127] positionYStart – Type: Byte, Range: [0 to 63] positionXEnd – Type: Byte, Range: [0 to 127] positionYEnd – Type: Byte, Range: [0 to 63] color – Type: Boolean

Draws a white or black line from (x, y)-start to (x, y)-end.

The following constants are available for this function:

For color:

BrickletLCD128x64.COLOR_WHITE = false
BrickletLCD128x64.COLOR_BLACK = true

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.DrawBox(ByVal positionXStart As Byte, ByVal positionYStart As Byte, ByVal positionXEnd As Byte, ByVal positionYEnd As Byte, ByVal fill As Boolean, ByVal color As Boolean)¶

Parameters:	positionXStart – Type: Byte, Range: [0 to 127] positionYStart – Type: Byte, Range: [0 to 63] positionXEnd – Type: Byte, Range: [0 to 127] positionYEnd – Type: Byte, Range: [0 to 63] fill – Type: Boolean color – Type: Boolean

Draws a white or black box from (x, y)-start to (x, y)-end.

If you set fill to true, the box will be filled with the color. Otherwise only the outline will be drawn.

The following constants are available for this function:

For color:

BrickletLCD128x64.COLOR_WHITE = false
BrickletLCD128x64.COLOR_BLACK = true

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.DrawText(ByVal positionX As Byte, ByVal positionY As Byte, ByVal font As Byte, ByVal color As Boolean, ByVal text As String)¶

Parameters:	positionX – Type: Byte, Range: [0 to 127] positionY – Type: Byte, Range: [0 to 63] font – Type: Byte, Range: See constants color – Type: Boolean text – Type: String, Length: up to 22

Draws a text at the pixel position (x, y).

You can use one of 9 different font sizes and draw the text in white or black.

The font conforms to code page 437.

The following constants are available for this function:

For font:

BrickletLCD128x64.FONT_6X8 = 0
BrickletLCD128x64.FONT_6X16 = 1
BrickletLCD128x64.FONT_6X24 = 2
BrickletLCD128x64.FONT_6X32 = 3
BrickletLCD128x64.FONT_12X16 = 4
BrickletLCD128x64.FONT_12X24 = 5
BrickletLCD128x64.FONT_12X32 = 6
BrickletLCD128x64.FONT_18X24 = 7
BrickletLCD128x64.FONT_18X32 = 8
BrickletLCD128x64.FONT_24X32 = 9

For color:

BrickletLCD128x64.COLOR_WHITE = false
BrickletLCD128x64.COLOR_BLACK = true

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.SetGUIButton(ByVal index As Byte, ByVal positionX As Byte, ByVal positionY As Byte, ByVal width As Byte, ByVal height As Byte, ByVal text As String)¶

Parameters:	index – Type: Byte, Range: [0 to 11] positionX – Type: Byte, Range: [0 to 127] positionY – Type: Byte, Range: [0 to 63] width – Type: Byte, Range: [1 to 128] height – Type: Byte, Range: [1 to 64] text – Type: String, Length: up to 16

Draws a clickable button at position (x, y) with the given text.

You can use up to 12 buttons.

The x position + width has to be within the range of 1 to 128 and the y position + height has to be within the range of 1 to 64.

The minimum useful width/height of a button is 3.

You can enable a callback for a button press with SetGUIButtonPressedCallbackConfiguration(). The callback will be triggered for press and release-events.

The button is drawn in a separate GUI buffer and the button-frame will always stay on top of the graphics drawn with WritePixels(). To remove the button use RemoveGUIButton().

If you want an icon instead of text, you can draw the icon inside of the button with WritePixels().

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.GetGUIButton(ByVal index As Byte, ByRef active As Boolean, ByRef positionX As Byte, ByRef positionY As Byte, ByRef width As Byte, ByRef height As Byte, ByRef text As String)¶

Parameters:	index – Type: Byte, Range: [0 to 11]
Output Parameters:	active – Type: Boolean positionX – Type: Byte, Range: [0 to 127] positionY – Type: Byte, Range: [0 to 63] width – Type: Byte, Range: [1 to 128] height – Type: Byte, Range: [1 to 64] text – Type: String, Length: up to 16

Returns the button properties for a given Index as set by SetGUIButton().

Additionally the Active parameter shows if a button is currently active/visible or not.

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.RemoveGUIButton(ByVal index As Byte)¶

Parameters:	index – Type: Byte, Range: [0 to 11, 255]

Removes the button with the given index.

You can use index 255 to remove all buttons.

Added in version 2.0.2$nbsp;(Plugin).

Function BrickletLCD128x64.GetGUIButtonPressed(ByVal index As Byte) As Boolean¶

Parameters:	index – Type: Byte, Range: [0 to 11]
Returns:	pressed – Type: Boolean

Returns the state of the button for the given index.

The state can either be pressed (true) or released (false).

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.SetGUISlider(ByVal index As Byte, ByVal positionX As Byte, ByVal positionY As Byte, ByVal length As Byte, ByVal direction As Byte, ByVal value As Byte)¶

Parameters:	index – Type: Byte, Range: [0 to 5] positionX – Type: Byte, Range: [0 to 128] positionY – Type: Byte, Range: [0 to 64] length – Type: Byte, Range: [8 to 128] direction – Type: Byte, Range: See constants value – Type: Byte, Range: [0 to 120]

Draws a slider at position (x, y) with the given length.

You can use up to 6 sliders.

If you use the horizontal direction, the x position + length has to be within the range of 1 to 128 and the y position has to be within the range of 0 to 46.

If you use the vertical direction, the y position + length has to be within the range of 1 to 64 and the x position has to be within the range of 0 to 110.

The minimum length of a slider is 8.

The parameter value is the start-position of the slider, it can be between 0 and length-8.

You can enable a callback for the slider value with SetGUISliderValueCallbackConfiguration().

The slider is drawn in a separate GUI buffer and it will always stay on top of the graphics drawn with WritePixels(). To remove the button use RemoveGUISlider().

The following constants are available for this function:

For direction:

BrickletLCD128x64.DIRECTION_HORIZONTAL = 0
BrickletLCD128x64.DIRECTION_VERTICAL = 1

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.GetGUISlider(ByVal index As Byte, ByRef active As Boolean, ByRef positionX As Byte, ByRef positionY As Byte, ByRef length As Byte, ByRef direction As Byte, ByRef value As Byte)¶

Parameters:	index – Type: Byte, Range: [0 to 5]
Output Parameters:	active – Type: Boolean positionX – Type: Byte, Range: [0 to 128] positionY – Type: Byte, Range: [0 to 64] length – Type: Byte, Range: [8 to 128] direction – Type: Byte, Range: See constants value – Type: Byte, Range: [0 to 120]

Returns the slider properties for a given Index as set by SetGUISlider().

Additionally the Active parameter shows if a button is currently active/visible or not.

The following constants are available for this function:

For direction:

BrickletLCD128x64.DIRECTION_HORIZONTAL = 0
BrickletLCD128x64.DIRECTION_VERTICAL = 1

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.RemoveGUISlider(ByVal index As Byte)¶

Parameters:	index – Type: Byte, Range: [0 to 5, 255]

Removes the slider with the given index.

You can use index 255 to remove all slider.

Added in version 2.0.2$nbsp;(Plugin).

Function BrickletLCD128x64.GetGUISliderValue(ByVal index As Byte) As Byte¶

Parameters:	index – Type: Byte, Range: [0 to 5]
Returns:	value – Type: Byte, Range: [0 to 120]

Returns the current slider value for the given index.

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.SetGUITabConfiguration(ByVal changeTabConfig As Byte, ByVal clearGUI As Boolean)¶

Parameters:	changeTabConfig – Type: Byte, Range: See constants, Default: 3 clearGUI – Type: Boolean, Default: true

Sets the general configuration for tabs. You can configure the tabs to only accept clicks or only swipes (gesture left/right and right/left) or both.

Additionally, if you set Clear GUI to true, all of the GUI elements (buttons, slider, graphs) will automatically be removed on every tab change.

The following constants are available for this function:

For changeTabConfig:

BrickletLCD128x64.CHANGE_TAB_ON_CLICK = 1
BrickletLCD128x64.CHANGE_TAB_ON_SWIPE = 2
BrickletLCD128x64.CHANGE_TAB_ON_CLICK_AND_SWIPE = 3

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.GetGUITabConfiguration(ByRef changeTabConfig As Byte, ByRef clearGUI As Boolean)¶

Output Parameters:	changeTabConfig – Type: Byte, Range: See constants, Default: 3 clearGUI – Type: Boolean, Default: true

Returns the tab configuration as set by SetGUITabConfiguration().

The following constants are available for this function:

For changeTabConfig:

BrickletLCD128x64.CHANGE_TAB_ON_CLICK = 1
BrickletLCD128x64.CHANGE_TAB_ON_SWIPE = 2
BrickletLCD128x64.CHANGE_TAB_ON_CLICK_AND_SWIPE = 3

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.SetGUITabText(ByVal index As Byte, ByVal text As String)¶

Parameters:	index – Type: Byte, Range: [0 to 9] text – Type: String, Length: up to 5

Adds a text-tab with the given index.

You can use up to 10 tabs.

A text-tab with the same index as a icon-tab will overwrite the icon-tab.

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.GetGUITabText(ByVal index As Byte, ByRef active As Boolean, ByRef text As String)¶

Parameters:	index – Type: Byte, Range: [0 to 9]
Output Parameters:	active – Type: Boolean text – Type: String, Length: up to 5

Returns the text for a given index as set by SetGUITabText().

Additionally the Active parameter shows if the tab is currently active/visible or not.

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.SetGUITabIcon(ByVal index As Byte, ByVal icon() As Boolean)¶

Parameters:	index – Type: Byte, Range: [0 to 9] icon – Type: Boolean Array, Length: 168

Adds a icon-tab with the given index. The icon can have a width of 28 pixels with a height of 6 pixels. It is drawn line-by-line from left to right.

You can use up to 10 tabs.

A icon-tab with the same index as a text-tab will overwrite the text-tab.

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.GetGUITabIcon(ByVal index As Byte, ByRef active As Boolean, ByRef icon() As Boolean)¶

Parameters:	index – Type: Byte, Range: [0 to 9]
Output Parameters:	active – Type: Boolean icon – Type: Boolean Array, Length: 168

Returns the icon for a given index as set by SetGUITabIcon().

Additionally the Active parameter shows if the tab is currently active/visible or not.

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.RemoveGUITab(ByVal index As Byte)¶

Parameters:	index – Type: Byte, Range: [0 to 9, 255]

Removes the tab with the given index.

You can use index 255 to remove all tabs.

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.SetGUITabSelected(ByVal index As Byte)¶

Parameters:	index – Type: Byte, Range: [0 to 9]

Sets the tab with the given index as selected (drawn as selected on the display).

Added in version 2.0.2$nbsp;(Plugin).

Function BrickletLCD128x64.GetGUITabSelected() As Short¶

Returns:	index – Type: Short, Range: [-1 to 9]

Returns the index of the currently selected tab. If there are not tabs, the returned index is -1.

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.SetGUIGraphConfiguration(ByVal index As Byte, ByVal graphType As Byte, ByVal positionX As Byte, ByVal positionY As Byte, ByVal width As Byte, ByVal height As Byte, ByVal textX As String, ByVal textY As String)¶

Parameters:	index – Type: Byte, Range: [0 to 3] graphType – Type: Byte, Range: See constants positionX – Type: Byte, Range: [0 to 127] positionY – Type: Byte, Range: [0 to 63] width – Type: Byte, Range: [0 to 118] height – Type: Byte, Range: [0 to 63] textX – Type: String, Length: up to 4 textY – Type: String, Length: up to 4

Sets the configuration for up to four graphs.

The graph type can be dot-, line- or bar-graph.

The x and y position are pixel positions.

You can add a text for the x and y axis. The text is drawn at the inside of the graph and it can overwrite some of the graph data. If you need the text outside of the graph you can leave this text here empty and use DrawText() to draw the caption outside of the graph.

The data of the graph can be set and updated with SetGUIGraphData().

The graph is drawn in a separate GUI buffer and the graph-frame and data will always stay on top of the graphics drawn with WritePixels(). To remove the graph use RemoveGUIGraph().

The following constants are available for this function:

For graphType:

BrickletLCD128x64.GRAPH_TYPE_DOT = 0
BrickletLCD128x64.GRAPH_TYPE_LINE = 1
BrickletLCD128x64.GRAPH_TYPE_BAR = 2

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.GetGUIGraphConfiguration(ByVal index As Byte, ByRef active As Boolean, ByRef graphType As Byte, ByRef positionX As Byte, ByRef positionY As Byte, ByRef width As Byte, ByRef height As Byte, ByRef textX As String, ByRef textY As String)¶

Parameters:	index – Type: Byte, Range: [0 to 3]
Output Parameters:	active – Type: Boolean graphType – Type: Byte, Range: See constants positionX – Type: Byte, Range: [0 to 127] positionY – Type: Byte, Range: [0 to 63] width – Type: Byte, Range: [0 to 118] height – Type: Byte, Range: [0 to 63] textX – Type: String, Length: up to 4 textY – Type: String, Length: up to 4

Returns the graph properties for a given Index as set by SetGUIGraphConfiguration().

Additionally the Active parameter shows if a graph is currently active/visible or not.

The following constants are available for this function:

For graphType:

BrickletLCD128x64.GRAPH_TYPE_DOT = 0
BrickletLCD128x64.GRAPH_TYPE_LINE = 1
BrickletLCD128x64.GRAPH_TYPE_BAR = 2

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.SetGUIGraphData(ByVal index As Byte, ByVal data() As Byte)¶

Parameters:	index – Type: Byte, Range: [0 to 3] data – Type: Byte Array, Length: variable, Range: [0 to 255]

Sets the data for a graph with the given index. You have to configure the graph with SetGUIGraphConfiguration() before you can set the first data.

The graph will show the first n values of the data that you set, where n is the width set with SetGUIGraphConfiguration(). If you set less then n values it will show the rest of the values as zero.

The maximum number of data-points you can set is 118 (which also corresponds to the maximum width of the graph).

You have to scale your values to be between 0 and 255. 0 will be shown at the bottom of the graph and 255 at the top.

Added in version 2.0.2$nbsp;(Plugin).

Function BrickletLCD128x64.GetGUIGraphData(ByVal index As Byte) As Byte()¶

Parameters:	index – Type: Byte, Range: [0 to 3]
Returns:	data – Type: Byte Array, Length: variable, Range: [0 to 255]

Returns the graph data for a given index as set by SetGUIGraphData().

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.RemoveGUIGraph(ByVal index As Byte)¶

Parameters:	index – Type: Byte, Range: [0 to 3, 255]

Removes the graph with the given index.

You can use index 255 to remove all graphs.

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.RemoveAllGUI()¶: Removes all GUI elements (buttons, slider, graphs, tabs).

Added in version 2.0.2$nbsp;(Plugin).

Advanced Functions¶

Sub BrickletLCD128x64.SetDisplayConfiguration(ByVal contrast As Byte, ByVal backlight As Byte, ByVal invert As Boolean, ByVal automaticDraw As Boolean)¶

Parameters:	contrast – Type: Byte, Range: [0 to 63], Default: 14 backlight – Type: Byte, Range: [0 to 100], Default: 100 invert – Type: Boolean, Default: false automaticDraw – Type: Boolean, Default: true

Sets the configuration of the display.

If automatic draw is set to true, the display is automatically updated with every call of WritePixels() and WriteLine(). If it is set to false, the changes are written into an internal buffer and only shown on the display after a call of DrawBufferedFrame().

Sub BrickletLCD128x64.GetDisplayConfiguration(ByRef contrast As Byte, ByRef backlight As Byte, ByRef invert As Boolean, ByRef automaticDraw As Boolean)¶

Output Parameters:	contrast – Type: Byte, Range: [0 to 63], Default: 14 backlight – Type: Byte, Range: [0 to 100], Default: 100 invert – Type: Boolean, Default: false automaticDraw – Type: Boolean, Default: true

Returns the configuration as set by SetDisplayConfiguration().

Sub BrickletLCD128x64.SetTouchLEDConfig(ByVal config As Byte)¶

Parameters:	config – Type: Byte, Range: See constants, Default: 3

Sets the touch LED configuration. By default the LED is on if the LCD is touched.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

The following constants are available for this function:

For config:

BrickletLCD128x64.TOUCH_LED_CONFIG_OFF = 0
BrickletLCD128x64.TOUCH_LED_CONFIG_ON = 1
BrickletLCD128x64.TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletLCD128x64.TOUCH_LED_CONFIG_SHOW_TOUCH = 3

Added in version 2.0.2$nbsp;(Plugin).

Function BrickletLCD128x64.GetTouchLEDConfig() As Byte¶

Returns:	config – Type: Byte, Range: See constants, Default: 3

Returns the configuration as set by SetTouchLEDConfig()

The following constants are available for this function:

For config:

BrickletLCD128x64.TOUCH_LED_CONFIG_OFF = 0
BrickletLCD128x64.TOUCH_LED_CONFIG_ON = 1
BrickletLCD128x64.TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletLCD128x64.TOUCH_LED_CONFIG_SHOW_TOUCH = 3

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)¶

Output Parameters:	errorCountAckChecksum – Type: Long, Range: [0 to 2³² - 1] errorCountMessageChecksum – Type: Long, Range: [0 to 2³² - 1] errorCountFrame – Type: Long, Range: [0 to 2³² - 1] errorCountOverflow – Type: Long, Range: [0 to 2³² - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

ACK checksum errors,
message checksum errors,
framing errors and
overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

Sub BrickletLCD128x64.SetStatusLEDConfig(ByVal config As Byte)¶

Parameters:	config – Type: Byte, Range: See constants, Default: 3

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For config:

BrickletLCD128x64.STATUS_LED_CONFIG_OFF = 0
BrickletLCD128x64.STATUS_LED_CONFIG_ON = 1
BrickletLCD128x64.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletLCD128x64.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletLCD128x64.GetStatusLEDConfig() As Byte¶

Returns:	config – Type: Byte, Range: See constants, Default: 3

Returns the configuration as set by SetStatusLEDConfig()

The following constants are available for this function:

For config:

BrickletLCD128x64.STATUS_LED_CONFIG_OFF = 0
BrickletLCD128x64.STATUS_LED_CONFIG_ON = 1
BrickletLCD128x64.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletLCD128x64.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletLCD128x64.GetChipTemperature() As Short¶

Returns:	temperature – Type: Short, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

Sub BrickletLCD128x64.Reset()¶

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

Sub BrickletLCD128x64.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)¶

Output Parameters:

Output Parameters:	uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: Char, Range: ["a"C to "h"C, "z"C] hardwareVersion – Type: Byte Array, Length: 3 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255] firmwareVersion – Type: Byte Array, Length: 3 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255] deviceIdentifier – Type: Integer, Range: [0 to 2¹⁶ - 1]

uid – Type: String, Length: up to 8
connectedUid – Type: String, Length: up to 8
position – Type: Char, Range: ["a"C to "h"C, "z"C]
hardwareVersion – Type: Byte Array, Length: 3

0: major – Type: Byte, Range: [0 to 255]
1: minor – Type: Byte, Range: [0 to 255]
2: revision – Type: Byte, Range: [0 to 255]

firmwareVersion – Type: Byte Array, Length: 3

0: major – Type: Byte, Range: [0 to 255]
1: minor – Type: Byte, Range: [0 to 255]
2: revision – Type: Byte, Range: [0 to 255]

deviceIdentifier – Type: Integer, Range: [0 to 2¹⁶ - 1]

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 Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions¶

Sub BrickletLCD128x64.SetTouchPositionCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean)¶

Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: Boolean, Default: false

The period is the period with which the TouchPositionCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

Sub BrickletLCD128x64.GetTouchPositionCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean)¶

Output Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: Boolean, Default: false

Returns the callback configuration as set by SetTouchPositionCallbackConfiguration().

Sub BrickletLCD128x64.SetTouchGestureCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean)¶

Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: Boolean, Default: false

The period is the period with which the TouchGestureCallback callback is triggered periodically. A value of 0 turns the callback off.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

Sub BrickletLCD128x64.GetTouchGestureCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean)¶

Output Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: Boolean, Default: false

Returns the callback configuration as set by SetTouchGestureCallbackConfiguration().

Sub BrickletLCD128x64.SetGUIButtonPressedCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean)¶

Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: Boolean, Default: false

The period is the period with which the GUIButtonPressedCallback callback is triggered periodically. A value of 0 turns the callback off.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.GetGUIButtonPressedCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean)¶

Output Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: Boolean, Default: false

Returns the callback configuration as set by SetGUIButtonPressedCallbackConfiguration().

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.SetGUISliderValueCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean)¶

Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: Boolean, Default: false

The period is the period with which the GUISliderValueCallback callback is triggered periodically. A value of 0 turns the callback off.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.GetGUISliderValueCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean)¶

Output Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: Boolean, Default: false

Returns the callback configuration as set by SetGUISliderValueCallbackConfiguration().

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.SetGUITabSelectedCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean)¶

Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: Boolean, Default: false

The period is the period with which the GUITabSelectedCallback callback is triggered periodically. A value of 0 turns the callback off.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

Added in version 2.0.2$nbsp;(Plugin).

Sub BrickletLCD128x64.GetGUITabSelectedCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean)¶

Output Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: Boolean, Default: false

Returns the callback configuration as set by SetGUITabSelectedCallbackConfiguration().

Added in version 2.0.2$nbsp;(Plugin).

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a procedure to an callback property of the device object:

Sub MyCallback(ByVal sender As BrickletLCD128x64, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler lcd128x64.ExampleCallback, AddressOf MyCallback

The available callback property and their type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

Event BrickletLCD128x64.TouchPositionCallback(ByVal sender As BrickletLCD128x64, ByVal pressure As Integer, ByVal x As Integer, ByVal y As Integer, ByVal age As Long)¶

Callback Parameters:	sender – Type: BrickletLCD128x64 pressure – Type: Integer, Range: [0 to 300] x – Type: Integer, Range: [0 to 127] y – Type: Integer, Range: [0 to 63] age – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1]

This callback is triggered periodically with the period that is set by SetTouchPositionCallbackConfiguration(). The parameters are the same as for GetTouchPosition().

Event BrickletLCD128x64.TouchGestureCallback(ByVal sender As BrickletLCD128x64, ByVal gesture As Byte, ByVal duration As Long, ByVal pressureMax As Integer, ByVal xStart As Integer, ByVal yStart As Integer, ByVal xEnd As Integer, ByVal yEnd As Integer, ByVal age As Long)¶

Callback Parameters:

sender – Type: BrickletLCD128x64
gesture – Type: Byte, Range: See constants
duration – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1]
pressureMax – Type: Integer, Range: [0 to 300]
xStart – Type: Integer, Range: [0 to 127]
yStart – Type: Integer, Range: [0 to 63]
xEnd – Type: Integer, Range: [0 to 127]
yEnd – Type: Integer, Range: [0 to 63]
age – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1]

This callback is triggered periodically with the period that is set by SetTouchGestureCallbackConfiguration(). The parameters are the same as for GetTouchGesture().

The following constants are available for this function:

For gesture:

BrickletLCD128x64.GESTURE_LEFT_TO_RIGHT = 0
BrickletLCD128x64.GESTURE_RIGHT_TO_LEFT = 1
BrickletLCD128x64.GESTURE_TOP_TO_BOTTOM = 2
BrickletLCD128x64.GESTURE_BOTTOM_TO_TOP = 3

Event BrickletLCD128x64.GUIButtonPressedCallback(ByVal sender As BrickletLCD128x64, ByVal index As Byte, ByVal pressed As Boolean)¶

Callback Parameters:	sender – Type: BrickletLCD128x64 index – Type: Byte, Range: [0 to 11] pressed – Type: Boolean

This callback is triggered periodically with the period that is set by SetGUIButtonPressedCallbackConfiguration(). The parameters are the same as for GetGUIButtonPressed().

Added in version 2.0.2$nbsp;(Plugin).

Event BrickletLCD128x64.GUISliderValueCallback(ByVal sender As BrickletLCD128x64, ByVal index As Byte, ByVal value As Byte)¶

Callback Parameters:	sender – Type: BrickletLCD128x64 index – Type: Byte, Range: [0 to 5] value – Type: Byte, Range: [0 to 120]

This callback is triggered periodically with the period that is set by SetGUISliderValueCallbackConfiguration(). The parameters are the same as for GetGUISliderValue().

Added in version 2.0.2$nbsp;(Plugin).

Event BrickletLCD128x64.GUITabSelectedCallback(ByVal sender As BrickletLCD128x64, ByVal index As Short)¶

Callback Parameters:	sender – Type: BrickletLCD128x64 index – Type: Short, Range: [0 to 9]

This callback is triggered periodically with the period that is set by SetGUITabSelectedCallbackConfiguration(). The parameters are the same as for GetGUITabSelected().

Added in version 2.0.2$nbsp;(Plugin).

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

Function BrickletLCD128x64.GetAPIVersion() As Byte()¶

Output Parameters:	apiVersion – Type: Byte Array, Length: 3 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

Function BrickletLCD128x64.GetResponseExpected(ByVal functionId As Byte) As Boolean¶

Parameters:	functionId – Type: Byte, Range: See constants
Returns:	responseExpected – Type: Boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

BrickletLCD128x64.FUNCTION_WRITE_PIXELS = 1
BrickletLCD128x64.FUNCTION_CLEAR_DISPLAY = 3
BrickletLCD128x64.FUNCTION_SET_DISPLAY_CONFIGURATION = 4
BrickletLCD128x64.FUNCTION_WRITE_LINE = 6
BrickletLCD128x64.FUNCTION_DRAW_BUFFERED_FRAME = 7
BrickletLCD128x64.FUNCTION_SET_TOUCH_POSITION_CALLBACK_CONFIGURATION = 9
BrickletLCD128x64.FUNCTION_SET_TOUCH_GESTURE_CALLBACK_CONFIGURATION = 13
BrickletLCD128x64.FUNCTION_DRAW_LINE = 16
BrickletLCD128x64.FUNCTION_DRAW_BOX = 17
BrickletLCD128x64.FUNCTION_DRAW_TEXT = 18
BrickletLCD128x64.FUNCTION_SET_GUI_BUTTON = 19
BrickletLCD128x64.FUNCTION_REMOVE_GUI_BUTTON = 21
BrickletLCD128x64.FUNCTION_SET_GUI_BUTTON_PRESSED_CALLBACK_CONFIGURATION = 22
BrickletLCD128x64.FUNCTION_SET_GUI_SLIDER = 26
BrickletLCD128x64.FUNCTION_REMOVE_GUI_SLIDER = 28
BrickletLCD128x64.FUNCTION_SET_GUI_SLIDER_VALUE_CALLBACK_CONFIGURATION = 29
BrickletLCD128x64.FUNCTION_SET_GUI_TAB_CONFIGURATION = 33
BrickletLCD128x64.FUNCTION_SET_GUI_TAB_TEXT = 35
BrickletLCD128x64.FUNCTION_SET_GUI_TAB_ICON = 37
BrickletLCD128x64.FUNCTION_REMOVE_GUI_TAB = 39
BrickletLCD128x64.FUNCTION_SET_GUI_TAB_SELECTED = 40
BrickletLCD128x64.FUNCTION_SET_GUI_TAB_SELECTED_CALLBACK_CONFIGURATION = 41
BrickletLCD128x64.FUNCTION_SET_GUI_GRAPH_CONFIGURATION = 45
BrickletLCD128x64.FUNCTION_SET_GUI_GRAPH_DATA = 47
BrickletLCD128x64.FUNCTION_REMOVE_GUI_GRAPH = 49
BrickletLCD128x64.FUNCTION_REMOVE_ALL_GUI = 50
BrickletLCD128x64.FUNCTION_SET_TOUCH_LED_CONFIG = 51
BrickletLCD128x64.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletLCD128x64.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletLCD128x64.FUNCTION_RESET = 243
BrickletLCD128x64.FUNCTION_WRITE_UID = 248

Sub BrickletLCD128x64.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)¶

Parameters:	functionId – Type: Byte, Range: See constants responseExpected – Type: Boolean

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

The following constants are available for this function:

For functionId:

BrickletLCD128x64.FUNCTION_WRITE_PIXELS = 1
BrickletLCD128x64.FUNCTION_CLEAR_DISPLAY = 3
BrickletLCD128x64.FUNCTION_SET_DISPLAY_CONFIGURATION = 4
BrickletLCD128x64.FUNCTION_WRITE_LINE = 6
BrickletLCD128x64.FUNCTION_DRAW_BUFFERED_FRAME = 7
BrickletLCD128x64.FUNCTION_SET_TOUCH_POSITION_CALLBACK_CONFIGURATION = 9
BrickletLCD128x64.FUNCTION_SET_TOUCH_GESTURE_CALLBACK_CONFIGURATION = 13
BrickletLCD128x64.FUNCTION_DRAW_LINE = 16
BrickletLCD128x64.FUNCTION_DRAW_BOX = 17
BrickletLCD128x64.FUNCTION_DRAW_TEXT = 18
BrickletLCD128x64.FUNCTION_SET_GUI_BUTTON = 19
BrickletLCD128x64.FUNCTION_REMOVE_GUI_BUTTON = 21
BrickletLCD128x64.FUNCTION_SET_GUI_BUTTON_PRESSED_CALLBACK_CONFIGURATION = 22
BrickletLCD128x64.FUNCTION_SET_GUI_SLIDER = 26
BrickletLCD128x64.FUNCTION_REMOVE_GUI_SLIDER = 28
BrickletLCD128x64.FUNCTION_SET_GUI_SLIDER_VALUE_CALLBACK_CONFIGURATION = 29
BrickletLCD128x64.FUNCTION_SET_GUI_TAB_CONFIGURATION = 33
BrickletLCD128x64.FUNCTION_SET_GUI_TAB_TEXT = 35
BrickletLCD128x64.FUNCTION_SET_GUI_TAB_ICON = 37
BrickletLCD128x64.FUNCTION_REMOVE_GUI_TAB = 39
BrickletLCD128x64.FUNCTION_SET_GUI_TAB_SELECTED = 40
BrickletLCD128x64.FUNCTION_SET_GUI_TAB_SELECTED_CALLBACK_CONFIGURATION = 41
BrickletLCD128x64.FUNCTION_SET_GUI_GRAPH_CONFIGURATION = 45
BrickletLCD128x64.FUNCTION_SET_GUI_GRAPH_DATA = 47
BrickletLCD128x64.FUNCTION_REMOVE_GUI_GRAPH = 49
BrickletLCD128x64.FUNCTION_REMOVE_ALL_GUI = 50
BrickletLCD128x64.FUNCTION_SET_TOUCH_LED_CONFIG = 51
BrickletLCD128x64.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletLCD128x64.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletLCD128x64.FUNCTION_RESET = 243
BrickletLCD128x64.FUNCTION_WRITE_UID = 248

Sub BrickletLCD128x64.SetResponseExpectedAll(ByVal responseExpected As Boolean)¶

Parameters:	responseExpected – Type: Boolean

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

Function BrickletLCD128x64.SetBootloaderMode(ByVal mode As Byte) As Byte¶

Parameters:	mode – Type: Byte, Range: See constants
Returns:	status – Type: Byte, Range: See constants

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For mode:

BrickletLCD128x64.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletLCD128x64.BOOTLOADER_MODE_FIRMWARE = 1
BrickletLCD128x64.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletLCD128x64.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletLCD128x64.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

BrickletLCD128x64.BOOTLOADER_STATUS_OK = 0
BrickletLCD128x64.BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletLCD128x64.BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletLCD128x64.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletLCD128x64.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletLCD128x64.BOOTLOADER_STATUS_CRC_MISMATCH = 5

Function BrickletLCD128x64.GetBootloaderMode() As Byte¶

Returns:	mode – Type: Byte, Range: See constants

Returns the current bootloader mode, see SetBootloaderMode().

The following constants are available for this function:

For mode:

BrickletLCD128x64.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletLCD128x64.BOOTLOADER_MODE_FIRMWARE = 1
BrickletLCD128x64.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletLCD128x64.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletLCD128x64.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Sub BrickletLCD128x64.SetWriteFirmwarePointer(ByVal pointer As Long)¶

Parameters:	pointer – Type: Long, Unit: 1 B, Range: [0 to 2³² - 1]

Sets the firmware pointer for WriteFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

Function BrickletLCD128x64.WriteFirmware(ByVal data() As Byte) As Byte¶

Parameters:	data – Type: Byte Array, Length: 64, Range: [0 to 255]
Returns:	status – Type: Byte, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

Sub BrickletLCD128x64.WriteUID(ByVal uid As Long)¶

Parameters:	uid – Type: Long, Range: [0 to 2³² - 1]

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

Function BrickletLCD128x64.ReadUID() As Long¶

Returns:	uid – Type: Long, Range: [0 to 2³² - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants¶

Const BrickletLCD128x64.DEVICE_IDENTIFIER¶

This constant is used to identify a LCD 128x64 Bricklet.

The GetIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

Const BrickletLCD128x64.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a LCD 128x64 Bricklet.