Rust - Outdoor Weather Bricklet

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

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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, outdoor_weather_bricklet::*};

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

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

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

    // Enable station data callbacks
    ow.set_station_callback_configuration(true).recv()?;

    // Enable sensor data callbacks
    ow.set_sensor_callback_configuration(true).recv()?;

    let station_data_receiver = ow.get_station_data_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `ow` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for station_data in station_data_receiver {
            println!("Identifier (Station): {}", station_data.identifier);
            println!("Temperature (Station): {} °C", station_data.temperature as f32 / 10.0);
            println!("Humidity (Station): {} %RH", station_data.humidity);
            println!("Wind Speed (Station): {} m/s", station_data.wind_speed as f32 / 10.0);
            println!("Gust Speed (Station): {} m/s", station_data.gust_speed as f32 / 10.0);
            println!("Rain (Station): {} mm", station_data.rain as f32 / 10.0);

            if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_N {
                println!("Wind Direction (Station): N");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NNE {
                println!("Wind Direction (Station): NNE");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NE {
                println!("Wind Direction (Station): NE");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ENE {
                println!("Wind Direction (Station): ENE");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_E {
                println!("Wind Direction (Station): E");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ESE {
                println!("Wind Direction (Station): ESE");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SE {
                println!("Wind Direction (Station): SE");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SSE {
                println!("Wind Direction (Station): SSE");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_S {
                println!("Wind Direction (Station): S");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SSW {
                println!("Wind Direction (Station): SSW");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SW {
                println!("Wind Direction (Station): SW");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_WSW {
                println!("Wind Direction (Station): WSW");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_W {
                println!("Wind Direction (Station): W");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_WNW {
                println!("Wind Direction (Station): WNW");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NW {
                println!("Wind Direction (Station): NW");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NNW {
                println!("Wind Direction (Station): NNW");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ERROR {
                println!("Wind Direction (Station): Error");
            }

            println!("Battery Low (Station): {}", station_data.battery_low);
            println!();
        }
    });

    let sensor_data_receiver = ow.get_sensor_data_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `ow` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for sensor_data in sensor_data_receiver {
            println!("Identifier (Sensor): {}", sensor_data.identifier);
            println!("Temperature (Sensor): {} °C", sensor_data.temperature as f32 / 10.0);
            println!("Humidity (Sensor): {} %RH", sensor_data.humidity);
            println!();
        }
    });

    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 OutdoorWeatherBricklet::new(uid: &str, ip_connection: &IpConnection) → OutdoorWeatherBricklet
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • outdoor_weather – Typ: OutdoorWeatherBricklet

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

let outdoor_weather = OutdoorWeatherBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn OutdoorWeatherBricklet::get_station_identifiers(&self) → Result<Vec<u8>, BrickletRecvTimeoutError>
Rückgabe:
  • identifiers – Typ: Vec<u8>, Wertebereich: [0 bis 255]

Gibt die Identifier (Zahl zwischen 0 und 255) von allen 'Stationen <https://www.tinkerforge.com/de/shop/accessories/sensors/outdoor-weather-station-ws-6147.html>`__ die seit dem Start des Bricklets entdeckt wurden.

Jede Station gibt sich selbst einen zufälligen Identifier beim ersten Start.

Seit Firmware-Version 2.0.2 wird eine Station von der Liste wieder entfernt wenn für 12 Stunden am Stück keine Daten empfangen werden.

pub fn OutdoorWeatherBricklet::get_sensor_identifiers(&self) → Result<Vec<u8>, BrickletRecvTimeoutError>
Rückgabe:
  • identifiers – Typ: Vec<u8>, Wertebereich: [0 bis 255]

Gibt die Identifier (Zahl zwischen 0 und 255) von allen 'Sensoren <https://www.tinkerforge.com/en/shop/accessories/sensors/temperature-humidity-sensor-th-6148.html>`__ die seit dem Start des Bricklets entdeckt wurden.

Jede Sensor gibt sich selbst einen zufälligen Identifier beim ersten Start.

Seit Firmware-Version 2.0.2 wird ein Sensor von der Liste wieder entfernt wenn für 12 Stunden am Stück keine Daten empfangen werden.

pub fn OutdoorWeatherBricklet::get_station_data(&self, identifier: u8) → ConvertingReceiver<StationData>
Parameter:
  • identifier – Typ: u8, Wertebereich: [0 bis 255]
Rückgabeobjekt:
  • temperature – Typ: i16, Einheit: 1/10 °C, Wertebereich: [-400 bis 650]
  • humidity – Typ: u8, Einheit: 1 %, Wertebereich: [10 bis 99]
  • wind_speed – Typ: u32, Einheit: 1/10 m/s, Wertebereich: [0 bis 232 - 1]
  • gust_speed – Typ: u32, Einheit: 1/10 m/s, Wertebereich: [0 bis 232 - 1]
  • rain – Typ: u32, Einheit: 1/10 mm, Wertebereich: [0 bis 232 - 1]
  • wind_direction – Typ: u8, Wertebereich: Siehe Konstanten
  • battery_low – Typ: bool
  • last_change – Typ: u16, Einheit: 1 s, Wertebereich: [0 bis 216 - 1]

Gibt die zuletzt empfangenen Daten für die Station mit dem entsprechenden Identifier zurück.

Die Rückgabewerte sind:

  • Temperatur,
  • Luftfeuchte,
  • Windgeschwindigkeit,
  • Windböengeschwindigkeit,
  • Niederschlag (kumuliert seit dem Einschalten der Station),
  • Windrichtung,
  • Batteriewarnung (true wenn der Batteriestand niedrig ist) und
  • Letzte Änderung (Sekunden seitdem diese Daten empfangen wurden).

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

Für wind_direction:

  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_N = 0
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NNE = 1
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NE = 2
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ENE = 3
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_E = 4
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ESE = 5
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SE = 6
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SSE = 7
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_S = 8
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SSW = 9
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SW = 10
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_WSW = 11
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_W = 12
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_WNW = 13
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NW = 14
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NNW = 15
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ERROR = 255
pub fn OutdoorWeatherBricklet::get_sensor_data(&self, identifier: u8) → ConvertingReceiver<SensorData>
Parameter:
  • identifier – Typ: u8, Wertebereich: [0 bis 255]
Rückgabeobjekt:
  • temperature – Typ: i16, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1]
  • humidity – Typ: u8, Einheit: 1 %, Wertebereich: [0 bis 255]
  • last_change – Typ: u16, Einheit: 1 s, Wertebereich: [0 bis 216 - 1]

Gibt die zuletzt empfangenen Daten für den Sensor mit dem entsprechenden Identifier zurück.

Die Rückgabewerte sind:

  • Temperatur,
  • Luftfeuchte und
  • Letzte Änderung (Sekunden seitdem diese Daten empfangen wurden).

Fortgeschrittene Funktionen

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

  • OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn OutdoorWeatherBricklet::get_status_led_config(&self) → ConvertingReceiver<u8>
Rückgabe:
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

  • OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn OutdoorWeatherBricklet::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 OutdoorWeatherBricklet::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 OutdoorWeatherBricklet::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 OutdoorWeatherBricklet::set_station_callback_configuration(&self, enable_callback: bool) → ConvertingReceiver<()>
Parameter:
  • enable_callback – Typ: bool, Standardwert: false

Aktiviert/Deaktiviert den Callback für Stationsdaten.

pub fn OutdoorWeatherBricklet::get_station_callback_configuration(&self) → ConvertingReceiver<bool>
Rückgabe:
  • enable_callback – Typ: bool, Standardwert: false

Gibt die Konfiguration zurück wie von OutdoorWeatherBricklet::set_station_callback_configuration gesetzt.

pub fn OutdoorWeatherBricklet::set_sensor_callback_configuration(&self, enable_callback: bool) → ConvertingReceiver<()>
Parameter:
  • enable_callback – Typ: bool, Standardwert: false

Aktiviert/Deaktiviert den Callback für Sensordaten.

pub fn OutdoorWeatherBricklet::get_sensor_callback_configuration(&self) → ConvertingReceiver<bool>
Rückgabe:
  • enable_callback – Typ: bool, Standardwert: false

Gibt die Konfiguration zurück wie von OutdoorWeatherBricklet::set_sensor_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.

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 OutdoorWeatherBricklet::get_station_data_callback_receiver(&self) → ConvertingCallbackReceiver<StationDataEvent>
Event-Objekt:
  • identifier – Typ: u8, Wertebereich: [0 bis 255]
  • temperature – Typ: i16, Einheit: 1/10 °C, Wertebereich: [-400 bis 650]
  • humidity – Typ: u8, Einheit: 1 %, Wertebereich: [10 bis 99]
  • wind_speed – Typ: u32, Einheit: 1/10 m/s, Wertebereich: [0 bis 232 - 1]
  • gust_speed – Typ: u32, Einheit: 1/10 m/s, Wertebereich: [0 bis 232 - 1]
  • rain – Typ: u32, Einheit: 1/10 mm, Wertebereich: [0 bis 232 - 1]
  • wind_direction – Typ: u8, Wertebereich: Siehe Konstanten
  • battery_low – Typ: bool

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

Meldet die Stationsdaten bei jedem eingehenden Datenpaket. Siehe OutdoorWeatherBricklet::get_station_data für Details über die Daten.

Für jede Station wird dieser Callback ca. alle 45 Sekunden ausgelöst werden.

Der Callback kann mittels OutdoorWeatherBricklet::set_station_callback_configuration aktiviert/deaktiviert werden (standardmäßig ist der Callback deaktiviert).

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

Für wind_direction:

  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_N = 0
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NNE = 1
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NE = 2
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ENE = 3
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_E = 4
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ESE = 5
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SE = 6
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SSE = 7
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_S = 8
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SSW = 9
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SW = 10
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_WSW = 11
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_W = 12
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_WNW = 13
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NW = 14
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NNW = 15
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ERROR = 255
pub fn OutdoorWeatherBricklet::get_sensor_data_callback_receiver(&self) → ConvertingCallbackReceiver<SensorDataEvent>
Event-Objekt:
  • identifier – Typ: u8, Wertebereich: [0 bis 255]
  • temperature – Typ: i16, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1]
  • humidity – Typ: u8, Einheit: 1 %, Wertebereich: [0 bis 255]

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

Meldet die Sensordaten bei jedem eingehenden Datenpaket. Siehe OutdoorWeatherBricklet::get_sensor_data für Details über die Daten.

Für jeden Sensor wird dieser Callback ca. alle 45 Sekunden ausgelöst werden.

Der Callback kann mittels OutdoorWeatherBricklet::set_sensor_callback_configuration aktiviert/deaktiviert werden (standardmäßig ist der Callback deaktiviert).

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

  • OUTDOOR_WEATHER_BRICKLET_FUNCTION_SET_STATION_CALLBACK_CONFIGURATION = 5
  • OUTDOOR_WEATHER_BRICKLET_FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION = 7
  • OUTDOOR_WEATHER_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • OUTDOOR_WEATHER_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • OUTDOOR_WEATHER_BRICKLET_FUNCTION_RESET = 243
  • OUTDOOR_WEATHER_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn OutdoorWeatherBricklet::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:

  • OUTDOOR_WEATHER_BRICKLET_FUNCTION_SET_STATION_CALLBACK_CONFIGURATION = 5
  • OUTDOOR_WEATHER_BRICKLET_FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION = 7
  • OUTDOOR_WEATHER_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • OUTDOOR_WEATHER_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • OUTDOOR_WEATHER_BRICKLET_FUNCTION_RESET = 243
  • OUTDOOR_WEATHER_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn OutdoorWeatherBricklet::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 OutdoorWeatherBricklet::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:

  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn OutdoorWeatherBricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>
Rückgabe:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten

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

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

Für mode:

  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn OutdoorWeatherBricklet::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 OutdoorWeatherBricklet::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 OutdoorWeatherBricklet::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 OutdoorWeatherBricklet::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 OutdoorWeatherBricklet::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 OutdoorWeatherBricklet::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 OutdoorWeatherBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Outdoor Weather Bricklet zu identifizieren.

Die OutdoorWeatherBricklet::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 OutdoorWeatherBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Outdoor Weather Bricklet dar.