Deutsch
English
Menu

Perl - OLED 128x64 Bricklet

Dies ist die Beschreibung der Perl 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 Perl API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Hello World

Download (example_hello_world.pl)

 1#!/usr/bin/perl
 2
 3use strict;
 4use Tinkerforge::IPConnection;
 5use Tinkerforge::BrickletOLED128x64;
 6
 7use constant HOST => 'localhost';
 8use constant PORT => 4223;
 9use constant UID => 'XYZ'; # Change XYZ to the UID of your OLED 128x64 Bricklet
10
11my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
12my $oled = Tinkerforge::BrickletOLED128x64->new(&UID, $ipcon); # Create device object
13
14$ipcon->connect(&HOST, &PORT); # Connect to brickd
15# Don't use device before ipcon is connected
16
17# Clear display
18$oled->clear_display();
19
20# Write "Hello World" starting from upper left corner of the screen
21$oled->write_line(0, 0, "Hello World");
22
23print "Press key to exit\n";
24<STDIN>;
25$ipcon->disconnect();

Pixel Matrix

Download (example_pixel_matrix.pl)

 1#!/usr/bin/perl
 2
 3use strict;
 4use Tinkerforge::IPConnection;
 5use Tinkerforge::BrickletOLED128x64;
 6
 7use constant HOST => 'localhost';
 8use constant PORT => 4223;
 9use constant UID => 'XYZ'; # Change XYZ to the UID of your OLED 128x64 Bricklet
10use constant WIDTH => 128;
11use constant HEIGHT => 64;
12
13sub draw_matrix
14{
15    my ($oled, $pixels_ref) = @_;
16    my @pixels = @{$pixels_ref};
17    my @pages = ();
18
19    foreach my $row (0..&HEIGHT / 8 - 1) {
20        $pages[$row] = ();
21
22        foreach my $column (0..&WIDTH - 1) {
23            $pages[$row][$column] = 0;
24
25            foreach my $bit (0..7) {
26                if ($pixels[($row * 8) + $bit][$column]) {
27                    $pages[$row][$column] |= 1 << $bit;
28                }
29            }
30        }
31    }
32
33    $oled->new_window(0, &WIDTH - 1, 0, &HEIGHT / 8 - 1);
34
35    foreach my $row (0..&HEIGHT / 8 - 1) {
36        for (my $column = 0; $column < &WIDTH; $column += 64) {
37            my @section = @{$pages[$row]}[$column..$column + 64];
38
39            $oled->write(\@section);
40        }
41    }
42}
43
44my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
45my $oled = Tinkerforge::BrickletOLED128x64->new(&UID, $ipcon); # Create device object
46
47$ipcon->connect(&HOST, &PORT); # Connect to brickd
48# Don't use device before ipcon is connected
49
50# Clear display
51$oled->clear_display();
52
53# Draw checkerboard pattern
54my @pixels = ();
55
56foreach my $row (0..&HEIGHT - 1) {
57    $pixels[$row] = ();
58
59    foreach my $column (0..&WIDTH - 1) {
60        $pixels[$row][$column] = (($row / 8) % 2) == (($column / 8) % 2);
61    }
62}
63
64draw_matrix($oled, \@pixels);
65
66print "Press key to exit\n";
67<STDIN>;
68$ipcon->disconnect();

Scribble

Download (example_scribble.pl)

 1#!/usr/bin/perl
 2
 3use strict;
 4use Math::Trig;
 5use Term::ReadKey;
 6use GD;
 7use Tinkerforge::IPConnection;
 8use Tinkerforge::BrickletOLED128x64;
 9
10use constant HOST => 'localhost';
11use constant PORT => 4223;
12use constant UID => 'XYZ'; # Change XYZ to the UID of your OLED 128x64 Bricklet
13use constant WIDTH => 128;
14use constant HEIGHT => 64;
15
16my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
17my $oled = Tinkerforge::BrickletOLED128x64->new(&UID, $ipcon); # Create device object
18
19sub draw_image
20{
21    my ($oled, $image) = @_;
22    my @pages = ();
23
24    foreach my $row (0..&HEIGHT / 8 - 1) {
25        $pages[$row] = ();
26
27        foreach my $column (0..&WIDTH - 1) {
28            $pages[$row][$column] = 0;
29
30            foreach my $bit (0..7) {
31                my $index = $image->getPixel($column, ($row * 8) + $bit);
32                my @rgb = $image->rgb($index);
33
34                if ($rgb[0] > 0) {
35                    $pages[$row][$column] |= 1 << $bit;
36                }
37            }
38        }
39    }
40
41    $oled->new_window(0, &WIDTH - 1, 0, &HEIGHT / 8 - 1);
42
43    foreach my $row (0..&HEIGHT / 8 - 1) {
44        for (my $column = 0; $column < &WIDTH; $column += 64) {
45            my @section = @{$pages[$row]}[$column..$column + 64];
46
47            $oled->write(\@section);
48        }
49    }
50}
51
52$ipcon->connect(&HOST, &PORT); # Connect to brickd
53# Don't use device before ipcon is connected
54
55# Clear display
56$oled->clear_display();
57
58# Draw rotating line
59my $image = new GD::Image(&WIDTH, &HEIGHT);
60my $black = $image->colorAllocate(0, 0, 0);
61my $white = $image->colorAllocate(255, 255, 255);
62my $origin_x = &WIDTH / 2;
63my $origin_y = &HEIGHT / 2;
64my $length = &HEIGHT / 2 - 2;
65my $angle = 0;
66
67print "Press key to exit\n";
68ReadMode(4);
69
70while (!defined(ReadKey(-1))) {
71    my $radians = pi * $angle / 180.0;
72    my $x = int($origin_x + $length * cos($radians));
73    my $y = int($origin_y + $length * sin($radians));
74
75    $image->filledRectangle(0, 0, &WIDTH, &HEIGHT, $black);
76    $image->line($origin_x, $origin_y, $x, $y, $white);
77
78    draw_image($oled, $image);
79    sleep 0.025;
80
81    $angle++;
82}
83
84ReadMode(0);
85$ipcon->disconnect();

