Dies ist die Beschreibung der Shell 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 Shell API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (example-big-font.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 LCD 128x64 Bricklet
# Clear display
tinkerforge call lcd-128x64-bricklet $uid clear-display
# Write "Hello World" with big 24x32 font
tinkerforge call lcd-128x64-bricklet $uid draw-text 0 0 font-24x32 color-black "24x32"
|
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 LCD 128x64 Bricklet
# Clear display
tinkerforge call lcd-128x64-bricklet $uid clear-display
# Write "Hello World" starting from upper left corner of the screen
tinkerforge call lcd-128x64-bricklet $uid write-line 0 0 "Hello World"
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | #!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this
uid=XYZ # Change XYZ to the UID of your LCD 128x64 Bricklet
# Handle incoming touch position callbacks
tinkerforge dispatch lcd-128x64-bricklet $uid touch-position &
# Handle incoming touch gesture callbacks
tinkerforge dispatch lcd-128x64-bricklet $uid touch-gesture &
# Set period for touch position callback to 0.1s (100ms)
tinkerforge call lcd-128x64-bricklet $uid set-touch-position-callback-configuration 100 true
# Set period for touch gesture callback to 0.1s (100ms)
tinkerforge call lcd-128x64-bricklet $uid set-touch-gesture-callback-configuration 100 true
echo "Press key to exit"; read dummy
kill -- -$$ # Stop callback dispatch in background
|
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 | #!/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 LCD 128x64 Bricklet
SCREEN_WIDTH=128
SCREEN_HEIGHT=64
# Clear display
tinkerforge call lcd-128x64-bricklet $uid clear-display
# Draw checkerboard pattern
pixels=""
for ((h=0;h<${SCREEN_HEIGHT};h++))
do
for ((w=0;w<${SCREEN_WIDTH};w++))
do
if [ $((((${h}/8))%2==((${w}/8))%2)) -gt 0 ]; then
pixels+="true,"
else
pixels+="false,"
fi
done
done
w=`expr $SCREEN_WIDTH - 1`
h=`expr $SCREEN_HEIGHT - 1`
tinkerforge call lcd-128x64-bricklet ${uid} write-pixels 0 0 $w $h ${pixels::-1}
|
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 | #!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this
uid=XYZ # Change XYZ to the UID of your LCD 128x64 Bricklet
# Handle incoming GUI button pressed callbacks
tinkerforge dispatch lcd-128x64-bricklet $uid gui-button-pressed &
# Handle incoming GUI slider value callbacks
tinkerforge dispatch lcd-128x64-bricklet $uid gui-slider-value &
# Handle incoming GUI tab selected callbacks
tinkerforge dispatch lcd-128x64-bricklet $uid gui-tab-selected &
# Clear display
tinkerforge call lcd-128x64-bricklet $uid clear-display
tinkerforge call lcd-128x64-bricklet $uid remove-all-gui
# Add GUI elements: Button, Slider and Graph with 60 data points
tinkerforge call lcd-128x64-bricklet $uid set-gui-button 0 0 0 60 20 "button"
tinkerforge call lcd-128x64-bricklet $uid set-gui-slider 0 0 30 60 direction-horizontal 50
tinkerforge call lcd-128x64-bricklet $uid set-gui-graph-configuration 0 graph-type-line 62 0 60 52 "X" "Y"
# Add a few data points (the remaining points will be 0)
tinkerforge call lcd-128x64-bricklet $uid set-gui-graph-data 0 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
tinkerforge call lcd-128x64-bricklet $uid set-gui-tab-configuration change-tab-on-click-and-swipe false
tinkerforge call lcd-128x64-bricklet $uid set-gui-tab-text 0 "Tab A"
tinkerforge call lcd-128x64-bricklet $uid set-gui-tab-text 1 "Tab B"
tinkerforge call lcd-128x64-bricklet $uid set-gui-tab-text 2 "Tab C"
tinkerforge call lcd-128x64-bricklet $uid set-gui-tab-text 3 "Tab D"
tinkerforge call lcd-128x64-bricklet $uid set-gui-tab-text 4 "Tab E"
# Set period for GUI button pressed callback to 0.1s (100ms)
tinkerforge call lcd-128x64-bricklet $uid set-gui-button-pressed-callback-configuration 100 true
# Set period for GUI slider value callback to 0.1s (100ms)
tinkerforge call lcd-128x64-bricklet $uid set-gui-slider-value-callback-configuration 100 true
# Set period for GUI tab selected callback to 0.1s (100ms)
tinkerforge call lcd-128x64-bricklet $uid set-gui-tab-selected-callback-configuration 100 true
echo "Press key to exit"; read dummy
kill -- -$$ # Stop callback dispatch in background
|
Mögliche Exit Codes für alle tinkerforge
Befehle sind:
argparse
Modul fehltAllgemeine Optionen des call
und des dispatch
Befehls sind
hier zu finden. Im Folgenden wird die spezifische
Befehlsstruktur dargestellt.
call
lcd-128x64-bricklet
[<option>..] <uid> <function> [<argument>..]¶Parameter: |
|
---|
Der call
Befehl wird verwendet um eine Funktion des LCD 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 LCD 128x64 Bricklet an
und endet danndispatch
lcd-128x64-bricklet
[<option>..] <uid> <callback>¶Parameter: |
|
---|
Der dispatch
Befehl wird verwendet um eingehende Callbacks des LCD 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 LCD 128x64 Bricklet an
und endet dannlcd-128x64-bricklet
<uid> <function>
[<option>..] [<argument>..]¶Parameter: |
|
---|
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 dannGetter-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 dieseMit 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.
lcd-128x64-bricklet
<uid> <callback>
[<option>..]¶Parameter: |
|
---|
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)lcd-128x64-bricklet
<uid> write-pixels
<x-start> <y-start> <x-end> <y-end> <pixels>¶Parameter: |
|
---|---|
Ausgabe: |
|
Schreibt Pixel in das angegebene Fenster.
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 draw-buffered-frame
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 set-display-configuration
Funktion
eingestellt werden.
lcd-128x64-bricklet
<uid> read-pixels
<x-start> <y-start> <x-end> <y-end>¶Parameter: |
|
---|---|
Ausgabe: |
|
Liest Pixel aus dem angegebenen Fenster.
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 draw-buffered-frame
).
Automatic Draw kann über die set-display-configuration
Funktion
eingestellt werden.
lcd-128x64-bricklet
<uid> clear-display
¶Ausgabe: |
|
---|
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 draw-buffered-frame
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 set-display-configuration
Funktion
eingestellt werden.
lcd-128x64-bricklet
<uid> write-line
<line> <position> <text>¶Parameter: |
|
---|---|
Ausgabe: |
|
Schreibt einen Text in die angegebene Zeile mit einer vorgegebenen Position.
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 draw-buffered-frame
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 set-display-configuration
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 draw-text
kann Text Pixelgenau
und mit unterschiedlichen Font-Größen gezeichnet werden.
lcd-128x64-bricklet
<uid> draw-buffered-frame
<force-complete-redraw>¶Parameter: |
|
---|---|
Ausgabe: |
|
Stellt den aktuell Inhalt des internen Buffers auf dem Display dar. Normalerweise
schreibt jeder Aufruf von write-pixels
und write-line
direkt auf
den Display. Wenn jedoch Automatic Draw deaktiviert ist (set-display-configuration
),
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.
lcd-128x64-bricklet
<uid> get-touch-position
¶Ausgabe: |
|
---|
Gibt die letzte gültige Touch-Position zurück:
lcd-128x64-bricklet
<uid> get-touch-gesture
¶Ausgabe: |
|
---|
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).
Der Age Parameter gibt das Alter der Geste an (wie lange ist die Erkennung der Geste her).
Die folgenden Symbole sind für diese Funktion verfügbar:
Für gesture:
lcd-128x64-bricklet
<uid> draw-line
<position-x-start> <position-y-start> <position-x-end> <position-y-end> <color>¶Parameter: |
|
---|---|
Ausgabe: |
|
Zeichnet eine weiße oder schwarze Linie von (x, y)-start nach (x, y)-end.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <color>:
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> draw-box
<position-x-start> <position-y-start> <position-x-end> <position-y-end> <fill> <color>¶Parameter: |
|
---|---|
Ausgabe: |
|
Zeichnet ein weißes oder schwarzes Rechteck von (x, y)-start nach (x, y)-end.
Wenn fill auf true gesetzt wird, wird das Rechteck mit der angegebenen Farbe ausgefüllt. Ansonsten wird nur der Umriss gezeichnet.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <color>:
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> draw-text
<position-x> <position-y> <font> <color> <text>¶Parameter: |
|
---|---|
Ausgabe: |
|
Zeichnet einen Text an die Pixelposition (x, y).
Es können 9 unterschiedliche Font-Größen genutzt werden und der Text kann in weiß oder schwarz gezeichnet werden.
Der der Zeichensatz entspricht Codepage 437.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <font>:
Für <color>:
Neu in Version 2.0.2 (Plugin).
Parameter: |
|
---|---|
Ausgabe: |
|
Zeichnet einen klickbaren Button an Position (x, y) mit dem gegebenem Text.
Es können bis zu 12 Buttons genutzt werden.
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
set-gui-button-pressed-callback-configuration
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 write-pixels
gezeichnet werden. Um einen Button zu entfernen kann die Funktion
remove-gui-button
genutzt werden.
Wenn anstatt des Textes ein Icon verwendet werden soll, kann dieses innerhalb
des Buttons mit per write-pixels
gezeichnet werden.
Neu in Version 2.0.2 (Plugin).
Parameter: |
|
---|---|
Ausgabe: |
|
Gibt die Button-Eigenschaften für den gegebenen Index zurück, wie von
set-gui-button
gesetzt.
Zusätzlich gibt der Active-Parameter an ob der Button aktuell aktiv/sichtbar ist oder nicht.
Neu in Version 2.0.2 (Plugin).
Parameter: |
|
---|---|
Ausgabe: |
|
Entfernt den Button mit dem gegebenen Index.
Index 255 kann genutzt werden um alle Buttons zu entfernen.
Neu in Version 2.0.2 (Plugin).
Parameter: |
|
---|---|
Ausgabe: |
|
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).
lcd-128x64-bricklet
<uid> set-gui-slider
<index> <position-x> <position-y> <length> <direction> <value>¶Parameter: |
|
---|---|
Ausgabe: |
|
Zeichnet einen Slider an Position (x, y) mit der gegebenen Länge.
Es können bis zu 6 Slider genutzt werden.
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.
Der 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
set-gui-slider-value-callback-configuration
eingestellt werden.
Der Slider wird in einem separaten GUI-Buffer gezeichnet und der Rahmen des
Buttons wrd immer über den Grafiken bleiben die mit write-pixels
gezeichnet werden. Um einen Button zu entfernen kann die Funktion
remove-gui-slider
genutzt werden.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <direction>:
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> get-gui-slider
<index>¶Parameter: |
|
---|---|
Ausgabe: |
|
Gibt die Slider-Eigenschaften für den gegebenen Index zurück, wie von
set-gui-slider
gesetzt.
Zusätzlich gibt der Active-Parameter an ob der Button aktuell aktiv/sichtbar ist oder nicht.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für direction:
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> remove-gui-slider
<index>¶Parameter: |
|
---|---|
Ausgabe: |
|
Entfernt den Slider mit dem gegebenen Index.
Index 255 kann genutzt werden um alle Slider zu entfernen.
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> get-gui-slider-value
<index>¶Parameter: |
|
---|---|
Ausgabe: |
|
Gibt den aktuellen Wert des Slider mit dem gegebenen Index zurück.
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> set-gui-tab-configuration
<change-tab-config> <clear-gui>¶Parameter: |
|
---|---|
Ausgabe: |
|
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.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <change-tab-config>:
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> get-gui-tab-configuration
¶Ausgabe: |
|
---|
Gibt die Tab-Konfiguration zurück, wie von set-gui-tab-configuration
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für change-tab-config:
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> set-gui-tab-text
<index> <text>¶Parameter: |
|
---|---|
Ausgabe: |
|
Fügt einen Text-Tab mit dem gegebenen Index hinzu.
Es können bis zu 10 Tabs verwendet werden.
Ein Text-Tab mit dem gleichen Index wie ein Icon-Tab überschreibt diesen.
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> get-gui-tab-text
<index>¶Parameter: |
|
---|---|
Ausgabe: |
|
Gibt den Text für den gegebenen Index zurück, wie von set-gui-tab-text
gesetzt.
Zusätzlich gibt der Active-Parameter an ob der Tab aktuell aktiv/sichtbar ist oder nicht.
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> set-gui-tab-icon
<index> <icon>¶Parameter: |
|
---|---|
Ausgabe: |
|
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.
Ein Icon-Tab mit dem gleichen Index wie ein Text-Tab überschreibt diesen.
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> get-gui-tab-icon
<index>¶Parameter: |
|
---|---|
Ausgabe: |
|
Gibt das Icon für den gegebenen Index zurück, wie von set-gui-tab-icon
gesetzt.
Zusätzlich gibt der Active-Parameter an ob der Tab aktuell aktiv/sichtbar ist oder nicht.
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> remove-gui-tab
<index>¶Parameter: |
|
---|---|
Ausgabe: |
|
Entfernt den Tab mit dem gegebenen Index.
Index 255 kann genutzt werden um alle Tabs zu entfernen.
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> set-gui-tab-selected
<index>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt den Tab mit dem gegebenen Index als "selected" (wird auf dem Display als ausgewählt gezeichnet)
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> get-gui-tab-selected
¶Ausgabe: |
|
---|
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).
lcd-128x64-bricklet
<uid> set-gui-graph-configuration
<index> <graph-type> <position-x> <position-y> <width> <height> <text-x> <text-y>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Konfiguration für bis zu vier Graphen.
Der Graph kann vom Typ Dot-, Line- oder Bar-Graph sein.
Die x- und y-Positionen sind Pixel-Positionen.
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 draw-text
hinzugefügt werden.
Die Datenpunkte des Graphen können mit der Funktion set-gui-graph-data
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
write-pixels
gezeichnet werden. Um einen Graphen zu entfernen kann die
Funktion remove-gui-graph
genutzt werden.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <graph-type>:
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> get-gui-graph-configuration
<index>¶Parameter: |
|
---|---|
Ausgabe: |
|
Gibt die Graph-Eigenschaften für den gegebenen Index zurück, wie von
set-gui-graph-configuration
gesetzt.
Zusätzlich gibt der Active-Parameter an ob der Button aktuell aktiv/sichtbar ist oder nicht.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für graph-type:
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> set-gui-graph-data
<index> <data>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Datenpukte für den Graph mit dem gegebenen Index. Der Graph muss mit
set-gui-graph-configuration
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 set-gui-graph-configuration
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).
lcd-128x64-bricklet
<uid> get-gui-graph-data
<index>¶Parameter: |
|
---|---|
Ausgabe: |
|
Gibt die Datenpunkte des Graphen mit dem gegebenen Index zurück, wie von
set-gui-graph-data
gesetzt.
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> remove-gui-graph
<index>¶Parameter: |
|
---|---|
Ausgabe: |
|
Entfernt den Graph mit dem gegebenen Index.
Index 255 kann genutzt werden um alle Graphen zu entfernen.
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> remove-all-gui
¶Ausgabe: |
|
---|
Entfernt alle GUI-Elemente (Buttons, Slider, Graphen, Tabs).
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> set-display-configuration
<contrast> <backlight> <invert> <automatic-draw>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Konfiguration des Displays.
Wenn Automatic Draw aktiviert (true) ist dann wird das Display bei jedem
Aufruf von write-pixels
und write-line
aktualisiert. Wenn
Automatic Draw deaktiviert (false) ist, dann werden Änderungen in einen
internen Buffer geschrieben, der dann bei bei einem Aufruf von
draw-buffered-frame
auf dem Display angezeigt wird.
lcd-128x64-bricklet
<uid> get-display-configuration
¶Ausgabe: |
|
---|
Gibt die Konfiguration zurück, wie von set-display-configuration
gesetzt.
lcd-128x64-bricklet
<uid> set-touch-led-config
<config>¶Parameter: |
|
---|---|
Ausgabe: |
|
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 Bootloadermodus befindet ist die LED aus.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <config>:
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> get-touch-led-config
¶Ausgabe: |
|
---|
Gibt die Konfiguration zurück, wie von set-touch-led-config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> get-spitfp-error-count
¶Ausgabe: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
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.
lcd-128x64-bricklet
<uid> set-status-led-config
<config>¶Parameter: |
|
---|---|
Ausgabe: |
|
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 Symbole sind für diese Funktion verfügbar:
Für <config>:
lcd-128x64-bricklet
<uid> get-status-led-config
¶Ausgabe: |
|
---|
Gibt die Konfiguration zurück, wie von set-status-led-config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
lcd-128x64-bricklet
<uid> get-chip-temperature
¶Ausgabe: |
|
---|
Gibt die Temperatur, 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.
lcd-128x64-bricklet
<uid> reset
¶Ausgabe: |
|
---|
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.
lcd-128x64-bricklet
<uid> get-identity
¶Ausgabe: |
|
---|
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.
lcd-128x64-bricklet
<uid> set-touch-position-callback-configuration
<period> <value-has-to-change>¶Parameter: |
|
---|---|
Ausgabe: |
|
Die Periode ist die Periode mit der der touch-position
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.
lcd-128x64-bricklet
<uid> get-touch-position-callback-configuration
¶Ausgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
set-touch-position-callback-configuration
gesetzt.
lcd-128x64-bricklet
<uid> set-touch-gesture-callback-configuration
<period> <value-has-to-change>¶Parameter: |
|
---|---|
Ausgabe: |
|
Die Periode ist die Periode mit der der touch-gesture
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.
lcd-128x64-bricklet
<uid> get-touch-gesture-callback-configuration
¶Ausgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
set-touch-gesture-callback-configuration
gesetzt.
Parameter: |
|
---|---|
Ausgabe: |
|
Die Periode ist die Periode mit der der gui-button-pressed
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.
Neu in Version 2.0.2 (Plugin).
Ausgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
set-gui-button-pressed-callback-configuration
gesetzt.
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> set-gui-slider-value-callback-configuration
<period> <value-has-to-change>¶Parameter: |
|
---|---|
Ausgabe: |
|
Die Periode ist die Periode mit der der gui-slider-value
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.
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> get-gui-slider-value-callback-configuration
¶Ausgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
set-gui-slider-value-callback-configuration
gesetzt.
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> set-gui-tab-selected-callback-configuration
<period> <value-has-to-change>¶Parameter: |
|
---|---|
Ausgabe: |
|
Die Periode ist die Periode mit der der gui-tab-selected
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.
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> get-gui-tab-selected-callback-configuration
¶Ausgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
set-gui-tab-selected-callback-configuration
gesetzt.
Neu in Version 2.0.2 (Plugin).
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:
tinkerforge dispatch lcd-128x64-bricklet <uid> example
Die verfügbaren Callbacks 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.
lcd-128x64-bricklet
<uid> touch-position
¶Ausgabe: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
set-touch-position-callback-configuration
, ausgelöst. Die Parameter sind
die gleichen wie die von get-touch-position
.
lcd-128x64-bricklet
<uid> touch-gesture
¶Ausgabe: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
set-touch-gesture-callback-configuration
, ausgelöst. Die Parameter sind
die gleichen wie die von get-touch-gesture
.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für gesture:
Ausgabe: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
set-gui-button-pressed-callback-configuration
, ausgelöst. Die Parameter sind
die gleichen wie die von get-gui-button-pressed
.
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> gui-slider-value
¶Ausgabe: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
set-gui-slider-value-callback-configuration
, ausgelöst. Die Parameter sind
die gleichen wie die von get-gui-slider-value
.
Neu in Version 2.0.2 (Plugin).
lcd-128x64-bricklet
<uid> gui-tab-selected
¶Ausgabe: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
set-gui-tab-selected-callback-configuration
, ausgelöst. Die Parameter sind
die gleichen wie die von get-gui-tab-selected
.
Neu in Version 2.0.2 (Plugin).
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
lcd-128x64-bricklet
<uid> set-bootloader-mode
<mode>¶Parameter: |
|
---|---|
Ausgabe: |
|
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 Bootloader- 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 Symbole sind für diese Funktion verfügbar:
Für <mode>:
Für status:
lcd-128x64-bricklet
<uid> get-bootloader-mode
¶Ausgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode
.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
lcd-128x64-bricklet
<uid> set-write-firmware-pointer
<pointer>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt den Firmware-Pointer für write-firmware
. 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.
lcd-128x64-bricklet
<uid> write-firmware
<data>¶Parameter: |
|
---|---|
Ausgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
set-write-firmware-pointer
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.
lcd-128x64-bricklet
<uid> write-uid
<uid>¶Parameter: |
|
---|---|
Ausgabe: |
|
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.
lcd-128x64-bricklet
<uid> read-uid
¶Ausgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.