Go - LCD 128x64 Bricklet

This is the description of the Go 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 Go API bindings is part of their general description. Additional documentation can be found on godoc.org.

Examples

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

Hello World

Download (example_hello_world.go)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/lcd_128x64_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your LCD 128x64 Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    lcd, _ := lcd_128x64_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // 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")

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

Big Font

Download (example_big_font.go)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/lcd_128x64_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your LCD 128x64 Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    lcd, _ := lcd_128x64_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Clear display
    lcd.ClearDisplay()

    // Write "Hello World" with big 24x32 font
    lcd.DrawText(0, 0, lcd_128x64_bricklet.Font24x32, lcd_128x64_bricklet.ColorBlack,
        "24x32")

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

Touch

Download (example_touch.go)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/lcd_128x64_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your LCD 128x64 Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    lcd, _ := lcd_128x64_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    lcd.RegisterTouchPositionCallback(func(pressure uint16, x uint16, y uint16, age uint32) {
        fmt.Printf("Pressure: %d\n", pressure)
        fmt.Printf("X: %d\n", x)
        fmt.Printf("Y: %d\n", y)
        fmt.Printf("Age: %d\n", age)
        fmt.Println()
    })

    lcd.RegisterTouchGestureCallback(func(gesture lcd_128x64_bricklet.Gesture, duration uint32, pressureMax uint16, xStart uint16, xEnd uint16, yStart uint16, yEnd uint16, age uint32) {

        if gesture == lcd_128x64_bricklet.GestureLeftToRight {
            fmt.Println("Gesture: Left To Right")
        } else if gesture == lcd_128x64_bricklet.GestureRightToLeft {
            fmt.Println("Gesture: Right To Left")
        } else if gesture == lcd_128x64_bricklet.GestureTopToBottom {
            fmt.Println("Gesture: Top To Bottom")
        } else if gesture == lcd_128x64_bricklet.GestureBottomToTop {
            fmt.Println("Gesture: Bottom To Top")
        }

        fmt.Printf("Duration: %d\n", duration)
        fmt.Printf("Pressure Max: %d\n", pressureMax)
        fmt.Printf("X Start: %d\n", xStart)
        fmt.Printf("X End: %d\n", xEnd)
        fmt.Printf("Y Start: %d\n", yStart)
        fmt.Printf("Y End: %d\n", yEnd)
        fmt.Printf("Age: %d\n", age)
        fmt.Println()
    })

    // 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)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

Gui

