Software / API Bindings / Go / API Referenz und Beispiele / Bricklets / LCD 128x64 Bricklet

Go - LCD 128x64 Bricklet¶

Dies ist die Beschreibung der Go API Bindings für das LCD 128x64 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des LCD 128x64 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Go API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf godoc.org.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Hello World¶

Download (example_hello_world.go)

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)

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)

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)

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¶

Die API des LCD 128x64 Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/lcd_128x64_bricklet definiert.

Fast alle Funktionen der Go Bindings können einen ipconnection.DeviceError, der das error-Interface implementiert, zurückgeben. Dieser kann folgende Werte annehmen:

ipconnection.DeviceErrorSuccess = 0
ipconnection.DeviceErrorInvalidParameter = 1
ipconnection.DeviceErrorFunctionNotSupported = 2
ipconnection.DeviceErrorUnknownError = 3

welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

func lcd_128x64_bricklet.New(uid string, ipcon *IPConnection) (device LCD128x64Bricklet, err error)¶

Parameter:	uid – Typ: string ipcon – Typ: *IPConnection
Rückgabe:	device – Typ: LCD128x64Bricklet err – Typ: error

Erzeugt ein neues LCD128x64Bricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IPConnection ipcon hinzu:

device, err := lcd_128x64_bricklet.New("YOUR_DEVICE_UID", &ipcon)

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.

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

Parameter:	xStart – Typ: uint8, Wertebereich: [0 bis 127] yStart – Typ: uint8, Wertebereich: [0 bis 63] xEnd – Typ: uint8, Wertebereich: [0 bis 127] yEnd – Typ: uint8, Wertebereich: [0 bis 63] pixels – Typ: []bool, Länge: variabel
Rückgabe:	err – Typ: error

Schreibt Pixel in das angegebene Fenster.

Die Pixel werden zeilenweise von oben nach unten geschrieben und die Zeilen werden jeweils von links nach rechts geschrieben.

Wenn Automatic Draw aktiviert ist (Standard), dann werden die Pixel direkt auf den Display geschrieben. Nur Pixel die sich wirklich verändert haben werden auf dem Display aktualisiert.

Wenn Automatic Draw deaktiviert ist, dann werden die Pixel in einen internen Buffer geschrieben der dann durch einen Aufruf von DrawBufferedFrame() auf dem Display angezeigt werden kann. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Automatic Draw kann über die SetDisplayConfiguration() Funktion eingestellt werden.

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

Parameter:	xStart – Typ: uint8, Wertebereich: [0 bis 127] yStart – Typ: uint8, Wertebereich: [0 bis 63] xEnd – Typ: uint8, Wertebereich: [0 bis 127] yEnd – Typ: uint8, Wertebereich: [0 bis 63]
Rückgabe:	pixels – Typ: []bool, Länge: variabel err – Typ: error

Liest Pixel aus dem angegebenen Fenster.

Die Pixel werden zeilenweise von oben nach unten und die Zeilen werden jeweils von links nach rechts gelesen.

Wenn Automatic Draw aktiviert ist (Standard), dann werden die Pixel direkt vom Display gelesen.

Wenn Automatic Draw deaktiviert ist, dann werden die Pixel aus einen internen Buffer gelesen (siehe DrawBufferedFrame()).

Automatic Draw kann über die SetDisplayConfiguration() Funktion eingestellt werden.

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

Rückgabe:	err – Typ: error

Löscht den kompletten aktuellen Inhalt des Displays.

Wenn Automatic Draw aktiviert ist (Standard), dann werden die Pixel direkt gelöscht.

Wenn Automatic Draw deaktiviert ist, dann werden die Pixel im internen Buffer gelöscht der dann durch einen Aufruf von DrawBufferedFrame() auf dem Display angezeigt werden kann. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Automatic Draw kann über die SetDisplayConfiguration() Funktion eingestellt werden.

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

Parameter:	line – Typ: uint8, Wertebereich: [0 bis 7] position – Typ: uint8, Wertebereich: [0 bis 21] text – Typ: string, Länge: bis zu 22
Rückgabe:	err – Typ: error

Schreibt einen Text in die angegebene Zeile mit einer vorgegebenen Position.

Beispiel: (1, 10, "Hallo") schreibt Hallo in die Mitte der zweiten Zeile des Displays.

Das Display nutzt einen speziellen 5x7 Pixel Zeichensatz. Der Zeichensatz kann mit Hilfe von Brick Viewer angezeigt werden.

Wenn Automatic Draw aktiviert ist (Standard), dann wird der Text direkt auf den Display geschrieben. Nur Pixel die sich wirklich verändert haben werden auf dem Display aktualisiert.

Wenn Automatic Draw deaktiviert ist, dann wird der Text in einen internen Buffer geschrieben der dann durch einen Aufruf von DrawBufferedFrame() auf dem Display angezeigt werden kann. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Automatic Draw kann über die SetDisplayConfiguration() Funktion eingestellt werden.

Diese Funktion ist ein 1:1-Ersatz für die Funktion mit dem gleichen Namen im LCD 20x4 Bricklet. Mit der Funktion DrawText() kann Text Pixelgenau und mit unterschiedlichen Font-Größen gezeichnet werden.

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

