Rust - Particulate Matter Bricklet¶

Simple¶

Download (example_simple.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

use std::{error::Error, io};

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

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Particulate Matter Bricklet.

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

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

    // Get current PM concentration.
    let pm_concentration = pm.get_pm_concentration().recv()?;

    println!("PM 1.0: {} µg/m³", pm_concentration.pm10);
    println!("PM 2.5: {} µg/m³", pm_concentration.pm25);
    println!("PM 10.0: {} µg/m³", pm_concentration.pm100);

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

Callback¶

Download (example_callback.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
34
35
36
37

use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, particulate_matter_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Particulate Matter Bricklet.

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

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

    let pm_concentration_receiver = pm.get_pm_concentration_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `pm` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for pm_concentration in pm_concentration_receiver {
            println!("PM 1.0: {} µg/m³", pm_concentration.pm10);
            println!("PM 2.5: {} µg/m³", pm_concentration.pm25);
            println!("PM 10.0: {} µg/m³", pm_concentration.pm100);
            println!();
        }
    });

    // Set period for PM concentration callback to 1s (1000ms).
    pm.set_pm_concentration_callback_configuration(1000, false);

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

Grundfunktionen¶

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

Parameter:	uid – Typ: &str ip_connection – Typ: &IPConnection
Rückgabe:	particulate_matter – Typ: ParticulateMatterBricklet

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

let particulate_matter = ParticulateMatterBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn ParticulateMatterBricklet::get_pm_concentration(&self) → ConvertingReceiver<PmConcentration>¶

Rückgabeobjekt:	pm10 – Typ: u16, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1] pm25 – Typ: u16, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1] pm100 – Typ: u16, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1]

Gibt die Feinstaub-Konzentration zurück, aufgeschlüsselt nach:

• PM_1.0,
• PM_2.5 und
• PM_10.0.

Wenn der Sensor deaktiviert ist (siehe ParticulateMatterBricklet::set_enable), dann wird weiterhin der letzte Sensorwert zurückgegeben.

Wenn die Werte periodisch benötigt werden, kann auch der ParticulateMatterBricklet::get_pm_concentration_callback_receiver Callback verwendet werden. Der Callback wird mit der Funktion ParticulateMatterBricklet::set_pm_concentration_callback_configuration konfiguriert.

pub fn ParticulateMatterBricklet::get_pm_count(&self) → ConvertingReceiver<PmCount>¶

Rückgabeobjekt:

greater03um – Typ: u16, Einheit: 10000 1/m³, Wertebereich: [0 bis 216 - 1] greater05um – Typ: u16, Einheit: 10000 1/m³, Wertebereich: [0 bis 216 - 1] greater10um – Typ: u16, Einheit: 10000 1/m³, Wertebereich: [0 bis 216 - 1] greater25um – Typ: u16, Einheit: 10000 1/m³, Wertebereich: [0 bis 216 - 1] greater50um – Typ: u16, Einheit: 10000 1/m³, Wertebereich: [0 bis 216 - 1] greater100um – Typ: u16, Einheit: 10000 1/m³, Wertebereich: [0 bis 216 - 1]

Gibt die Anzahl der Feinstaub-Teilchen in 100ml Luft zurück, aufgeschlüsselt nach deren Durchmesser:

• größer 0,3µm,
• größer 0,5µm,
• größer 1,0µm,
• größer 2,5µm,
• größer 5,0µm und
• größer 10,0µm.

Wenn der Sensor deaktiviert ist (siehe ParticulateMatterBricklet::set_enable), dann wird weiterhin der letzte Sensorwert zurückgegeben.

Wenn die Werte periodisch benötigt werden, kann auch der ParticulateMatterBricklet::get_pm_count_callback_receiver Callback verwendet werden. Der Callback wird mit der Funktion ParticulateMatterBricklet::set_pm_count_callback_configuration konfiguriert.

Fortgeschrittene Funktionen¶

pub fn ParticulateMatterBricklet::set_enable(&self, enable: bool) → ConvertingReceiver<()>¶

Parameter:	enable – Typ: bool, Standardwert: true

Aktiviert/deaktiviert den Lüfter und die Laserdiode des Sensors.

Der Sensor benötigt ca. 30 Sekunden nach der Aktivierung um sich einzuschwingen und stabile Werte zu produzieren.

Die Lebensdauer der Laserdiode beträgt ca. 8000 Stunden. Wenn Messungen in größeren Abständen stattfinden sollen (z.B. stündlich) lohnt es sich die Laserdiode zwischen den Messungen auszumachen.

pub fn ParticulateMatterBricklet::get_enable(&self) → ConvertingReceiver<bool>¶

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

Gibt den Zustand des Sensors zurück, wie von ParticulateMatterBricklet::set_enable gesetzt.

pub fn ParticulateMatterBricklet::get_sensor_info(&self) → ConvertingReceiver<SensorInfo>¶