Download (example_gui.go)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/lcd_128x64_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your LCD 128x64 Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    lcd, _ := lcd_128x64_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    lcd.RegisterGUIButtonPressedCallback(func(index uint8, pressed bool) {
        fmt.Printf("Index: %d\n", index)
        fmt.Printf("Pressed: %s\n", pressed)
        fmt.Println()
    })

    lcd.RegisterGUISliderValueCallback(func(index uint8, value uint8) {
        fmt.Printf("Index: %d\n", index)
        fmt.Printf("Value: %d\n", value)
        fmt.Println()
    })

    lcd.RegisterGUITabSelectedCallback(func(index int8) {
        fmt.Printf("Index: %d\n", index)
    })

    // 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, lcd_128x64_bricklet.DirectionHorizontal, 50)
    lcd.SetGUIGraphConfiguration(0, lcd_128x64_bricklet.GraphTypeLine, 62, 0, 60, 52,
        "X", "Y")

    // Add a few data points (the remaining points will be 0)
    lcd.SetGUIGraphData(0,
        []uint8{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(lcd_128x64_bricklet.ChangeTabOnClickAndSwipe, 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)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

API

The LCD 128x64 Bricklet API is defined in the package github.com/Tinkerforge/go-api-bindings/lcd_128x64_bricklet

Nearly every function of the Go bindings can return an BrickletError, implementing the error interface. The error can have one of the following values:

  • BrickletErrorSuccess = 0
  • BrickletErrorInvalidParameter = 1
  • BrickletErrorFunctionNotSupported = 2
  • BrickletErrorUnknownError = 3

which correspond to the values returned from Bricks and Bricklets.

All functions listed below are thread-safe.

Basic Functions

func NewLCD128x64Bricklet(uid string, ipcon *IPConnection)(device LCD128x64Bricklet, err error)

Creates a new LCD128x64Bricklet object with the unique device ID uid and adds it to the IPConnection ipcon:

This device object can be used after the IPConnection has been connected (see examples above).

func (*LCD128x64Bricklet)WritePixels(xStart uint8, yStart uint8, xEnd uint8, yEnd uint8, pixels []bool)(err error)

Writes pixels to the specified window.

The x-axis goes from 0 to 127 and the y-axis from 0 to 63. 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 (*LCD128x64Bricklet) 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 (*LCD128x64Bricklet) SetDisplayConfiguration function.

func (*LCD128x64Bricklet)ReadPixels(xStart uint8, yStart uint8, xEnd uint8, yEnd uint8)(pixels []bool, err error)

Reads pixels from the specified window.

The x-axis goes from 0 to 127 and the y-axis from 0 to 63. 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 (*LCD128x64Bricklet) DrawBufferedFrame).

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

func (*LCD128x64Bricklet)ClearDisplay()(err error)

Clears the complete content of the display.

func (*LCD128x64Bricklet)WriteLine(line uint8, position uint8, text string)(err error)

Writes text to a specific line (0 to 7) with a specific position (0 to 21). The text can have a maximum of 22 characters.

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.

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 (*LCD128x64Bricklet) DrawText function.

func (*LCD128x64Bricklet)DrawBufferedFrame(forceCompleteRedraw bool)(err error)

Draws the currently buffered frame. Normally each call of (*LCD128x64Bricklet) WritePixels and (*LCD128x64Bricklet) WriteLine draws directly onto the display. If you turn automatic draw off ((*LCD128x64Bricklet) 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.

func (*LCD128x64Bricklet)GetTouchPosition()(pressure uint16, x uint16, y uint16, age uint32, err error)

Returns the last valid touch position:

  • Pressure: Amount of pressure applied by the user (0-300)
  • X: Touch position on x-axis (0-127)
  • Y: Touch position on y-axis (0-63)
  • Age: Age of touch press in ms (how long ago it was)
func (*LCD128x64Bricklet)GetTouchGesture()(gesture Gesture, duration uint32, pressureMax uint16, xStart uint16, yStart uint16, xEnd uint16, yEnd uint16, age uint32, err error)

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 in ms (how long ago it was).

The following constants are available for this function:

  • GestureLeftToRight = 0
  • GestureRightToLeft = 1
  • GestureTopToBottom = 2
  • GestureBottomToTop = 3
func (*LCD128x64Bricklet)DrawLine(positionXStart uint8, positionYStart uint8, positionXEnd uint8, positionYEnd uint8, color Color)(err error)

Draws a white or black line from (x, y)-start to (x, y)-end. The x values have to be within the range of 0 to 127 and the y values have t be within the range of 0 to 63.

The following constants are available for this function:

  • ColorWhite = False
  • ColorBlack = True

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)DrawBox(positionXStart uint8, positionYStart uint8, positionXEnd uint8, positionYEnd uint8, fill bool, color Color)(err error)

Draws a white or black box from (x, y)-start to (x, y)-end. The x values have to be within the range of 0 to 127 and the y values have to be within the range of 0 to 63.

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:

  • ColorWhite = False
  • ColorBlack = True

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)DrawText(positionX uint8, positionY uint8, font Font, color Color, text string)(err error)

Draws a text with up to 22 characters at the pixel position (x, y).

The x values have to be within the range of 0 to 127 and the y values have to be within the range of 0 to 63.

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

The following constants are available for this function:

  • Font6x8 = 0
  • Font6x16 = 1
  • Font6x24 = 2
  • Font6x32 = 3
  • Font12x16 = 4
  • Font12x24 = 5
  • Font12x32 = 6
  • Font18x24 = 7
  • Font18x32 = 8
  • Font24x32 = 9
  • ColorWhite = False
  • ColorBlack = True

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)SetGUIButton(index uint8, positionX uint8, positionY uint8, width uint8, height uint8, text string)(err error)

