Python - OLED 64x48 Bricklet¶

Hello World¶

Download (example_hello_world.py)

 1#!/usr/bin/env python
 2# -*- coding: utf-8 -*-
 3
 4HOST = "localhost"
 5PORT = 4223
 6UID = "XYZ" # Change XYZ to the UID of your OLED 64x48 Bricklet
 7
 8from tinkerforge.ip_connection import IPConnection
 9from tinkerforge.bricklet_oled_64x48 import BrickletOLED64x48
10
11if __name__ == "__main__":
12    ipcon = IPConnection() # Create IP connection
13    oled = BrickletOLED64x48(UID, ipcon) # Create device object
14
15    ipcon.connect(HOST, PORT) # Connect to brickd
16    # Don't use device before ipcon is connected
17
18    # Clear display
19    oled.clear_display()
20
21    # Write "Hello World" starting from upper left corner of the screen
22    oled.write_line(0, 0, "Hello World")
23
24    input("Press key to exit\n") # Use raw_input() in Python 2
25    ipcon.disconnect()

Pixel Matrix¶

Download (example_pixel_matrix.py)

 1#!/usr/bin/env python
 2# -*- coding: utf-8 -*-
 3
 4HOST = "localhost"
 5PORT = 4223
 6UID = "XYZ" # Change XYZ to the UID of your OLED 64x48 Bricklet
 7WIDTH = 64 # Columns (each 1 pixel wide)
 8HEIGHT = 6 # Rows (each 8 pixels high)
 9