Parameter:	forceCompleteRedraw – Typ: bool
Rückgabe:	err – Typ: error

Stellt den aktuell Inhalt des internen Buffers auf dem Display dar. Normalerweise schreibt jeder Aufruf von WritePixels() und WriteLine() direkt auf den Display. Wenn jedoch Automatic Draw deaktiviert ist (SetDisplayConfiguration()), dann werden Änderungen in einen internen Buffer anstatt auf den Display geschrieben. Der internen Buffer kann dann durch einen Aufruf dieser Funktion auf den Display geschrieben werden. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Wenn Force Complete Redraw auf true gesetzt ist, dann wird der gesamte Display aktualisiert, anstatt nur die Pixel die sich wirklich verändert haben. Normalerweise sollte dies nicht notwendig sein, außer bei hängenden Pixeln bedingt durch Fehler.

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

Rückgabe:	pressure – Typ: uint16, Wertebereich: [0 bis 300] x – Typ: uint16, Wertebereich: [0 bis 127] y – Typ: uint16, Wertebereich: [0 bis 63] age – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1] err – Typ: error

Gibt die letzte gültige Touch-Position zurück:

Pressure: Anpressdruck des Touches
X: Touch-Position auf der X-Achse
Y: Touch-Position auf der Y-Achse
Age: Alter des Touches (wie lange ist die Erkennung des Touches her)

func (*LCD128x64Bricklet) GetTouchGesture() (gesture uint8, duration uint32, pressureMax uint16, xStart uint16, yStart uint16, xEnd uint16, yEnd uint16, age uint32, err error)¶

Rückgabe:

Rückgabe:	gesture – Typ: uint8, Wertebereich: Siehe Konstanten duration – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1] pressureMax – Typ: uint16, Wertebereich: [0 bis 300] xStart – Typ: uint16, Wertebereich: [0 bis 127] yStart – Typ: uint16, Wertebereich: [0 bis 63] xEnd – Typ: uint16, Wertebereich: [0 bis 127] yEnd – Typ: uint16, Wertebereich: [0 bis 63] age – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1] err – Typ: error

gesture – Typ: uint8, Wertebereich: Siehe Konstanten
duration – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1]
pressureMax – Typ: uint16, Wertebereich: [0 bis 300]
xStart – Typ: uint16, Wertebereich: [0 bis 127]
yStart – Typ: uint16, Wertebereich: [0 bis 63]
xEnd – Typ: uint16, Wertebereich: [0 bis 127]
yEnd – Typ: uint16, Wertebereich: [0 bis 63]
age – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1]
err – Typ: error

Gibt eine der vier Touch-Gesten zurück, die das Bricklet automatisch erkennen kann.

Die Gesten umfassen Wischen von links nach rechts, rechts nach links, oben nach unten und unten nach oben.

Zusätzlich zu Geste wird der Vektor von Start- nach Endposition des Wischens angegeben. Dieser kann genutzt werden um die genaue Position der Geste zu ermitteln (z.B. ob ein Wischen von oben nach unten auf der linken oder rechten des Bildschirms erkannt wurde).

Der Age Parameter gibt das Alter der Geste an (wie lange ist die Erkennung der Geste her).

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für gesture:

lcd_128x64_bricklet.GestureLeftToRight = 0
lcd_128x64_bricklet.GestureRightToLeft = 1
lcd_128x64_bricklet.GestureTopToBottom = 2
lcd_128x64_bricklet.GestureBottomToTop = 3

func (*LCD128x64Bricklet) DrawLine(positionXStart uint8, positionYStart uint8, positionXEnd uint8, positionYEnd uint8, color bool) (err error)¶

Parameter:	positionXStart – Typ: uint8, Wertebereich: [0 bis 127] positionYStart – Typ: uint8, Wertebereich: [0 bis 63] positionXEnd – Typ: uint8, Wertebereich: [0 bis 127] positionYEnd – Typ: uint8, Wertebereich: [0 bis 63] color – Typ: bool
Rückgabe:	err – Typ: error

Zeichnet eine weiße oder schwarze Linie von (x, y)-start nach (x, y)-end.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für color:

lcd_128x64_bricklet.ColorWhite = false
lcd_128x64_bricklet.ColorBlack = true

Neu in Version 2.0.2 (Plugin).

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

Parameter:	positionXStart – Typ: uint8, Wertebereich: [0 bis 127] positionYStart – Typ: uint8, Wertebereich: [0 bis 63] positionXEnd – Typ: uint8, Wertebereich: [0 bis 127] positionYEnd – Typ: uint8, Wertebereich: [0 bis 63] fill – Typ: bool color – Typ: bool
Rückgabe:	err – Typ: error

Zeichnet ein weißes oder schwarzes Rechteck von (x, y)-start nach (x, y)-end.

Wenn fill auf true gesetzt wird, wird das Rechteck mit der angegebenen Farbe ausgefüllt. Ansonsten wird nur der Umriss gezeichnet.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für color:

lcd_128x64_bricklet.ColorWhite = false
lcd_128x64_bricklet.ColorBlack = true

Neu in Version 2.0.2 (Plugin).

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

Parameter:	positionX – Typ: uint8, Wertebereich: [0 bis 127] positionY – Typ: uint8, Wertebereich: [0 bis 63] font – Typ: uint8, Wertebereich: Siehe Konstanten color – Typ: bool text – Typ: string, Länge: bis zu 22
Rückgabe:	err – Typ: error

Zeichnet einen Text an die Pixelposition (x, y).

Es können 9 unterschiedliche Font-Größen genutzt werden und der Text kann in weiß oder schwarz gezeichnet werden.

Der der Zeichensatz entspricht Codepage 437.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für font:

lcd_128x64_bricklet.Font6x8 = 0
lcd_128x64_bricklet.Font6x16 = 1
lcd_128x64_bricklet.Font6x24 = 2
lcd_128x64_bricklet.Font6x32 = 3
lcd_128x64_bricklet.Font12x16 = 4
lcd_128x64_bricklet.Font12x24 = 5
lcd_128x64_bricklet.Font12x32 = 6
lcd_128x64_bricklet.Font18x24 = 7
lcd_128x64_bricklet.Font18x32 = 8
lcd_128x64_bricklet.Font24x32 = 9

Für color:

lcd_128x64_bricklet.ColorWhite = false
lcd_128x64_bricklet.ColorBlack = true

Neu in Version 2.0.2 (Plugin).

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

Parameter:	index – Typ: uint8, Wertebereich: [0 bis 11] positionX – Typ: uint8, Wertebereich: [0 bis 127] positionY – Typ: uint8, Wertebereich: [0 bis 63] width – Typ: uint8, Wertebereich: [1 bis 128] height – Typ: uint8, Wertebereich: [1 bis 64] text – Typ: string, Länge: bis zu 16
Rückgabe:	err – Typ: error

Zeichnet einen klickbaren Button an Position (x, y) mit dem gegebenem Text.

Es können bis zu 12 Buttons genutzt werden.

Die x-Position + Width muss im Wertebereich von 1 bis 128 liegen und die y-Position+Height muss im Wertebereich von 1 bis 64 liegen.

Die minimale nützliche Breite/Höhe eines Buttons ist 3.

Der Callback für Button-Events kann mit der Funktion SetGUIButtonPressedCallbackConfiguration() eingestellt werden. Der Callback wird sowohl für gedrückt als auch losgelassen Events ausgelöst.

Der Button wird in einem separaten GUI-Buffer gezeichnet und der Rahmen des Buttons wird immer über den Grafiken bleiben die mit WritePixels() gezeichnet werden. Um einen Button zu entfernen kann die Funktion RemoveGUIButton() genutzt werden.

Wenn anstatt des Textes ein Icon verwendet werden soll, kann dieses innerhalb des Buttons mit per WritePixels() gezeichnet werden.

Neu 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)¶

Parameter:	index – Typ: uint8, Wertebereich: [0 bis 11]
Rückgabe:	active – Typ: bool positionX – Typ: uint8, Wertebereich: [0 bis 127] positionY – Typ: uint8, Wertebereich: [0 bis 63] width – Typ: uint8, Wertebereich: [1 bis 128] height – Typ: uint8, Wertebereich: [1 bis 64] text – Typ: string, Länge: bis zu 16 err – Typ: error

Gibt die Button-Eigenschaften für den gegebenen Index zurück, wie von SetGUIButton() gesetzt.

Zusätzlich gibt der Active-Parameter an ob der Button aktuell aktiv/sichtbar ist oder nicht.

Neu in Version 2.0.2 (Plugin).

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

Parameter:	index – Typ: uint8, Wertebereich: [0 bis 11, 255]
Rückgabe:	err – Typ: error

Entfernt den Button mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Buttons zu entfernen.

Neu in Version 2.0.2 (Plugin).

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

Parameter:	index – Typ: uint8, Wertebereich: [0 bis 11]
Rückgabe:	pressed – Typ: bool err – Typ: error

Gibt den aktuellen Button-Zustand für einen gegebenen Index zurück.

Der Zustand kann entweder gedrückt (true) oder losgelassen (false) sein.

Neu in Version 2.0.2 (Plugin).

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

Parameter:	index – Typ: uint8, Wertebereich: [0 bis 5] positionX – Typ: uint8, Wertebereich: [0 bis 128] positionY – Typ: uint8, Wertebereich: [0 bis 64] length – Typ: uint8, Wertebereich: [8 bis 128] direction – Typ: uint8, Wertebereich: Siehe Konstanten value – Typ: uint8, Wertebereich: [0 bis 120]
Rückgabe:	err – Typ: error

Zeichnet einen Slider an Position (x, y) mit der gegebenen Länge.

Es können bis zu 6 Slider genutzt werden.

Wenn eine horizontale Richtung verwendet wird muss Die x-Position + Länge im Wertebereich von 1 bis 128 und die y-Position im Wertebereich von 0 bis 46 liegen.

