Visual Basic .NET - OLED 128x64 Bricklet¶

Hello World¶

Download (ExampleHelloWorld.vb)

 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

Imports System
Imports Tinkerforge

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

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

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' 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")

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

Pixel Matrix¶

Download (ExamplePixelMatrix.vb)

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

Imports System
Imports System.Math
Imports Tinkerforge

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

    Sub DrawMatrix(ByRef oled As BrickletOLED128x64, ByVal pixels()() As Boolean)
        Dim pages()() As Byte = New Byte(HEIGHT \ 8)() {}

        For row As Integer = 0 To HEIGHT \ 8 - 1
            pages(row) = New Byte(WIDTH) {}

            For column As Integer = 0 To WIDTH - 1
                pages(row)(column) = 0

                For bit As Integer = 0 To 7
                    If pixels((row * 8) + bit)(column) Then
                        pages(row)(column) = pages(row)(column) Or Convert.ToByte(1 << bit)
                    End If
                Next bit
            Next column
        Next row

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

        Dim section() As Byte = New Byte(64) {}

        For row As Integer = 0 To HEIGHT \ 8 - 1
            For column As Integer = 0 To WIDTH - 1 Step 64
                Array.Copy(pages(row), column, section, 0, 64)
                oled.Write(section)
            Next column
        Next row
    End Sub

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

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

        ' Clear display
        oled.ClearDisplay()

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

        For row As Integer = 0 To HEIGHT - 1
            pixels(row) = New Boolean(WIDTH) {}

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

        DrawMatrix(oled, pixels)

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

Scribble¶

Download (ExampleScribble.vb)

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

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

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

    Sub DrawImage(ByRef oled As BrickletOLED128x64, ByVal bitmap As Bitmap)
        Dim pages()() As Byte = New Byte(HEIGHT \ 8)() {}

        For row As Integer = 0 To HEIGHT \ 8 - 1
            pages(row) = New Byte(WIDTH) {}

            For column As Integer = 0 To WIDTH - 1
                pages(row)(column) = 0

                For bit As Integer = 0 To 7
                    If bitmap.GetPixel(column, (row * 8) + bit).GetBrightness() > 0 Then
                        pages(row)(column) = pages(row)(column) Or Convert.ToByte(1 << bit)
                    End If
                Next bit
            Next column
        Next row

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

        Dim section() As Byte = New Byte(64) {}

        For row As Integer = 0 To HEIGHT \ 8 - 1
            For column As Integer = 0 To WIDTH - 1 Step 64
                Array.Copy(pages(row), column, section, 0, 64)
                oled.Write(section)
            Next column
        Next row
    End Sub

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

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

        ' Clear display
        oled.ClearDisplay()

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

        Console.WriteLine("Press enter to exit")

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

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

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

            angle += 1
        End While

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

Grundfunktionen¶

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

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

Dim oled128x64 As New BrickletOLED128x64("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

Sub BrickletOLED128x64.Write(ByVal data() As Byte)¶

Parameter:	data – Typ: Byte Array, Länge: 64, Wertebereich: [0 bis 255]

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.

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.

Sub BrickletOLED128x64.NewWindow(ByVal columnFrom As Byte, ByVal columnTo As Byte, ByVal rowFrom As Byte, ByVal rowTo As Byte)¶

Parameter:	columnFrom – Typ: Byte, Wertebereich: [0 bis 127] columnTo – Typ: Byte, Wertebereich: [0 bis 127] rowFrom – Typ: Byte, Wertebereich: [0 bis 7] rowTo – Typ: Byte, Wertebereich: [0 bis 7]

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

Sub BrickletOLED128x64.ClearDisplay()¶

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

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

Parameter:	line – Typ: Byte, Wertebereich: [0 bis 7] position – Typ: Byte, Wertebereich: [0 bis 25] text – Typ: String, Länge: bis zu 26

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.

Der der Zeichensatz entspricht Codepage 437.

Fortgeschrittene Funktionen¶

Sub BrickletOLED128x64.SetDisplayConfiguration(ByVal contrast As Byte, ByVal invert As Boolean)¶

Parameter:	contrast – Typ: Byte, Wertebereich: [0 bis 255], Standardwert: 143 invert – Typ: Boolean, Standardwert: false

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.

Sub BrickletOLED128x64.GetDisplayConfiguration(ByRef contrast As Byte, ByRef invert As Boolean)¶

Ausgabeparameter:	contrast – Typ: Byte, Wertebereich: [0 bis 255], Standardwert: 143 invert – Typ: Boolean, Standardwert: false

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

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

Ausgabeparameter:

uid – Typ: String, Länge: bis zu 8 connectedUid – Typ: String, Länge: bis zu 8 position – Typ: Char, Wertebereich: ["a"C bis "h"C, "z"C] hardwareVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255] deviceIdentifier – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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.

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.

Function BrickletOLED128x64.GetAPIVersion() As Byte()¶

Ausgabeparameter:	apiVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255]

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.

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

Parameter:	functionId – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: Boolean

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:

• BrickletOLED128x64.FUNCTION_WRITE = 1
• BrickletOLED128x64.FUNCTION_NEW_WINDOW = 2
• BrickletOLED128x64.FUNCTION_CLEAR_DISPLAY = 3
• BrickletOLED128x64.FUNCTION_SET_DISPLAY_CONFIGURATION = 4
• BrickletOLED128x64.FUNCTION_WRITE_LINE = 6

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

Parameter:	functionId – Typ: Byte, Wertebereich: Siehe Konstanten responseExpected – Typ: Boolean

Ä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:

• BrickletOLED128x64.FUNCTION_WRITE = 1
• BrickletOLED128x64.FUNCTION_NEW_WINDOW = 2
• BrickletOLED128x64.FUNCTION_CLEAR_DISPLAY = 3
• BrickletOLED128x64.FUNCTION_SET_DISPLAY_CONFIGURATION = 4
• BrickletOLED128x64.FUNCTION_WRITE_LINE = 6

Sub BrickletOLED128x64.SetResponseExpectedAll(ByVal responseExpected As Boolean)¶

Parameter:	responseExpected – Typ: Boolean

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

Konstanten¶

Const BrickletOLED128x64.DEVICE_IDENTIFIER¶

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

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

Const BrickletOLED128x64.DEVICE_DISPLAY_NAME¶

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