MQTT - LCD 128x64 Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Big Font

Download (example-big-font.txt)

1
2
3
4
5
6
7
8
# Change XYZ to the UID of your LCD 128x64 Bricklet

setup:
    # Clear display
    publish '' to tinkerforge/request/lcd_128x64_bricklet/XYZ/clear_display 
    
    # Write "Hello World" with big 24x32 font
    publish '{"position_x": 0, "position_y": 0, "font": "24x32", "color": "black", "text": "24x32"}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/draw_text 

Hello World

Download (example-hello-world.txt)

1
2
3
4
5
6
7
8
# Change XYZ to the UID of your LCD 128x64 Bricklet

setup:
    # Clear display
    publish '' to tinkerforge/request/lcd_128x64_bricklet/XYZ/clear_display 
    
    # Write "Hello World" starting from upper left corner of the screen
    publish '{"line": 0, "position": 0, "text": "Hello World"}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/write_line 

Touch

Download (example-touch.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
# Change XYZ to the UID of your LCD 128x64 Bricklet

setup:
    # Handle incoming touch position callbacks
    subscribe to tinkerforge/callback/lcd_128x64_bricklet/XYZ/touch_position
    publish '{"register": true}' to tinkerforge/register/lcd_128x64_bricklet/XYZ/touch_position # Register touch_position callback
    
    # Handle incoming touch gesture callbacks
    subscribe to tinkerforge/callback/lcd_128x64_bricklet/XYZ/touch_gesture
    publish '{"register": true}' to tinkerforge/register/lcd_128x64_bricklet/XYZ/touch_gesture # Register touch_gesture callback
    
    # Set period for touch position callback to 0.1s (100ms)
    publish '{"period": 100, "value_has_to_change": true}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_touch_position_callback_configuration
    
    # Set period for touch gesture callback to 0.1s (100ms)
    publish '{"period": 100, "value_has_to_change": true}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_touch_gesture_callback_configuration

Gui

Download (example-gui.txt)

 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
# Change XYZ to the UID of your LCD 128x64 Bricklet

setup:
    # Handle incoming GUI button pressed callbacks
    subscribe to tinkerforge/callback/lcd_128x64_bricklet/XYZ/gui_button_pressed
    publish '{"register": true}' to tinkerforge/register/lcd_128x64_bricklet/XYZ/gui_button_pressed # Register gui_button_pressed callback
    
    # Handle incoming GUI slider value callbacks
    subscribe to tinkerforge/callback/lcd_128x64_bricklet/XYZ/gui_slider_value
    publish '{"register": true}' to tinkerforge/register/lcd_128x64_bricklet/XYZ/gui_slider_value # Register gui_slider_value callback
    
    # Handle incoming GUI tab selected callbacks
    subscribe to tinkerforge/callback/lcd_128x64_bricklet/XYZ/gui_tab_selected
    publish '{"register": true}' to tinkerforge/register/lcd_128x64_bricklet/XYZ/gui_tab_selected # Register gui_tab_selected callback
    
    # Clear display
    publish '' to tinkerforge/request/lcd_128x64_bricklet/XYZ/clear_display 
    
    publish '' to tinkerforge/request/lcd_128x64_bricklet/XYZ/remove_all_gui 
    
    # Add GUI elements: Button, Slider and Graph with 60 data points
    publish '{"index": 0, "position_x": 0, "position_y": 0, "width": 60, "height": 20, "text": "button"}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_button 
    
    publish '{"index": 0, "position_x": 0, "position_y": 30, "length": 60, "direction": "horizontal", "value": 50}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_slider 
    
    publish '{"index": 0, "graph_type": "line", "position_x": 62, "position_y": 0, "width": 60, "height": 52, "text_x": "X", "text_y": "Y"}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_graph_configuration 
    
    # Add a few data points (the remaining points will be 0)
    publish '{"index": 0, "data": [20,40,60,80,100,120,140,160,180,200,220,240]}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_graph_data 
    
    # Add 5 text tabs without and configure it for click and swipe without auto-redraw
    publish '{"change_tab_config": "click_and_swipe", "clear_gui": false}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_tab_configuration 
    
    publish '{"index": 0, "text": "Tab A"}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_tab_text 
    
    publish '{"index": 1, "text": "Tab B"}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_tab_text 
    
    publish '{"index": 2, "text": "Tab C"}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_tab_text 
    
    publish '{"index": 3, "text": "Tab D"}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_tab_text 
    
    publish '{"index": 4, "text": "Tab E"}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_tab_text 
    
    # Set period for GUI button pressed callback to 0.1s (100ms)
    publish '{"period": 100, "value_has_to_change": true}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_button_pressed_callback_configuration
    
    # Set period for GUI slider value callback to 0.1s (100ms)
    publish '{"period": 100, "value_has_to_change": true}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_slider_value_callback_configuration
    
    # Set period for GUI tab selected callback to 0.1s (100ms)
    publish '{"period": 100, "value_has_to_change": true}' to tinkerforge/request/lcd_128x64_bricklet/XYZ/set_gui_tab_selected_callback_configuration

API

Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.

Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR-Member enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen

request/lcd_128x64_bricklet/<UID>/write_pixels
Anfrage:
  • x_start – Typ: int, Wertebereich: [0 bis 127]
  • y_start – Typ: int, Wertebereich: [0 bis 63]
  • x_end – Typ: int, Wertebereich: [0 bis 127]
  • y_end – Typ: int, Wertebereich: [0 bis 63]
  • pixels – Typ: [bool, ...], Länge: variabel
Antwort:
  • keine Antwort

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 request/lcd_128x64_bricklet/<UID>/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 request/lcd_128x64_bricklet/<UID>/set_display_configuration Funktion eingestellt werden.

request/lcd_128x64_bricklet/<UID>/read_pixels
Anfrage:
  • x_start – Typ: int, Wertebereich: [0 bis 127]
  • y_start – Typ: int, Wertebereich: [0 bis 63]
  • x_end – Typ: int, Wertebereich: [0 bis 127]
  • y_end – Typ: int, Wertebereich: [0 bis 63]
Antwort:
  • pixels – Typ: [bool, ...], Länge: variabel

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 request/lcd_128x64_bricklet/<UID>/draw_buffered_frame).