Wenn eine vertikale Richtung verwendet wird muss Die y-Position + Länge im Wertebereich von 1 bis 64 und die x-Position im Wertebereich von 0 bis 110 liegen.

Die minimale Länge des Sliders ist 8.

Der Parameter value ist die Startposition des Sliders. Diese kann zwischen 0 und length-8 liegen.

Der Callback für Slider-Events kann mit der Funktion SetGUISliderValueCallbackConfiguration() eingestellt werden.

Der Slider wird in einem separaten GUI-Buffer gezeichnet und der Rahmen des Buttons wrd immer über den Grafiken bleiben die mit WritePixels() gezeichnet werden. Um einen Button zu entfernen kann die Funktion RemoveGUISlider() genutzt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für direction:

lcd_128x64_bricklet.DirectionHorizontal = 0
lcd_128x64_bricklet.DirectionVertical = 1

Neu in Version 2.0.2 (Plugin).

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

Parameter:	index – Typ: uint8, Wertebereich: [0 bis 5]
Rückgabe:	active – Typ: bool positionX – Typ: uint8, Wertebereich: [0 bis 128] positionY – Typ: uint8, Wertebereich: [0 bis 64] length – Typ: uint8, Wertebereich: [8 bis 128] direction – Typ: uint8, Wertebereich: Siehe Konstanten value – Typ: uint8, Wertebereich: [0 bis 120] err – Typ: error

Gibt die Slider-Eigenschaften für den gegebenen Index zurück, wie von SetGUISlider() gesetzt.

Zusätzlich gibt der Active-Parameter an ob der Button aktuell aktiv/sichtbar ist oder nicht.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für direction:

lcd_128x64_bricklet.DirectionHorizontal = 0
lcd_128x64_bricklet.DirectionVertical = 1

Neu in Version 2.0.2 (Plugin).

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

Parameter:	index – Typ: uint8, Wertebereich: [0 bis 5, 255]
Rückgabe:	err – Typ: error

Entfernt den Slider mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Slider zu entfernen.

Neu in Version 2.0.2 (Plugin).

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

Parameter:	index – Typ: uint8, Wertebereich: [0 bis 5]
Rückgabe:	value – Typ: uint8, Wertebereich: [0 bis 120] err – Typ: error

Gibt den aktuellen Wert des Slider mit dem gegebenen Index zurück.

Neu in Version 2.0.2 (Plugin).

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

Parameter:	changeTabConfig – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3 clearGUI – Typ: bool, Standardwert: true
Rückgabe:	err – Typ: error

Setzt die generelle Konfiguration für Tabs. Tabs können auf klicken, wischen (links/rechts und rechts/links) oder beides reagieren.

Zusätzlich kann Clear GUI auf true gesetzt werden. In diesem Fall werden bei einem wechsel der Tabs automatisch alle GUI Elemente (Buttons, Slider, Graphen) gelöscht.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für changeTabConfig:

lcd_128x64_bricklet.ChangeTabOnClick = 1
lcd_128x64_bricklet.ChangeTabOnSwipe = 2
lcd_128x64_bricklet.ChangeTabOnClickAndSwipe = 3

Neu in Version 2.0.2 (Plugin).

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

Rückgabe:	changeTabConfig – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3 clearGUI – Typ: bool, Standardwert: true err – Typ: error

Gibt die Tab-Konfiguration zurück, wie von SetGUITabConfiguration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für changeTabConfig:

lcd_128x64_bricklet.ChangeTabOnClick = 1
lcd_128x64_bricklet.ChangeTabOnSwipe = 2
lcd_128x64_bricklet.ChangeTabOnClickAndSwipe = 3

Neu in Version 2.0.2 (Plugin).

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

Parameter:	index – Typ: uint8, Wertebereich: [0 bis 9] text – Typ: string, Länge: bis zu 5
Rückgabe:	err – Typ: error

Fügt einen Text-Tab mit dem gegebenen Index hinzu.

Es können bis zu 10 Tabs verwendet werden.

Ein Text-Tab mit dem gleichen Index wie ein Icon-Tab überschreibt diesen.

Neu in Version 2.0.2 (Plugin).

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

Parameter:	index – Typ: uint8, Wertebereich: [0 bis 9]
Rückgabe:	active – Typ: bool text – Typ: string, Länge: bis zu 5 err – Typ: error

Gibt den Text für den gegebenen Index zurück, wie von SetGUITabText() gesetzt.

Zusätzlich gibt der Active-Parameter an ob der Tab aktuell aktiv/sichtbar ist oder nicht.

Neu in Version 2.0.2 (Plugin).

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

Parameter:	index – Typ: uint8, Wertebereich: [0 bis 9] icon – Typ: [168]bool
Rückgabe:	err – Typ: error

Fügt einen Icon-Tab mit dem gegebenen Index hinzu. Das Icon kann eine Breite von 28 Pixel bei einer Höhe von 6 Pixel haben. Es wird Zeile für Zeile von links nach rechts gezeichnet.

Es können bis zu 10 Tabs verwendet werden.

Ein Icon-Tab mit dem gleichen Index wie ein Text-Tab überschreibt diesen.

