Rust - Segment Display 4x7 Bricklet 2.0

Dies ist die Beschreibung der Rust API Bindings für das Segment Display 4x7 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Segment Display 4x7 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).

Numeric Value

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

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

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Segment Display 4x7 Bricklet 2.0.

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

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    sd.set_brightness(7); // Set to full brightness

    // Show "- 42" on the Display
    sd.set_numeric_value([-2, -1, 4, 2]);

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

Set Segments

Download (example_set_segments.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
28
29
30
31
32
33
use std::{error::Error, io};

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

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Segment Display 4x7 Bricklet 2.0.

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

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    sd.set_brightness(7); // Set to full brightness

    // Activate all segments
    sd.set_segments(
        [true, true, true, true, true, true, true, true],
        [true, true, true, true, true, true, true, true],
        [true, true, true, true, true, true, true, true],
        [true, true, true, true, true, true, true, true],
        [true, true],
        true,
    );

    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 SegmentDisplay4x7V2Bricklet::new(uid: &str, ip_connection: &IpConnection) → SegmentDisplay4x7V2Bricklet

Erzeugt ein neues SegmentDisplay4x7V2Bricklet-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 SegmentDisplay4x7V2Bricklet::set_segments(&self, digit0: [bool; 8], digit1: [bool; 8], digit2: [bool; 8], digit3: [bool; 8], colon: [bool; 2], tick: bool) → ConvertingReceiver<()>

Setzt die einzelnen Segmente des Segment Display 4x7 Bricklet 2.0 Segment für Segment.

Die Daten sind aufgeteilt in die vier Ziffern (digit0-3), dem Doppelpunkt (colon) und dem Hochkomma (tick).

Die Indizes der Segmente in den Ziffern und dem Doppelpunkt sind wie folgt aufgeteilt:

Indizes der Segmente
pub fn SegmentDisplay4x7V2Bricklet::get_segments(&self) → ConvertingReceiver<Segments>

Gibt die Segmentdaten zurück, wie von SegmentDisplay4x7V2Bricklet::set_segments gesetzt.

pub fn SegmentDisplay4x7V2Bricklet::set_brightness(&self, brightness: u8) → ConvertingReceiver<()>

Die Helligkeit kann zwischen 0 (dunkel) und 7 (hell) gesetzt werden.

Der Standardwert ist 7.

pub fn SegmentDisplay4x7V2Bricklet::get_brightness(&self) → ConvertingReceiver<u8>

Gibt die Helligkeit zurück, wie von SegmentDisplay4x7V2Bricklet::set_brightness gesetzt.

pub fn SegmentDisplay4x7V2Bricklet::set_numeric_value(&self, value: [i8; 4]) → ConvertingReceiver<()>

Setzt einen numerischen Wert für jede Ziffer. Die Werte können zwischen -2 und 15 seien. Die Werte repräsentieren:

  • -2: Minuszeichen
  • -1: Leerstelle
  • 0-9: 0-9
  • 10: A
  • 11: b
  • 12: C
  • 13: d
  • 14: E
  • 15: F

Beispiel: Ein Aufruf mit [-2, -1, 4, 2] erzeugt eine Anzeige auf dem Display von "- 42".

pub fn SegmentDisplay4x7V2Bricklet::set_selected_segment(&self, segment: u8, value: bool) → ConvertingReceiver<()>

Aktiviert/deaktiviert ein selektiertes Segment.

Die Indizes sind wie folgt aufgeteilt:

Indizes für einzeln selektierte Segmente
pub fn SegmentDisplay4x7V2Bricklet::get_selected_segment(&self, segment: u8) → ConvertingReceiver<bool>

Gibt den Wert eines einzelnen Segments zurück.

Fortgeschrittene Funktionen

pub fn SegmentDisplay4x7V2Bricklet::start_counter(&self, value_from: i16, value_to: i16, increment: i16, length: u32) → ConvertingReceiver<()>

Starter einen Zähler mit dem from Wert der bis zum to Wert zählt mit einer Schrittweite von increment. Das Argument length gibt die Pause zwischen den Erhöhungen in ms an.

Beispiel: Wenn from auf 0, to auf 100, increment auf 1 und length auf 1000 gesetzt wird, wird ein Zähler gestartet der von 0 bis 100 zählt mit Rate von einer Sekunde zwischen jeder Erhöhung.

Der Maximalwert für from, to und increment ist 9999, der Minimalwert ist -999.

Wenn increment negativ ist läuft der Zähler rückwärts.

Der Zähler kann jederzeit durch einen Aufruf von SegmentDisplay4x7V2Bricklet::set_segments oder SegmentDisplay4x7V2Bricklet::set_numeric_value gestoppt werden.

pub fn SegmentDisplay4x7V2Bricklet::get_counter_value(&self) → ConvertingReceiver<u16>

Gibt den aktuellen Zählerstand zurück der auf der Anzeige angezeigt wird.

Wenn kein Zähler läuft wird eine 0 zurückgegeben.

pub fn SegmentDisplay4x7V2Bricklet::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 SegmentDisplay4x7V2Bricklet::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 SegmentDisplay4x7V2Bricklet::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:

  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_SEGMENTS = 1
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_BRIGHTNESS = 3
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_NUMERIC_VALUE = 5
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_SELECTED_SEGMENT = 6
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_START_COUNTER = 8
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_RESET = 243
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn SegmentDisplay4x7V2Bricklet::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 Konstanten sind für diese Funktion verfügbar:

  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_SEGMENTS = 1
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_BRIGHTNESS = 3
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_NUMERIC_VALUE = 5
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_SELECTED_SEGMENT = 6
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_START_COUNTER = 8
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_RESET = 243
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn SegmentDisplay4x7V2Bricklet::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 SegmentDisplay4x7V2Bricklet::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 SegmentDisplay4x7V2Bricklet::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:

  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn SegmentDisplay4x7V2Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>

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

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

  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn SegmentDisplay4x7V2Bricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>

Setzt den Firmware-Pointer für SegmentDisplay4x7V2Bricklet::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 SegmentDisplay4x7V2Bricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>

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

  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn SegmentDisplay4x7V2Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>

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

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

  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • SEGMENT_DISPLAY_4X7_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn SegmentDisplay4x7V2Bricklet::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 SegmentDisplay4x7V2Bricklet::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 SegmentDisplay4x7V2Bricklet::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 SegmentDisplay4x7V2Bricklet::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 SegmentDisplay4x7V2Bricklet::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.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden get_*_callback_receiver-Function durchgeführt werden, welche einen Receiver für Callback-Events zurück gibt.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

pub fn SegmentDisplay4x7V2Bricklet::get_counter_finished_callback_receiver(&self) → ConvertingCallbackReceiver<()>

Receiver die mit dieser Funktion erstellt werden, empfangen Counter Finished-Events.

Diese Callback wird ausgelöst, wenn der Zähler (siehe SegmentDisplay4x7V2Bricklet::start_counter) fertig ist.

Konstanten

SegmentDisplay4x7V2Bricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Segment Display 4x7 Bricklet 2.0 zu identifizieren.

Die SegmentDisplay4x7V2Bricklet::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.

SegmentDisplay4x7V2Bricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Segment Display 4x7 Bricklet 2.0 dar.