Rückgabeobjekt:	sensor_version – Typ: u8, Wertebereich: [0 bis 255] last_error_code – Typ: u8, Wertebereich: [0 bis 255] framing_error_count – Typ: u8, Wertebereich: [0 bis 255] checksum_error_count – Typ: u8, Wertebereich: [0 bis 255]

Gibt Informationen über den Sensor zurück:

• die Versionsnummer des Sensors,
• den letzten Fehlercode den der Sensor gemeldet (0 bedeute kein Fehler) hat,
• die Anzahl der Framing und Prüfsummenfehler die in der Kommunikation mit dem Sensor aufgetreten sind.

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

• PARTICULATE_MATTER_BRICKLET_STATUS_LED_CONFIG_OFF = 0
• PARTICULATE_MATTER_BRICKLET_STATUS_LED_CONFIG_ON = 1
• PARTICULATE_MATTER_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• PARTICULATE_MATTER_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn ParticulateMatterBricklet::get_status_led_config(&self) → ConvertingReceiver<u8>¶

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

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

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

Für config:

• PARTICULATE_MATTER_BRICKLET_STATUS_LED_CONFIG_OFF = 0
• PARTICULATE_MATTER_BRICKLET_STATUS_LED_CONFIG_ON = 1
• PARTICULATE_MATTER_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• PARTICULATE_MATTER_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn ParticulateMatterBricklet::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 ParticulateMatterBricklet::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 ParticulateMatterBricklet::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: ['a' bis 'h', 'z'] 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 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.

Konfigurationsfunktionen für Callbacks¶

pub fn ParticulateMatterBricklet::set_pm_concentration_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 ParticulateMatterBricklet::get_pm_concentration_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.

pub fn ParticulateMatterBricklet::get_pm_concentration_callback_configuration(&self) → ConvertingReceiver<PmConcentrationCallbackConfiguration>¶

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 ParticulateMatterBricklet::set_pm_concentration_callback_configuration gesetzt.

pub fn ParticulateMatterBricklet::set_pm_count_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 ParticulateMatterBricklet::get_pm_count_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.

pub fn ParticulateMatterBricklet::get_pm_count_callback_configuration(&self) → ConvertingReceiver<PmCountCallbackConfiguration>¶

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 ParticulateMatterBricklet::set_pm_count_callback_configuration gesetzt.

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 ParticulateMatterBricklet::get_pm_concentration_callback_receiver(&self) → ConvertingCallbackReceiver<PmConcentrationEvent>¶

Event-Objekt:	pm10 – Typ: u16, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1] pm25 – Typ: u16, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1] pm100 – Typ: u16, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1]

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

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

Die Felder der empfangenen Struktur sind der gleiche wie ParticulateMatterBricklet::get_pm_concentration.

pub fn ParticulateMatterBricklet::get_pm_count_callback_receiver(&self) → ConvertingCallbackReceiver<PmCountEvent>¶

Event-Objekt:

greater03um – Typ: u16, Einheit: 10000 1/m³, Wertebereich: [0 bis 216 - 1] greater05um – Typ: u16, Einheit: 10000 1/m³, Wertebereich: [0 bis 216 - 1] greater10um – Typ: u16, Einheit: 10000 1/m³, Wertebereich: [0 bis 216 - 1] greater25um – Typ: u16, Einheit: 10000 1/m³, Wertebereich: [0 bis 216 - 1] greater50um – Typ: u16, Einheit: 10000 1/m³, Wertebereich: [0 bis 216 - 1] greater100um – Typ: u16, Einheit: 10000 1/m³, Wertebereich: [0 bis 216 - 1]

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

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

Die Felder der empfangenen Struktur sind der gleiche wie ParticulateMatterBricklet::get_pm_count.

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

• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_ENABLE = 3
• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION = 6
• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION = 8
• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
• PARTICULATE_MATTER_BRICKLET_FUNCTION_RESET = 243
• PARTICULATE_MATTER_BRICKLET_FUNCTION_WRITE_UID = 248

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

• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_ENABLE = 3
• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION = 6
• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION = 8
• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
• PARTICULATE_MATTER_BRICKLET_FUNCTION_RESET = 243
• PARTICULATE_MATTER_BRICKLET_FUNCTION_WRITE_UID = 248

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

• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_STATUS_OK = 0
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5

pub fn ParticulateMatterBricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>¶

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

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

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

Für mode:

• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

pub fn ParticulateMatterBricklet::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 ParticulateMatterBricklet::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 ParticulateMatterBricklet::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 ParticulateMatterBricklet::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 ParticulateMatterBricklet::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 ParticulateMatterBricklet::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 ParticulateMatterBricklet::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Particulate Matter Bricklet zu identifizieren.

Die ParticulateMatterBricklet::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 ParticulateMatterBricklet::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Particulate Matter Bricklet dar.