10from tinkerforge.ip_connection import IPConnection
11from tinkerforge.bricklet_oled_64x48 import BrickletOLED64x48
12
13def draw_matrix(oled, start_column, start_row, column_count, row_count, pixels):
14    pages = []
15
16    # Convert pixel matrix into 8bit pages
17    for row in range(row_count):
18        pages.append([])
19
20        for column in range(column_count):
21            page = 0
22
23            for bit in range(8):
24                if pixels[(row * 8) + bit][column]:
25                    page |= 1 << bit
26
27            pages[row].append(page)
28
29    # Merge page matrix into single page array
30    data = []
31
32    for row in range(row_count):
33        for column in range(column_count):
34            data.append(pages[row][column])
35
36    # Set new window
37    oled.new_window(start_column, start_column + column_count - 1,
38                    start_row, start_row + row_count - 1)
39
40    # Write page data in 64 byte blocks
41    for i in range(0, len(data), 64):
42        block = data[i:i + 64]
43        oled.write(block + [0] * (64 - len(block)))
44
45if __name__ == "__main__":
46    ipcon = IPConnection() # Create IP connection
47    oled = BrickletOLED64x48(UID, ipcon) # Create device object
48
49    ipcon.connect(HOST, PORT) # Connect to brickd
50    # Don't use device before ipcon is connected
51
52    # Clear display
53    oled.clear_display()
54
55    # Draw checkerboard pattern
56    pixels = []
57
58    for row in range(HEIGHT * 8):
59        pixels.append([])
60
61        for column in range(WIDTH):
62            pixels[row].append((row // 8) % 2 == (column // 8) % 2)
63
64    draw_matrix(oled, 0, 0, WIDTH, HEIGHT, pixels)
65
66    input("Press key to exit\n") # Use raw_input() in Python 2
67    ipcon.disconnect()

Load Image¶

Download (example_load_image.py)

 1#!/usr/bin/env python
 2# -*- coding: utf-8 -*-
 3
 4HOST = "localhost"
 5PORT = 4223
 6UID = "XYZ" # Change XYZ to the UID of your OLED 64x48 Bricklet
 7WIDTH = 64 # Columns (each 1 pixel wide)
 8HEIGHT = 6 # Rows (each 8 pixels high)
 9
10import sys
11from PIL import Image
12from tinkerforge.ip_connection import IPConnection
13from tinkerforge.bricklet_oled_64x48 import BrickletOLED64x48
14
15def draw_matrix(oled, start_column, start_row, column_count, row_count, pixels):
16    pages = []
17
18    # Convert pixel matrix into 8bit pages
19    for row in range(row_count):
20        pages.append([])
21
22        for column in range(column_count):
23            page = 0
24
25            for bit in range(8):
26                if pixels[(row * 8) + bit][column]:
27                    page |= 1 << bit
28
29            pages[row].append(page)
30
31    # Merge page matrix into single page array
32    data = []
33
34    for row in range(row_count):
35        for column in range(column_count):
36            data.append(pages[row][column])
37
38    # Set new window
39    oled.new_window(start_column, start_column + column_count - 1,
40                    start_row, start_row + row_count - 1)
41
42    # Write page data in 64 byte blocks
43    for i in range(0, len(data), 64):
44        block = data[i:i + 64]
45        oled.write(block + [0] * (64 - len(block)))
46
47if __name__ == "__main__":
48    ipcon = IPConnection() # Create IP connection
49    oled = BrickletOLED64x48(UID, ipcon) # Create device object
50
51    ipcon.connect(HOST, PORT) # Connect to brickd
52    # Don't use device before ipcon is connected
53
54    # Clear display
55    oled.clear_display()
56
57    # Convert image to black/white pixels
58    image = Image.open(sys.argv[1])
59    image_data = image.load()
60    pixels = []
61
62    for row in range(HEIGHT * 8):
63        pixels.append([])
64
65        for column in range(WIDTH):
66            if column < image.size[0] and row < image.size[1]:
67                pixel = image_data[column, row] > 0
68            else:
69                pixel = False
70
71            pixels[row].append(pixel)
72
73    draw_matrix(oled, 0, 0, WIDTH, HEIGHT, pixels)
74
75    input("Press key to exit\n") # Use raw_input() in Python 2
76    ipcon.disconnect()

Scribble¶

Download (example_scribble.py)

 1#!/usr/bin/env python
 2# -*- coding: utf-8 -*-
 3
 4HOST = "localhost"
 5PORT = 4223
 6UID = "XYZ" # Change XYZ to the UID of your OLED 64x48 Bricklet
 7WIDTH = 64 # Columns (each 1 pixel wide)
 8HEIGHT = 6 # Rows (each 8 pixels high)
 9
10import math
11import time
12from PIL import Image, ImageDraw
13from tinkerforge.ip_connection import IPConnection
14from tinkerforge.bricklet_oled_64x48 import BrickletOLED64x48
15
16def draw_image(oled, start_column, start_row, column_count, row_count, image):
17    image_data = image.load()
18    pages = []
19
20    # Convert image pixels into 8bit pages
21    for row in range(row_count):
22        pages.append([])
23
24        for column in range(column_count):
25            page = 0
26
27            for bit in range(8):
28                if image_data[column, (row * 8) + bit]:
29                    page |= 1 << bit
30
31            pages[row].append(page)
32
33    # Merge page matrix into single page array
34    data = []
35
36    for row in range(row_count):
37        for column in range(column_count):
38            data.append(pages[row][column])
39
40    # Set new window
41    oled.new_window(start_column, start_column + column_count - 1,
42                    start_row, start_row + row_count - 1)
43
44    # Write page data in 64 byte blocks
45    for i in range(0, len(data), 64):
46        block = data[i:i + 64]
47        oled.write(block + [0] * (64 - len(block)))
48
49if __name__ == "__main__":
50    ipcon = IPConnection() # Create IP connection
51    oled = BrickletOLED64x48(UID, ipcon) # Create device object
52
53    ipcon.connect(HOST, PORT) # Connect to brickd
54    # Don't use device before ipcon is connected
55
56    # Clear display
57    oled.clear_display()
58
59    # Draw rotating line
60    image = Image.new("1", (WIDTH, HEIGHT * 8), 0)
61    draw = ImageDraw.Draw(image)
62    origin_x = WIDTH // 2
63    origin_y = HEIGHT * 8 // 2
64    length = HEIGHT * 8 // 2 - 2
65    angle = 0
66
67    print("Press ctrl+c to exit")
68
69    try:
70        while True:
71            radians = math.pi * angle / 180.0
72            x = (int)(origin_x + length * math.cos(radians))
73            y = (int)(origin_y + length * math.sin(radians))
74
75            draw.rectangle((0, 0, WIDTH, HEIGHT * 8), 0, 0)
76            draw.line((origin_x, origin_y, x, y), 1, 1)
77
78            draw_image(oled, 0, 0, WIDTH, HEIGHT, image)
79            time.sleep(0.025)
80
81            angle += 1
82    except KeyboardInterrupt:
83        pass
84
85    ipcon.disconnect()

Grundfunktionen¶

BrickletOLED64x48(uid, ipcon)¶

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("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickletOLED64x48.write(data)¶

Parameter:	data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	None

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.

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

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]
Rückgabe:	None

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

BrickletOLED64x48.clear_display()¶

Rückgabe:	None

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

BrickletOLED64x48.write_line(line, position, text)¶

Parameter:	line – Typ: int, Wertebereich: [0 bis 5] position – Typ: int, Wertebereich: [0 bis 12] text – Typ: str, Länge: bis zu 13
Rückgabe:	None

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.

Der der Zeichensatz entspricht Codepage 437.

Fortgeschrittene Funktionen¶

BrickletOLED64x48.set_display_configuration(contrast, invert)¶

Parameter:	contrast – Typ: int, Wertebereich: [0 bis 255], Standardwert: 143 invert – Typ: bool, Standardwert: False
Rückgabe:	None

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()¶

Rückgabeobjekt:	contrast – Typ: int, Wertebereich: [0 bis 255], Standardwert: 143 invert – Typ: bool, Standardwert: False

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

BrickletOLED64x48.get_identity()¶

Rückgabeobjekt:

uid – Typ: str, Länge: bis zu 8 connected_uid – Typ: str, Länge: bis zu 8 position – Typ: chr, Wertebereich: ["a" bis "h", "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]

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¶

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()¶

Rückgabeobjekt:	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)¶

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

Parameter:	function_id – Typ: int, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	None

Ä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)¶

Parameter:	response_expected – Typ: bool
Rückgabe:	None

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