Automatic Draw kann über die request/lcd_128x64_bricklet/<UID>/set_display_configuration Funktion eingestellt werden.

request/lcd_128x64_bricklet/<UID>/clear_display
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

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 request/lcd_128x64_bricklet/<UID>/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 request/lcd_128x64_bricklet/<UID>/set_display_configuration Funktion eingestellt werden.

request/lcd_128x64_bricklet/<UID>/write_line
Anfrage:
  • line – Typ: int, Wertebereich: [0 bis 7]
  • position – Typ: int, Wertebereich: [0 bis 21]
  • text – Typ: string, Länge: bis zu 22
Antwort:
  • keine Antwort

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 request/lcd_128x64_bricklet/<UID>/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 request/lcd_128x64_bricklet/<UID>/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 request/lcd_128x64_bricklet/<UID>/draw_text kann Text Pixelgenau und mit unterschiedlichen Font-Größen gezeichnet werden.

request/lcd_128x64_bricklet/<UID>/draw_buffered_frame
Anfrage:
  • force_complete_redraw – Typ: bool
Antwort:
  • keine Antwort

Stellt den aktuell Inhalt des internen Buffers auf dem Display dar. Normalerweise schreibt jeder Aufruf von request/lcd_128x64_bricklet/<UID>/write_pixels und request/lcd_128x64_bricklet/<UID>/write_line direkt auf den Display. Wenn jedoch Automatic Draw deaktiviert ist (request/lcd_128x64_bricklet/<UID>/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.

request/lcd_128x64_bricklet/<UID>/get_touch_position
Anfrage:
  • keine Nutzdaten
Antwort:
  • pressure – Typ: int, Wertebereich: [0 bis 300]
  • x – Typ: int, Wertebereich: [0 bis 127]
  • y – Typ: int, Wertebereich: [0 bis 63]
  • age – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Gibt die letzte gültige Touch-Position zurück:

  • Pressure: Anpressdruck des Touches
  • X: Touch-Position auf der X-Achse
  • Y: Touch-Position auf der Y-Achse
  • Age: Alter des Touches (wie lange ist die Erkennung des Touches her)
request/lcd_128x64_bricklet/<UID>/get_touch_gesture
Anfrage:
  • keine Nutzdaten
Antwort:
  • gesture – Typ: int, Wertebereich: Siehe Symbole
  • duration – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
  • pressure_max – Typ: int, Wertebereich: [0 bis 300]
  • x_start – Typ: int, Wertebereich: [0 bis 127]
  • y_start – Typ: int, Wertebereich: [0 bis 63]
  • x_end – Typ: int, Wertebereich: [0 bis 127]
  • y_end – Typ: int, Wertebereich: [0 bis 63]
  • age – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

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:

  • "left_to_right" = 0
  • "right_to_left" = 1
  • "top_to_bottom" = 2
  • "bottom_to_top" = 3
request/lcd_128x64_bricklet/<UID>/draw_line
Anfrage:
  • position_x_start – Typ: int, Wertebereich: [0 bis 127]
  • position_y_start – Typ: int, Wertebereich: [0 bis 63]
  • position_x_end – Typ: int, Wertebereich: [0 bis 127]
  • position_y_end – Typ: int, Wertebereich: [0 bis 63]
  • color – Typ: bool
Antwort:
  • keine Antwort

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:

  • "white" = false
  • "black" = true

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/draw_box
Anfrage:
  • position_x_start – Typ: int, Wertebereich: [0 bis 127]
  • position_y_start – Typ: int, Wertebereich: [0 bis 63]
  • position_x_end – Typ: int, Wertebereich: [0 bis 127]
  • position_y_end – Typ: int, Wertebereich: [0 bis 63]
  • fill – Typ: bool
  • color – Typ: bool
Antwort:
  • keine Antwort

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:

  • "white" = false
  • "black" = true

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/draw_text
Anfrage:
  • position_x – Typ: int, Wertebereich: [0 bis 127]
  • position_y – Typ: int, Wertebereich: [0 bis 63]
  • font – Typ: int, Wertebereich: Siehe Symbole
  • color – Typ: bool
  • text – Typ: string, Länge: bis zu 22
Antwort:
  • keine Antwort

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.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für font:

  • "6x8" = 0
  • "6x16" = 1
  • "6x24" = 2
  • "6x32" = 3
  • "12x16" = 4
  • "12x24" = 5
  • "12x32" = 6
  • "18x24" = 7
  • "18x32" = 8
  • "24x32" = 9

Für color:

  • "white" = false
  • "black" = true

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/set_gui_button
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 11]
  • position_x – Typ: int, Wertebereich: [0 bis 127]
  • position_y – Typ: int, Wertebereich: [0 bis 63]
  • width – Typ: int, Wertebereich: [1 bis 128]
  • height – Typ: int, Wertebereich: [1 bis 64]
  • text – Typ: string, Länge: bis zu 16