Draws a clickable button at position (x, y) with the given text of up to 16 characters.

You can use up to 12 buttons (index 0-11).

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 (*LCD128x64Bricklet) 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 (*LCD128x64Bricklet) WritePixels. To remove the button use (*LCD128x64Bricklet) RemoveGUIButton.

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

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)GetGUIButton(index uint8)(active bool, positionX uint8, positionY uint8, width uint8, height uint8, text string, err error)

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

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

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)RemoveGUIButton(index uint8)(err error)

Removes the button with the given index.

You can use index 255 to remove all buttons.

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)GetGUIButtonPressed(index uint8)(pressed bool, err error)

Returns the state of the button for the given index.

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

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)SetGUISlider(index uint8, positionX uint8, positionY uint8, length uint8, direction Direction, value uint8)(err error)

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

You can use up to 6 sliders (index 0-5).

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 (*LCD128x64Bricklet) SetGUISliderValueCallbackConfiguration.

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

The following constants are available for this function:

  • DirectionHorizontal = 0
  • DirectionVertical = 1

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)GetGUISlider(index uint8)(active bool, positionX uint8, positionY uint8, length uint8, direction Direction, value uint8, err error)

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

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

The following constants are available for this function:

  • DirectionHorizontal = 0
  • DirectionVertical = 1

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)RemoveGUISlider(index uint8)(err error)

Removes the slider with the given index.

You can use index 255 to remove all slider.

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)GetGUISliderValue(index uint8)(value uint8, err error)

Returns the current slider value for the given index.

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)SetGUITabConfiguration(changeTabConfig ChangeTabOn, clearGUI bool)(err error)

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.

By default click and swipe as well as automatic GUI clear is enabled.

The following constants are available for this function:

  • ChangeTabOnClick = 1
  • ChangeTabOnSwipe = 2
  • ChangeTabOnClickAndSwipe = 3

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)GetGUITabConfiguration()(changeTabConfig ChangeTabOn, clearGUI bool, err error)

Returns the tab configuration as set by (*LCD128x64Bricklet) SetGUITabConfiguration.

The following constants are available for this function:

  • ChangeTabOnClick = 1
  • ChangeTabOnSwipe = 2
  • ChangeTabOnClickAndSwipe = 3

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)SetGUITabText(index uint8, text string)(err error)

Adds a text-tab with the given index. The text can have a length of up to 5 characters.

You can use up to 10 tabs (index 0-9).

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

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)GetGUITabText(index uint8)(active bool, text string, err error)

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

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

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)SetGUITabIcon(index uint8, icon [168]bool)(err error)

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 (index 0-9).

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

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)GetGUITabIcon(index uint8)(active bool, icon [168]bool, err error)

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

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

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)RemoveGUITab(index uint8)(err error)

Removes the tab with the given index.

You can use index 255 to remove all tabs.

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)SetGUITabSelected(index uint8)(err error)

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

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)GetGUITabSelected()(index int8, err error)

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

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)SetGUIGraphConfiguration(index uint8, graphType GraphType, positionX uint8, positionY uint8, width uint8, height uint8, textX string, textY string)(err error)

Sets the configuration for up to four graphs (index 0-3).

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

The x and y position are pixel positions. They have to be within the range of (0, 0) to (127, 63). The maximum width is 118 and the maximum height is 63.

You can add a text for the x and y axis with at most 4 characters each. 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 (*LCD128x64Bricklet) DrawText to draw the caption outside of the graph.

The data of the graph can be set and updated with (*LCD128x64Bricklet) 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 (*LCD128x64Bricklet) WritePixels. To remove the graph use (*LCD128x64Bricklet) RemoveGUIGraph.

The following constants are available for this function:

  • GraphTypeDot = 0
  • GraphTypeLine = 1
  • GraphTypeBar = 2

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)GetGUIGraphConfiguration(index uint8)(active bool, graphType GraphType, positionX uint8, positionY uint8, width uint8, height uint8, textX string, textY string, err error)

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

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

The following constants are available for this function:

  • GraphTypeDot = 0
  • GraphTypeLine = 1
  • GraphTypeBar = 2

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)SetGUIGraphData(index uint8, data []uint8)(err error)

