C# - LCD 128x64 Bricklet

Dies ist die Beschreibung der C# 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 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 LCD 128x64 Bricklet

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLCD128x64 lcd = new BrickletLCD128x64(UID, ipcon); // Create device object

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

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

Big Font

Download (ExampleBigFont.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
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 LCD 128x64 Bricklet

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLCD128x64 lcd = new BrickletLCD128x64(UID, ipcon); // Create device object

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

        // Clear display
        lcd.ClearDisplay();

        // Write "Hello World" with big 24x32 font
        lcd.DrawText(0, 0, BrickletLCD128x64.FONT_24X32, BrickletLCD128x64.COLOR_BLACK,
                     "24x32");

        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
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 128x64 Bricklet
    private static byte WIDTH = 128;
    private static byte HEIGHT = 64;

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLCD128x64 lcd = new BrickletLCD128x64(UID, ipcon); // Create device object

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

        // Clear display
        lcd.ClearDisplay();

        // Draw checkerboard pattern
        bool[] pixels = new bool[HEIGHT*WIDTH];

        for (int row = 0; row < HEIGHT; row++)
        {
            for (int column = 0; column < WIDTH; column++)
            {
                pixels[row*WIDTH + column] = (row / 8) % 2 == (column / 8) % 2;
            }
        }
        lcd.WritePixels(0, 0, (byte)(WIDTH-1), (byte)(HEIGHT-1), 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
using System;
using System.Drawing;
using System.Threading;
using Tinkerforge;

// Tested with 
// > mcs /reference:System.Drawing.dll /target:exe /out:Example.exe /reference:Tinkerforge.dll ExampleScribble.cs

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 = 128;
    private static int HEIGHT = 64;

    private static void DrawBitmap(BrickletLCD128x64 lcd, Bitmap bitmap)
    {
        bool[] pixels = new bool[HEIGHT*WIDTH];

        for (int row = 0; row < HEIGHT; row++)
        {
            for (int column = 0; column < WIDTH; column++)
            {
                pixels[row*WIDTH + column] = bitmap.GetPixel(column, row).GetBrightness() > 0;
            }
        }

        lcd.WritePixels(0, 0, (byte)(WIDTH-1), (byte)(HEIGHT-1), pixels);
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLCD128x64 lcd = new BrickletLCD128x64(UID, ipcon); // Create device object

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

        // Clear display
        lcd.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(lcd, bitmap);
            Thread.Sleep(25);

            angle++;
        }

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

Touch

Download (ExampleTouch.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
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 LCD 128x64 Bricklet

    // Callback function for touch position callback
    static void TouchPositionCB(BrickletLCD128x64 sender, int pressure, int x, int y,
                                long age)
    {
        Console.WriteLine("Pressure: " + pressure);
        Console.WriteLine("X: " + x);
        Console.WriteLine("Y: " + y);
        Console.WriteLine("Age: " + age);
        Console.WriteLine("");
    }

    // Callback function for touch gesture callback
    static void TouchGestureCB(BrickletLCD128x64 sender, byte gesture, long duration,
                               int pressureMax, int xStart, int xEnd, int yStart,
                               int yEnd, long age)
    {
        if(gesture == BrickletLCD128x64.GESTURE_LEFT_TO_RIGHT)
        {
            Console.WriteLine("Gesture: Left To Right");
        }
        else if(gesture == BrickletLCD128x64.GESTURE_RIGHT_TO_LEFT)
        {
            Console.WriteLine("Gesture: Right To Left");
        }
        else if(gesture == BrickletLCD128x64.GESTURE_TOP_TO_BOTTOM)
        {
            Console.WriteLine("Gesture: Top To Bottom");
        }
        else if(gesture == BrickletLCD128x64.GESTURE_BOTTOM_TO_TOP)
        {
            Console.WriteLine("Gesture: Bottom To Top");
        }

        Console.WriteLine("Duration: " + duration);
        Console.WriteLine("Pressure Max: " + pressureMax);
        Console.WriteLine("X Start: " + xStart);
        Console.WriteLine("X End: " + xEnd);
        Console.WriteLine("Y Start: " + yStart);
        Console.WriteLine("Y End: " + yEnd);
        Console.WriteLine("Age: " + age);
        Console.WriteLine("");
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLCD128x64 lcd = new BrickletLCD128x64(UID, ipcon); // Create device object

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

        // Register touch position callback to function TouchPositionCB
        lcd.TouchPositionCallback += TouchPositionCB;

        // Register touch gesture callback to function TouchGestureCB
        lcd.TouchGestureCallback += TouchGestureCB;

        // 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);

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

GUI

Download (ExampleGUI.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 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 LCD 128x64 Bricklet

    // Callback function for GUI button pressed callback
    static void GUIButtonPressedCB(BrickletLCD128x64 sender, byte index, bool pressed)
    {
        Console.WriteLine("Index: " + index);
        Console.WriteLine("Pressed: " + pressed);
        Console.WriteLine("");
    }

    // Callback function for GUI slider value callback
    static void GUISliderValueCB(BrickletLCD128x64 sender, byte index, byte value)
    {
        Console.WriteLine("Index: " + index);
        Console.WriteLine("Value: " + value);
        Console.WriteLine("");
    }

    // Callback function for GUI tab selected callback
    static void GUITabSelectedCB(BrickletLCD128x64 sender, short index)
    {
        Console.WriteLine("Index: " + index);
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLCD128x64 lcd = new BrickletLCD128x64(UID, ipcon); // Create device object

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

        // Register GUI button pressed callback to function GUIButtonPressedCB
        lcd.GUIButtonPressedCallback += GUIButtonPressedCB;

        // Register GUI slider value callback to function GUISliderValueCB
        lcd.GUISliderValueCallback += GUISliderValueCB;

        // Register GUI tab selected callback to function GUITabSelectedCB
        lcd.GUITabSelectedCallback += GUITabSelectedCB;

        // 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, BrickletLCD128x64.DIRECTION_HORIZONTAL, 50);
        lcd.SetGUIGraphConfiguration(0, BrickletLCD128x64.GRAPH_TYPE_LINE, 62, 0, 60, 52,
                                     "X", "Y");

        // Add a few data points (the remaining points will be 0)
        lcd.SetGUIGraphData(0,
                            new byte[]{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(BrickletLCD128x64.CHANGE_TAB_ON_CLICK_AND_SWIPE,
                                   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);

        Console.WriteLine("Press enter to exit");
        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 BrickletLCD128x64(String uid, IPConnection ipcon)

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

BrickletLCD128x64 lcd128x64 = new BrickletLCD128x64("YOUR_DEVICE_UID", ipcon);

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

public void WritePixels(byte xStart, byte yStart, byte xEnd, byte yEnd, bool[] pixels)

Schreibt Pixel in das angegebene Fenster.

Die X-Achse läuft von 0 bis 127 und die Y-Achse von 0 bis 63. 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.

public bool[] ReadPixels(byte xStart, byte yStart, byte xEnd, byte yEnd)

Liest Pixel aus dem angegebenen Fenster.

Die X-Achse läuft von 0 bis 127 und die Y-Achse von 0 bis 63. 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.

public void ClearDisplay()

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.

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

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

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.

public void DrawBufferedFrame(bool forceCompleteRedraw)

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.

public void GetTouchPosition(out int pressure, out int x, out int y, out long age)

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

  • Pressure: Anpressdruck des Touches (0-300)
  • X: Touch-Position auf der X-Achse (0-127)
  • Y: Touch-Position auf der Y-Achse (0-63)
  • Age: Alter des Touches in ms (wie lange ist die Erkennung des Touches her)
public void GetTouchGesture(out byte gesture, out long duration, out int pressureMax, out int xStart, out int yStart, out int xEnd, out int yEnd, out long age)

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).

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

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

  • BrickletLCD128x64.GESTURE_LEFT_TO_RIGHT = 0
  • BrickletLCD128x64.GESTURE_RIGHT_TO_LEFT = 1
  • BrickletLCD128x64.GESTURE_TOP_TO_BOTTOM = 2
  • BrickletLCD128x64.GESTURE_BOTTOM_TO_TOP = 3
public void DrawLine(byte positionXStart, byte positionYStart, byte positionXEnd, byte positionYEnd, bool color)

Zeichnet eine weiße oder schwarze Linie von (x, y)-start nach (x, y)-end. Der Wertebereich für die x-Werte ist 0 bis 127 und der Wertebereich für die y-Werte ist 0-63.

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

  • BrickletLCD128x64.COLOR_WHITE = false
  • BrickletLCD128x64.COLOR_BLACK = true

Neu in Version 2.0.2 (Plugin).

public void DrawBox(byte positionXStart, byte positionYStart, byte positionXEnd, byte positionYEnd, bool fill, bool color)

Zeichnet ein weißes oder schwarzes Rechteck von (x, y)-start nach (x, y)-end. Der Wertebereich für die x-Werte ist 0 bis 127 und der Wertebereich für die y-Werte ist 0-63.

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:

  • BrickletLCD128x64.COLOR_WHITE = false
  • BrickletLCD128x64.COLOR_BLACK = true

Neu in Version 2.0.2 (Plugin).

public void DrawText(byte positionX, byte positionY, byte font, bool color, string text)

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

Die Wertebereich für die x-Werte ist 0 bis 127 und der Wertebereich für die y-Werte ist 0-63.

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

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

  • BrickletLCD128x64.FONT_6X8 = 0
  • BrickletLCD128x64.FONT_6X16 = 1
  • BrickletLCD128x64.FONT_6X24 = 2
  • BrickletLCD128x64.FONT_6X32 = 3
  • BrickletLCD128x64.FONT_12X16 = 4
  • BrickletLCD128x64.FONT_12X24 = 5
  • BrickletLCD128x64.FONT_12X32 = 6
  • BrickletLCD128x64.FONT_18X24 = 7
  • BrickletLCD128x64.FONT_18X32 = 8
  • BrickletLCD128x64.FONT_24X32 = 9
  • BrickletLCD128x64.COLOR_WHITE = false
  • BrickletLCD128x64.COLOR_BLACK = true

Neu in Version 2.0.2 (Plugin).

public void SetGUIButton(byte index, byte positionX, byte positionY, byte width, byte height, string text)

Zeichnet einen klickbaren Button an Position (x, y) mit dem gegebenem Text von bis zu 16 Zeichen.

Es können bis zu 12 Buttons genutzt werden (Index 0-11).

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).

public void GetGUIButton(byte index, out bool active, out byte positionX, out byte positionY, out byte width, out byte height, out string text)

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).

public void RemoveGUIButton(byte index)

Entfernt den Button mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Buttons zu entfernen.

Neu in Version 2.0.2 (Plugin).

public bool GetGUIButtonPressed(byte index)

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).

public void SetGUISlider(byte index, byte positionX, byte positionY, byte length, byte direction, byte value)

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

Es können bis zu 8 Slider genutzt werden (Index 0-7).

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.

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

  • BrickletLCD128x64.DIRECTION_HORIZONTAL = 0
  • BrickletLCD128x64.DIRECTION_VERTICAL = 1

Neu in Version 2.0.2 (Plugin).

public void GetGUISlider(byte index, out bool active, out byte positionX, out byte positionY, out byte length, out byte direction, out byte value)

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:

  • BrickletLCD128x64.DIRECTION_HORIZONTAL = 0
  • BrickletLCD128x64.DIRECTION_VERTICAL = 1

Neu in Version 2.0.2 (Plugin).

public void RemoveGUISlider(byte index)

Entfernt den Slider mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Slider zu entfernen.

Neu in Version 2.0.2 (Plugin).

public byte GetGUISliderValue(byte index)

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

Neu in Version 2.0.2 (Plugin).

public void SetGUITabConfiguration(byte changeTabConfig, bool clearGUI)

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.

Standardmäßig ist klicken und wischen sowie das automatische löschen der GUI aktiviert.

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

  • BrickletLCD128x64.CHANGE_TAB_ON_CLICK = 1
  • BrickletLCD128x64.CHANGE_TAB_ON_SWIPE = 2
  • BrickletLCD128x64.CHANGE_TAB_ON_CLICK_AND_SWIPE = 3

Neu in Version 2.0.2 (Plugin).

public void GetGUITabConfiguration(out byte changeTabConfig, out bool clearGUI)

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

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

  • BrickletLCD128x64.CHANGE_TAB_ON_CLICK = 1
  • BrickletLCD128x64.CHANGE_TAB_ON_SWIPE = 2
  • BrickletLCD128x64.CHANGE_TAB_ON_CLICK_AND_SWIPE = 3

Neu in Version 2.0.2 (Plugin).

public void SetGUITabText(byte index, string text)

Fügt einen Text-Tab mit dem gegebenen Index hinzu. Der Text kann eine Länge von bis zu 5 Buchstaben haben.

Es können bis zu 10 Tabs verwendet werden (Index 0-9).

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

Neu in Version 2.0.2 (Plugin).

public void GetGUITabText(byte index, out bool active, out string text)

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).

public void SetGUITabIcon(byte index, bool[] icon)

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 (Index 0-9).

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

Neu in Version 2.0.2 (Plugin).

public void GetGUITabIcon(byte index, out bool active, out bool[] icon)

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).

public void RemoveGUITab(byte index)

Entfernt den Tab mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Tabs zu entfernen.

Neu in Version 2.0.2 (Plugin).

public void SetGUITabSelected(byte index)

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

Neu in Version 2.0.2 (Plugin).

public short GetGUITabSelected()

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).

public void SetGUIGraphConfiguration(byte index, byte graphType, byte positionX, byte positionY, byte width, byte height, string textX, string textY)

Setzt die Konfiguration für bis zu vier Graphen (Index 0-3).

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

Die x- und y-Positionen sind Pixel-Positionen. Diese sind im Wertebereich von (0, 0) bis (127, 63). Die Maximale Breite (width) ist 118 und die maximale Höhe (height) ist 63.

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:

  • BrickletLCD128x64.GRAPH_TYPE_DOT = 0
  • BrickletLCD128x64.GRAPH_TYPE_LINE = 1
  • BrickletLCD128x64.GRAPH_TYPE_BAR = 2

Neu in Version 2.0.2 (Plugin).

public void GetGUIGraphConfiguration(byte index, out bool active, out byte graphType, out byte positionX, out byte positionY, out byte width, out byte height, out string textX, out string textY)

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:

  • BrickletLCD128x64.GRAPH_TYPE_DOT = 0
  • BrickletLCD128x64.GRAPH_TYPE_LINE = 1
  • BrickletLCD128x64.GRAPH_TYPE_BAR = 2

Neu in Version 2.0.2 (Plugin).

public void SetGUIGraphData(byte index, byte[] data)

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).