API

Allgemein kann jede Subroutine der Perl Bindings Fehler als Tinkerforge::Error Objekt mittels croak() melden. Das Objekt hat eine get_code() und eine get_message() Subroutine. Es sind verschiedene Fehlercodes definiert:

  • Error->ALREADY_CONNECTED = 11

  • Error->NOT_CONNECTED = 12

  • Error->CONNECT_FAILED = 13

  • Error->INVALID_FUNCTION_ID = 21

  • Error->TIMEOUT = 31

  • Error->INVALID_PARAMETER = 41

  • Error->FUNCTION_NOT_SUPPORTED = 42

  • Error->UNKNOWN_ERROR = 43

  • Error->STREAM_OUT_OF_SYNC = 51

  • Error->INVALID_UID = 61

  • Error->NON_ASCII_CHAR_IN_SECRET = 71

  • Error->WRONG_DEVICE_TYPE = 81

  • Error->DEVICE_REPLACED = 82

  • Error->WRONG_RESPONSE_LENGTH = 83

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickletOLED128x64->new($uid, $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $oled_128x64 – Typ: BrickletOLED128x64

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

$oled_128x64 = BrickletOLED128x64->new("YOUR_DEVICE_UID", $ipcon);

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

BrickletOLED128x64->write(\\@data)
Parameter:
  • \@data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • undef

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

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

Beispiel: Wenn new_window() 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.

BrickletOLED128x64->new_window($column_from, $column_to, $row_from, $row_to)
Parameter:
  • $column_from – Typ: int, Wertebereich: [0 bis 127]
  • $column_to – Typ: int, Wertebereich: [0 bis 127]
  • $row_from – Typ: int, Wertebereich: [0 bis 7]
  • $row_to – Typ: int, Wertebereich: [0 bis 7]
Rückgabe:
  • undef

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

BrickletOLED128x64->clear_display()
Rückgabe:
  • undef

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

BrickletOLED128x64->write_line($line, $position, $text)
Parameter:
  • $line – Typ: int, Wertebereich: [0 bis 7]
  • $position – Typ: int, Wertebereich: [0 bis 25]
  • $text – Typ: string, Länge: bis zu 26
Rückgabe:
  • undef

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

BrickletOLED128x64->set_display_configuration($contrast, $invert)
Parameter:
  • $contrast – Typ: int, Wertebereich: [0 bis 255], Standardwert: 143
  • $invert – Typ: bool, Standardwert: 0
Rückgabe:
  • undef

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.

BrickletOLED128x64->get_display_configuration()
Rückgabe-Array:
  • 0: $contrast – Typ: int, Wertebereich: [0 bis 255], Standardwert: 143
  • 1: $invert – Typ: bool, Standardwert: 0

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

BrickletOLED128x64->get_identity()
Rückgabe-Array:
  • 0: $uid – Typ: string, Länge: bis zu 8
  • 1: $connected_uid – Typ: string, Länge: bis zu 8
  • 2: $position – Typ: char, Wertebereich: ['a' bis 'h', 'z']
  • 3: \@hardware_version – Typ: [int, ...], Länge: 3
    • 0: $major – Typ: int, Wertebereich: [0 bis 255]
    • 1: $minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: $revision – Typ: int, Wertebereich: [0 bis 255]
  • 4: \@firmware_version – Typ: [int, ...], Länge: 3
    • 0: $major – Typ: int, Wertebereich: [0 bis 255]
    • 1: $minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: $revision – Typ: int, Wertebereich: [0 bis 255]
  • 5: $device_identifier – Typ: int, 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.

BrickletOLED128x64->get_api_version()
Rückgabe-Array:
  • 0: \@api_version – Typ: [int, ...], Länge: 3
    • 0: $major – Typ: int, Wertebereich: [0 bis 255]
    • 1: $minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: $revision – Typ: int, 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.

BrickletOLED128x64->get_response_expected($function_id)
Parameter:
  • $function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • $response_expected – Typ: bool

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 set_response_expected(). 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 $function_id:

  • 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

BrickletOLED128x64->set_response_expected($function_id, $response_expected)
Parameter:
  • $function_id – Typ: int, Wertebereich: Siehe Konstanten
  • $response_expected – Typ: bool
Rückgabe:
  • undef

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

  • 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

BrickletOLED128x64->set_response_expected_all($response_expected)
Parameter:
  • $response_expected – Typ: bool
Rückgabe:
  • undef

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

Konstanten

BrickletOLED128x64->DEVICE_IDENTIFIER

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

Die get_identity() Funktion und der IPConnection->CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletOLED128x64->DEVICE_DISPLAY_NAME

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