Rust - OLED 128x64 Bricklet 2.0

Dies ist die Beschreibung der Rust 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 Rust API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf docs.rs.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Hello World

Download (example_hello_world.rs)

 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
use std::{error::Error, io};

use tinkerforge::{ip_connection::IpConnection, oled_128x64_v2_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your OLED 128x64 Bricklet 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let oled = Oled128x64V2Bricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // 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".to_string());

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

API

Um eine nicht-blockierende Verwendung zu erlauben, gibt fast jede Funktion der Rust-Bindings einen Wrapper um einen mpsc::Receiver zurück. Um das Ergebnis eines Funktionsaufrufs zu erhalten und zu blockieren, bis das Gerät die Anfrage verarbeitet hat, können die recv-Varianten des Receivers verwendet werden. Diese geben entweder das vom Gerät gesendete Ergebnis, oder einen aufgetretenen Fehler zurück.

Funktionen die direkt ein Result zurückgeben, blockieren bis das Gerät die Anfrage verarbeitet hat.

Alle folgend aufgelisteten Funktionen sind Thread-sicher, diese, die einen Receiver zurückgeben, sind Lock-frei.

Grundfunktionen

pub fn Oled128x64V2Bricklet::new(uid: &str, ip_connection: &IpConnection) → Oled128x64V2Bricklet

Erzeugt ein neues Oled128x64V2Bricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IP-Connection ipcon hinzu:

Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden wurde (siehe Beispiele oben).

pub fn Oled128x64V2Bricklet::write_pixels(&self, x_start: u8, y_start: u8, x_end: u8, y_end: u8, pixels: bool) → Result<(), BrickletRecvTimeoutError>

Schreibt Pixel in das angegebene 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 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 Oled128x64V2Bricklet::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 Oled128x64V2Bricklet::set_display_configuration Funktion eingestellt werden.

pub fn Oled128x64V2Bricklet::read_pixels(&self, x_start: u8, y_start: u8, x_end: u8, y_end: u8) → Result<Vec<bool>, BrickletRecvTimeoutError>

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 Oled128x64V2Bricklet::draw_buffered_frame).

Automatic Draw kann über die Oled128x64V2Bricklet::set_display_configuration Funktion eingestellt werden.

pub fn Oled128x64V2Bricklet::clear_display(&self) → ConvertingReceiver<()>

Löscht den kompletten aktuellen Inhalt des Displays.

pub fn Oled128x64V2Bricklet::write_line(&self, line: u8, position: u8, text: String) → ConvertingReceiver<()>

Schreibt einen Text in die angegebene Zeile (0 bis 7) mit einer vorgegebenen Position (0 bis 21). 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.

pub fn Oled128x64V2Bricklet::draw_buffered_frame(&self, force_complete_redraw: bool) → ConvertingReceiver<()>

Stellt den aktuell Inhalt des internen Buffers auf dem Display dar. Normalerweise schreibt jeder Aufruf von Oled128x64V2Bricklet::write_pixels und Oled128x64V2Bricklet::write_line direkt auf den Display. Wenn jedoch Automatic Draw deaktiviert ist (Oled128x64V2Bricklet::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

pub fn Oled128x64V2Bricklet::set_display_configuration(&self, contrast: u8, invert: bool, automatic_draw: bool) → ConvertingReceiver<()>

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 Oled128x64V2Bricklet::write_pixels und Oled128x64V2Bricklet::write_line aktualisiert. Wenn Automatic Draw deaktiviert (false) ist, dann werden Änderungen in einen internen Buffer geschrieben, der dann bei bei einem Aufruf von Oled128x64V2Bricklet::draw_buffered_frame auf dem Display angezeigt wird.

Standardwerte: Kontrast 143, Invertierung aus und Automatic Draw aktiviert.

pub fn Oled128x64V2Bricklet::get_display_configuration(&self) → ConvertingReceiver<DisplayConfiguration>

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

pub fn Oled128x64V2Bricklet::get_api_version(&self) → [u8; 3]

Gibt die Version der API Definition (Major, Minor, Revision) 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.

pub fn Oled128x64V2Bricklet::get_response_expected(&mut self, function_id: u8) → 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 Oled128x64V2Bricklet::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.

Siehe Oled128x64V2Bricklet::set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

pub fn Oled128x64V2Bricklet::set_response_expected(&mut self, function_id: u8, response_expected: 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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • OLED_128X64_V2_BRICKLET_FUNCTION_WRITE_PIXELS = 1
  • OLED_128X64_V2_BRICKLET_FUNCTION_CLEAR_DISPLAY = 3
  • OLED_128X64_V2_BRICKLET_FUNCTION_SET_DISPLAY_CONFIGURATION = 4
  • OLED_128X64_V2_BRICKLET_FUNCTION_WRITE_LINE = 6
  • OLED_128X64_V2_BRICKLET_FUNCTION_DRAW_BUFFERED_FRAME = 7
  • OLED_128X64_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • OLED_128X64_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • OLED_128X64_V2_BRICKLET_FUNCTION_RESET = 243
  • OLED_128X64_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn Oled128x64V2Bricklet::set_response_expected_all(&mut self, response_expected: bool) → ()

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

pub fn Oled128x64V2Bricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>

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.

pub fn Oled128x64V2Bricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>

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

  • OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • OLED_128X64_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • OLED_128X64_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • OLED_128X64_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • OLED_128X64_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • OLED_128X64_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • OLED_128X64_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn Oled128x64V2Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>

Gibt den aktuellen Bootloader-Modus zurück, siehe Oled128x64V2Bricklet::set_bootloader_mode.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • OLED_128X64_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn Oled128x64V2Bricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>

Setzt den Firmware-Pointer für Oled128x64V2Bricklet::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.

pub fn Oled128x64V2Bricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>

Schreibt 64 Bytes Firmware an die Position die vorher von Oled128x64V2Bricklet::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.

pub fn Oled128x64V2Bricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>

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:

  • OLED_128X64_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • OLED_128X64_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • OLED_128X64_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • OLED_128X64_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn Oled128x64V2Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>

Gibt die Konfiguration zurück, wie von Oled128x64V2Bricklet::set_status_led_config gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • OLED_128X64_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • OLED_128X64_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • OLED_128X64_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • OLED_128X64_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn Oled128x64V2Bricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>

Gibt die Temperatur in °C, 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.

pub fn Oled128x64V2Bricklet::reset(&self) → ConvertingReceiver<()>

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.

pub fn Oled128x64V2Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>

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.

pub fn Oled128x64V2Bricklet::read_uid(&self) → ConvertingReceiver<u32>

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

pub fn Oled128x64V2Bricklet::get_identity(&self) → ConvertingReceiver<Identity>

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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konstanten

Oled128x64V2Bricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein OLED 128x64 Bricklet 2.0 zu identifizieren.

Die Oled128x64V2Bricklet::get_identity Funktion und der IpConnection::get_enumerate_callback_receiver Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

Oled128x64V2Bricklet::DEVICE_DISPLAY_NAME

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