Rust - Barometer Bricklet

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

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
29
use std::{error::Error, io};

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

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

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

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

    // Get current air pressure.
    let air_pressure = b.get_air_pressure().recv()?;
    println!("Air Pressure: {} mbar", air_pressure as f32 / 1000.0);

    // Get current altitude.
    let altitude = b.get_altitude().recv()?;
    println!("Altitude: {} m", altitude as f32 / 100.0);

    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
use std::{error::Error, io, thread};
use tinkerforge::{barometer_bricklet::*, ip_connection::IpConnection};

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

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

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

    let air_pressure_receiver = b.get_air_pressure_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `b` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for air_pressure in air_pressure_receiver {
            println!("Air Pressure: {} mbar", air_pressure as f32 / 1000.0);
        }
    });

    // Set period for air pressure receiver to 1s (1000ms).
    // Note: The air pressure callback is only called every second
    //       if the air pressure has changed since the last call!
    b.set_air_pressure_callback_period(1000);

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

Threshold

Download (example_threshold.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
use std::{error::Error, io, thread};
use tinkerforge::{barometer_bricklet::*, ip_connection::IpConnection};

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

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

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

    // Get threshold receivers with a debounce time of 10 seconds (10000ms).
    b.set_debounce_period(10000);

    let air_pressure_reached_receiver = b.get_air_pressure_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `b` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for air_pressure_reached in air_pressure_reached_receiver {
            println!("Air Pressure: {} mbar", air_pressure_reached as f32 / 1000.0);
            println!("Enjoy the potentially good weather!");
        }
    });

    // Configure threshold for air pressure "greater than 1025 mbar".
    b.set_air_pressure_callback_threshold('>', 1025 * 1000, 0);

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

Erzeugt ein neues BarometerBricklet-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 BarometerBricklet::get_air_pressure(&self) → ConvertingReceiver<i32>

Gibt den Luftdruck des Luftdrucksensors zurück. Der Wertbereich geht von 10000 bis 1200000 und ist in mbar/1000 angegeben, d.h. bei einem Wert von 1001092 wurde ein Luftdruck von 1001,092 mbar gemessen.

Wenn der Luftdruck periodisch abgefragt werden soll, wird empfohlen den BarometerBricklet::get_air_pressure_callback_receiver Callback zu nutzen und die Periode mit BarometerBricklet::set_air_pressure_callback_period vorzugeben.

pub fn BarometerBricklet::get_altitude(&self) → ConvertingReceiver<i32>

Gibt die relative Höhe des Luftdrucksensors zurück. Der Wert ist in cm angegeben und wird auf Basis der Differenz zwischen dem aktuellen Luftdruck und dem Referenzluftdruck berechnet, welcher mit BarometerBricklet::set_reference_air_pressure gesetzt werden kann.

Wenn die Höhe periodisch abgefragt werden soll, wird empfohlen den BarometerBricklet::get_altitude_callback_receiver Callback zu nutzen und die Periode mit BarometerBricklet::set_altitude_callback_period vorzugeben.

pub fn BarometerBricklet::set_reference_air_pressure(&self, air_pressure: i32) → ConvertingReceiver<()>

Setzt den Referenzluftdruck in mbar/1000 für die Höhenberechnung. Gültige Werte liegen zwischen 10000 und 1200000. Wenn der aktuelle Luftdruckwert als Referenz übergeben wird dann gibt die Höhenberechnung 0cm aus. Als Abkürzung kann auch 0 übergeben werden, dadurch wird der Referenzluftdruck intern auf den aktuellen Luftdruckwert gesetzt.

Wohl bekannte Referenzluftdruckwerte, die in der Luftfahrt verwendet werden, sind QNH und QFE aus dem Q-Schlüssel.

Der Standardwert ist 1013,25mbar.

pub fn BarometerBricklet::get_reference_air_pressure(&self) → ConvertingReceiver<i32>

Gibt den Referenzluftdruckwert zurück, wie von BarometerBricklet::set_reference_air_pressure gesetzt.

