Modbus - LCD 128x64 Bricklet

Dies ist die Beschreibung des Modbus Protokolls für das LCD 128x64 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des LCD 128x64 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletLCD128x64.write_pixels_low_level
Funktions ID:

1

Anfrage:
  • x_start -- uint8
  • y_start -- uint8
  • x_end -- uint8
  • y_end -- uint8
  • pixels_length -- uint16
  • pixels_chunk_offset -- uint16
  • pixels_chunk_data -- bool[448]
Antwort:

keine Antwort

Schreibt Pixel in das angegebene Fenster.

Die X-Achse läuft von 0 bis 127 und die Y-Achse von 0 bis 63. 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.

BrickletLCD128x64.read_pixels_low_level
Funktions ID:

2

Anfrage:
  • x_start -- uint8
  • y_start -- uint8
  • x_end -- uint8
  • y_end -- uint8
Antwort:
  • pixels_length -- uint16
  • pixels_chunk_offset -- uint16
  • pixels_chunk_data -- bool[480]

Liest Pixel aus dem angegebenen Fenster.

Die X-Achse läuft von 0 bis 127 und die Y-Achse von 0 bis 63. 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.

BrickletLCD128x64.clear_display
Funktions ID:3
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 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.

BrickletLCD128x64.write_line
Funktions ID:

6

Anfrage:
  • line -- uint8
  • position -- uint8
  • text -- char[22]
Antwort:

keine Antwort

Schreibt einen Text in die angegebene Zeile (0 bis 7) mit einer vorgegebenen Position (0 bis 21). Der Text kann maximal 22 Zeichen lang sein.

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.

BrickletLCD128x64.draw_buffered_frame
Funktions ID:

7

Anfrage:
  • force_complete_redraw -- bool
Antwort:

keine Antwort

Stellt den aktuell Inhalt des internen Buffers auf dem Display dar. Normalerweise schreibt jeder Aufruf von write_pixels_low_level 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.

BrickletLCD128x64.get_touch_position
Funktions ID:

8

Anfrage:

keine Nutzdaten

Antwort:
  • pressure -- uint16
  • x -- uint16
  • y -- uint16
  • age -- uint32

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

  • Pressure: Anpressdruck des Touches (0-300)
  • X: Touch-Position auf der X-Achse (0-127)
  • Y: Touch-Position auf der Y-Achse (0-63)
  • Age: Alter des Touches in ms (wie lange ist die Erkennung des Touches her)
BrickletLCD128x64.get_touch_gesture
Funktions ID:

12

Anfrage:

keine Nutzdaten

Antwort:
  • gesture -- uint8
  • duration -- uint32
  • pressure_max -- uint16
  • x_start -- uint16
  • y_start -- uint16
  • x_end -- uint16
  • y_end -- uint16
  • age -- uint32

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

Das Age Parameter gibt das Alter der Geste in ms an (wie lange ist die Erkennung der Geste her).

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: left to right, für gesture
  • 1: right to left, für gesture
  • 2: top to bottom, für gesture
  • 3: bottom to top, für gesture
BrickletLCD128x64.draw_line
Funktions ID:

16

Anfrage:
  • position_x_start -- uint8
  • position_y_start -- uint8
  • position_x_end -- uint8
  • position_y_end -- uint8
  • color -- bool
Antwort:

keine Antwort

Zeichnet eine weiße oder schwarze Linie von (x, y)-start nach (x, y)-end. Der Wertebereich für die x-Werte ist 0 bis 127 und der Wertebereich für die y-Werte ist 0-63.

Neu in Version 2.0.2 (Plugin).

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: white, für color
  • 1: black, für color
BrickletLCD128x64.draw_box
Funktions ID:

17

Anfrage:
  • position_x_start -- uint8
  • position_y_start -- uint8
  • position_x_end -- uint8
  • position_y_end -- uint8
  • fill -- bool
  • color -- bool
Antwort:

keine Antwort

Zeichnet ein weißes oder schwarzes Rechteck von (x, y)-start nach (x, y)-end. Der Wertebereich für die x-Werte ist 0 bis 127 und der Wertebereich für die y-Werte ist 0-63.