Neu in Version 2.0.2 (Plugin).

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

Parameter:	index – Typ: uint8, Wertebereich: [0 bis 9]
Rückgabe:	active – Typ: bool icon – Typ: [168]bool err – Typ: error

Gibt das Icon für den gegebenen Index zurück, wie von SetGUITabIcon() gesetzt.

Zusätzlich gibt der Active-Parameter an ob der Tab aktuell aktiv/sichtbar ist oder nicht.

Neu in Version 2.0.2 (Plugin).

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

Parameter:	index – Typ: uint8, Wertebereich: [0 bis 9, 255]
Rückgabe:	err – Typ: error

Entfernt den Tab mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Tabs zu entfernen.

Neu in Version 2.0.2 (Plugin).

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

Parameter:	index – Typ: uint8, Wertebereich: [0 bis 9]
Rückgabe:	err – Typ: error

Setzt den Tab mit dem gegebenen Index als "selected" (wird auf dem Display als ausgewählt gezeichnet)

Neu in Version 2.0.2 (Plugin).

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

Rückgabe:	index – Typ: int8, Wertebereich: [-1 bis 9] err – Typ: error

Gibt den Index des aktuell ausgewählten Tabs zurück. Wenn es keine Tabs gibt, wird -1 als Index zurückgegeben.

Neu in Version 2.0.2 (Plugin).

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

Parameter:

Parameter:	index – Typ: uint8, Wertebereich: [0 bis 3] graphType – Typ: uint8, Wertebereich: Siehe Konstanten positionX – Typ: uint8, Wertebereich: [0 bis 127] positionY – Typ: uint8, Wertebereich: [0 bis 63] width – Typ: uint8, Wertebereich: [0 bis 118] height – Typ: uint8, Wertebereich: [0 bis 63] textX – Typ: string, Länge: bis zu 4 textY – Typ: string, Länge: bis zu 4
Rückgabe:	err – Typ: error

index – Typ: uint8, Wertebereich: [0 bis 3]
graphType – Typ: uint8, Wertebereich: Siehe Konstanten
positionX – Typ: uint8, Wertebereich: [0 bis 127]
positionY – Typ: uint8, Wertebereich: [0 bis 63]
width – Typ: uint8, Wertebereich: [0 bis 118]
height – Typ: uint8, Wertebereich: [0 bis 63]
textX – Typ: string, Länge: bis zu 4
textY – Typ: string, Länge: bis zu 4

Rückgabe:

err – Typ: error

Setzt die Konfiguration für bis zu vier Graphen.

Der Graph kann vom Typ Dot-, Line- oder Bar-Graph sein.

Die x- und y-Positionen sind Pixel-Positionen.

Es können bis zu 4 Buchstaben Text zur Beschreibung der x- und y-Achse genutzt werden. Der Text wird auf die Innenseite des Graphen gezeichnet und er kann Datenpunkte des Graphen überschreiben. Wenn der Text außerhalb des Graphen benötigt wird kann die Beschriftung hier leer gelassen werden. Der Text kann im Nachhinein mit DrawText() hinzugefügt werden.

Die Datenpunkte des Graphen können mit der Funktion SetGUIGraphData() gesetzt und aktualisiert werden.

Der Graph wird in einem separaten GUI-Buffer gezeichnet und der Rahmen sowie die Datenpunkte des Graphen werden immer über den Grafiken bleiben die mit WritePixels() gezeichnet werden. Um einen Graphen zu entfernen kann die Funktion RemoveGUIGraph() genutzt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für graphType:

lcd_128x64_bricklet.GraphTypeDot = 0
lcd_128x64_bricklet.GraphTypeLine = 1
lcd_128x64_bricklet.GraphTypeBar = 2

Neu in Version 2.0.2 (Plugin).

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

Parameter:

index – Typ: uint8, Wertebereich: [0 bis 3]

Rückgabe:

active – Typ: bool
graphType – Typ: uint8, Wertebereich: Siehe Konstanten
positionX – Typ: uint8, Wertebereich: [0 bis 127]
positionY – Typ: uint8, Wertebereich: [0 bis 63]
width – Typ: uint8, Wertebereich: [0 bis 118]
height – Typ: uint8, Wertebereich: [0 bis 63]
textX – Typ: string, Länge: bis zu 4
textY – Typ: string, Länge: bis zu 4
err – Typ: error

Gibt die Graph-Eigenschaften für den gegebenen Index zurück, wie von SetGUIGraphConfiguration() gesetzt.

Zusätzlich gibt der Active-Parameter an ob der Button aktuell aktiv/sichtbar ist oder nicht.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für graphType:

lcd_128x64_bricklet.GraphTypeDot = 0
lcd_128x64_bricklet.GraphTypeLine = 1
lcd_128x64_bricklet.GraphTypeBar = 2

Neu in Version 2.0.2 (Plugin).

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

Parameter:	index – Typ: uint8, Wertebereich: [0 bis 3] data – Typ: []uint8, Länge: variabel, Wertebereich: [0 bis 255]
Rückgabe:	err – Typ: error