Fortgeschrittene Funktionen

pub fn BarometerBricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>

Gibt die Temperatur des Luftdrucksensors zurück. Der Wertbereich ist von -4000 bis 8500 und ist in °C/100 angegeben, d.h. bei einem Wert von 2007 wurde eine Temperatur von 20,07 °C gemessen.

Diese Temperatur wird intern zur Temperaturkompensation der Luftdruckmessung verwendet. Sie ist nicht so genau wie die Temperatur die vom Temperature Bricklet oder dem Temperature IR Bricklet gemessen wird.

pub fn BarometerBricklet::set_averaging(&self, moving_average_pressure: u8, average_pressure: u8, average_temperature: u8) → ConvertingReceiver<()>

Setzt die unterschiedlichen Averaging-Parameter (Mittelwertbildung). Es ist möglich die Länge des Mittelwerts für Temperatur und Luftdruck anzugeben. Zusätzlich gibt kann die Länge für einen gleitenden Mittelwert für den Luftdruck angegeben werden. Der gleitende Mittelwert wird mit den Werten des normalen Mittelwerts berechnet. Es gibt keinen gleitenden Mittelwert für die Temperatur.

Die maximale Länge des Luftdruckmittelwerts ist 10, des Temperaturmittelwerts 255 und des gleitenden Mittelwertes 25.

Wenn alle drei Parameter auf 0 gesetzt werden, ist das Averaging komplett aus. In diesem Fall gibt es viel Rauschen auf den Daten, allerdings sind die Daten dann ohne Verzögerung. Wir empfehlen das Averaging auszustellen wenn die Daten des Barometer Bricklets zusammen mit anderen Sensordaten fusioniert werden sollen.

Der Standardwert ist 10 für die normalen Mittelwerte und 25 für den gleitenden Mittelwert

Neu in Version 2.0.1 (Plugin).

pub fn BarometerBricklet::get_averaging(&self) → ConvertingReceiver<Averaging>

Gibt die Averaging-Konfiguration zurück, wie von BarometerBricklet::set_averaging gesetzt.

Neu in Version 2.0.1 (Plugin).

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

  • BAROMETER_BRICKLET_FUNCTION_SET_AIR_PRESSURE_CALLBACK_PERIOD = 3
  • BAROMETER_BRICKLET_FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 5
  • BAROMETER_BRICKLET_FUNCTION_SET_AIR_PRESSURE_CALLBACK_THRESHOLD = 7
  • BAROMETER_BRICKLET_FUNCTION_SET_ALTITUDE_CALLBACK_THRESHOLD = 9
  • BAROMETER_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BAROMETER_BRICKLET_FUNCTION_SET_REFERENCE_AIR_PRESSURE = 13
  • BAROMETER_BRICKLET_FUNCTION_SET_AVERAGING = 20
pub fn BarometerBricklet::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:

  • BAROMETER_BRICKLET_FUNCTION_SET_AIR_PRESSURE_CALLBACK_PERIOD = 3
  • BAROMETER_BRICKLET_FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 5
  • BAROMETER_BRICKLET_FUNCTION_SET_AIR_PRESSURE_CALLBACK_THRESHOLD = 7
  • BAROMETER_BRICKLET_FUNCTION_SET_ALTITUDE_CALLBACK_THRESHOLD = 9
  • BAROMETER_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BAROMETER_BRICKLET_FUNCTION_SET_REFERENCE_AIR_PRESSURE = 13
  • BAROMETER_BRICKLET_FUNCTION_SET_AVERAGING = 20
pub fn BarometerBricklet::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 BarometerBricklet::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.

Konfigurationsfunktionen für Callbacks