Wenn fill auf true gesetzt wird, wird das Rechteck mit der angegebenen Farbe ausgefüllt. Ansonsten wird nur der Umriss gezeichnet.

Neu in Version 2.0.2 (Plugin).

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: white, für color
  • 1: black, für color
BrickletLCD128x64.draw_text
Funktions ID:

18

Anfrage:
  • position_x -- uint8
  • position_y -- uint8
  • font -- uint8
  • color -- bool
  • text -- char[22]
Antwort:

keine Antwort

Zeichnet einen Text mit bis zu 22 Buchstaben an die Pixelposition (x, y).

Die Wertebereich für die x-Werte ist 0 bis 127 und der Wertebereich für die y-Werte ist 0-63.

Es können 9 unterschiedliche Font-Größen genutzt werden und der Text kann in weiß oder schwarz gezeichnet werden.

Neu in Version 2.0.2 (Plugin).

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: 6x8, für font
  • 1: 6x16, für font
  • 2: 6x24, für font
  • 3: 6x32, für font
  • 4: 12x16, für font
  • 5: 12x24, für font
  • 6: 12x32, für font
  • 7: 18x24, für font
  • 8: 18x32, für font
  • 9: 24x32, für font
  • 0: white, für color
  • 1: black, für color
BrickletLCD128x64.set_gui_button
Funktions ID:

19

Anfrage:
  • index -- uint8
  • position_x -- uint8
  • position_y -- uint8
  • width -- uint8
  • height -- uint8
  • text -- char[16]
Antwort:

keine Antwort

Zeichnet einen klickbaren Button an Position (x, y) mit dem gegebenem Text von bis zu 16 Zeichen.

Es können bis zu 12 Buttons genutzt werden (Index 0-11).

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_low_level 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_low_level gezeichnet werden.

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64.get_gui_button
Funktions ID:

20

Anfrage:
  • index -- uint8
Antwort:
  • active -- bool
  • position_x -- uint8
  • position_y -- uint8
  • width -- uint8
  • height -- uint8
  • text -- char[16]

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

BrickletLCD128x64.remove_gui_button
Funktions ID:

21

Anfrage:
  • index -- uint8
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).

BrickletLCD128x64.get_gui_button_pressed
Funktions ID:

24

Anfrage:
  • index -- uint8
Antwort:
  • pressed -- 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).

BrickletLCD128x64.set_gui_slider
Funktions ID:

26

Anfrage:
  • index -- uint8
  • position_x -- uint8
  • position_y -- uint8
  • length -- uint8
  • direction -- uint8
  • value -- uint8
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.

Das Rückgabewert 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_low_level gezeichnet werden. Um einen Button zu entfernen kann die Funktion remove_gui_slider genutzt werden.

Neu in Version 2.0.2 (Plugin).

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: horizontal, für direction
  • 1: vertical, für direction
BrickletLCD128x64.get_gui_slider
Funktions ID:

27

Anfrage:
  • index -- uint8
Antwort:
  • active -- bool
  • position_x -- uint8
  • position_y -- uint8
  • length -- uint8
  • direction -- uint8
  • value -- uint8

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.

Neu in Version 2.0.2 (Plugin).

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: horizontal, für direction
  • 1: vertical, für direction
BrickletLCD128x64.remove_gui_slider
Funktions ID:

28

Anfrage:
  • index -- uint8
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).

BrickletLCD128x64.get_gui_slider_value
Funktions ID:

31

Anfrage:
  • index -- uint8
Antwort:
  • value -- uint8

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

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64.set_gui_tab_configuration
Funktions ID:

33

Anfrage:
  • change_tab_config -- uint8
  • clear_gui -- bool
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.

Standardmäßig ist klicken und wischen sowie das automatische löschen der GUI aktiviert.

Neu in Version 2.0.2 (Plugin).

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 1: click, für change_tab_config
  • 2: swipe, für change_tab_config
  • 3: click and swipe, für change_tab_config
BrickletLCD128x64.get_gui_tab_configuration
Funktions ID:

34

Anfrage:

keine Nutzdaten

Antwort:
  • change_tab_config -- uint8
  • clear_gui -- bool

Gibt die Tab-Konfiguration zurück, wie von set_gui_tab_configuration gesetzt.