Sets the data for a graph with the given index. You have to configure the graph with (*LCD128x64Bricklet) 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 (*LCD128x64Bricklet) 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.

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)GetGUIGraphData(index uint8)(data []uint8, err error)

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

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)RemoveGUIGraph(index uint8)(err error)

Removes the graph with the given index.

You can use index 255 to remove all graphs.

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)RemoveAllGUI()(err error)

Removes all GUI elements (buttons, slider, graphs, tabs).

New in version 2.0.2 (Plugin).

Advanced Functions

func (*LCD128x64Bricklet)SetDisplayConfiguration(contrast uint8, backlight uint8, invert bool, automaticDraw bool)(err error)

Sets the configuration of the display.

You can set a contrast value from 0 to 63, a backlight intensity value from 0 to 100 and you can invert the color (white/black) of the display.

If automatic draw is set to true, the display is automatically updated with every call of (*LCD128x64Bricklet) WritePixels and (*LCD128x64Bricklet) 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 (*LCD128x64Bricklet) DrawBufferedFrame.

The default values are contrast 14, backlight intensity 100, inverting off and automatic draw on.

func (*LCD128x64Bricklet)GetDisplayConfiguration()(contrast uint8, backlight uint8, invert bool, automaticDraw bool, err error)

Returns the configuration as set by (*LCD128x64Bricklet) SetDisplayConfiguration.

func (*LCD128x64Bricklet)SetTouchLEDConfig(config TouchLEDConfig)(err error)

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:

  • TouchLEDConfigOff = 0
  • TouchLEDConfigOn = 1
  • TouchLEDConfigShowHeartbeat = 2
  • TouchLEDConfigShowTouch = 3

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)GetTouchLEDConfig()(config TouchLEDConfig, err error)

Returns the configuration as set by (*LCD128x64Bricklet) SetTouchLEDConfig

The following constants are available for this function:

  • TouchLEDConfigOff = 0
  • TouchLEDConfigOn = 1
  • TouchLEDConfigShowHeartbeat = 2
  • TouchLEDConfigShowTouch = 3

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)GetAPIVersion()(apiVersion [3]uint8, err error)

Returns the version of the API definition (major, minor, revision) 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.

func (*LCD128x64Bricklet)GetResponseExpected(functionId uint8)(responseExpected bool, err error)

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 (*LCD128x64Bricklet) 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 send and errors are silently ignored, because they cannot be detected.

See (*LCD128x64Bricklet) SetResponseExpected for the list of function ID constants available for this function.

func (*LCD128x64Bricklet)SetResponseExpected(functionId uint8, responseExpected bool)(err error)

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.

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 send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • FunctionWritePixels = 1
  • FunctionClearDisplay = 3
  • FunctionSetDisplayConfiguration = 4
  • FunctionWriteLine = 6
  • FunctionDrawBufferedFrame = 7
  • FunctionSetTouchPositionCallbackConfiguration = 9
  • FunctionSetTouchGestureCallbackConfiguration = 13
  • FunctionDrawLine = 16
  • FunctionDrawBox = 17
  • FunctionDrawText = 18
  • FunctionSetGUIButton = 19
  • FunctionRemoveGUIButton = 21
  • FunctionSetGUIButtonPressedCallbackConfiguration = 22
  • FunctionSetGUISlider = 26
  • FunctionRemoveGUISlider = 28
  • FunctionSetGUISliderValueCallbackConfiguration = 29
  • FunctionSetGUITabConfiguration = 33
  • FunctionSetGUITabText = 35
  • FunctionSetGUITabIcon = 37
  • FunctionRemoveGUITab = 39
  • FunctionSetGUITabSelected = 40
  • FunctionSetGUITabSelectedCallbackConfiguration = 41
  • FunctionSetGUIGraphConfiguration = 45
  • FunctionSetGUIGraphData = 47
  • FunctionRemoveGUIGraph = 49
  • FunctionRemoveAllGUI = 50
  • FunctionSetTouchLEDConfig = 51
  • FunctionSetWriteFirmwarePointer = 237
  • FunctionSetStatusLEDConfig = 239
  • FunctionReset = 243
  • FunctionWriteUID = 248
