C# - OLED 64x48 Bricklet

Dies ist die Beschreibung der C# API Bindings für das OLED 64x48 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des OLED 64x48 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die C# API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Hello World

Download (ExampleHelloWorld.cs)

 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
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your OLED 64x48 Bricklet

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletOLED64x48 oled = new BrickletOLED64x48(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 enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Pixel Matrix

Download (ExamplePixelMatrix.cs)

 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
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your OLED 64x48 Bricklet
    private static int WIDTH = 64;
    private static int HEIGHT = 48;

    private static void DrawMatrix(BrickletOLED64x48 oled, bool[][] pixels)
    {
        byte[][] pages = new byte[HEIGHT / 8][];

        for (int row = 0; row < HEIGHT / 8; row++)
        {
            pages[row] = new byte[WIDTH];

            for (int column = 0; column < WIDTH; column++)
            {
                pages[row][column] = 0;

                for (int bit = 0; bit < 8; bit++)
                {
                    if (pixels[(row * 8) + bit][column])
                    {
                        pages[row][column] |= (byte)(1 << bit);
                    }
                }
            }
        }

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

        for (int row = 0; row < HEIGHT / 8; row++)
        {
            oled.Write(pages[row]);
        }
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletOLED64x48 oled = new BrickletOLED64x48(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
        bool[][] pixels = new bool[HEIGHT][];

        for (int row = 0; row < HEIGHT; row++)
        {
            pixels[row] = new bool[WIDTH];

            for (int column = 0; column < WIDTH; column++)
            {
                pixels[row][column] = (row / 8) % 2 == (column / 8) % 2;
            }
        }

        DrawMatrix(oled, pixels);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Scribble

Download (ExampleScribble.cs)

 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
83
84
85
using System;
using System.Drawing;
using System.Threading;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change to your UID
    private static int WIDTH = 64;
    private static int HEIGHT = 48;

    private static void DrawBitmap(BrickletOLED64x48 oled, Bitmap bitmap)
    {
        byte[][] pages = new byte[HEIGHT / 8][];

        for (int row = 0; row < HEIGHT / 8; row++)
        {
            pages[row] = new byte[WIDTH];

            for (int column = 0; column < WIDTH; column++)
            {
                pages[row][column] = 0;

                for (int bit = 0; bit < 8; bit++)
                {
                    if (bitmap.GetPixel(column, (row * 8) + bit).GetBrightness() > 0)
                    {
                        pages[row][column] |= (byte)(1 << bit);
                    }
                }
            }
        }

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

        for (int row = 0; row < HEIGHT / 8; row++)
        {
            oled.Write(pages[row]);
        }
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletOLED64x48 oled = new BrickletOLED64x48(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
        Bitmap bitmap = new Bitmap(WIDTH, HEIGHT);
        int originX = WIDTH / 2;
        int originY = HEIGHT / 2;
        int length = HEIGHT / 2 - 2;
        int angle = 0;

        Console.WriteLine("Press enter to exit");

        while (!Console.KeyAvailable)
        {
            double radians = Math.PI * angle / 180.0;
            int x = (int)(originX + length * Math.Cos(radians));
            int y = (int)(originY + length * Math.Sin(radians));

            using (Graphics g = Graphics.FromImage(bitmap))
            {
                g.FillRectangle(Brushes.Black, 0, 0, WIDTH, HEIGHT);
                g.DrawLine(Pens.White, originX, originY, x, y);
            }

            DrawBitmap(oled, bitmap);
            Thread.Sleep(25);

            angle++;
        }

        Console.ReadLine();
        ipcon.Disconnect();
    }
}

API

Prinzipiell kann jede Funktion der C# Bindings, welche einen Wert zurück gibt eine Tinkerforge.TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Da C# nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

public class BrickletOLED64x48(String uid, IPConnection ipcon)

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

BrickletOLED64x48 oled64x48 = new BrickletOLED64x48("YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

public void Write(byte[] data)

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 63 und Zeile (Row) von 0 bis 5 (das ganze Display) aufgerufen wird, schreibt jedes Write() (roter Pfeil) eine 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 Zeile usw. Um das ganze Display zu füllen muss Write() 6 mal aufgerufen werden.

public void NewWindow(byte columnFrom, byte columnTo, byte rowFrom, byte rowTo)

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 63 und die Zeilen haben einen Wertebereich von 0 bis 5.

public void ClearDisplay()

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

public void WriteLine(byte line, byte position, string text)

Schreibt einen Text in die angegebene Zeile (0 bis 5) mit einer vorgegebenen Position (0 bis 12). Der Text kann maximal 13 Zeichen lang sein.

Beispiel: (1, 4, "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

public void SetDisplayConfiguration(byte contrast, bool invert)

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.

public void GetDisplayConfiguration(out byte contrast, out bool invert)

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

public byte[] GetAPIVersion()

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.

public bool GetResponseExpected(byte functionId)

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.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

public void SetResponseExpected(byte functionId, bool responseExpected)

Ä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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletOLED64x48.FUNCTION_WRITE = 1
  • BrickletOLED64x48.FUNCTION_NEW_WINDOW = 2
  • BrickletOLED64x48.FUNCTION_CLEAR_DISPLAY = 3
  • BrickletOLED64x48.FUNCTION_SET_DISPLAY_CONFIGURATION = 4
  • BrickletOLED64x48.FUNCTION_WRITE_LINE = 6
public void SetResponseExpectedAll(bool responseExpected)

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

public void GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)

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

public int DEVICE_IDENTIFIER

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

public string DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines OLED 64x48 Bricklet dar.