Neu in Version 2.0.2 (Plugin).

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 1: click, für change_tab_config
  • 2: swipe, für change_tab_config
  • 3: click and swipe, für change_tab_config
BrickletLCD128x64.set_gui_tab_text
Funktions ID:

35

Anfrage:
  • index -- uint8
  • text -- char[5]
Antwort:

keine Antwort

Fügt einen Text-Tab mit dem gegebenen Index hinzu. Der Text kann eine Länge von bis zu 5 Buchstaben haben.

Es können bis zu 10 Tabs verwendet werden (Index 0-9).

Ein Text-Tab mit dem gleichen Index wie ein Icon-Tab überschreibt diesen.

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64.get_gui_tab_text
Funktions ID:

36

Anfrage:
  • index -- uint8
Antwort:
  • active -- bool
  • text -- char[5]

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

BrickletLCD128x64.set_gui_tab_icon
Funktions ID:

37

Anfrage:
  • index -- uint8
  • icon -- bool[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 (Index 0-9).

Ein Icon-Tab mit dem gleichen Index wie ein Text-Tab überschreibt diesen.

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64.get_gui_tab_icon
Funktions ID:

38

Anfrage:
  • index -- uint8
Antwort:
  • active -- bool
  • icon -- bool[168]

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

BrickletLCD128x64.remove_gui_tab
Funktions ID:

39

Anfrage:
  • index -- uint8
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).

BrickletLCD128x64.set_gui_tab_selected
Funktions ID:

40

Anfrage:
  • index -- uint8
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).

BrickletLCD128x64.get_gui_tab_selected
Funktions ID:

43

Anfrage:

keine Nutzdaten

Antwort:
  • index -- int8

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

BrickletLCD128x64.set_gui_graph_configuration
Funktions ID:

45

Anfrage:
  • index -- uint8
  • graph_type -- uint8
  • position_x -- uint8
  • position_y -- uint8
  • width -- uint8
  • height -- uint8
  • text_x -- char[4]
  • text_y -- char[4]
Antwort:

keine Antwort

Setzt die Konfiguration für bis zu vier Graphen (Index 0-3).

Der Graph kann vom Typ Dot-, Line- oder Bar-Graph sein.

Die x- und y-Positionen sind Pixel-Positionen. Diese sind im Wertebereich von (0, 0) bis (127, 63). Die Maximale Breite (width) ist 118 und die maximale Höhe (height) ist 63.

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_low_level 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_low_level gezeichnet werden. Um einen Graphen zu entfernen kann die Funktion remove_gui_graph genutzt werden.

Neu in Version 2.0.2 (Plugin).

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: dot, für graph_type
  • 1: line, für graph_type
  • 2: bar, für graph_type
BrickletLCD128x64.get_gui_graph_configuration
Funktions ID:

46

Anfrage:
  • index -- uint8
Antwort:
  • active -- bool
  • graph_type -- uint8
  • position_x -- uint8
  • position_y -- uint8
  • width -- uint8
  • height -- uint8
  • text_x -- char[4]
  • text_y -- char[4]

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.

Neu in Version 2.0.2 (Plugin).

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: dot, für graph_type
  • 1: line, für graph_type
  • 2: bar, für graph_type
BrickletLCD128x64.set_gui_graph_data_low_level
Funktions ID:

47

Anfrage:
  • index -- uint8
  • data_length -- uint16
  • data_chunk_offset -- uint16
  • data_chunk_data -- uint8[59]
Antwort:

keine Antwort

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

BrickletLCD128x64.get_gui_graph_data_low_level
Funktions ID:

48

Anfrage:
  • index -- uint8
Antwort:
  • data_length -- uint16
  • data_chunk_offset -- uint16
  • data_chunk_data -- uint8[59]

Gibt die Datenpunkte des Graphen mit dem gegebenen Index zurück, wie von set_gui_graph_data_low_level gesetzt.

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64.remove_gui_graph
Funktions ID:

49

Anfrage:
  • index -- uint8
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).

BrickletLCD128x64.remove_all_gui
Funktions ID:50
Anfrage:keine Nutzdaten
Antwort:keine Antwort

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

Neu in Version 2.0.2 (Plugin).

Fortgeschrittene Funktionen

BrickletLCD128x64.set_display_configuration
Funktions ID:

4

Anfrage:
  • contrast -- uint8
  • backlight -- uint8
  • invert -- bool
  • automatic_draw -- bool
Antwort:

keine Antwort

Setzt die Konfiguration des Displays.

Der Kontrast kann zwischen 0 und 63, die Backlight-Intensität zwischen 0 und 100 und das Farbschema invertiert (weiß/schwarz) eingestellt werden.

Wenn Automatic Draw aktiviert (true) ist dann wird das Display bei jedem Aufruf von write_pixels_low_level 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.

Standardwerte: Kontrast 14, Backlight-Intensität 100, Invertierung aus und Automatic Draw aktiviert.

BrickletLCD128x64.get_display_configuration
Funktions ID:

5

Anfrage:

keine Nutzdaten

Antwort:
  • contrast -- uint8
  • backlight -- uint8
  • invert -- bool
  • automatic_draw -- bool

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

BrickletLCD128x64.set_touch_led_config
Funktions ID:

51

Anfrage:
  • config -- uint8
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 Bootlodermodus befindet ist die LED aus.

Neu in Version 2.0.2 (Plugin).

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show touch, für config
BrickletLCD128x64.get_touch_led_config
Funktions ID:

52

Anfrage:

keine Nutzdaten

Antwort:
  • config -- uint8

Gibt die Konfiguration zurück, wie von set_touch_led_config gesetzt.

Neu in Version 2.0.2 (Plugin).

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show touch, für config
BrickletLCD128x64.get_spitfp_error_count
Funktions ID:

234

Anfrage:

keine Nutzdaten

Antwort:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

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.

BrickletLCD128x64.set_bootloader_mode
Funktions ID:

235

Anfrage:
  • mode -- uint8
Antwort:
  • status -- uint8

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 Bootlodaer- 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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
  • 0: ok, für status
  • 1: invalid mode, für status
  • 2: no change, für status
  • 3: entry function not present, für status
  • 4: device identifier incorrect, für status
  • 5: crc mismatch, für status
BrickletLCD128x64.get_bootloader_mode
Funktions ID:

236

Anfrage:

keine Nutzdaten

Antwort:
  • mode -- uint8

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
BrickletLCD128x64.set_write_firmware_pointer
Funktions ID:

237

Anfrage:
  • pointer -- uint32
Antwort:

keine Antwort

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.

BrickletLCD128x64.write_firmware
Funktions ID:

238

Anfrage:
  • data -- uint8[64]
Antwort:
  • status -- uint8

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.

BrickletLCD128x64.set_status_led_config
Funktions ID:

239

Anfrage:
  • config -- uint8
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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletLCD128x64.get_status_led_config
Funktions ID:

240

Anfrage:

keine Nutzdaten

Antwort:
  • config -- uint8

Gibt die Konfiguration zurück, wie von set_status_led_config gesetzt.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletLCD128x64.get_chip_temperature
Funktions ID:

242

Anfrage:

keine Nutzdaten

Antwort:
  • temperature -- int16

Gibt die Temperatur in °C, 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.

BrickletLCD128x64.reset
Funktions ID:243
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.

BrickletLCD128x64.write_uid
Funktions ID:

248

Anfrage:
  • uid -- uint32
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.

BrickletLCD128x64.read_uid
Funktions ID:

249

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- uint32

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

BrickletLCD128x64.get_identity
Funktions ID:

255

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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. 

Konfigurationsfunktionen für Callbacks

BrickletLCD128x64.set_touch_position_callback_configuration
Funktions ID:

9

Anfrage:
  • period -- uint32
  • value_has_to_change -- bool
Antwort:

keine Antwort

Die Periode in ms ist die Periode mit der der CALLBACK_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.

Der Standardwert ist (0, false).

BrickletLCD128x64.get_touch_position_callback_configuration
Funktions ID:

10

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32
  • value_has_to_change -- bool

Gibt die Callback-Konfiguration zurück, wie mittels set_touch_position_callback_configuration gesetzt.

BrickletLCD128x64.set_touch_gesture_callback_configuration
Funktions ID:

13

Anfrage:
  • period -- uint32
  • value_has_to_change -- bool
Antwort:

keine Antwort