public byte[] GetGUIGraphData(byte index)

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

Neu in Version 2.0.2 (Plugin).

public void RemoveGUIGraph(byte index)

Entfernt den Graph mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Graphen zu entfernen.

Neu in Version 2.0.2 (Plugin).

public void RemoveAllGUI()

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

Neu in Version 2.0.2 (Plugin).

Fortgeschrittene Funktionen

public void SetDisplayConfiguration(byte contrast, byte backlight, bool invert, bool automaticDraw)

Setzt die Konfiguration des Displays.

Der Kontrast kann zwischen 0 und 63, die Backlight-Intensität zwischen 0 und 100 und das Farbschema invertiert (weiß/schwarz) eingestellt werden.

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.

Standardwerte: Kontrast 14, Backlight-Intensität 100, Invertierung aus und Automatic Draw aktiviert.

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

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

public void SetTouchLEDConfig(byte config)

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 Bootlodermodus befindet ist die LED aus.

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

  • BrickletLCD128x64.TOUCH_LED_CONFIG_OFF = 0
  • BrickletLCD128x64.TOUCH_LED_CONFIG_ON = 1
  • BrickletLCD128x64.TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletLCD128x64.TOUCH_LED_CONFIG_SHOW_TOUCH = 3

Neu in Version 2.0.2 (Plugin).

