Shell - OLED 128x64 Bricklet¶

Hello World¶

Download (example-hello-world.sh)

 1#!/bin/sh
 2# Connects to localhost:4223 by default, use --host and --port to change this
 3
 4uid=XYZ # Change XYZ to the UID of your OLED 128x64 Bricklet
 5
 6# Clear display
 7tinkerforge call oled-128x64-bricklet $uid clear-display
 8
 9# Write "Hello World" starting from upper left corner of the screen
10tinkerforge call oled-128x64-bricklet $uid write-line 0 0 "Hello World"

Pixel Matrix¶

Download (example-pixel-matrix.sh)

 1#!/bin/bash
 2# Connects to localhost:4223 by default, use --host and --port to change this
 3
 4# This example requires Bash 4
 5
 6uid=XYZ # Change XYZ to the UID of your OLED 128x64 Bricklet
 7
 8SCREEN_WIDTH=128
 9SCREEN_HEIGHT=64
10
11function draw_matrix {
12    declare -A column
13    declare -A column_write
14
15    for ((i=0; i<${SCREEN_HEIGHT}/8; i++))
16    do
17        for ((j=0; j<${SCREEN_WIDTH}; j++))
18        do
19            page=0
20
21            for ((k=0; k<8; k++))
22            do
23                if ((${pixel_matrix[$((((${i}*8))+${k})),${j}]}))
24                then
25                    page=$((${page}|$((1<<${k}))))
26                fi
27            done
28            column[${i},${j}]=${page}
29        done
30    done
31    tinkerforge call oled-128x64-bricklet ${uid} new-window 0 $((${SCREEN_WIDTH}-1)) 0 7
32
33    for ((i=0; i<${SCREEN_HEIGHT}/8; i++))
34    do
35        l=0
36        for ((j=0; j < ${SCREEN_WIDTH}/2; j++))
37        do
38            column_write[${l}]=${column[${i},${j}]}
39            l=$((l+1))
40        done
41        write_bytes=""
42        for ((j=0; j<${SCREEN_WIDTH}/2; j++))
43        do
44            write_bytes+=${column_write[${j}]}
45            if ((${j}==${SCREEN_HEIGHT}-1))
46            then
47                continue
48            fi
49            write_bytes+=","
50        done
51        tinkerforge call oled-128x64-bricklet ${uid} write ${write_bytes}
52
53        l=0
54        for ((j=${SCREEN_WIDTH}/2; j < ${SCREEN_WIDTH}; j++))
55        do
56            column_write[${l}]=${column[${i},${j}]}
57            l=$((l+1))
58        done
59
60        write_bytes=""
61        for ((j=0; j<${SCREEN_WIDTH}/2; j++))
62        do
63            write_bytes+=${column_write[${j}]}
64            if ((${j}==${SCREEN_HEIGHT}-1))
65            then
66                continue
67            fi
68            write_bytes+=","
69        done
70        tinkerforge call oled-128x64-bricklet ${uid} write ${write_bytes}
71    done
72}
73
74# Clear display
75tinkerforge call oled-128x64-bricklet $uid clear-display
76
77# Draw checkerboard pattern
78declare -A pixel_matrix
79
80for ((h=0;h<${SCREEN_HEIGHT};h++))
81do
82    for ((w=0;w<${SCREEN_WIDTH};w++))
83    do
84        pixel_matrix[${h},${w}]=$((((${h}/8))%2==((${w}/8))%2))
85    done
86done
87
88draw_matrix

Befehlsstruktur¶

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call oled-128x64-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameter:	<uid> – Typ: String <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des OLED 128x64 Bricklet aufzurufen. Der Befehl kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifischen call Befehl an und endet dann

• --list-functions zeigt eine Liste der bekannten Funktionen des OLED 128x64 Bricklet an und endet dann

tinkerforge dispatch oled-128x64-bricklet [<option>..] <uid> <callback>¶

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des OLED 128x64 Bricklet abzufertigen. Der Befehl kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann

• --list-callbacks zeigt eine Liste der bekannten Callbacks des OLED 128x64 Bricklet an und endet dann

tinkerforge call oled-128x64-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameter:	<uid> – Typ: String <function> – Typ: String

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

• --help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

• --execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

• --expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

tinkerforge dispatch oled-128x64-bricklet <uid> <callback> [<option>..]¶

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der abzufertigende <callback> kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifische <callback> an und endet dann

• --execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen¶

tinkerforge call oled-128x64-bricklet <uid> write <data>¶

Parameter:	<data> – Typ: Int Array, Länge: 64, Wertebereich: [0 bis 255]
Ausgabe:	keine Ausgabe

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.

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.

tinkerforge call oled-128x64-bricklet <uid> 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]
Ausgabe:	keine Ausgabe

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

tinkerforge call oled-128x64-bricklet <uid> clear-display¶

Ausgabe:	keine Ausgabe

Löscht den aktuellen Inhalt des mit new-window gesetztem Fensters.

tinkerforge call oled-128x64-bricklet <uid> 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
Ausgabe:	keine Ausgabe

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¶

tinkerforge call oled-128x64-bricklet <uid> set-display-configuration <contrast> <invert>¶

Parameter:	<contrast> – Typ: Int, Wertebereich: [0 bis 255], Standardwert: 143 <invert> – Typ: Bool, Standardwert: false
Ausgabe:	keine Ausgabe

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.

tinkerforge call oled-128x64-bricklet <uid> get-display-configuration¶

Ausgabe:	contrast – Typ: Int, Wertebereich: [0 bis 255], Standardwert: 143 invert – Typ: Bool, Standardwert: false

Gibt die Konfiguration zurück, wie von set-display-configuration gesetzt.

tinkerforge call oled-128x64-bricklet <uid> get-identity¶

Ausgabe:

uid – Typ: String, Länge: bis zu 8 connected-uid – Typ: String, Länge: bis zu 8 position – Typ: Char, Wertebereich: [a bis h, z] hardware-version – Typ: Int Array, 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] firmware-version – Typ: Int Array, 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] 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.