Shell - OLED 64x48 Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Hello World

Download (example-hello-world.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your OLED 64x48 Bricklet

# Clear display
tinkerforge call oled-64x48-bricklet $uid clear-display

# Write "Hello World" starting from upper left corner of the screen
tinkerforge call oled-64x48-bricklet $uid write-line 0 0 "Hello World"

Pixel Matrix

Download (example-pixel-matrix.sh)

 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
#!/bin/bash
# Connects to localhost:4223 by default, use --host and --port to change this

# This example requires Bash 4

uid=XYZ # Change XYZ to the UID of your OLED 64x48 Bricklet

screen_width=64
screen_height=48

function draw_matrix {
    declare -A column

    for ((i=0; i<${screen_height}/8; i++))
    do
        for ((j=0; j<${screen_width}; j++))
        do
            page=0

            for ((k=0; k<8; k++))
            do
                if ((${pixel_matrix[$((((${i}*8))+${k})),${j}]}))
                then
                    page=$((${page}|$((1<<${k}))))
                fi
            done
            column[${i},${j}]=${page}
        done
    done
    tinkerforge call oled-64x48-bricklet ${uid} new-window 0 $((${screen_width}-1)) 0 5

    for ((i=0; i<${screen_height}/8; i++))
    do
        write_bytes=""
        for ((j=0; j<${screen_width}; j++))
        do
            write_bytes+=${column[${i},${j}]}
            if ((${j}==${screen_width}-1))
            then
                continue
            fi
            write_bytes+=","
        done
        tinkerforge call oled-64x48-bricklet ${uid} write ${write_bytes}
    done
}

# Clear display
tinkerforge call oled-64x48-bricklet $uid clear-display

# Draw checkerboard pattern
declare -A pixel_matrix

for ((h=0;h<${screen_height};h++))
do
    for ((w=0;w<${screen_width};w++))
    do
        pixel_matrix[${h},${w}]=$((((${h}/8))%2==((${w}/8))%2))
    done
done

draw_matrix

API

Mögliche Exit Codes für alle tinkerforge Befehle sind:

  • 1: Unterbrochen (Ctrl+C)
  • 2: Syntaxfehler
  • 21: Python 2.5 oder neuer wird benötigt
  • 22: Python argparse Modul fehlt
  • 23: Socket-Fehler
  • 24: Andere Exception
  • 25: Ungültiger Platzhalter in Format-String
  • 26: Authentifizierungsfehler
  • 201: Timeout ist aufgetreten
  • 209: Ungültiger Argumentwert
  • 210: Funktion wird nicht unterstützt
  • 211: Unbekannter Fehler

Befehlsstruktur

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

tinkerforge call oled-64x48-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- string

Der call Befehl wird verwendet um eine Funktion des OLED 64x48 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 64x48 Bricklet an und endet dann
tinkerforge dispatch oled-64x48-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> -- string
  • <callback> -- string

Der dispatch Befehl wird verwendet um eingehende Callbacks des OLED 64x48 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 64x48 Bricklet an und endet dann
tinkerforge call oled-64x48-bricklet <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- 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-64x48-bricklet <uid> <callback> [<option>..]
Parameter:
  • <uid> -- string
  • <callback> -- 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-64x48-bricklet <uid> write <data>
Parameter:
  • <data> -- int,int,..61x..,int
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 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.

tinkerforge call oled-64x48-bricklet <uid> new-window <column-from> <column-to> <row-from> <row-to>
Parameter:
  • <column-from> -- int
  • <column-to> -- int
  • <row-from> -- int
  • <row-to> -- int
Ausgabe:

keine Ausgabe

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.

tinkerforge call oled-64x48-bricklet <uid> clear-display
Ausgabe:keine Ausgabe

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

tinkerforge call oled-64x48-bricklet <uid> write-line <line> <position> <text>
Parameter:
  • <line> -- int
  • <position> -- int
  • <text> -- string
Ausgabe:

keine Ausgabe

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

tinkerforge call oled-64x48-bricklet <uid> set-display-configuration <contrast> <invert>
Parameter:
  • <contrast> -- int
  • <invert> -- bool
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.

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

tinkerforge call oled-64x48-bricklet <uid> get-display-configuration
Ausgabe:
  • contrast -- int
  • invert -- bool

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

tinkerforge call oled-64x48-bricklet <uid> get-identity
Ausgabe:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (hat Symbole)

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.