public byte GetTouchLEDConfig()

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

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

  • BrickletLCD128x64.TOUCH_LED_CONFIG_OFF = 0
  • BrickletLCD128x64.TOUCH_LED_CONFIG_ON = 1
  • BrickletLCD128x64.TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletLCD128x64.TOUCH_LED_CONFIG_SHOW_TOUCH = 3

Neu in Version 2.0.2 (Plugin).

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:

  • BrickletLCD128x64.FUNCTION_WRITE_PIXELS = 1
  • BrickletLCD128x64.FUNCTION_CLEAR_DISPLAY = 3
  • BrickletLCD128x64.FUNCTION_SET_DISPLAY_CONFIGURATION = 4
  • BrickletLCD128x64.FUNCTION_WRITE_LINE = 6
  • BrickletLCD128x64.FUNCTION_DRAW_BUFFERED_FRAME = 7
  • BrickletLCD128x64.FUNCTION_SET_TOUCH_POSITION_CALLBACK_CONFIGURATION = 9
  • BrickletLCD128x64.FUNCTION_SET_TOUCH_GESTURE_CALLBACK_CONFIGURATION = 13
  • BrickletLCD128x64.FUNCTION_DRAW_LINE = 16
  • BrickletLCD128x64.FUNCTION_DRAW_BOX = 17
  • BrickletLCD128x64.FUNCTION_DRAW_TEXT = 18
  • BrickletLCD128x64.FUNCTION_SET_GUI_BUTTON = 19
  • BrickletLCD128x64.FUNCTION_REMOVE_GUI_BUTTON = 21
  • BrickletLCD128x64.FUNCTION_SET_GUI_BUTTON_PRESSED_CALLBACK_CONFIGURATION = 22
  • BrickletLCD128x64.FUNCTION_SET_GUI_SLIDER = 26
  • BrickletLCD128x64.FUNCTION_REMOVE_GUI_SLIDER = 28
  • BrickletLCD128x64.FUNCTION_SET_GUI_SLIDER_VALUE_CALLBACK_CONFIGURATION = 29
  • BrickletLCD128x64.FUNCTION_SET_GUI_TAB_CONFIGURATION = 33
  • BrickletLCD128x64.FUNCTION_SET_GUI_TAB_TEXT = 35
  • BrickletLCD128x64.FUNCTION_SET_GUI_TAB_ICON = 37
  • BrickletLCD128x64.FUNCTION_REMOVE_GUI_TAB = 39
  • BrickletLCD128x64.FUNCTION_SET_GUI_TAB_SELECTED = 40
  • BrickletLCD128x64.FUNCTION_SET_GUI_TAB_SELECTED_CALLBACK_CONFIGURATION = 41
  • BrickletLCD128x64.FUNCTION_SET_GUI_GRAPH_CONFIGURATION = 45
  • BrickletLCD128x64.FUNCTION_SET_GUI_GRAPH_DATA = 47
  • BrickletLCD128x64.FUNCTION_REMOVE_GUI_GRAPH = 49
  • BrickletLCD128x64.FUNCTION_REMOVE_ALL_GUI = 50
  • BrickletLCD128x64.FUNCTION_SET_TOUCH_LED_CONFIG = 51
  • BrickletLCD128x64.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletLCD128x64.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletLCD128x64.FUNCTION_RESET = 243
  • BrickletLCD128x64.FUNCTION_WRITE_UID = 248
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 GetSPITFPErrorCount(out long errorCountAckChecksum, out long errorCountMessageChecksum, out long errorCountFrame, out long errorCountOverflow)

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.