func (*LCD128x64Bricklet)SetResponseExpectedAll(responseExpected bool)(err error)

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

func (*LCD128x64Bricklet)GetSPITFPErrorCount()(errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)

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.

func (*LCD128x64Bricklet)SetBootloaderMode(mode BootloaderMode)(status BootloaderStatus, err error)

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:

  • BootloaderModeBootloader = 0
  • BootloaderModeFirmware = 1
  • BootloaderModeBootloaderWaitForReboot = 2
  • BootloaderModeFirmwareWaitForReboot = 3
  • BootloaderModeFirmwareWaitForEraseAndReboot = 4
  • BootloaderStatusOK = 0
  • BootloaderStatusInvalidMode = 1
  • BootloaderStatusNoChange = 2
  • BootloaderStatusEntryFunctionNotPresent = 3
  • BootloaderStatusDeviceIdentifierIncorrect = 4
  • BootloaderStatusCRCMismatch = 5
func (*LCD128x64Bricklet)GetBootloaderMode()(mode BootloaderMode, err error)

Returns the current bootloader mode, see (*LCD128x64Bricklet) SetBootloaderMode.

The following constants are available for this function:

  • BootloaderModeBootloader = 0
  • BootloaderModeFirmware = 1
  • BootloaderModeBootloaderWaitForReboot = 2
  • BootloaderModeFirmwareWaitForReboot = 3
  • BootloaderModeFirmwareWaitForEraseAndReboot = 4
func (*LCD128x64Bricklet)SetWriteFirmwarePointer(pointer uint32)(err error)

Sets the firmware pointer for (*LCD128x64Bricklet) 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.

func (*LCD128x64Bricklet)WriteFirmware(data [64]uint8)(status uint8, err error)

Writes 64 Bytes of firmware at the position as written by (*LCD128x64Bricklet) 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.

func (*LCD128x64Bricklet)SetStatusLEDConfig(config StatusLEDConfig)(err error)

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:

  • StatusLEDConfigOff = 0
  • StatusLEDConfigOn = 1
  • StatusLEDConfigShowHeartbeat = 2
  • StatusLEDConfigShowStatus = 3
func (*LCD128x64Bricklet)GetStatusLEDConfig()(config StatusLEDConfig, err error)

Returns the configuration as set by (*LCD128x64Bricklet) SetStatusLEDConfig

The following constants are available for this function:

  • StatusLEDConfigOff = 0
  • StatusLEDConfigOn = 1
  • StatusLEDConfigShowHeartbeat = 2
  • StatusLEDConfigShowStatus = 3
func (*LCD128x64Bricklet)GetChipTemperature()(temperature int16, err error)

Returns the temperature in °C 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.

func (*LCD128x64Bricklet)Reset()(err error)

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!

func (*LCD128x64Bricklet)WriteUID(uid uint32)(err error)

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.

func (*LCD128x64Bricklet)ReadUID()(uid uint32, err error)

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

func (*LCD128x64Bricklet)GetIdentity()(uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)

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' or 'd'.

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

Callback Configuration Functions

func (*LCD128x64Bricklet)SetTouchPositionCallbackConfiguration(period uint32, valueHasToChange bool)(err error)

The period in ms is the period with which the (*LCD128x64Bricklet) RegisterTouchPositionCallback 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.

The default value is (0, false).

func (*LCD128x64Bricklet)GetTouchPositionCallbackConfiguration()(period uint32, valueHasToChange bool, err error)

Returns the callback configuration as set by (*LCD128x64Bricklet) SetTouchPositionCallbackConfiguration.

func (*LCD128x64Bricklet)SetTouchGestureCallbackConfiguration(period uint32, valueHasToChange bool)(err error)

The period in ms is the period with which the (*LCD128x64Bricklet) RegisterTouchGestureCallback 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.

The default value is (0, false).

func (*LCD128x64Bricklet)GetTouchGestureCallbackConfiguration()(period uint32, valueHasToChange bool, err error)

