Python - OLED 128x64 Bricklet 2.0

Dies ist die Beschreibung der Python 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 Python API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Hello World

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 2.0

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_oled_128x64_v2 import BrickletOLED128x64V2

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    oled = BrickletOLED128x64V2(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()

Pixel Matrix

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
#!/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
HEIGHT = 64 # Rows

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_oled_128x64_v2 import BrickletOLED128x64V2

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    oled = BrickletOLED128x64V2(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):
        for column in range(WIDTH):
            pixels.append((row // 8) % 2 == (column // 8) % 2)

    oled.write_pixels(0, 0, WIDTH-1, HEIGHT-1, pixels)

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()

Load Image

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

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your OLED 128x64 Bricklet 2.0
WIDTH = 128 # Columns
HEIGHT = 64 # Rows

import sys
from PIL import Image
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_oled_128x64_v2 import BrickletOLED128x64V2

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    oled = BrickletOLED128x64V2(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):
        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.append(pixel)

    oled.write_pixels(0, 0, WIDTH-1, HEIGHT-1, pixels)

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()

Scribble

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

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your OLED 128x64 Bricklet 2.0
WIDTH = 128 # Columns
HEIGHT = 64 # Rows

import math
import time
from PIL import Image, ImageDraw
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_oled_128x64_v2 import BrickletOLED128x64V2

def draw_image(oled, start_column, start_row, column_count, row_count, image):
    image_data = image.load()
    pixels = []

    # Convert image pixels into 8bit pages
    for row in range(row_count):
        for column in range(column_count):
            pixels.append(image_data[column, row] != 0)

    oled.write_pixels(0, 0, WIDTH-1, HEIGHT-1, pixels)

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    oled = BrickletOLED128x64V2(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), 0)
    draw = ImageDraw.Draw(image)
    origin_x = WIDTH // 2
    origin_y = HEIGHT // 2
    length = HEIGHT // 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), 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()

API

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:

  • Error.TIMEOUT = -1
  • Error.NOT_ADDED = -6 (seit Python Bindings Version 2.0.0 nicht mehr verwendet)
  • Error.ALREADY_CONNECTED = -7
  • Error.NOT_CONNECTED = -8
  • Error.INVALID_PARAMETER = -9
  • Error.NOT_SUPPORTED = -10
  • Error.UNKNOWN_ERROR_CODE = -11
  • Error.STREAM_OUT_OF_SYNC = -12
  • Error.INVALID_UID = -13
  • Error.NON_ASCII_CHAR_IN_SECRET = -14
  • Error.WRONG_DEVICE_TYPE = -15
  • Error.DEVICE_REPLACED = -16
  • Error.WRONG_RESPONSE_LENGTH = -17

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickletOLED128x64V2(uid, ipcon)
Parameter:
  • uid – Typ: str
  • ipcon – Typ: IPConnection
Rückgabe:
  • oled_128x64_v2 – Typ: BrickletOLED128x64V2

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

oled_128x64_v2 = BrickletOLED128x64V2("YOUR_DEVICE_UID", ipcon)

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

BrickletOLED128x64V2.write_pixels(x_start, y_start, x_end, y_end, pixels)
Parameter:
  • x_start – Typ: int, Wertebereich: [0 bis 127]
  • y_start – Typ: int, Wertebereich: [0 bis 63]
  • x_end – Typ: int, Wertebereich: [0 bis 127]
  • y_end – Typ: int, Wertebereich: [0 bis 63]
  • pixels – Typ: [bool, ...], Länge: variabel
Rückgabe:
  • None

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.

BrickletOLED128x64V2.read_pixels(x_start, y_start, x_end, y_end)
Parameter:
  • x_start – Typ: int, Wertebereich: [0 bis 127]
  • y_start – Typ: int, Wertebereich: [0 bis 63]
  • x_end – Typ: int, Wertebereich: [0 bis 127]
  • y_end – Typ: int, Wertebereich: [0 bis 63]
Rückgabe:
  • pixels – Typ: [bool, ...], Länge: variabel

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.

BrickletOLED128x64V2.clear_display()
Rückgabe:
  • None

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.

BrickletOLED128x64V2.write_line(line, position, text)
Parameter:
  • line – Typ: int, Wertebereich: [0 bis 7]
  • position – Typ: int, Wertebereich: [0 bis 21]
  • text – Typ: str, Länge: bis zu 22
Rückgabe:
  • None

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.

BrickletOLED128x64V2.draw_buffered_frame(force_complete_redraw)
Parameter:
  • force_complete_redraw – Typ: bool
Rückgabe:
  • None

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.

Fortgeschrittene Funktionen

BrickletOLED128x64V2.set_display_configuration(contrast, invert, automatic_draw)
Parameter:
  • contrast – Typ: int, Wertebereich: [0 bis 255], Standardwert: 143
  • invert – Typ: bool, Standardwert: False
  • automatic_draw – Typ: bool, Standardwert: True
Rückgabe:
  • None

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.

BrickletOLED128x64V2.get_display_configuration()
Rückgabeobjekt:
  • contrast – Typ: int, Wertebereich: [0 bis 255], Standardwert: 143
  • invert – Typ: bool, Standardwert: False
  • automatic_draw – Typ: bool, Standardwert: True

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

BrickletOLED128x64V2.get_spitfp_error_count()
Rückgabeobjekt:
  • error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: int, Wertebereich: [0 bis 232 - 1]

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.

BrickletOLED128x64V2.set_status_led_config(config)
Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • None

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
BrickletOLED128x64V2.get_status_led_config()
Rückgabe:
  • config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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
BrickletOLED128x64V2.get_chip_temperature()
Rückgabe:
  • temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

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.

BrickletOLED128x64V2.reset()
Rückgabe:
  • None

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.

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

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

BrickletOLED128x64V2.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:

  • 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_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletOLED128x64V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletOLED128x64V2.FUNCTION_RESET = 243
  • BrickletOLED128x64V2.FUNCTION_WRITE_UID = 248
BrickletOLED128x64V2.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:

  • 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_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletOLED128x64V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletOLED128x64V2.FUNCTION_RESET = 243
  • BrickletOLED128x64V2.FUNCTION_WRITE_UID = 248
BrickletOLED128x64V2.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.

Interne Funktionen

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.

BrickletOLED128x64V2.set_bootloader_mode(mode)
Parameter:
  • mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: int, Wertebereich: Siehe Konstanten

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
BrickletOLED128x64V2.get_bootloader_mode()
Rückgabe:
  • mode – Typ: int, Wertebereich: Siehe Konstanten

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
BrickletOLED128x64V2.set_write_firmware_pointer(pointer)
Parameter:
  • pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • None

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.

BrickletOLED128x64V2.write_firmware(data)
Parameter:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: int, Wertebereich: [0 bis 255]

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.

BrickletOLED128x64V2.write_uid(uid)
Parameter:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • None

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.

BrickletOLED128x64V2.read_uid()
Rückgabe:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]

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

Konstanten

BrickletOLED128x64V2.DEVICE_IDENTIFIER

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.

BrickletOLED128x64V2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines OLED 128x64 Bricklet 2.0 dar.