Antwort:
  • keine Antwort

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 request/lcd_128x64_bricklet/<UID>/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 request/lcd_128x64_bricklet/<UID>/write_pixels gezeichnet werden. Um einen Button zu entfernen kann die Funktion request/lcd_128x64_bricklet/<UID>/remove_gui_button genutzt werden.

Wenn anstatt des Textes ein Icon verwendet werden soll, kann dieses innerhalb des Buttons mit per request/lcd_128x64_bricklet/<UID>/write_pixels gezeichnet werden.

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/get_gui_button
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 11]
Antwort:
  • active – Typ: bool
  • position_x – Typ: int, Wertebereich: [0 bis 127]
  • position_y – Typ: int, Wertebereich: [0 bis 63]
  • width – Typ: int, Wertebereich: [1 bis 128]
  • height – Typ: int, Wertebereich: [1 bis 64]
  • text – Typ: string, Länge: bis zu 16

Gibt die Button-Eigenschaften für den gegebenen Index zurück, wie von request/lcd_128x64_bricklet/<UID>/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).

request/lcd_128x64_bricklet/<UID>/remove_gui_button
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 11, 255]
Antwort:
  • keine Antwort

Entfernt den Button mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Buttons zu entfernen.

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/get_gui_button_pressed
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 11]
Antwort:
  • pressed – Typ: bool

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