pub fn BarometerBricklet::set_air_pressure_callback_period(&self, period: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der BarometerBricklet::get_air_pressure_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der BarometerBricklet::get_air_pressure_callback_receiver Callback wird nur ausgelöst, wenn sich der Luftdruck seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

pub fn BarometerBricklet::get_air_pressure_callback_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von BarometerBricklet::set_air_pressure_callback_period gesetzt.

pub fn BarometerBricklet::set_altitude_callback_period(&self, period: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der BarometerBricklet::get_altitude_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der BarometerBricklet::get_altitude_callback_receiver Callback wird nur ausgelöst, wenn sich Höhe seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

pub fn BarometerBricklet::get_altitude_callback_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von BarometerBricklet::set_altitude_callback_period gesetzt.

pub fn BarometerBricklet::set_air_pressure_callback_threshold(&self, option: char, min: i32, max: i32) → ConvertingReceiver<()>

Setzt den Schwellwert für den BarometerBricklet::get_air_pressure_reached_callback_receiver Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn der Luftdruck außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn der Luftdruck innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn der Luftdruck kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn der Luftdruck größer als der min Wert ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0).

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

  • BAROMETER_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • BAROMETER_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BAROMETER_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • BAROMETER_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • BAROMETER_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn BarometerBricklet::get_air_pressure_callback_threshold(&self) → ConvertingReceiver<AirPressureCallbackThreshold>

Gibt den Schwellwert zurück, wie von BarometerBricklet::set_air_pressure_callback_threshold gesetzt.

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

  • BAROMETER_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • BAROMETER_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BAROMETER_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • BAROMETER_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • BAROMETER_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn BarometerBricklet::set_altitude_callback_threshold(&self, option: char, min: i32, max: i32) → ConvertingReceiver<()>

Setzt den Schwellwert für den BarometerBricklet::get_altitude_reached_callback_receiver Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Höhe außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Höhe innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Höhe kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Höhe größer als der min Wert ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0).

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

  • BAROMETER_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • BAROMETER_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BAROMETER_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • BAROMETER_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • BAROMETER_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn BarometerBricklet::get_altitude_callback_threshold(&self) → ConvertingReceiver<AltitudeCallbackThreshold>

Gibt den Schwellwert zurück, wie von BarometerBricklet::set_altitude_callback_threshold gesetzt.

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

  • BAROMETER_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • BAROMETER_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BAROMETER_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • BAROMETER_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • BAROMETER_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn BarometerBricklet::set_debounce_period(&self, debounce: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

pub fn BarometerBricklet::get_debounce_period(&self) → ConvertingReceiver<u32>

Gibt die Entprellperiode zurück, wie von BarometerBricklet::set_debounce_period 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 BarometerBricklet::get_air_pressure_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

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

Dieser Callback wird mit der Periode, wie gesetzt mit BarometerBricklet::set_air_pressure_callback_period, ausgelöst. Der empfangene Variable ist der Luftdruck des Luftdrucksensors.

Der BarometerBricklet::get_air_pressure_callback_receiver Callback wird nur ausgelöst, wenn sich der Luftdruck seit der letzten Auslösung geändert hat.

pub fn BarometerBricklet::get_altitude_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

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

Dieser Callback wird mit der Periode, wie gesetzt mit BarometerBricklet::set_altitude_callback_period, ausgelöst. Der empfangene Variable ist die Höhe des Luftdrucksensors.

Der BarometerBricklet::get_altitude_callback_receiver Callback wird nur ausgelöst, wenn sich die Höhe seit der letzten Auslösung geändert hat.

pub fn BarometerBricklet::get_air_pressure_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

Receiver die mit dieser Funktion erstellt werden, empfangen Air Pressure Reached-Events.

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von BarometerBricklet::set_air_pressure_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist der Luftdruck des Luftdrucksensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit BarometerBricklet::set_debounce_period gesetzt, ausgelöst.

pub fn BarometerBricklet::get_altitude_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von BarometerBricklet::set_altitude_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist die Höhe des Luftdrucksensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit BarometerBricklet::set_debounce_period gesetzt, ausgelöst.

Konstanten

BarometerBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Barometer Bricklet zu identifizieren.

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

BarometerBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Barometer Bricklet dar.