Dies ist die Beschreibung der Python API Bindings für das OLED 128x64 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des OLED 128x64 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Python API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (example_hello_world.py)
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 | #!/usr/bin/env python
# -*- coding: utf-8 -*-
HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your OLED 128x64 Bricklet
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_oled_128x64 import BrickletOLED128x64
if __name__ == "__main__":
ipcon = IPConnection() # Create IP connection
oled = BrickletOLED128x64(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")
input("Press key to exit\n") # Use raw_input() in Python 2
ipcon.disconnect()
|
Download (example_pixel_matrix.py)
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 | #!/usr/bin/env python
# -*- coding: utf-8 -*-
HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your OLED 128x64 Bricklet
WIDTH = 128 # Columns (each 1 pixel wide)
HEIGHT = 8 # Rows (each 8 pixels high)
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_oled_128x64 import BrickletOLED128x64
def draw_matrix(oled, start_column, start_row, column_count, row_count, pixels):
pages = []
# Convert pixel matrix into 8bit pages
for row in range(row_count):
pages.append([])
for column in range(column_count):
page = 0
for bit in range(8):
if pixels[(row * 8) + bit][column]:
page |= 1 << bit
pages[row].append(page)
# Merge page matrix into single page array
data = []
for row in range(row_count):
for column in range(column_count):
data.append(pages[row][column])
# 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 range(0, len(data), 64):
block = data[i:i + 64]
oled.write(block + [0] * (64 - len(block)))
if __name__ == "__main__":
ipcon = IPConnection() # Create IP connection
oled = BrickletOLED128x64(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 range(HEIGHT * 8):
pixels.append([])
for column in range(WIDTH):
pixels[row].append((row // 8) % 2 == (column // 8) % 2)
draw_matrix(oled, 0, 0, WIDTH, HEIGHT, pixels)
input("Press key to exit\n") # Use raw_input() in Python 2
ipcon.disconnect()
|
Download (example_load_image.py)
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 | #!/usr/bin/env python
# -*- coding: utf-8 -*-
HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your OLED 128x64 Bricklet
WIDTH = 128 # Columns (each 1 pixel wide)
HEIGHT = 8 # Rows (each 8 pixels high)
import sys
from PIL import Image
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_oled_128x64 import BrickletOLED128x64
def draw_matrix(oled, start_column, start_row, column_count, row_count, pixels):
pages = []
# Convert pixel matrix into 8bit pages
for row in range(row_count):
pages.append([])
for column in range(column_count):
page = 0
for bit in range(8):
if pixels[(row * 8) + bit][column]:
page |= 1 << bit
pages[row].append(page)
# Merge page matrix into single page array
data = []
for row in range(row_count):
for column in range(column_count):
data.append(pages[row][column])
# 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 range(0, len(data), 64):
block = data[i:i + 64]
oled.write(block + [0] * (64 - len(block)))
if __name__ == "__main__":
ipcon = IPConnection() # Create IP connection
oled = BrickletOLED128x64(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()
# Convert image to black/white pixels
image = Image.open(sys.argv[1])
image_data = image.load()
pixels = []
for row in range(HEIGHT * 8):
pixels.append([])
for column in range(WIDTH):
if column < image.size[0] and row < image.size[1]:
pixel = image_data[column, row] > 0
else:
pixel = False
pixels[row].append(pixel)
draw_matrix(oled, 0, 0, WIDTH, HEIGHT, pixels)
input("Press key to exit\n") # Use raw_input() in Python 2
ipcon.disconnect()
|
Download (example_scribble.py)
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 | #!/usr/bin/env python
# -*- coding: utf-8 -*-
HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your OLED 128x64 Bricklet
WIDTH = 128 # Columns (each 1 pixel wide)
HEIGHT = 8 # Rows (each 8 pixels high)
import math
import time
from PIL import Image, ImageDraw
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_oled_128x64 import BrickletOLED128x64
def draw_image(oled, start_column, start_row, column_count, row_count, image):
image_data = image.load()
pages = []
# Convert image pixels into 8bit pages
for row in range(row_count):
pages.append([])
for column in range(column_count):
page = 0
for bit in range(8):
if image_data[column, (row * 8) + bit]:
page |= 1 << bit
pages[row].append(page)
# Merge page matrix into single page array
data = []
for row in range(row_count):
for column in range(column_count):
data.append(pages[row][column])
# 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 range(0, len(data), 64):
block = data[i:i + 64]
oled.write(block + [0] * (64 - len(block)))
if __name__ == "__main__":
ipcon = IPConnection() # Create IP connection
oled = BrickletOLED128x64(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 rotating line
image = Image.new("1", (WIDTH, HEIGHT * 8), 0)
draw = ImageDraw.Draw(image)
origin_x = WIDTH // 2
origin_y = HEIGHT * 8 // 2
length = HEIGHT * 8 // 2 - 2
angle = 0
print("Press ctrl+c to exit")
try:
while True:
radians = math.pi * angle / 180.0
x = (int)(origin_x + length * math.cos(radians))
y = (int)(origin_y + length * math.sin(radians))
draw.rectangle((0, 0, WIDTH, HEIGHT * 8), 0, 0)
draw.line((origin_x, origin_y, x, y), 1, 1)
draw_image(oled, 0, 0, WIDTH, HEIGHT, image)
time.sleep(0.025)
angle += 1
except KeyboardInterrupt:
pass
ipcon.disconnect()
|
Download (example_draw_servo_poti.py)
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 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 | #!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# This example uses a Servo Brick, a Rotary Poti Bricklet and
# a OLED 128x64 Bricklet.
#
# The position of the Rotary Poti Bricklet is drawn on the OLED
# display (as text, as a bar graph and as a dial indicator).
# At the same time the servo moves to an angle that is equivalent
# of the position of the Rotary Poti Bricklet.
#
HOST = "localhost"
PORT = 4223
SCREEN_WIDTH = 128
SCREEN_HEIGHT = 64
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_oled_128x64 import BrickletOLED128x64
from tinkerforge.bricklet_rotary_poti import BrickletRotaryPoti
from tinkerforge.brick_servo import BrickServo
from PIL import Image, ImageDraw, ImageFont
import sys
import math
import time
def draw_matrix(pixels):
column_index = 0
column = []
for i in range(SCREEN_HEIGHT//8 - 1): # We use last 8 pixels for text
for j in range(SCREEN_WIDTH):
page = 0
for k in range(8):
if pixels[i*8 + k][j] == 1:
page |= 1 << k
if len(column) <= column_index:
column.append([])
column[column_index].append(page)
if len(column[column_index]) == SCREEN_HEIGHT:
column_index += 1
oled.new_window(0, SCREEN_WIDTH-1, 0, 6)
for i in range(len(column)):
oled.write(column[i])
def line_at_angle(startx, starty, angle, length):
radian_angle = math.pi * angle / 180.0
x = startx + length * math.cos(radian_angle)
y = starty + length * math.sin(radian_angle)
return (startx, starty, x, y)
if __name__ == "__main__":
# Create Brick/Bricklet objects
ipcon = IPConnection()
oled = BrickletOLED128x64('x5U', ipcon)
poti = BrickletRotaryPoti('8Co', ipcon)
servo = BrickServo('6e8MF1', ipcon)
# Connect to brickd
ipcon.connect(HOST, PORT)
# Configure Servo so that it rotates 180°
servo.set_pulse_width(6, 650, 2350)
servo.enable(6)
# Clear display
oled.clear_display()
# Draw text once at beginning, the window in draw_matrix does not overwrite
# the last line of the display
oled.write_line(7, 5, "tinkerforge.com")
# We just use an endless loop here, press ctrl + c to abort the script
while True:
# With position 110 poti is at 90°
angle = poti.get_position()*90//110
if angle > 90:
angle = 90
elif angle < -90:
angle = -90
# Set servo position according to angle
servo.set_position(6, angle*100)
# Create angle text
angle_str = str(angle) + u'°'
if angle >= 0:
angle_str = ' ' + angle_str
# Draw servo position line
img = Image.new('1', (128, 64), 0)
draw = ImageDraw.Draw(img)
draw.line(line_at_angle(32, 32, angle - 90, 32), 1, 6)
# Draw bar graph
draw.line((90, 4, 90 + angle*30//90, 4), 1, 6)
# Draw angle text
font = ImageFont.truetype("./share/fonts/truetype/dejavu/DejaVuSans.ttf", 25)
draw.text((70, 22), angle_str, font=font, fill=1)
# Move data from PIL image into matrix of bools
data = img.load()
pixel_matrix = [[False]*SCREEN_WIDTH for i in range(SCREEN_HEIGHT)]
for x in range(SCREEN_WIDTH):
for y in range(SCREEN_HEIGHT):
pixel_matrix[y][x] = data[x, y] == 1
# Draw everything to display
draw_matrix(pixel_matrix)
# Framerate of ~40 FPS
time.sleep(0.04)
ipcon.disconnect()
|
Prinzipiell kann jede Funktion der Python Bindings
tinkerforge.ip_connection.Error
Exception werfen, welche ein value
und
eine description
Property hat. value
kann verschiende Werte haben:
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
BrickletOLED128x64
(uid, ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
oled_128x64 = BrickletOLED128x64("YOUR_DEVICE_UID", ipcon)
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletOLED128x64.
write
(data)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 127 und
Zeile (Row) von 0 bis 7 (das ganze Display) aufgerufen wird, schreibt
jedes write()
(roter Pfeil) eine halbe 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 Hälfte
der erste Zeile, und die nächsten beiden Aufrufe die zweite Zeile
usw. Um das ganze Display zu füllen muss write()
16 mal
aufgerufen werden.
BrickletOLED128x64.
new_window
(column_from, column_to, row_from, row_to)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt das Fenster in welches mit write()
geschrieben
werden kann. Eine Zeile (Row) hat eine Höhe von 8 Pixel.
BrickletOLED128x64.
clear_display
()¶Rückgabe: |
|
---|
Löscht den aktuellen Inhalt des mit new_window()
gesetztem Fensters.
BrickletOLED128x64.
write_line
(line, position, text)¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt einen Text in die angegebene Zeile (0 bis 7) mit einer vorgegebenen Position (0 bis 25). Der Text kann maximal 26 Zeichen lang sein.
Beispiel: (1, 10, "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.
BrickletOLED128x64.
set_display_configuration
(contrast, invert)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
BrickletOLED128x64.
get_display_configuration
()¶Rückgabeobjekt: |
|
---|
Gibt die Konfiguration zurück, wie von set_display_configuration()
gesetzt.
BrickletOLED128x64.
get_identity
()¶Rückgabeobjekt: |
|
---|
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.
BrickletOLED128x64.
get_api_version
()¶Rückgabeobjekt: |
|
---|
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.
BrickletOLED128x64.
get_response_expected
(function_id)¶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:
BrickletOLED128x64.
set_response_expected
(function_id, response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ä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:
BrickletOLED128x64.
set_response_expected_all
(response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletOLED128x64.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein OLED 128x64 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.
BrickletOLED128x64.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines OLED 128x64 Bricklet dar.