Setzt die Datenpukte für den Graph mit dem gegebenen Index. Der Graph muss mit SetGUIGraphConfiguration() konfiguriert werden bevor die ersten Daten gesetzt werden können.

Der Graph zeigt die ersten n Werte der gesetzten Daten an, wobei n die Breite (width) ist die mit SetGUIGraphConfiguration() gesetzt wurde. Wenn weniger als n Werte gesetzt werden, werden die restlichen Datenpunkte als 0 angezeigt.

Die maximale Anzahl an Datenpunkte die gesetzt werden kann ist 118 (dies entspricht auch der maximalen Breite des Graphen).

Die gesetzten Werte müssen zwischen 0 und 255 skaliert werden. 0 wird unten und 255 wird oben im Graph gezeichnet.

Neu in Version 2.0.2 (Plugin).

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

Parameter:	index – Typ: uint8, Wertebereich: [0 bis 3]
Rückgabe:	data – Typ: []uint8, Länge: variabel, Wertebereich: [0 bis 255] err – Typ: error

Gibt die Datenpunkte des Graphen mit dem gegebenen Index zurück, wie von SetGUIGraphData() gesetzt.

Neu in Version 2.0.2 (Plugin).

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

Parameter:	index – Typ: uint8, Wertebereich: [0 bis 3, 255]
Rückgabe:	err – Typ: error

Entfernt den Graph mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Graphen zu entfernen.

Neu in Version 2.0.2 (Plugin).

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

Rückgabe:	err – Typ: error

Entfernt alle GUI-Elemente (Buttons, Slider, Graphen, Tabs).

Neu in Version 2.0.2 (Plugin).

Fortgeschrittene Funktionen¶

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

Parameter:	contrast – Typ: uint8, Wertebereich: [0 bis 63], Standardwert: 14 backlight – Typ: uint8, Wertebereich: [0 bis 100], Standardwert: 100 invert – Typ: bool, Standardwert: false automaticDraw – Typ: bool, Standardwert: true
Rückgabe:	err – Typ: error

Setzt die Konfiguration des Displays.

Wenn Automatic Draw aktiviert (true) ist dann wird das Display bei jedem Aufruf von WritePixels() und WriteLine() aktualisiert. Wenn Automatic Draw deaktiviert (false) ist, dann werden Änderungen in einen internen Buffer geschrieben, der dann bei bei einem Aufruf von DrawBufferedFrame() auf dem Display angezeigt wird.

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

Rückgabe:	contrast – Typ: uint8, Wertebereich: [0 bis 63], Standardwert: 14 backlight – Typ: uint8, Wertebereich: [0 bis 100], Standardwert: 100 invert – Typ: bool, Standardwert: false automaticDraw – Typ: bool, Standardwert: true err – Typ: error

Gibt die Konfiguration zurück, wie von SetDisplayConfiguration() gesetzt.

func (*LCD128x64Bricklet) SetTouchLEDConfig(config uint8) (err error)¶

Parameter:	config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	err – Typ: error

Setzt die Konfiguration der Kommunikations-LED. Standardmäßig ist die LED an wenn das LCD berührt wird.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootloadermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

lcd_128x64_bricklet.TouchLEDConfigOff = 0
lcd_128x64_bricklet.TouchLEDConfigOn = 1
lcd_128x64_bricklet.TouchLEDConfigShowHeartbeat = 2
lcd_128x64_bricklet.TouchLEDConfigShowTouch = 3

Neu in Version 2.0.2 (Plugin).

func (*LCD128x64Bricklet) GetTouchLEDConfig() (config uint8, err error)¶

Rückgabe:	config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3 err – Typ: error

Gibt die Konfiguration zurück, wie von SetTouchLEDConfig() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

lcd_128x64_bricklet.TouchLEDConfigOff = 0
lcd_128x64_bricklet.TouchLEDConfigOn = 1
lcd_128x64_bricklet.TouchLEDConfigShowHeartbeat = 2
lcd_128x64_bricklet.TouchLEDConfigShowTouch = 3

Neu in Version 2.0.2 (Plugin).

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

Rückgabe:	errorCountAckChecksum – Typ: uint32, Wertebereich: [0 bis 2³² - 1] errorCountMessageChecksum – Typ: uint32, Wertebereich: [0 bis 2³² - 1] errorCountFrame – Typ: uint32, Wertebereich: [0 bis 2³² - 1] errorCountOverflow – Typ: uint32, Wertebereich: [0 bis 2³² - 1] err – Typ: error

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

ACK-Checksummen Fehler,
Message-Checksummen Fehler,
Framing Fehler und
Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

func (*LCD128x64Bricklet) SetStatusLEDConfig(config uint8) (err error)¶

Parameter:	config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	err – Typ: error

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

lcd_128x64_bricklet.StatusLEDConfigOff = 0
lcd_128x64_bricklet.StatusLEDConfigOn = 1
lcd_128x64_bricklet.StatusLEDConfigShowHeartbeat = 2
lcd_128x64_bricklet.StatusLEDConfigShowStatus = 3

