Dies ist die Beschreibung der Ruby API Bindings für das OLED 128x64 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des OLED 128x64 Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Ruby API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (example_hello_world.rb)
1#!/usr/bin/env ruby
2# -*- ruby encoding: utf-8 -*-
3
4require 'tinkerforge/ip_connection'
5require 'tinkerforge/bricklet_oled_128x64_v2'
6
7include Tinkerforge
8
9HOST = 'localhost'
10PORT = 4223
11UID = 'XYZ' # Change XYZ to the UID of your OLED 128x64 Bricklet 2.0
12
13ipcon = IPConnection.new # Create IP connection
14oled = BrickletOLED128x64V2.new UID, ipcon # Create device object
15
16ipcon.connect HOST, PORT # Connect to brickd
17# Don't use device before ipcon is connected
18
19# Clear display
20oled.clear_display
21
22# Write "Hello World" starting from upper left corner of the screen
23oled.write_line 0, 0, 'Hello World'
24
25puts 'Press key to exit'
26$stdin.gets
27ipcon.disconnect
Download (example_pixel_matrix.rb)
1#!/usr/bin/env ruby
2# -*- ruby encoding: utf-8 -*-
3
4require 'tinkerforge/ip_connection'
5require 'tinkerforge/bricklet_oled_128x64_v2'
6
7include Tinkerforge
8
9HOST = 'localhost'
10PORT = 4223
11UID = 'XYZ' # Change XYZ to the UID of your OLED 128x64 Bricklet 2.0
12WIDTH = 128 # Columns
13HEIGHT = 64 # Rows
14
15ipcon = IPConnection.new # Create IP connection
16oled = BrickletOLED128x64V2.new UID, ipcon # Create device object
17
18ipcon.connect HOST, PORT # Connect to brickd
19# Don't use device before ipcon is connected
20
21# Clear display
22oled.clear_display
23
24# Draw checkerboard pattern
25pixels = []
26
27for row in 0..HEIGHT - 1
28 for column in 0..WIDTH - 1
29 pixels[row * WIDTH + column] = (row / 8) % 2 == (column / 8) % 2
30 end
31end
32
33oled.write_pixels 0, 0, WIDTH-1, HEIGHT-1, pixels
34
35puts 'Press key to exit'
36$stdin.gets
37ipcon.disconnect
Download (example_scribble.rb)
1#!/usr/bin/env ruby
2# -*- ruby encoding: utf-8 -*-
3
4require 'rgd'
5require 'tinkerforge/ip_connection'
6require 'tinkerforge/bricklet_oled_128x64_v2'
7
8include Tinkerforge
9
10HOST = 'localhost'
11PORT = 4223
12UID = 'XYZ' # Change XYZ to the UID of your OLED 128x64 Bricklet 2.0
13WIDTH = 128 # Columns
14HEIGHT = 64 # Rows
15
16def draw_image(oled, start_column, start_row, column_count, row_count, image)
17 pixels = []
18
19 # Convert image pixels into 8bit pages
20 for row in 0..row_count - 1
21
22 for column in 0..column_count - 1
23 index = image[column, row]
24 rgba = image.rgba index
25 pixels[row*column_count + column] = rgba[0] > 0
26 end
27 end
28
29 oled.write_pixels 0, 0, WIDTH-1, HEIGHT-1, pixels
30end
31
32ipcon = IPConnection.new # Create IP connection
33oled = BrickletOLED128x64V2.new UID, ipcon # Create device object
34
35ipcon.connect HOST, PORT # Connect to brickd
36# Don't use device before ipcon is connected
37
38# Clear display
39oled.clear_display
40
41# Draw checkerboard pattern
42image = RGD::Image.create WIDTH, HEIGHT
43black = image.color_allocate 0, 0, 0
44white = image.color_allocate 255, 255, 255
45origin_x = WIDTH / 2
46origin_y = HEIGHT / 2
47length = HEIGHT / 2 - 2
48angle = 0
49
50puts 'Press key to exit'
51
52Thread.new do
53 $stdin.gets
54 exit
55end
56
57while true
58 radians = Math::PI * angle / 180.0
59 x = (origin_x + length * Math.cos(radians)).to_i
60 y = (origin_y + length * Math.sin(radians)).to_i
61
62 image.filled_rectangle 0, 0, WIDTH, HEIGHT, black
63 image.line origin_x, origin_y, x, y, white
64
65 draw_image oled, 0, 0, WIDTH, HEIGHT, image
66 sleep 0.025
67
68 angle += 1
69end
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:
oled_128x64_v2 = BrickletOLED128x64V2.new 'YOUR_DEVICE_UID', ipcon
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
| Parameter: |
|
|---|
Schreibt Pixel in das angegebene Fenster.
Die Pixel werden zeilenweise von oben nach unten 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.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
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.
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.
| Parameter: |
|
|---|
Bemerkung
Diese Funktion ist ist nur hier für Rückwärtskompatibilität.
Seit Firmware Version 2.0.5 empfehlen wir #write_line_2.
Diese Funktion hat zusätzlich einen Parameter für Letter-Spacing.
Schreibt einen Text in die angegebene Zeile mit einer vorgegebenen Position. 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.
Der der Zeichensatz entspricht Codepage 437.
| Parameter: |
|
|---|
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.
| Parameter: |
|
|---|
Schreibt einen Text in die angegebene Zeile mit einer vorgegebenen Position. Der Text kann maximal 26 Zeichen lang sein.
Mit einem Letter-Spacing von 0 können bis zu 26 Zeichen geschrieben werden und mit einem Letter-Spacing von 1 können bis zu 22 Zeichen geschrieben werden.
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.
| Parameter: |
|
|---|
Setzt die Konfiguration des Displays.
Der Kontrast kann zwischen 0 und 255 und das Farbschema invertiert (weiß/schwarz) eingestellt werden.
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.
| Rückgabe-Array: |
|
|---|
Gibt die Konfiguration zurück, wie von #set_display_configuration gesetzt.
| Rückgabe-Array: |
|
|---|
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.
| Parameter: |
|
|---|
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 Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletOLED128x64V2::STATUS_LED_CONFIG_OFF = 0
BrickletOLED128x64V2::STATUS_LED_CONFIG_ON = 1
BrickletOLED128x64V2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletOLED128x64V2::STATUS_LED_CONFIG_SHOW_STATUS = 3
| Rückgabe: |
|
|---|
Gibt die Konfiguration zurück, wie von #set_status_led_config gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletOLED128x64V2::STATUS_LED_CONFIG_OFF = 0
BrickletOLED128x64V2::STATUS_LED_CONFIG_ON = 1
BrickletOLED128x64V2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletOLED128x64V2::STATUS_LED_CONFIG_SHOW_STATUS = 3
| Rückgabe: |
|
|---|
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.
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.
| Rückgabe-Array: |
|
|---|
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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.
Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.
| Rückgabe-Array: |
|
|---|
Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.
Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt
werden, da diese Funktionen immer eine Antwort senden. Für
Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber
entfernt werden mittels #set_response_expected. Für Setter-Funktionen ist
es standardmäßig nicht gesetzt, kann aber gesetzt werden.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für function_id:
BrickletOLED128x64V2::FUNCTION_WRITE_PIXELS = 1
BrickletOLED128x64V2::FUNCTION_CLEAR_DISPLAY = 3
BrickletOLED128x64V2::FUNCTION_SET_DISPLAY_CONFIGURATION = 4
BrickletOLED128x64V2::FUNCTION_WRITE_LINE = 6
BrickletOLED128x64V2::FUNCTION_DRAW_BUFFERED_FRAME = 7
BrickletOLED128x64V2::FUNCTION_WRITE_LINE_2 = 8
BrickletOLED128x64V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletOLED128x64V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletOLED128x64V2::FUNCTION_RESET = 243
BrickletOLED128x64V2::FUNCTION_WRITE_UID = 248
| Parameter: |
|
|---|
Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für function_id:
BrickletOLED128x64V2::FUNCTION_WRITE_PIXELS = 1
BrickletOLED128x64V2::FUNCTION_CLEAR_DISPLAY = 3
BrickletOLED128x64V2::FUNCTION_SET_DISPLAY_CONFIGURATION = 4
BrickletOLED128x64V2::FUNCTION_WRITE_LINE = 6
BrickletOLED128x64V2::FUNCTION_DRAW_BUFFERED_FRAME = 7
BrickletOLED128x64V2::FUNCTION_WRITE_LINE_2 = 8
BrickletOLED128x64V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletOLED128x64V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletOLED128x64V2::FUNCTION_RESET = 243
BrickletOLED128x64V2::FUNCTION_WRITE_UID = 248
| Parameter: |
|
|---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
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.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
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 Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletOLED128x64V2::BOOTLOADER_MODE_BOOTLOADER = 0
BrickletOLED128x64V2::BOOTLOADER_MODE_FIRMWARE = 1
BrickletOLED128x64V2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletOLED128x64V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletOLED128x64V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
Für status:
BrickletOLED128x64V2::BOOTLOADER_STATUS_OK = 0
BrickletOLED128x64V2::BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletOLED128x64V2::BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletOLED128x64V2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletOLED128x64V2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletOLED128x64V2::BOOTLOADER_STATUS_CRC_MISMATCH = 5
| Rückgabe: |
|
|---|
Gibt den aktuellen Bootloader-Modus zurück, siehe #set_bootloader_mode.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletOLED128x64V2::BOOTLOADER_MODE_BOOTLOADER = 0
BrickletOLED128x64V2::BOOTLOADER_MODE_FIRMWARE = 1
BrickletOLED128x64V2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletOLED128x64V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletOLED128x64V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
| Parameter: |
|
|---|
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.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
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.
| Parameter: |
|
|---|
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.
| Rückgabe: |
|
|---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
Diese Konstante wird verwendet um ein OLED 128x64 Bricklet 2.0 zu identifizieren.
Die #get_identity() Funktion und der
IPConnection::CALLBACK_ENUMERATE
Callback der IP Connection haben ein device_identifier Parameter um den Typ
des Bricks oder Bricklets anzugeben.
Diese Konstante stellt den Anzeigenamen eines OLED 128x64 Bricklet 2.0 dar.