Perl - OLED 64x48 Bricklet

Dies ist die Beschreibung der Perl 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 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
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletOLED64x48;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your OLED 64x48 Bricklet

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $oled = Tinkerforge::BrickletOLED64x48->new(&UID, $ipcon); # Create device object

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Clear display
$oled->clear_display();

# Write "Hello World" starting from upper left corner of the screen
$oled->write_line(0, 0, "Hello World");

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

Pixel Matrix

Download (example_pixel_matrix.pl)

 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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletOLED64x48;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your OLED 64x48 Bricklet
use constant WIDTH => 64;
use constant HEIGHT => 48;

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $oled = Tinkerforge::BrickletOLED64x48->new(&UID, $ipcon); # Create device object

sub draw_matrix
{
    my ($oled, $pixels_ref) = @_;
    my @pixels = @{$pixels_ref};
    my @pages = ();

    foreach my $row (0..&HEIGHT / 8 - 1) {
        $pages[$row] = ();

        foreach my $column (0..&WIDTH - 1) {
            $pages[$row][$column] = 0;

            foreach my $bit (0..7) {
                if ($pixels[($row * 8) + $bit][$column]) {
                    $pages[$row][$column] |= 1 << $bit;
                }
            }
        }
    }

    $oled->new_window(0, &WIDTH - 1, 0, &HEIGHT / 8 - 1);

    foreach my $row (0..&HEIGHT / 8 - 1) {
        $oled->write($pages[$row]);
    }
}

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Clear display
$oled->clear_display();

# Draw checkerboard pattern
my @pixels = ();

foreach my $row (0..&HEIGHT - 1) {
    $pixels[$row] = ();

    foreach my $column (0..&WIDTH - 1) {
        $pixels[$row][$column] = (($row / 8) % 2) == (($column / 8) % 2);
    }
}

draw_matrix($oled, \@pixels);

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

Scribble

Download (example_scribble.pl)

 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
#!/usr/bin/perl

use strict;
use Math::Trig;
use Term::ReadKey;
use GD;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletOLED64x48;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change to your UID
use constant WIDTH => 64;
use constant HEIGHT => 48;

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $oled = Tinkerforge::BrickletOLED64x48->new(&UID, $ipcon); # Create device object

sub draw_image
{
    my ($oled, $image) = @_;
    my @pages = ();

    foreach my $row (0..&HEIGHT / 8 - 1) {
        $pages[$row] = ();

        foreach my $column (0..&WIDTH - 1) {
            $pages[$row][$column] = 0;

            foreach my $bit (0..7) {
                my $index = $image->getPixel($column, ($row * 8) + $bit);
                my @rgb = $image->rgb($index);

                if ($rgb[0] > 0) {
                    $pages[$row][$column] |= 1 << $bit;
                }
            }
        }
    }

    $oled->new_window(0, &WIDTH - 1, 0, &HEIGHT / 8 - 1);

    foreach my $row (0..&HEIGHT / 8 - 1) {
        $oled->write($pages[$row]);
    }
}

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Clear display
$oled->clear_display();

# Draw rotating line
my $image = new GD::Image(&WIDTH, &HEIGHT);
my $black = $image->colorAllocate(0, 0, 0);
my $white = $image->colorAllocate(255, 255, 255);
my $origin_x = &WIDTH / 2;
my $origin_y = &HEIGHT / 2;
my $length = &HEIGHT / 2 - 2;
my $angle = 0;

print "Press key to exit\n";
ReadMode(4);

while (!defined(ReadKey(-1))) {
    my $radians = pi * $angle / 180.0;
    my $x = int($origin_x + $length * cos($radians));
    my $y = int($origin_y + $length * sin($radians));

    $image->filledRectangle(0, 0, &WIDTH, &HEIGHT, $black);
    $image->line($origin_x, $origin_y, $x, $y, $white);

    draw_image($oled, $image);
    sleep 0.025;

    $angle++;
}

ReadMode(0);
$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

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

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

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

$oled_64x48 = BrickletOLED64x48->new("YOUR_DEVICE_UID", $ipcon);

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

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

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

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.

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

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

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

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

BrickletOLED64x48->set_display_configuration($contrast, $invert)
Parameter:
  • $contrast – Typ: int, Wertebereich: [0 bis 255]
  • $invert – Typ: bool
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.

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

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

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

BrickletOLED64x48->get_api_version()
Rückgabe:
  • @api_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]

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.

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

  • 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
BrickletOLED64x48->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:

  • 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
BrickletOLED64x48->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.

BrickletOLED64x48->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
  • 3: @hardware_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • 4: @firmware_version – Typ: [int, ...], Länge: 3, 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 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

BrickletOLED64x48->DEVICE_IDENTIFIER

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

BrickletOLED64x48->DEVICE_DISPLAY_NAME

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