Die Periode in ms ist die Periode mit der der CALLBACK_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.

Der Standardwert ist (0, false).

BrickletLCD128x64.get_touch_gesture_callback_configuration
Funktions ID:

14

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32
  • value_has_to_change -- bool

Gibt die Callback-Konfiguration zurück, wie mittels set_touch_gesture_callback_configuration gesetzt.

BrickletLCD128x64.set_gui_button_pressed_callback_configuration
Funktions ID:

22

Anfrage:
  • period -- uint32
  • value_has_to_change -- bool
Antwort:

keine Antwort

Die Periode in ms ist die Periode mit der der CALLBACK_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.

Der Standardwert ist (0, false).

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64.get_gui_button_pressed_callback_configuration
Funktions ID:

23

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32
  • value_has_to_change -- bool

Gibt die Callback-Konfiguration zurück, wie mittels set_gui_button_pressed_callback_configuration gesetzt.

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64.set_gui_slider_value_callback_configuration
Funktions ID:

29

Anfrage:
  • period -- uint32
  • value_has_to_change -- bool
Antwort:

keine Antwort

Die Periode in ms ist die Periode mit der der CALLBACK_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.

Der Standardwert ist (0, false).

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64.get_gui_slider_value_callback_configuration
Funktions ID:

30

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32
  • value_has_to_change -- bool

Gibt die Callback-Konfiguration zurück, wie mittels set_gui_slider_value_callback_configuration gesetzt.

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64.set_gui_tab_selected_callback_configuration
Funktions ID:

41

Anfrage:
  • period -- uint32
  • value_has_to_change -- bool
Antwort:

keine Antwort

Die Periode in ms ist die Periode mit der der CALLBACK_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.

Der Standardwert ist (0, false).

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64.get_gui_tab_selected_callback_configuration
Funktions ID:

42

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32
  • value_has_to_change -- bool

Gibt die Callback-Konfiguration zurück, wie mittels set_gui_tab_selected_callback_configuration gesetzt.

Neu in Version 2.0.2 (Plugin).

Callbacks

BrickletLCD128x64.CALLBACK_TOUCH_POSITION
Funktions ID:

11

Antwort:
  • pressure -- uint16
  • x -- uint16
  • y -- uint16
  • age -- uint32

Dieser Callback wird mit der Periode, wie gesetzt mit set_touch_position_callback_configuration, ausgelöst. Die Rückgabewerte sind die gleichen wie die von get_touch_position.

BrickletLCD128x64.CALLBACK_TOUCH_GESTURE
Funktions ID:

15

Antwort:
  • gesture -- uint8
  • duration -- uint32
  • pressure_max -- uint16
  • x_start -- uint16
  • y_start -- uint16
  • x_end -- uint16
  • y_end -- uint16
  • age -- uint32

Dieser Callback wird mit der Periode, wie gesetzt mit set_touch_gesture_callback_configuration, ausgelöst. Die Rückgabewerte sind die gleichen wie die von get_touch_gesture.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: left to right, für gesture
  • 1: right to left, für gesture
  • 2: top to bottom, für gesture
  • 3: bottom to top, für gesture
BrickletLCD128x64.CALLBACK_GUI_BUTTON_PRESSED
Funktions ID:

25

Antwort:
  • index -- uint8
  • pressed -- bool

Dieser Callback wird mit der Periode, wie gesetzt mit set_gui_button_pressed_callback_configuration, ausgelöst. Die Rückgabewerte sind die gleichen wie die von get_gui_button_pressed.

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64.CALLBACK_GUI_SLIDER_VALUE
Funktions ID:

32

Antwort:
  • index -- uint8
  • value -- uint8

Dieser Callback wird mit der Periode, wie gesetzt mit set_gui_slider_value_callback_configuration, ausgelöst. Die Rückgabewerte sind die gleichen wie die von get_gui_slider_value.

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64.CALLBACK_GUI_TAB_SELECTED
Funktions ID:

44

Antwort:
  • index -- int8

Dieser Callback wird mit der Periode, wie gesetzt mit set_gui_tab_selected_callback_configuration, ausgelöst. Die Rückgabewerte sind die gleichen wie die von get_gui_tab_selected.

Neu in Version 2.0.2 (Plugin).