Returns the callback configuration as set by (*LCD128x64Bricklet) SetTouchGestureCallbackConfiguration.

func (*LCD128x64Bricklet)SetGUIButtonPressedCallbackConfiguration(period uint32, valueHasToChange bool)(err error)

The period in ms is the period with which the (*LCD128x64Bricklet) RegisterGUIButtonPressedCallback 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.

The default value is (0, false).

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)GetGUIButtonPressedCallbackConfiguration()(period uint32, valueHasToChange bool, err error)

Returns the callback configuration as set by (*LCD128x64Bricklet) SetGUIButtonPressedCallbackConfiguration.

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)SetGUISliderValueCallbackConfiguration(period uint32, valueHasToChange bool)(err error)

The period in ms is the period with which the (*LCD128x64Bricklet) RegisterGUISliderValueCallback 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.

The default value is (0, false).

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)GetGUISliderValueCallbackConfiguration()(period uint32, valueHasToChange bool, err error)

Returns the callback configuration as set by (*LCD128x64Bricklet) SetGUISliderValueCallbackConfiguration.

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)SetGUITabSelectedCallbackConfiguration(period uint32, valueHasToChange bool)(err error)

The period in ms is the period with which the (*LCD128x64Bricklet) RegisterGUITabSelectedCallback 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.

The default value is (0, false).

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)GetGUITabSelectedCallbackConfiguration()(period uint32, valueHasToChange bool, err error)

Returns the callback configuration as set by (*LCD128x64Bricklet) SetGUITabSelectedCallbackConfiguration.

New in version 2.0.2 (Plugin).

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding Register*Callback function, which returns a unique callback ID. This ID can be used to deregister the callback later.

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.

func (*LCD128x64Bricklet)RegisterTouchPositionCallback(func(pressure uint16, x uint16, y uint16, age uint32))(registrationID uint64)

A callback can be registered for this event with the RegisterTouchPositionCallback() function. This function returns the ID of the registered callback. An added callback can be removed with the DeregisterTouchPositionCallback(registrationID uint64) function.

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

func (*LCD128x64Bricklet)RegisterTouchGestureCallback(func(gesture Gesture, duration uint32, pressureMax uint16, xStart uint16, yStart uint16, xEnd uint16, yEnd uint16, age uint32))(registrationID uint64)

A callback can be registered for this event with the RegisterTouchGestureCallback() function. This function returns the ID of the registered callback. An added callback can be removed with the DeregisterTouchGestureCallback(registrationID uint64) function.

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

The following constants are available for this function:

  • GestureLeftToRight = 0
  • GestureRightToLeft = 1
  • GestureTopToBottom = 2
  • GestureBottomToTop = 3
func (*LCD128x64Bricklet)RegisterGUIButtonPressedCallback(func(index uint8, pressed bool))(registrationID uint64)

A callback can be registered for this event with the RegisterGUIButtonPressedCallback() function. This function returns the ID of the registered callback. An added callback can be removed with the DeregisterGUIButtonPressedCallback(registrationID uint64) function.

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

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)RegisterGUISliderValueCallback(func(index uint8, value uint8))(registrationID uint64)

A callback can be registered for this event with the RegisterGUISliderValueCallback() function. This function returns the ID of the registered callback. An added callback can be removed with the DeregisterGUISliderValueCallback(registrationID uint64) function.

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

New in version 2.0.2 (Plugin).

func (*LCD128x64Bricklet)RegisterGUITabSelectedCallback(func(index int8))(registrationID uint64)

A callback can be registered for this event with the RegisterGUITabSelectedCallback() function. This function returns the ID of the registered callback. An added callback can be removed with the DeregisterGUITabSelectedCallback(registrationID uint64) function.

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

New in version 2.0.2 (Plugin).

Constants

lcd_128x64_bricklet.DeviceIdentifier

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

The (*LCD128x64Bricklet) GetIdentity function and the (*IPConnection) RegisterEnumerateCallback callback of the IPConnection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

lcd_128x64_bricklet.DeviceDisplayName

This constant represents the human readable name of a LCD 128x64 Bricklet.