Rust - HAT Brick

Dies ist die Beschreibung der Rust API Bindings für den HAT Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des HAT Brick 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).

Sleep

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

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

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XXYYZZ"; // Change XXYYZZ to the UID of your HAT Brick.

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

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

    // Turn Raspberry Pi and Bricklets off in 2 seconds for 30 minutes with sleep indicator enabled
    hat.set_sleep_mode(2, 1800, 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 HatBrick::new(uid: &str, ip_connection: &IpConnection) → HatBrick

Erzeugt ein neues HatBrick-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 HatBrick::set_sleep_mode(&self, power_off_delay: u32, power_off_duration: u32, raspberry_pi_off: bool, bricklets_off: bool, enable_sleep_indicator: bool) → ConvertingReceiver<()>

Setzt den Schlaf-Modus.

Bemerkung

Diese Funktion schaltet die Stromversorgung des Raspberry Pis nach Power Off Delay Sekunden ab. Das Betriebssystem muss manuell heruntergefahren werden, zum Beispiel durch Ausführen von 'sudo shutdown -h now'.

Parameter:

  • Power Off Delay: Zeit in Sekunden bis der RPi/die Bricklets ausgeschaltet werden.
  • Power Off Duration: Dauer in Sekunden für die der RPi/die Bricklets ausgeschaltet bleiben.
  • Raspberry Pi Off: RPi wird ausgeschaltet, falls auf true gesetzt.
  • Bricklets Off: Bricklets werden ausgeschaltet falls auf true gesetzt.
  • Enable Sleep Indicator: Wenn dieser Parameter auf true gesetzt wird, blinkt die Status LED während der Schlafdauer mit einem Intervall von 1s. Dies verbraucht zusätzliche 0,3mA.

Beispiel: Um den RPi und die Bricklets in 5 Sekunden für 10 Minuten mit aktivierter Indicator-LED auszuschalten, rufe (5, 60*10, true, true, true) auf.

Diese Funktion kann auch genutzt werden um einen Watchdog zu implementieren. Dazu kann ein Programm geschrieben werden, welches in einer Schleife einmal pro Sekunde folgendes aufruft: (10, 2, true, false, false). Dies führt dazu, dass das HAT den RPi nach 10 Sekunden neustartet, wenn dieser abgestürzt oder stecken geblieben ist.

pub fn HatBrick::get_sleep_mode(&self) → ConvertingReceiver<SleepMode>

Gibt die Sleep-Mode-Einstellungen zurück, wie von HatBrick::set_sleep_mode gesetzt.

pub fn HatBrick::set_bricklet_power(&self, bricklet_power: bool) → ConvertingReceiver<()>

Kann auf true/false gesetzt werden um die Spannungsversorgung der angeschlossenen Bricklets an/aus zu stellen.

Standardmäßig sind die Bricklets an.

pub fn HatBrick::get_bricklet_power(&self) → ConvertingReceiver<bool>

Gibt den Status der Stromversorgung der angeschlossenen Bricklets zurück, wie von HatBrick::set_bricklet_power gesetzt.

pub fn HatBrick::get_voltages(&self) → ConvertingReceiver<Voltages>

Gibt die USB- und DC-Input-Versorgungsspannung in mV zurück.

Es gibt drei mögliche Kombinationen:

  • Nur USB verbunden: Die USB-Versorgungsspannung wird auf den DC-Input-Stecker zurückgespeist. Die USB-Spannung wird angezeigt und die DC-Input-Spannung ist etwas niedriger als die USB-Spannung.
  • Nur DC-Input verbunden: Die DC-Versorgungsspannung wird nicht auf den USB-Stecker zurückgespeist. Die DC-Versorgungsspannung wird angezeigt und die USB-Spannung ist 0.
  • USB und DC-Input verbunden: Beide Spannungen werden angezeigt. In diesem Fall ist die USB-Versorgungsspannung ohne Last, sie wird als Backup verwendet wenn der DC-Input getrennt wird (oder die DC-Input-Versorgungsspannung unter die USB-Spannung fällt).

Fortgeschrittene Funktionen

pub fn HatBrick::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 HatBrick::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 HatBrick::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 HatBrick::set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

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

  • HAT_BRICK_FUNCTION_SET_SLEEP_MODE = 1
  • HAT_BRICK_FUNCTION_SET_BRICKLET_POWER = 3
  • HAT_BRICK_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • HAT_BRICK_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • HAT_BRICK_FUNCTION_RESET = 243
  • HAT_BRICK_FUNCTION_WRITE_UID = 248
pub fn HatBrick::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 HatBrick::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 HatBrick::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:

  • HAT_BRICK_BOOTLOADER_MODE_BOOTLOADER = 0
  • HAT_BRICK_BOOTLOADER_MODE_FIRMWARE = 1
  • HAT_BRICK_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • HAT_BRICK_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • HAT_BRICK_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • HAT_BRICK_BOOTLOADER_STATUS_OK = 0
  • HAT_BRICK_BOOTLOADER_STATUS_INVALID_MODE = 1
  • HAT_BRICK_BOOTLOADER_STATUS_NO_CHANGE = 2
  • HAT_BRICK_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • HAT_BRICK_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • HAT_BRICK_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn HatBrick::get_bootloader_mode(&self) → ConvertingReceiver<u8>

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

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

  • HAT_BRICK_BOOTLOADER_MODE_BOOTLOADER = 0
  • HAT_BRICK_BOOTLOADER_MODE_FIRMWARE = 1
  • HAT_BRICK_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • HAT_BRICK_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • HAT_BRICK_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn HatBrick::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>

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

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

  • HAT_BRICK_STATUS_LED_CONFIG_OFF = 0
  • HAT_BRICK_STATUS_LED_CONFIG_ON = 1
  • HAT_BRICK_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • HAT_BRICK_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn HatBrick::get_status_led_config(&self) → ConvertingReceiver<u8>

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

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

  • HAT_BRICK_STATUS_LED_CONFIG_OFF = 0
  • HAT_BRICK_STATUS_LED_CONFIG_ON = 1
  • HAT_BRICK_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • HAT_BRICK_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn HatBrick::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 HatBrick::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 HatBrick::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 HatBrick::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 HatBrick::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 Bricks.

Konstanten

HatBrick::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen HAT Brick zu identifizieren.

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

HatBrick::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines HAT Brick dar.