request/lcd_128x64_bricklet/<UID>/set_gui_slider
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 5]
  • position_x – Typ: int, Wertebereich: [0 bis 128]
  • position_y – Typ: int, Wertebereich: [0 bis 64]
  • length – Typ: int, Wertebereich: [8 bis 128]
  • direction – Typ: int, Wertebereich: Siehe Symbole
  • value – Typ: int, Wertebereich: [0 bis 120]
Antwort:
  • keine Antwort

Zeichnet einen Slider an Position (x, y) mit der gegebenen Länge.

Es können bis zu 8 Slider genutzt werden (Index 0-7).

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 request/lcd_128x64_bricklet/<UID>/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 request/lcd_128x64_bricklet/<UID>/write_pixels gezeichnet werden. Um einen Button zu entfernen kann die Funktion request/lcd_128x64_bricklet/<UID>/remove_gui_slider genutzt werden.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für direction:

  • "horizontal" = 0
  • "vertical" = 1

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/get_gui_slider
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 5]
Antwort:
  • active – Typ: bool
  • position_x – Typ: int, Wertebereich: [0 bis 128]
  • position_y – Typ: int, Wertebereich: [0 bis 64]
  • length – Typ: int, Wertebereich: [8 bis 128]
  • direction – Typ: int, Wertebereich: Siehe Symbole
  • value – Typ: int, Wertebereich: [0 bis 120]

Gibt die Slider-Eigenschaften für den gegebenen Index zurück, wie von request/lcd_128x64_bricklet/<UID>/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:

  • "horizontal" = 0
  • "vertical" = 1

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/remove_gui_slider
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 5, 255]
Antwort:
  • keine Antwort

Entfernt den Slider mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Slider zu entfernen.

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/get_gui_slider_value
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 5]
Antwort:
  • value – Typ: int, Wertebereich: [0 bis 120]

Gibt den aktuellen Wert des Slider mit dem gegebenen Index zurück.

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/set_gui_tab_configuration
Anfrage:
  • change_tab_config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
  • clear_gui – Typ: bool, Standardwert: true
Antwort:
  • keine Antwort

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:

  • "click" = 1
  • "swipe" = 2
  • "click_and_swipe" = 3

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/get_gui_tab_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • change_tab_config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
  • clear_gui – Typ: bool, Standardwert: true

Gibt die Tab-Konfiguration zurück, wie von request/lcd_128x64_bricklet/<UID>/set_gui_tab_configuration gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für change_tab_config:

  • "click" = 1
  • "swipe" = 2
  • "click_and_swipe" = 3

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/set_gui_tab_text
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 9]
  • text – Typ: string, Länge: bis zu 5
Antwort:
  • keine Antwort

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

request/lcd_128x64_bricklet/<UID>/get_gui_tab_text
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 9]
Antwort:
  • active – Typ: bool
  • text – Typ: string, Länge: bis zu 5

Gibt den Text für den gegebenen Index zurück, wie von request/lcd_128x64_bricklet/<UID>/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).

request/lcd_128x64_bricklet/<UID>/set_gui_tab_icon
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 9]
  • icon – Typ: [bool, ...], Länge: 168
Antwort:
  • keine Antwort

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

request/lcd_128x64_bricklet/<UID>/get_gui_tab_icon
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 9]
Antwort:
  • active – Typ: bool
  • icon – Typ: [bool, ...], Länge: 168

Gibt das Icon für den gegebenen Index zurück, wie von request/lcd_128x64_bricklet/<UID>/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).

request/lcd_128x64_bricklet/<UID>/remove_gui_tab
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 9, 255]
Antwort:
  • keine Antwort

Entfernt den Tab mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Tabs zu entfernen.

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/set_gui_tab_selected
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 9]
Antwort:
  • keine Antwort

