Ruby - OLED 64x48 Bricklet

Dies ist die Beschreibung der Ruby API Bindings für das OLED 64x48 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des OLED 64x48 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Ruby API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Hello World

Download (example_hello_world.rb)

 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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_oled_64x48'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your OLED 64x48 Bricklet

ipcon = IPConnection.new # Create IP connection
oled = BrickletOLED64x48.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Clear display
oled.clear_display

# Write "Hello World" starting from upper left corner of the screen
oled.write_line 0, 0, 'Hello World'

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Pixel Matrix

Download (example_pixel_matrix.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_oled_64x48'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your OLED 64x48 Bricklet
WIDTH = 64 # Columns (each 1 pixel wide)
HEIGHT = 6 # Rows (each 8 pixels high)

def draw_matrix(oled, start_column, start_row, column_count, row_count, pixels)
  pages = []

  # Convert pixel matrix into 8bit pages
  for row in 0..row_count - 1
    pages[row] = []

    for column in 0..column_count - 1
      pages[row][column] = 0

      for bit in 0..7
        if pixels[row * 8 + bit][column]
          pages[row][column] |= 1 << bit
        end
      end
    end
  end

  # Merge page matrix into single page array
  data = []

  for row in 0..row_count - 1
    for column in 0..column_count - 1
      data.push pages[row][column]
    end
  end

  # Set new window
  oled.new_window start_column, start_column + column_count - 1, \
                  start_row, start_row + row_count - 1

  # Write page data in 64 byte blocks
  for i in (0..data.length - 1).step(64)
    block = data[i, 64]
    oled.write block.fill(0, block.length, 64 - block.length)
  end
end

ipcon = IPConnection.new # Create IP connection
oled = BrickletOLED64x48.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Clear display
oled.clear_display

# Draw checkerboard pattern
pixels = []

for row in 0..HEIGHT * 8 - 1
  pixels[row] = []

  for column in 0..WIDTH - 1
    pixels[row][column] = (row / 8) % 2 == (column / 8) % 2
  end
end

draw_matrix oled, 0, 0, WIDTH, HEIGHT, pixels

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Scribble

Download (example_scribble.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'rgd'
require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_oled_64x48'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change to your UID
WIDTH = 64 # Columns (each 1 pixel wide)
HEIGHT = 6 # Rows (each 8 pixels high)

def draw_image(oled, start_column, start_row, column_count, row_count, image)
  pages = []

  # Convert image pixels into 8bit pages
  for row in 0..row_count - 1
    pages[row] = []

    for column in 0..column_count - 1
      pages[row][column] = 0

      for bit in 0..7
        index = image[column, (row * 8) + bit]
        rgba = image.rgba index

        if rgba[0] > 0
          pages[row][column] |= 1 << bit
        end
      end
    end
  end

  # Merge page matrix into single page array
  data = []

  for row in 0..row_count - 1
    for column in 0..column_count - 1
      data.push pages[row][column]
    end
  end

  # Set new window
  oled.new_window start_column, start_column + column_count - 1, \
                  start_row, start_row + row_count - 1

  # Write page data in 64 byte blocks
  for i in (0..data.length - 1).step(64)
    block = data[i, 64]
    oled.write block.fill(0, block.length, 64 - block.length)
  end
end

ipcon = IPConnection.new # Create IP connection
oled = BrickletOLED64x48.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Clear display
oled.clear_display

# Draw checkerboard pattern
image = RGD::Image.create WIDTH, HEIGHT * 8
black = image.color_allocate 0, 0, 0
white = image.color_allocate 255, 255, 255
origin_x = WIDTH / 2
origin_y = HEIGHT * 8 / 2
length = HEIGHT * 8 / 2 - 2
angle = 0

puts 'Press key to exit'

Thread.new do
  $stdin.gets
  exit
end

while true
    radians = Math::PI * angle / 180.0
    x = (origin_x + length * Math.cos(radians)).to_i
    y = (origin_y + length * Math.sin(radians)).to_i

    image.filled_rectangle 0, 0, WIDTH, HEIGHT * 8, black
    image.line origin_x, origin_y, x, y, white

    draw_image oled, 0, 0, WIDTH, HEIGHT, image
    sleep 0.025

    angle += 1
end

API

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickletOLED64x48::new(uid, ipcon) → oled_64x48
Parameter:
  • uid – Typ: str
  • ipcon – Typ: IPConnection
Rückgabe:
  • oled_64x48 – Typ: BrickletOLED64x48

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

oled_64x48 = BrickletOLED64x48.new 'YOUR_DEVICE_UID', ipcon

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickletOLED64x48#write(data) → nil
Parameter:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]

Fügt 64 Byte Daten zu dem mit #new_window gesetztem Fenster hinzu.

Jede Zeile hat eine Höhe von 8 Pixeln welche einem Byte Daten entsprechen.

Beispiel: Wenn #new_window mit Spalte (Column) von 0 bis 63 und Zeile (Row) von 0 bis 5 (das ganze Display) aufgerufen wird, schreibt jedes #write (roter Pfeil) eine Zeile.

Display Pixel Reihenfolge

Das LSB (D0) von jedem Daten-Byte ist in der Zeile oben und das MSB (D7) ist in der Zeile unten.

Der nächste Aufruf von #write schreibt die zweite Zeile usw. Um das ganze Display zu füllen muss #write 6 mal aufgerufen werden.

BrickletOLED64x48#new_window(column_from, column_to, row_from, row_to) → nil
Parameter:
  • column_from – Typ: int, Wertebereich: [0 bis 63]
  • column_to – Typ: int, Wertebereich: [0 bis 63]
  • row_from – Typ: int, Wertebereich: [0 bis 5]
  • row_to – Typ: int, Wertebereich: [0 bis 5]

Setzt das Fenster in welches mit #write geschrieben werden kann. Eine Zeile (Row) hat eine Höhe von 8 Pixel.

BrickletOLED64x48#clear_display → nil

Löscht den aktuellen Inhalt des mit #new_window gesetztem Fensters.

BrickletOLED64x48#write_line(line, position, text) → nil
Parameter:
  • line – Typ: int, Wertebereich: [0 bis 5]
  • position – Typ: int, Wertebereich: [0 bis 12]
  • text – Typ: str, Länge: bis zu 13

Schreibt einen Text in die angegebene Zeile (0 bis 5) mit einer vorgegebenen Position (0 bis 12). Der Text kann maximal 13 Zeichen lang sein.

Beispiel: (1, 4, "Hallo") schreibt Hallo in die Mitte der zweiten Zeile des Displays.

Es ist möglich zuerst auf das Display mit #write zu malen und danach Text hinzuzufügen.

Das Display nutzt einen speziellen 5x7 Pixel Zeichensatz. Der Zeichensatz kann mit Hilfe von Brick Viewer angezeigt werden.

Fortgeschrittene Funktionen

BrickletOLED64x48#set_display_configuration(contrast, invert) → nil
Parameter:
  • contrast – Typ: int, Wertebereich: [0 bis 255], Standardwert: 143
  • invert – Typ: bool, Standardwert: false

Setzt die Konfiguration des Displays

Es können der Kontrast mit einem Wertebereich von 0 bis 255 gesetzt, sowie die Farben (schwarz/weiß) des Displays invertiert werden.

BrickletOLED64x48#get_display_configuration → [int, bool]
Rückgabe-Array:
  • 0: contrast – Typ: int, Wertebereich: [0 bis 255], Standardwert: 143
  • 1: invert – Typ: bool, Standardwert: false

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

BrickletOLED64x48#get_identity → [str, str, chr, [int, ...], [int, ...], int]
Rückgabe-Array:
  • 0: uid – Typ: str, Länge: bis zu 8
  • 1: connected_uid – Typ: str, Länge: bis zu 8
  • 2: position – Typ: chr, Wertebereich: ['a' bis 'i', 'z']
  • 3: 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]
  • 4: 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]
  • 5: device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]

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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Virtuelle Funktionen

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.

