Software / API Bindings / Go / API Referenz und Beispiele / Bricklets / E-Paper 296x128 Bricklet

Go - E-Paper 296x128 Bricklet¶

Dies ist die Beschreibung der Go API Bindings für das E-Paper 296x128 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des E-Paper 296x128 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/e_paper_296x128_bricklet"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your E-Paper 296x128 Bricklet.

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

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

    // Use black background
    ep.FillDisplay(e_paper_296x128_bricklet.ColorBlack)

    // Write big white "Hello World" in the middle of the screen
    ep.DrawText(16, 48, e_paper_296x128_bricklet.Font24x32,
        e_paper_296x128_bricklet.ColorWhite,
        e_paper_296x128_bricklet.OrientationHorizontal, "Hello World")
    ep.Draw()

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

Load Image¶

Download (example_load_image.go)

package main

import (
    "fmt"
    "os"
    "image"
    "image/png"
    "github.com/Tinkerforge/go-api-bindings/e_paper_296x128_bricklet"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your E-Paper 296x128 Bricklet.
const WIDTH = 296
const HEIGHT = 128

// Convert Image to matching color bool array
func BoolArrayFromImage(image image.Image, r uint32, g uint32, b uint32) ([]bool, error) {
    var pixels []bool
    for row := 0; row < HEIGHT; row++ {
        for column := 0; column < WIDTH; column++ {
            rCmp, gCmp, bCmp, _ := image.At(column, row).RGBA();
            pixels = append(pixels, (rCmp == r) && (gCmp == g) && (bCmp == b))
        }
    }

    return pixels, nil
}

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

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

    // Download example image here:
    // https://raw.githubusercontent.com/Tinkerforge/e-paper-296x128-bricklet/master/software/examples/tf_red.png
    image.RegisterFormat("png", "png", png.Decode, png.DecodeConfig)
    file, _ := os.Open("tf_red.png")
    defer file.Close()
    image, _, _ := image.Decode(file)

    // Get black/white pixels from image and write them to the Bricklet buffer
    pixelsBW, _ := BoolArrayFromImage(image, 0xFFFF, 0xFFFF, 0xFFFF)
    ep.WriteBlackWhite(0, 0, WIDTH-1, HEIGHT-1, pixelsBW)

    // Get red pixels from image and write them to the Bricklet buffer
    pixelsRed, _ := BoolArrayFromImage(image, 0xFFFF, 0, 0)
    ep.WriteColor(0, 0, WIDTH-1, HEIGHT-1, pixelsRed)

    // Draw buffered values to the display
    ep.Draw()

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

API¶

Die API des E-Paper 296x128 Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/e_paper_296x128_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 e_paper_296x128_bricklet.New(uid string, ipcon *IPConnection) (device EPaper296x128Bricklet, err error)¶

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

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

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

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

func (*EPaper296x128Bricklet) Draw() (err error)¶

Rückgabe:	err – Typ: error

Zeichnet den aktuellen Schwarz-/Weiß- und Rot- oder Grau-Buffer auf das E-Paper-Display.

Das Bricklet nutzt kein Double-Buffering. Diese Funktion sollte daher nicht aufgerufen werden während in den Buffer geschrieben wird. Siehe GetDrawStatus().

func (*EPaper296x128Bricklet) GetDrawStatus() (drawStatus uint8, err error)¶

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

Gibt einen von drei möglichen Status zurück:

Idle
Copying: Daten werden vom Buffer des Bricklets in den Buffer des Displays kopiert.
Drawing: Das Display aktualisiert den Inhalt (während dieser Phase flackert das Display).

Der Buffer kann beschrieben werden (durch eine der write- oder draw-Funktionen) wenn der Status entweder idle oder drawing ist. Der Buffer sollte nicht beschrieben werden während er kopiert wird. Es findet kein Double-Buffering statt.

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

Für drawStatus:

e_paper_296x128_bricklet.DrawStatusIdle = 0
e_paper_296x128_bricklet.DrawStatusCopying = 1
e_paper_296x128_bricklet.DrawStatusDrawing = 2

func (*EPaper296x128Bricklet) WriteBlackWhite(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8, pixels []bool) (err error)¶

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

Schreibt schwarze/weiße Pixel in das angegebene Fenster in den Buffer.

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

Der Wert 0 (false) entspricht einem schwarzen Pixel und der Wert 1 (true) einem weißen Pixel.

Diese Funktion schreibt Pixel in den Schwarz-/Weiß-Buffer. Der Buffer kann mit der Funktion Draw() auf das Display übertragen werden.

Die Funktion WriteColor() kann genutzt werden um rote oder graue Pixel zu schreiben.

func (*EPaper296x128Bricklet) ReadBlackWhite(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8) (pixels []bool, err error)¶

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

Gibt den aktuellen Inhalt des Schwarz-/Weiß-Buffers für das spezifizierte Fenster zurück.

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

Der aktuelle Inhalt des Buffers muss nicht dem aktuellen Inhalt des Displays entsprechen. Es ist möglich das der Buffer noch nicht auf das Display übertragen wurde und nach einem Neustart wird der Buffer des Bricklets als schwarz initialisiert, während das Display den Inhalt beibehält.

func (*EPaper296x128Bricklet) WriteColor(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8, pixels []bool) (err error)¶

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

Das E-Paper 296x128 Bricklet ist in den Farben schwarz/weiß/rot sowie schwarz/weiß/grau verfügbar. Abhängig vom verwendeten Modell schreibt diese Funktion entweder rote oder graue Pixel in das spezifizierte Fenster des Buffers.

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

Der Wert 0 (false) bedeutet dass das Pixel keine Farbe hat. Es ist in diesem Fall entweder schwarz oder weiß (siehe WriteBlackWhite()). Der Wert 1 (true) entspricht einem roten oder grauen Pixel, abhängig vom Modell des Bricklets.

Diese Funktion schreibt Pixel in den Rot- oder Grau-Buffer. Der Buffer kann mit der Funktion Draw() auf das Display übertragen werden.

Die Funktion WriteBlackWhite() kann genutzt werden um schwarze/weiße Pixel zu schreiben.

func (*EPaper296x128Bricklet) ReadColor(xStart uint16, yStart uint8, xEnd uint16, yEnd uint8) (pixels []bool, err error)¶

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

Gibt den aktuellen Inhalt des Rot- oder Grau-Buffers für das spezifizierte Fenster zurück.

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

func (*EPaper296x128Bricklet) FillDisplay(color uint8) (err error)¶

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

Füllt den kompletten Inhalt des Displays mit der gegebenen Farbe.

Diese Funktion schreibt Pixel in den Schwarz-/Weiß-/Grau|Rot-Buffer. Der Buffer kann mit der Funktion Draw() auf das Display übertragen werden.

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

Für color:

e_paper_296x128_bricklet.ColorBlack = 0
e_paper_296x128_bricklet.ColorWhite = 1
e_paper_296x128_bricklet.ColorRed = 2
e_paper_296x128_bricklet.ColorGray = 2

func (*EPaper296x128Bricklet) DrawText(positionX uint16, positionY uint8, font uint8, color uint8, orientation uint8, text string) (err error)¶

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

Zeichnet einen Text mit bis zu 50 Buchstaben an die Pixelposition (x, y).

Es können 9 unterschiedliche Font-Größen genutzt werden und der Text kann in schwarz/weiß/rot|grau gezeichnet werden. Der Text kann horizontal oder vertikal gezeichnet werden.

Diese Funktion schreibt Pixel in den Schwarz-/Weiß-/Grau|Rot-Buffer. Der Buffer kann mit der Funktion Draw() auf das Display übertragen werden.

Der der Zeichensatz entspricht Codepage 437.

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

Für font:

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

Für color:

e_paper_296x128_bricklet.ColorBlack = 0
e_paper_296x128_bricklet.ColorWhite = 1
e_paper_296x128_bricklet.ColorRed = 2
e_paper_296x128_bricklet.ColorGray = 2

Für orientation:

e_paper_296x128_bricklet.OrientationHorizontal = 0
e_paper_296x128_bricklet.OrientationVertical = 1

func (*EPaper296x128Bricklet) DrawLine(positionXStart uint16, positionYStart uint8, positionXEnd uint16, positionYEnd uint8, color uint8) (err error)¶

Parameter:	positionXStart – Typ: uint16, Wertebereich: [0 bis 295] positionYStart – Typ: uint8, Wertebereich: [0 bis 127] positionXEnd – Typ: uint16, Wertebereich: [0 bis 295] positionYEnd – Typ: uint8, Wertebereich: [0 bis 127] color – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:	err – Typ: error

Zeichnet eine Linie von (x, y)-Start nach (x, y)-Ende in der eingestellten Farbe.

Diese Funktion schreibt Pixel in den Schwarz-/Weiß-/Grau|Rot-Buffer. Der Buffer kann mit der Funktion Draw() auf das Display übertragen werden.

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

Für color:

e_paper_296x128_bricklet.ColorBlack = 0
e_paper_296x128_bricklet.ColorWhite = 1
e_paper_296x128_bricklet.ColorRed = 2
e_paper_296x128_bricklet.ColorGray = 2

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

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

Zeichnet ein Rechteck von (x, y)-Start nach (x, y)-Ende in der eingestellten Farbe.

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

Diese Funktion schreibt Pixel in den Schwarz-/Weiß-/Grau|Rot-Buffer. Der Buffer kann mit der Funktion Draw() auf das Display übertragen werden.

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

Für color:

e_paper_296x128_bricklet.ColorBlack = 0
e_paper_296x128_bricklet.ColorWhite = 1
e_paper_296x128_bricklet.ColorRed = 2
e_paper_296x128_bricklet.ColorGray = 2

Fortgeschrittene Funktionen¶

func (*EPaper296x128Bricklet) SetUpdateMode(updateMode uint8) (err error)¶

Parameter:	updateMode – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	err – Typ: error

Bemerkung

Der Default Update-Modus basiert auf den Standardeinstellungen des E-Paper-Display Herstellers. Alle anderen Modi sind experimentell und es tritt mehr Ghosting sowie mögliche Langzeiteffekte auf.

Für einen Überblick über die Funktionsweise eines E-Paper-Displays können wir das exzellente Video von Ben Krasnow empfehlen: https://www.youtube.com/watch?v=MsbiO8EAsGw.

Falls es nicht klar ist was diese Optionen bedeuten, empfehlen wir den Update-Modus auf Default zu belassen.

Aktuell gibt es drei unterschiedliche Update-Modi:

Default: Einstellungen wie vom Hersteller vorgegeben. Eine Bildschirmaktualisierung dauert ungefähr 7,5 Sekunden und während der Aktualisierung flackert der Bildschirm mehrfach.
Black/White: In diesem Modus werden nur die schwarzen und weißen Pixel aktualisiert. Es werden die Herstellereinstellungen für schwarz/weiß genutzt, allerdings wird der rote oder graue Buffer ignoriert. Mit diesem Modus flackert das Display bei einer Aktualisierung einmal und es dauert in etwa 2,5 Sekunden. Verglichen zu der Standardeinstellung entsteht mehr Ghosting.
Delta: In diesem Modus werden auch nur die schwarzen und weißen Pixel aktualisiert. Es wird eine aggressive Aktualisierungsmethode genutzt. Änderungen werden nicht auf dem kompletten Buffer angewendet, sondern nur auf dem Unterschied (Delta) zwischen dem letzten und dem nächsten Buffer. Mit diesem Modus flackert das Display nicht und eine Aktualisierung dauert 900-950ms. Verglichen zu den anderen beiden Modi gibt es mehr Ghosting. Dieser Modus ist gut geeignet um z.B. flackerfrei einen regelmäßig aktualisierten Text darzustellen.

Wenn der Black/White- oder Delta-Modus zusammen mit dem schwarz/weiß/rot-Bildschirm verwendet wird, bekommt die weiße Farbe nach mehrmaligem Wechsel zwischen schwarz und weiß einen rötlichen Stich.

Wenn der Delta-Modus mit schnell Aktualisierungen verwendet wird, empfehlen wir in regelmäßigen Abständen zurück zum Default-Modus zu wechseln um dort vollflächig zwischen den drei Farben hin und her zu wechseln. Dadurch wird das Ghosting welches durch die Verwendung des Delta-Modus entsteht wieder entfernt. Danach kann dann wieder in den Delta-Modus gewechselt werden für flackerfreie Aktualisierungen.

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

Für updateMode:

e_paper_296x128_bricklet.UpdateModeDefault = 0
e_paper_296x128_bricklet.UpdateModeBlackWhite = 1
e_paper_296x128_bricklet.UpdateModeDelta = 2

func (*EPaper296x128Bricklet) GetUpdateMode() (updateMode uint8, err error)¶

Rückgabe:	updateMode – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0 err – Typ: error

Gibt den Update Mode zurück, wie von SetUpdateMode() gesetzt.

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

Für updateMode:

e_paper_296x128_bricklet.UpdateModeDefault = 0
e_paper_296x128_bricklet.UpdateModeBlackWhite = 1
e_paper_296x128_bricklet.UpdateModeDelta = 2

func (*EPaper296x128Bricklet) SetDisplayType(displayType uint8) (err error)¶

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

Setzt den Typ des Displays. Das E-Paper Display ist in den Farben schwarz/weiß/rot und schwarz/weiß/grau verfügbar. Das korrekte Display wird bereits werksseitig während des Flashens und Testens gesetzt. Der Wert wird in nicht-flüchtigem Speicher gespeichert und bleibt bei einem Neustart unverändert.

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

Für displayType:

e_paper_296x128_bricklet.DisplayTypeBlackWhiteRed = 0
e_paper_296x128_bricklet.DisplayTypeBlackWhiteGray = 1

func (*EPaper296x128Bricklet) GetDisplayType() (displayType uint8, err error)¶

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

Gibt den Typ des E-Paper Displays zurück. Der Typ kann entweder schwarz/weiß/rot oder schwarz/weiß/grau sein.

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

Für displayType:

e_paper_296x128_bricklet.DisplayTypeBlackWhiteRed = 0
e_paper_296x128_bricklet.DisplayTypeBlackWhiteGray = 1

func (*EPaper296x128Bricklet) SetDisplayDriver(displayDriver uint8) (err error)¶

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

Setzt den Typ des Display-Treibers. Das unterstützt aktuell SSD1675A und SSD1680. Dar korrekte Display-Treiber wird bereits werksseitig während des Flashens und Testens gesetzt. Der Wert wird in nicht-flüchtigem Speicher gespeichert und bleibt bei einem Neustart unverändert.

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

Für displayDriver:

e_paper_296x128_bricklet.DisplayDriverSSD1675A = 0
e_paper_296x128_bricklet.DisplayDriverSSD1680 = 1

Neu in Version 2.0.3 (Plugin).

func (*EPaper296x128Bricklet) GetDisplayDriver() (displayDriver uint8, err error)¶

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

Gibt den E-Paper Display-Treibers zurück.

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

Für displayDriver:

e_paper_296x128_bricklet.DisplayDriverSSD1675A = 0
e_paper_296x128_bricklet.DisplayDriverSSD1680 = 1

Neu in Version 2.0.3 (Plugin).

func (*EPaper296x128Bricklet) 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 (*EPaper296x128Bricklet) 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:

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

func (*EPaper296x128Bricklet) 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:

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

func (*EPaper296x128Bricklet) 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 (*EPaper296x128Bricklet) 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 (*EPaper296x128Bricklet) 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.

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 (*EPaper296x128Bricklet) RegisterDrawStatusCallback(func(drawStatus uint8)) (registrationId uint64)¶

Callback-Parameter:	drawStatus – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:	registrationId – Typ: uint64

Callback für den aktuellen Draw Status. Diese Callback wird jedes mal ausgelöst, wenn sich der Draw Status ändert (siehe GetDrawStatus()).

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

Für drawStatus:

e_paper_296x128_bricklet.DrawStatusIdle = 0
e_paper_296x128_bricklet.DrawStatusCopying = 1
e_paper_296x128_bricklet.DrawStatusDrawing = 2

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 (*EPaper296x128Bricklet) 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 (*EPaper296x128Bricklet) 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:

e_paper_296x128_bricklet.FunctionDraw = 1
e_paper_296x128_bricklet.FunctionWriteBlackWhite = 3
e_paper_296x128_bricklet.FunctionWriteColor = 5
e_paper_296x128_bricklet.FunctionFillDisplay = 7
e_paper_296x128_bricklet.FunctionDrawText = 8
e_paper_296x128_bricklet.FunctionDrawLine = 9
e_paper_296x128_bricklet.FunctionDrawBox = 10
e_paper_296x128_bricklet.FunctionSetUpdateMode = 12
e_paper_296x128_bricklet.FunctionSetDisplayType = 14
e_paper_296x128_bricklet.FunctionSetDisplayDriver = 16
e_paper_296x128_bricklet.FunctionSetWriteFirmwarePointer = 237
e_paper_296x128_bricklet.FunctionSetStatusLEDConfig = 239
e_paper_296x128_bricklet.FunctionReset = 243
e_paper_296x128_bricklet.FunctionWriteUID = 248

func (*EPaper296x128Bricklet) 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:

e_paper_296x128_bricklet.FunctionDraw = 1
e_paper_296x128_bricklet.FunctionWriteBlackWhite = 3
e_paper_296x128_bricklet.FunctionWriteColor = 5
e_paper_296x128_bricklet.FunctionFillDisplay = 7
e_paper_296x128_bricklet.FunctionDrawText = 8
e_paper_296x128_bricklet.FunctionDrawLine = 9
e_paper_296x128_bricklet.FunctionDrawBox = 10
e_paper_296x128_bricklet.FunctionSetUpdateMode = 12
e_paper_296x128_bricklet.FunctionSetDisplayType = 14
e_paper_296x128_bricklet.FunctionSetDisplayDriver = 16
e_paper_296x128_bricklet.FunctionSetWriteFirmwarePointer = 237
e_paper_296x128_bricklet.FunctionSetStatusLEDConfig = 239
e_paper_296x128_bricklet.FunctionReset = 243
e_paper_296x128_bricklet.FunctionWriteUID = 248

func (*EPaper296x128Bricklet) 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 (*EPaper296x128Bricklet) 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:

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

Für status:

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

func (*EPaper296x128Bricklet) 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:

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

func (*EPaper296x128Bricklet) 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 (*EPaper296x128Bricklet) 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 (*EPaper296x128Bricklet) 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 (*EPaper296x128Bricklet) 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¶

e_paper_296x128_bricklet.DeviceIdentifier¶

Diese Konstante wird verwendet um ein E-Paper 296x128 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.

e_paper_296x128_bricklet.DeviceDisplayName¶: Diese Konstante stellt den Anzeigenamen eines E-Paper 296x128 Bricklet dar.