Setzt den Tab mit dem gegebenen Index als "selected" (wird auf dem Display als ausgewählt gezeichnet)

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/get_gui_tab_selected
Anfrage:
  • keine Nutzdaten
Antwort:
  • index – Typ: int, Wertebereich: [-1 bis 9]

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

request/lcd_128x64_bricklet/<UID>/set_gui_graph_configuration
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 3]
  • graph_type – Typ: int, Wertebereich: Siehe Symbole
  • position_x – Typ: int, Wertebereich: [0 bis 127]
  • position_y – Typ: int, Wertebereich: [0 bis 63]
  • width – Typ: int, Wertebereich: [0 bis 118]
  • height – Typ: int, Wertebereich: [0 bis 63]
  • text_x – Typ: string, Länge: bis zu 4
  • text_y – Typ: string, Länge: bis zu 4
Antwort:
  • keine Antwort

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 request/lcd_128x64_bricklet/<UID>/draw_text hinzugefügt werden.

Die Datenpunkte des Graphen können mit der Funktion request/lcd_128x64_bricklet/<UID>/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 request/lcd_128x64_bricklet/<UID>/write_pixels gezeichnet werden. Um einen Graphen zu entfernen kann die Funktion request/lcd_128x64_bricklet/<UID>/remove_gui_graph genutzt werden.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für graph_type:

  • "dot" = 0
  • "line" = 1
  • "bar" = 2

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/get_gui_graph_configuration
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 3]
Antwort:
  • active – Typ: bool
  • graph_type – Typ: int, Wertebereich: Siehe Symbole
  • position_x – Typ: int, Wertebereich: [0 bis 127]
  • position_y – Typ: int, Wertebereich: [0 bis 63]
  • width – Typ: int, Wertebereich: [0 bis 118]
  • height – Typ: int, Wertebereich: [0 bis 63]
  • text_x – Typ: string, Länge: bis zu 4
  • text_y – Typ: string, Länge: bis zu 4

Gibt die Graph-Eigenschaften für den gegebenen Index zurück, wie von request/lcd_128x64_bricklet/<UID>/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:

  • "dot" = 0
  • "line" = 1
  • "bar" = 2

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/set_gui_graph_data
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 3]
  • data – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 255]
Antwort:
  • keine Antwort

Setzt die Datenpukte für den Graph mit dem gegebenen Index. Der Graph muss mit request/lcd_128x64_bricklet/<UID>/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 request/lcd_128x64_bricklet/<UID>/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).

request/lcd_128x64_bricklet/<UID>/get_gui_graph_data
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 3]
Antwort:
  • data – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 255]

Gibt die Datenpunkte des Graphen mit dem gegebenen Index zurück, wie von request/lcd_128x64_bricklet/<UID>/set_gui_graph_data gesetzt.

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/remove_gui_graph
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 3, 255]
Antwort:
  • keine Antwort

Entfernt den Graph mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Graphen zu entfernen.

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/remove_all_gui
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Entfernt alle GUI-Elemente (Buttons, Slider, Graphen, Tabs).

Neu in Version 2.0.2 (Plugin).

Fortgeschrittene Funktionen

request/lcd_128x64_bricklet/<UID>/set_display_configuration
Anfrage:
  • contrast – Typ: int, Wertebereich: [0 bis 63], Standardwert: 14
  • backlight – Typ: int, Wertebereich: [0 bis 100], Standardwert: 100
  • invert – Typ: bool, Standardwert: false
  • automatic_draw – Typ: bool, Standardwert: true
Antwort:
  • keine Antwort

Setzt die Konfiguration des Displays.

Wenn Automatic Draw aktiviert (true) ist dann wird das Display bei jedem Aufruf von request/lcd_128x64_bricklet/<UID>/write_pixels und request/lcd_128x64_bricklet/<UID>/write_line aktualisiert. Wenn Automatic Draw deaktiviert (false) ist, dann werden Änderungen in einen internen Buffer geschrieben, der dann bei bei einem Aufruf von request/lcd_128x64_bricklet/<UID>/draw_buffered_frame auf dem Display angezeigt wird.