public byte SetBootloaderMode(byte mode)

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

  • BrickletLCD128x64.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletLCD128x64.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletLCD128x64.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletLCD128x64.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletLCD128x64.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletLCD128x64.BOOTLOADER_STATUS_OK = 0
  • BrickletLCD128x64.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletLCD128x64.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletLCD128x64.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletLCD128x64.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletLCD128x64.BOOTLOADER_STATUS_CRC_MISMATCH = 5
public byte GetBootloaderMode()

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

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

  • BrickletLCD128x64.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletLCD128x64.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletLCD128x64.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletLCD128x64.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletLCD128x64.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
public void SetWriteFirmwarePointer(long pointer)

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.

public byte WriteFirmware(byte[] data)

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.

public void SetStatusLEDConfig(byte config)

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:

  • BrickletLCD128x64.STATUS_LED_CONFIG_OFF = 0
  • BrickletLCD128x64.STATUS_LED_CONFIG_ON = 1
  • BrickletLCD128x64.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletLCD128x64.STATUS_LED_CONFIG_SHOW_STATUS = 3
public byte GetStatusLEDConfig()

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

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

  • BrickletLCD128x64.STATUS_LED_CONFIG_OFF = 0
  • BrickletLCD128x64.STATUS_LED_CONFIG_ON = 1
  • BrickletLCD128x64.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletLCD128x64.STATUS_LED_CONFIG_SHOW_STATUS = 3