func (*LCD128x64Bricklet) GetStatusLEDConfig() (config uint8, err error)¶

Rückgabe:	config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3 err – Typ: error

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

lcd_128x64_bricklet.StatusLEDConfigOff = 0
lcd_128x64_bricklet.StatusLEDConfigOn = 1
lcd_128x64_bricklet.StatusLEDConfigShowHeartbeat = 2
lcd_128x64_bricklet.StatusLEDConfigShowStatus = 3

func (*LCD128x64Bricklet) GetChipTemperature() (temperature int16, err error)¶

Rückgabe:	temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] err – Typ: error

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

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

Rückgabe:	err – Typ: error

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

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

Rückgabe:

Rückgabe:	uid – Typ: string, Länge: bis zu 8 connectedUid – Typ: string, Länge: bis zu 8 position – Typ: rune, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: [3]uint8 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] firmwareVersion – Typ: [3]uint8 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] err – Typ: error

uid – Typ: string, Länge: bis zu 8
connectedUid – Typ: string, Länge: bis zu 8
position – Typ: rune, Wertebereich: ['a' bis 'h', 'z']
hardwareVersion – Typ: [3]uint8

0: major – Typ: uint8, Wertebereich: [0 bis 255]
1: minor – Typ: uint8, Wertebereich: [0 bis 255]
2: revision – Typ: uint8, Wertebereich: [0 bis 255]

firmwareVersion – Typ: [3]uint8

0: major – Typ: uint8, Wertebereich: [0 bis 255]
1: minor – Typ: uint8, Wertebereich: [0 bis 255]
2: revision – Typ: uint8, Wertebereich: [0 bis 255]

deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1]
err – Typ: error

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

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

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false
Rückgabe:	err – Typ: error

Die Periode ist die Periode mit der der TouchPositionCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

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

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false err – Typ: error

Gibt die Callback-Konfiguration zurück, wie mittels SetTouchPositionCallbackConfiguration() gesetzt.

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

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false
Rückgabe:	err – Typ: error

Die Periode ist die Periode mit der der TouchGestureCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

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

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false err – Typ: error

Gibt die Callback-Konfiguration zurück, wie mittels SetTouchGestureCallbackConfiguration() gesetzt.

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

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false
Rückgabe:	err – Typ: error

Die Periode ist die Periode mit der der GUIButtonPressedCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Neu in Version 2.0.2 (Plugin).

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

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false err – Typ: error

Gibt die Callback-Konfiguration zurück, wie mittels SetGUIButtonPressedCallbackConfiguration() gesetzt.

Neu in Version 2.0.2 (Plugin).

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

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false
Rückgabe:	err – Typ: error

Die Periode ist die Periode mit der der GUISliderValueCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Neu in Version 2.0.2 (Plugin).

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

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false err – Typ: error

Gibt die Callback-Konfiguration zurück, wie mittels SetGUISliderValueCallbackConfiguration() gesetzt.

Neu in Version 2.0.2 (Plugin).

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

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false
Rückgabe:	err – Typ: error

Die Periode ist die Periode mit der der GUITabSelectedCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Neu in Version 2.0.2 (Plugin).

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

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false err – Typ: error

Gibt die Callback-Konfiguration zurück, wie mittels SetGUITabSelectedCallbackConfiguration() gesetzt.

Neu in Version 2.0.2 (Plugin).

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden Register*Callback-Function durchgeführt werden, welche eine eindeutige Callback-ID zurück gibt. Mit dieser ID kann das Callback später deregistriert werden.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

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

Callback-Parameter:	pressure – Typ: uint16, Wertebereich: [0 bis 300] x – Typ: uint16, Wertebereich: [0 bis 127] y – Typ: uint16, Wertebereich: [0 bis 63] age – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	registrationId – Typ: uint64

Dieser Callback wird mit der Periode, wie gesetzt mit SetTouchPositionCallbackConfiguration(), ausgelöst. Die Parameter des Callbacks sind die gleichen wie die von GetTouchPosition().

func (*LCD128x64Bricklet) RegisterTouchGestureCallback(func(gesture uint8, duration uint32, pressureMax uint16, xStart uint16, yStart uint16, xEnd uint16, yEnd uint16, age uint32)) (registrationId uint64)¶

Callback-Parameter:

gesture – Typ: uint8, Wertebereich: Siehe Konstanten
duration – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1]
pressureMax – Typ: uint16, Wertebereich: [0 bis 300]
xStart – Typ: uint16, Wertebereich: [0 bis 127]
yStart – Typ: uint16, Wertebereich: [0 bis 63]
xEnd – Typ: uint16, Wertebereich: [0 bis 127]
yEnd – Typ: uint16, Wertebereich: [0 bis 63]
age – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1]

Rückgabe:

registrationId – Typ: uint64

Dieser Callback wird mit der Periode, wie gesetzt mit SetTouchGestureCallbackConfiguration(), ausgelöst. Die Parameter des Callbacks sind die gleichen wie die von GetTouchGesture().

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für gesture:

lcd_128x64_bricklet.GestureLeftToRight = 0
lcd_128x64_bricklet.GestureRightToLeft = 1
lcd_128x64_bricklet.GestureTopToBottom = 2
lcd_128x64_bricklet.GestureBottomToTop = 3

func (*LCD128x64Bricklet) RegisterGUIButtonPressedCallback(func(index uint8, pressed bool)) (registrationId uint64)¶

Callback-Parameter:	index – Typ: uint8, Wertebereich: [0 bis 11] pressed – Typ: bool
Rückgabe:	registrationId – Typ: uint64

Dieser Callback wird mit der Periode, wie gesetzt mit SetGUIButtonPressedCallbackConfiguration(), ausgelöst. Die Parameter des Callbacks sind die gleichen wie die von GetGUIButtonPressed().

Neu in Version 2.0.2 (Plugin).

func (*LCD128x64Bricklet) RegisterGUISliderValueCallback(func(index uint8, value uint8)) (registrationId uint64)¶

Callback-Parameter:	index – Typ: uint8, Wertebereich: [0 bis 5] value – Typ: uint8, Wertebereich: [0 bis 120]
Rückgabe:	registrationId – Typ: uint64

Dieser Callback wird mit der Periode, wie gesetzt mit SetGUISliderValueCallbackConfiguration(), ausgelöst. Die Parameter des Callbacks sind die gleichen wie die von GetGUISliderValue().

Neu in Version 2.0.2 (Plugin).

func (*LCD128x64Bricklet) RegisterGUITabSelectedCallback(func(index int8)) (registrationId uint64)¶

Callback-Parameter:	index – Typ: int8, Wertebereich: [0 bis 9]
Rückgabe:	registrationId – Typ: uint64

Dieser Callback wird mit der Periode, wie gesetzt mit SetGUITabSelectedCallbackConfiguration(), ausgelöst. Die Parameter des Callbacks sind die gleichen wie die von GetGUITabSelected().

Neu in Version 2.0.2 (Plugin).

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

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

Rückgabe:	apiVersion – Typ: [3]uint8 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] err – Typ: error

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

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

Parameter:	functionId – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: bool err – Typ: error

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels SetResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für functionId:

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

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

Parameter:	functionId – Typ: uint8, Wertebereich: Siehe Konstanten responseExpected – Typ: bool
Rückgabe:	err – Typ: error

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für functionId:

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

func (*LCD128x64Bricklet) SetResponseExpectedAll(responseExpected bool) (err error)¶

Parameter:	responseExpected – Typ: bool
Rückgabe:	err – Typ: error

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

func (*LCD128x64Bricklet) SetBootloaderMode(mode uint8) (status uint8, err error)¶

Parameter:	mode – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: uint8, Wertebereich: Siehe Konstanten err – Typ: error

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für mode:

lcd_128x64_bricklet.BootloaderModeBootloader = 0
lcd_128x64_bricklet.BootloaderModeFirmware = 1
lcd_128x64_bricklet.BootloaderModeBootloaderWaitForReboot = 2
lcd_128x64_bricklet.BootloaderModeFirmwareWaitForReboot = 3
lcd_128x64_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4

Für status:

lcd_128x64_bricklet.BootloaderStatusOK = 0
lcd_128x64_bricklet.BootloaderStatusInvalidMode = 1
lcd_128x64_bricklet.BootloaderStatusNoChange = 2
lcd_128x64_bricklet.BootloaderStatusEntryFunctionNotPresent = 3
lcd_128x64_bricklet.BootloaderStatusDeviceIdentifierIncorrect = 4
lcd_128x64_bricklet.BootloaderStatusCRCMismatch = 5

func (*LCD128x64Bricklet) GetBootloaderMode() (mode uint8, err error)¶

Rückgabe:	mode – Typ: uint8, Wertebereich: Siehe Konstanten err – Typ: error

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für mode:

lcd_128x64_bricklet.BootloaderModeBootloader = 0
lcd_128x64_bricklet.BootloaderModeFirmware = 1
lcd_128x64_bricklet.BootloaderModeBootloaderWaitForReboot = 2
lcd_128x64_bricklet.BootloaderModeFirmwareWaitForReboot = 3
lcd_128x64_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4

func (*LCD128x64Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)¶

Parameter:	pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	err – Typ: error

Setzt den Firmware-Pointer für WriteFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Parameter:	data – Typ: [64]uint8, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: uint8, Wertebereich: [0 bis 255] err – Typ: error

Schreibt 64 Bytes Firmware an die Position die vorher von SetWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Parameter:	uid – Typ: uint32, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	err – Typ: error

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

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

Rückgabe:	uid – Typ: uint32, Wertebereich: [0 bis 2³² - 1] err – Typ: error

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten¶

lcd_128x64_bricklet.DeviceIdentifier¶

Diese Konstante wird verwendet um ein LCD 128x64 Bricklet zu identifizieren.

Die GetIdentity() Funktion und der (*IPConnection) RegisterEnumerateCallback Callback der IPConnection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

lcd_128x64_bricklet.DeviceDisplayName¶: Diese Konstante stellt den Anzeigenamen eines LCD 128x64 Bricklet dar.