Rust - HAT Brick¶

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).recv()?;

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

Print Voltages¶

Download (example_print_voltages.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::{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.

    // Get current get voltages.
    let voltages = hat.get_voltages().recv()?;

    println!("Voltage USB: {} V", voltages.voltage_usb as f32 / 1000.0);
    println!("Voltage DC: {} V", voltages.voltage_dc as f32 / 1000.0);

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

Grundfunktionen¶

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

Parameter:	uid – Typ: &str ip_connection – Typ: &IPConnection
Rückgabe:	hat – Typ: HatBrick

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

let hat = HatBrick::new("YOUR_DEVICE_UID", &ip_connection);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden.

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<()>¶

Parameter:	power_off_delay – Typ: u32, Einheit: 1 s, Wertebereich: [0 bis 232 - 1] power_off_duration – Typ: u32, Einheit: 1 s, Wertebereich: [0 bis 232 - 1] raspberry_pi_off – Typ: bool bricklets_off – Typ: bool enable_sleep_indicator – Typ: bool

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 Status-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>¶

Rückgabeobjekt:	power_off_delay – Typ: u32, Einheit: 1 s, Wertebereich: [0 bis 232 - 1] power_off_duration – Typ: u32, Einheit: 1 s, Wertebereich: [0 bis 232 - 1] raspberry_pi_off – Typ: bool bricklets_off – Typ: bool enable_sleep_indicator – Typ: bool

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<()>¶

Parameter:	bricklet_power – Typ: bool, Standardwert: true

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

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

Rückgabe:	bricklet_power – Typ: bool, Standardwert: true

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>¶

Rückgabeobjekt:	voltage_usb – Typ: u16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1] voltage_dc – Typ: u16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die USB- und DC-Input-Versorgungsspannung 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::set_rtc_driver(&self, rtc_driver: u8) → ConvertingReceiver<()>¶

Parameter:	rtc_driver – Typ: u8, Wertebereich: Siehe Konstanten

Konfiguriert den RTC-Treiber der dem Raspberry Pi zur Nutzung gegeben wird. Aktuell werden zwei unterschiedliche RTCs verbaut:

• Hardwareversion <= 1.5: PCF8523
• Hardwareversion 1.6: DS1338

Der korrekte Treiber wird während dem ersten Flashens von Tinkerforge gesetzt.

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

Für rtc_driver:

• HAT_BRICK_RTC_DRIVER_PCF8523 = 0
• HAT_BRICK_RTC_DRIVER_DS1338 = 1

Neu in Version 2.0.3 (Firmware).

pub fn HatBrick::get_rtc_driver(&self) → ConvertingReceiver<u8>¶

Rückgabe:	rtc_driver – Typ: u8, Wertebereich: Siehe Konstanten

Gibt den RTC-Treiber zurück, wie von HatBrick::set_rtc_driver gesetzt.

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

Für rtc_driver:

• HAT_BRICK_RTC_DRIVER_PCF8523 = 0
• HAT_BRICK_RTC_DRIVER_DS1338 = 1

Neu in Version 2.0.3 (Firmware).

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

Rückgabeobjekt:	error_count_ack_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1] error_count_message_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1] error_count_frame – Typ: u32, Wertebereich: [0 bis 232 - 1] error_count_overflow – Typ: u32, 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.

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

Parameter:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

• 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>¶

Rückgabe:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

• 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>¶

Rückgabe:	temperature – Typ: i16, 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.

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::get_identity(&self) → ConvertingReceiver<Identity>¶

Rückgabeobjekt:

uid – Typ: String, Länge: bis zu 8 connected_uid – Typ: String, Länge: bis zu 8 position – Typ: char, Wertebereich: ['i'] hardware_version – Typ: [u8; 3] 0: major – Typ: u8, Wertebereich: [0 bis 255] 1: minor – Typ: u8, Wertebereich: [0 bis 255] 2: revision – Typ: u8, Wertebereich: [0 bis 255] firmware_version – Typ: [u8; 3] 0: major – Typ: u8, Wertebereich: [0 bis 255] 1: minor – Typ: u8, Wertebereich: [0 bis 255] 2: revision – Typ: u8, Wertebereich: [0 bis 255] device_identifier – Typ: u16, Wertebereich: [0 bis 216 - 1]

Gibt die UID, die UID zu der das HAT verbunden ist (typischerweise '0' da das HAT das Wurzelgerät der Topologie ist), die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Der HAT (Zero) Brick ist immer an Position 'i'.

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

Konfigurationsfunktionen für Callbacks¶

pub fn HatBrick::set_voltages_callback_configuration(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>¶

Parameter:	period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der HatBrick::get_voltages_callback_receiver Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Neu in Version 2.0.1 (Firmware).

pub fn HatBrick::get_voltages_callback_configuration(&self) → ConvertingReceiver<VoltagesCallbackConfiguration>¶

Rückgabeobjekt:	period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels HatBrick::set_voltages_callback_configuration gesetzt.

Neu in Version 2.0.1 (Firmware).

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.

pub fn HatBrick::get_voltages_callback_receiver(&self) → ConvertingCallbackReceiver<VoltagesEvent>¶

Event-Objekt:	voltage_usb – Typ: u16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1] voltage_dc – Typ: u16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels HatBrick::set_voltages_callback_configuration gesetzten Konfiguration

Die Felder der empfangenen Struktur sind der gleiche wie HatBrick::get_voltages.

Neu in Version 2.0.1 (Firmware).

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.

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

Rückgabeobjekt:	api_version – Typ: [u8; 3] 0: major – Typ: u8, Wertebereich: [0 bis 255] 1: minor – Typ: u8, Wertebereich: [0 bis 255] 2: revision – Typ: u8, 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.

pub fn HatBrick::get_response_expected(&mut self, function_id: u8) → bool¶

Parameter:	function_id – Typ: u8, 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 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.

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

Für function_id:

• HAT_BRICK_FUNCTION_SET_SLEEP_MODE = 1
• HAT_BRICK_FUNCTION_SET_BRICKLET_POWER = 3
• HAT_BRICK_FUNCTION_SET_VOLTAGES_CALLBACK_CONFIGURATION = 6
• HAT_BRICK_FUNCTION_SET_RTC_DRIVER = 9
• 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(&mut self, function_id: u8, response_expected: bool) → ()¶

Parameter:	function_id – Typ: u8, Wertebereich: Siehe Konstanten response_expected – Typ: 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:

Für function_id:

• HAT_BRICK_FUNCTION_SET_SLEEP_MODE = 1
• HAT_BRICK_FUNCTION_SET_BRICKLET_POWER = 3
• HAT_BRICK_FUNCTION_SET_VOLTAGES_CALLBACK_CONFIGURATION = 6
• HAT_BRICK_FUNCTION_SET_RTC_DRIVER = 9
• 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) → ()¶

Parameter:	response_expected – Typ: bool

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

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

Parameter:	mode – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: u8, 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:

• 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

Für status:

• 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>¶

Rückgabe:	mode – Typ: u8, Wertebereich: Siehe Konstanten

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

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

Für mode:

• 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<()>¶

Parameter:	pointer – Typ: u32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

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>¶

Parameter:	data – Typ: [u8; 64], Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: u8, Wertebereich: [0 bis 255]

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::write_uid(&self, uid: u32) → ConvertingReceiver<()>¶

Parameter:	uid – Typ: u32, Wertebereich: [0 bis 232 - 1]

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>¶

Rückgabe:	uid – Typ: u32, 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¶

pub const 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.

pub const HatBrick::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines HAT Brick dar.