public short GetChipTemperature()

Gibt die Temperatur in °C, 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.

public void Reset()

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.

public void WriteUID(long uid)

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.

public long ReadUID()

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

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.

Konfigurationsfunktionen für Callbacks

public void SetTouchPositionCallbackConfiguration(long period, bool valueHasToChange)

Die Periode in ms 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.

Der Standardwert ist (0, false).

public void GetTouchPositionCallbackConfiguration(out long period, out bool valueHasToChange)

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

public void SetTouchGestureCallbackConfiguration(long period, bool valueHasToChange)

Die Periode in ms ist die Periode mit der der TouchGestureCallback 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.

Der Standardwert ist (0, false).

public void GetTouchGestureCallbackConfiguration(out long period, out bool valueHasToChange)

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

public void SetGUIButtonPressedCallbackConfiguration(long period, bool valueHasToChange)

Die Periode in ms ist die Periode mit der der GUIButtonPressedCallback 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.

Der Standardwert ist (0, false).

Neu in Version 2.0.2 (Plugin).

public void GetGUIButtonPressedCallbackConfiguration(out long period, out bool valueHasToChange)

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

Neu in Version 2.0.2 (Plugin).

public void SetGUISliderValueCallbackConfiguration(long period, bool valueHasToChange)

Die Periode in ms ist die Periode mit der der GUISliderValueCallback 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.