request/lcd_128x64_bricklet/<UID>/get_display_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • contrast – Typ: int, Wertebereich: [0 bis 63], Standardwert: 14
  • backlight – Typ: int, Wertebereich: [0 bis 100], Standardwert: 100
  • invert – Typ: bool, Standardwert: false
  • automatic_draw – Typ: bool, Standardwert: true

Gibt die Konfiguration zurück, wie von request/lcd_128x64_bricklet/<UID>/set_display_configuration gesetzt.

request/lcd_128x64_bricklet/<UID>/set_touch_led_config
Anfrage:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:
  • keine Antwort

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:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_touch" = 3

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/get_touch_led_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/lcd_128x64_bricklet/<UID>/set_touch_led_config gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_touch" = 3

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/get_spitfp_error_count
Anfrage:
  • keine Nutzdaten
Antwort:
  • error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

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.

request/lcd_128x64_bricklet/<UID>/set_bootloader_mode
Anfrage:
  • mode – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • status – Typ: int, Wertebereich: Siehe Symbole

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:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4

Für status:

  • "ok" = 0
  • "invalid_mode" = 1
  • "no_change" = 2
  • "entry_function_not_present" = 3
  • "device_identifier_incorrect" = 4
  • "crc_mismatch" = 5
request/lcd_128x64_bricklet/<UID>/get_bootloader_mode
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe request/lcd_128x64_bricklet/<UID>/set_bootloader_mode.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für mode:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4
request/lcd_128x64_bricklet/<UID>/set_write_firmware_pointer
Anfrage:
  • pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Setzt den Firmware-Pointer für request/lcd_128x64_bricklet/<UID>/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.

request/lcd_128x64_bricklet/<UID>/write_firmware
Anfrage:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:
  • status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von request/lcd_128x64_bricklet/<UID>/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.

request/lcd_128x64_bricklet/<UID>/set_status_led_config
Anfrage:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:
  • keine Antwort

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:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/lcd_128x64_bricklet/<UID>/get_status_led_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/lcd_128x64_bricklet/<UID>/set_status_led_config gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/lcd_128x64_bricklet/<UID>/get_chip_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

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.

request/lcd_128x64_bricklet/<UID>/reset
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

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.

request/lcd_128x64_bricklet/<UID>/write_uid
Anfrage:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

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.

request/lcd_128x64_bricklet/<UID>/read_uid
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

request/lcd_128x64_bricklet/<UID>/get_identity
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: string, Länge: bis zu 8
  • connected_uid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ["a" bis "h", "i", "z"]
  • 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]
  • 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]
  • device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]
  • _display_name – Typ: string

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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des LCD 128x64.

Konfigurationsfunktionen für Callbacks

request/lcd_128x64_bricklet/<UID>/set_touch_position_callback_configuration
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der register/lcd_128x64_bricklet/<UID>/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.

request/lcd_128x64_bricklet/<UID>/get_touch_position_callback_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels request/lcd_128x64_bricklet/<UID>/set_touch_position_callback_configuration gesetzt.

request/lcd_128x64_bricklet/<UID>/set_touch_gesture_callback_configuration
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der register/lcd_128x64_bricklet/<UID>/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.

request/lcd_128x64_bricklet/<UID>/get_touch_gesture_callback_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels request/lcd_128x64_bricklet/<UID>/set_touch_gesture_callback_configuration gesetzt.

request/lcd_128x64_bricklet/<UID>/set_gui_button_pressed_callback_configuration
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der register/lcd_128x64_bricklet/<UID>/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).

request/lcd_128x64_bricklet/<UID>/get_gui_button_pressed_callback_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels request/lcd_128x64_bricklet/<UID>/set_gui_button_pressed_callback_configuration gesetzt.

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/set_gui_slider_value_callback_configuration
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der register/lcd_128x64_bricklet/<UID>/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).

request/lcd_128x64_bricklet/<UID>/get_gui_slider_value_callback_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels request/lcd_128x64_bricklet/<UID>/set_gui_slider_value_callback_configuration gesetzt.

