Go - OLED 128x64 Bricklet

Dies ist die Beschreibung der Go API Bindings für das OLED 128x64 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des OLED 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)

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

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    oled, _ := oled_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
    oled.ClearDisplay()

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

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

Pixel Matrix

Download (example_pixel_matrix.go)

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

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

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

const WIDTH = 128
const HEIGHT = 64

func drawMatrix(oled oled_128x64_bricklet.OLED128x64Bricklet, pixels [HEIGHT][WIDTH]bool) {
    var pages [HEIGHT / 8][WIDTH]uint8
    for colIdx, col := range pages {
        for rowIdx := range col {
            for bit := 0; bit < 8; bit++ {
                if pixels[colIdx*8+bit][rowIdx] {
                    pages[colIdx][rowIdx] |= 1 << uint(bit)
                }
            }
        }
    }

    oled.NewWindow(0, WIDTH-1, 0, (HEIGHT/8)-1)

    for row := 0; row < HEIGHT/8; row++ {
        for col := 0; col < WIDTH; col += 64 {
            var arr [64]uint8
            copy(arr[:], pages[row][col:col+64])
            oled.Write(arr)
        }
    }
}

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    oled, _ := oled_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
    oled.ClearDisplay()

    // Draw checkerboard pattern
    var pixels [HEIGHT][WIDTH]bool
    for rowIdx, row := range pixels {
        for colIdx := range row {
            pixels[rowIdx][colIdx] = (rowIdx/8)%2 == (colIdx/8)%2
        }
    }

    drawMatrix(oled, pixels)

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

API

Die API des OLED 128x64 Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/oled_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 oled_128x64_bricklet.New(uid string, ipcon *IPConnection) (device OLED128x64Bricklet, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: OLED128x64Bricklet
  • err – Typ: error

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

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

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden wurde (siehe Beispiele oben).

func (*OLED128x64Bricklet) Write(data [64]uint8) (err error)
Parameter:
  • data – Typ: [64]uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: error

Fügt 64 Byte Daten zu dem mit NewWindow() gesetztem Fenster hinzu.

Jede Zeile hat eine Höhe von 8 Pixeln welche einem Byte Daten entsprechen.

Beispiel: Wenn NewWindow() mit Spalte (Column) von 0 bis 127 und Zeile (Row) von 0 bis 7 (das ganze Display) aufgerufen wird, schreibt jedes Write() (roter Pfeil) eine halbe Zeile.

Display Pixel Reihenfolge

Das LSB (D0) von jedem Daten-Byte ist in der Zeile oben und das MSB (D7) ist in der Zeile unten.

Der nächste Aufruf von Write() schreibt die zweite Hälfte der erste Zeile, und die nächsten beiden Aufrufe die zweite Zeile usw. Um das ganze Display zu füllen muss Write() 16 mal aufgerufen werden.

func (*OLED128x64Bricklet) NewWindow(columnFrom uint8, columnTo uint8, rowFrom uint8, rowTo uint8) (err error)
Parameter:
  • columnFrom – Typ: uint8, Wertebereich: [0 bis 255]
  • columnTo – Typ: uint8, Wertebereich: [0 bis 255]
  • rowFrom – Typ: uint8, Wertebereich: [0 bis 255]
  • rowTo – Typ: uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: error

Setzt das Fenster in welches mit Write() geschrieben werden kann. Eine Zeile (Row) hat eine Höhe von 8 Pixel.

Die Spalten haben einen Wertebereich von 0 bis 127 und die Zeilen haben einen Wertebereich von 0 bis 7.

func (*OLED128x64Bricklet) ClearDisplay() (err error)
Rückgabe:
  • err – Typ: error

Löscht den aktuellen Inhalt des mit NewWindow() gesetztem Fensters.

func (*OLED128x64Bricklet) WriteLine(line uint8, position uint8, text string) (err error)
Parameter:
  • line – Typ: uint8, Wertebereich: [0 bis 255]
  • position – Typ: uint8, Wertebereich: [0 bis 255]
  • text – Typ: string, Länge: bis zu 26
Rückgabe:
  • err – Typ: error

Schreibt einen Text in die angegebene Zeile (0 bis 7) mit einer vorgegebenen Position (0 bis 25). Der Text kann maximal 26 Zeichen lang sein.

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

Es ist möglich zuerst auf das Display mit Write() zu malen und danach Text hinzuzufügen.

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

Fortgeschrittene Funktionen

func (*OLED128x64Bricklet) SetDisplayConfiguration(contrast uint8, invert bool) (err error)
Parameter:
  • contrast – Typ: uint8, Wertebereich: [0 bis 255]
  • invert – Typ: bool
Rückgabe:
  • err – Typ: error

Setzt die Konfiguration des Displays

Es können der Kontrast mit einem Wertebereich von 0 bis 255 gesetzt, sowie die Farben (schwarz/weiß) des Displays invertiert werden.

Die Standardwerte sind ein Kontrast von 143 und die Invertierung ist aus.

func (*OLED128x64Bricklet) GetDisplayConfiguration() (contrast uint8, invert bool, err error)
Rückgabe:
  • contrast – Typ: uint8, Wertebereich: [0 bis 255]
  • invert – Typ: bool
  • err – Typ: error

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

func (*OLED128x64Bricklet) GetAPIVersion() (apiVersion [3]uint8, err error)
Rückgabe:
  • apiVersion – Typ: [3]uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

Gibt die Version der API Definition (Major, Minor, Revision) 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 (*OLED128x64Bricklet) 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:

  • oled_128x64_bricklet.FunctionWrite = 1
  • oled_128x64_bricklet.FunctionNewWindow = 2
  • oled_128x64_bricklet.FunctionClearDisplay = 3
  • oled_128x64_bricklet.FunctionSetDisplayConfiguration = 4
  • oled_128x64_bricklet.FunctionWriteLine = 6
func (*OLED128x64Bricklet) 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.

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:

  • oled_128x64_bricklet.FunctionWrite = 1
  • oled_128x64_bricklet.FunctionNewWindow = 2
  • oled_128x64_bricklet.FunctionClearDisplay = 3
  • oled_128x64_bricklet.FunctionSetDisplayConfiguration = 4
  • oled_128x64_bricklet.FunctionWriteLine = 6
func (*OLED128x64Bricklet) 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.

func (*OLED128x64Bricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
Rückgabe:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: rune
  • hardwareVersion – Typ: [3]uint8, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [3]uint8, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 216 - 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 kann 'a', 'b', 'c' oder 'd' sein.

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

Konstanten

oled_128x64_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein OLED 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.

oled_128x64_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines OLED 128x64 Bricklet dar.