BrickletOLED64x48#get_api_version → [int, ...]
Rückgabe-Array:
  • 0: api_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]

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.

BrickletOLED64x48#get_response_expected(function_id) → bool
Parameter:
  • function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • response_expected – Typ: bool

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:

  • BrickletOLED64x48::FUNCTION_WRITE = 1
  • BrickletOLED64x48::FUNCTION_NEW_WINDOW = 2
  • BrickletOLED64x48::FUNCTION_CLEAR_DISPLAY = 3
  • BrickletOLED64x48::FUNCTION_SET_DISPLAY_CONFIGURATION = 4
  • BrickletOLED64x48::FUNCTION_WRITE_LINE = 6
BrickletOLED64x48#set_response_expected(function_id, response_expected) → nil
Parameter:
  • function_id – Typ: int, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool

Ä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:

  • BrickletOLED64x48::FUNCTION_WRITE = 1
  • BrickletOLED64x48::FUNCTION_NEW_WINDOW = 2
  • BrickletOLED64x48::FUNCTION_CLEAR_DISPLAY = 3
  • BrickletOLED64x48::FUNCTION_SET_DISPLAY_CONFIGURATION = 4
  • BrickletOLED64x48::FUNCTION_WRITE_LINE = 6
BrickletOLED64x48#set_response_expected_all(response_expected) → nil
Parameter:
  • response_expected – Typ: bool

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

BrickletOLED64x48::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein OLED 64x48 Bricklet 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.

BrickletOLED64x48::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines OLED 64x48 Bricklet dar.