Neu in Version 2.0.2 (Plugin).

request/lcd_128x64_bricklet/<UID>/set_gui_tab_selected_callback_configuration
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der register/lcd_128x64_bricklet/<UID>/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).

request/lcd_128x64_bricklet/<UID>/get_gui_tab_selected_callback_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels request/lcd_128x64_bricklet/<UID>/set_gui_tab_selected_callback_configuration gesetzt.

Neu in Version 2.0.2 (Plugin).

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

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.

register/lcd_128x64_bricklet/<UID>/touch_position
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • pressure – Typ: int, Wertebereich: [0 bis 300]
  • x – Typ: int, Wertebereich: [0 bis 127]
  • y – Typ: int, Wertebereich: [0 bis 63]
  • age – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/lcd_128x64_bricklet/<UID>/touch_position[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/lcd_128x64_bricklet/<UID>/touch_position[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/lcd_128x64_bricklet/<UID>/set_touch_position_callback_configuration, ausgelöst. Die Payload-Member des Callbacks sind die gleichen wie die von request/lcd_128x64_bricklet/<UID>/get_touch_position.

register/lcd_128x64_bricklet/<UID>/touch_gesture
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • gesture – Typ: int, Wertebereich: Siehe Symbole
  • duration – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
  • pressure_max – Typ: int, Wertebereich: [0 bis 300]
  • x_start – Typ: int, Wertebereich: [0 bis 127]
  • y_start – Typ: int, Wertebereich: [0 bis 63]
  • x_end – Typ: int, Wertebereich: [0 bis 127]
  • y_end – Typ: int, Wertebereich: [0 bis 63]
  • age – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/lcd_128x64_bricklet/<UID>/touch_gesture[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/lcd_128x64_bricklet/<UID>/touch_gesture[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/lcd_128x64_bricklet/<UID>/set_touch_gesture_callback_configuration, ausgelöst. Die Payload-Member des Callbacks sind die gleichen wie die von request/lcd_128x64_bricklet/<UID>/get_touch_gesture.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für gesture:

  • "left_to_right" = 0
  • "right_to_left" = 1
  • "top_to_bottom" = 2
  • "bottom_to_top" = 3
register/lcd_128x64_bricklet/<UID>/gui_button_pressed
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • index – Typ: int, Wertebereich: [0 bis 11]
  • pressed – Typ: bool

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/lcd_128x64_bricklet/<UID>/gui_button_pressed[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/lcd_128x64_bricklet/<UID>/gui_button_pressed[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/lcd_128x64_bricklet/<UID>/set_gui_button_pressed_callback_configuration, ausgelöst. Die Payload-Member des Callbacks sind die gleichen wie die von request/lcd_128x64_bricklet/<UID>/get_gui_button_pressed.

Neu in Version 2.0.2 (Plugin).

register/lcd_128x64_bricklet/<UID>/gui_slider_value
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • index – Typ: int, Wertebereich: [0 bis 5]
  • value – Typ: int, Wertebereich: [0 bis 120]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/lcd_128x64_bricklet/<UID>/gui_slider_value[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/lcd_128x64_bricklet/<UID>/gui_slider_value[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/lcd_128x64_bricklet/<UID>/set_gui_slider_value_callback_configuration, ausgelöst. Die Payload-Member des Callbacks sind die gleichen wie die von request/lcd_128x64_bricklet/<UID>/get_gui_slider_value.

Neu in Version 2.0.2 (Plugin).

register/lcd_128x64_bricklet/<UID>/gui_tab_selected
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • index – Typ: int, Wertebereich: [0 bis 9]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/lcd_128x64_bricklet/<UID>/gui_tab_selected[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/lcd_128x64_bricklet/<UID>/gui_tab_selected[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/lcd_128x64_bricklet/<UID>/set_gui_tab_selected_callback_configuration, ausgelöst. Die Payload-Member des Callbacks sind die gleichen wie die von request/lcd_128x64_bricklet/<UID>/get_gui_tab_selected.

Neu in Version 2.0.2 (Plugin).