Der Standardwert ist (0, false).

Neu in Version 2.0.2 (Plugin).

public void GetGUISliderValueCallbackConfiguration(out long period, out bool valueHasToChange)

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

Neu in Version 2.0.2 (Plugin).

public void SetGUITabSelectedCallbackConfiguration(long period, bool valueHasToChange)

Die Periode in ms ist die Periode mit der der GUITabSelectedCallback 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.

Der Standardwert ist (0, false).

Neu in Version 2.0.2 (Plugin).

public void GetGUITabSelectedCallbackConfiguration(out long period, out bool valueHasToChange)

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 geschieht durch Anhängen des Callback Handlers an den passenden Event:

void MyCallback(BrickletLCD128x64 sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

lcd128x64.ExampleCallback += MyCallback;

Die verfügbaren Events werden weiter unten beschrieben.

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.

public event TouchPositionCallback(BrickletLCD128x64 sender, int pressure, int x, int y, long age)

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

public event TouchGestureCallback(BrickletLCD128x64 sender, byte gesture, long duration, int pressureMax, int xStart, int yStart, int xEnd, int yEnd, long age)

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

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

  • BrickletLCD128x64.GESTURE_LEFT_TO_RIGHT = 0
  • BrickletLCD128x64.GESTURE_RIGHT_TO_LEFT = 1
  • BrickletLCD128x64.GESTURE_TOP_TO_BOTTOM = 2
  • BrickletLCD128x64.GESTURE_BOTTOM_TO_TOP = 3
public event GUIButtonPressedCallback(BrickletLCD128x64 sender, byte index, bool pressed)

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

Neu in Version 2.0.2 (Plugin).

public event GUISliderValueCallback(BrickletLCD128x64 sender, byte index, byte value)

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

Neu in Version 2.0.2 (Plugin).

public event GUITabSelectedCallback(BrickletLCD128x64 sender, short index)

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

Neu in Version 2.0.2 (Plugin).

Konstanten

public int DEVICE_IDENTIFIER

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

public string DEVICE_DISPLAY_NAME

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