Rust - Temperature IR Bricklet

Dies ist die Beschreibung der Rust API Bindings für das Temperature IR Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Temperature IR 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::{ip_connection::IpConnection, temperature_ir_bricklet::*};

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

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

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

    // Get current ambient temperature.
    let ambient_temperature = tir.get_ambient_temperature().recv()?;
    println!("Ambient Temperature: {} °C", ambient_temperature as f32 / 10.0);

    // Get current object temperature.
    let object_temperature = tir.get_object_temperature().recv()?;
    println!("Object Temperature: {} °C", object_temperature as f32 / 10.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::{ip_connection::IpConnection, temperature_ir_bricklet::*};

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

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

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

    let object_temperature_receiver = tir.get_object_temperature_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `tir` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for object_temperature in object_temperature_receiver {
            println!("Object Temperature: {} °C", object_temperature as f32 / 10.0);
        }
    });

    // Set period for object temperature receiver to 1s (1000ms).
    // Note: The object temperature callback is only called every second
    //       if the object temperature has changed since the last call!
    tir.set_object_temperature_callback_period(1000);

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

Water Boiling

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

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

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

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

    // Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
    tir.set_emissivity(64224);

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

    let object_temperature_reached_receiver = tir.get_object_temperature_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `tir` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for object_temperature_reached in object_temperature_reached_receiver {
            println!("Object Temperature: {} °C", object_temperature_reached as f32 / 10.0);
            println!("The water is boiling!");
        }
    });

    // Configure threshold for object temperature "greater than 100 °C".
    tir.set_object_temperature_callback_threshold('>', 100 * 10, 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 TemperatureIrBricklet::new(uid: &str, ip_connection: &IpConnection) → TemperatureIrBricklet

Erzeugt ein neues TemperatureIrBricklet-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 TemperatureIrBricklet::get_ambient_temperature(&self) → ConvertingReceiver<i16>

Gibt die Umgebungstemperatur des Sensors zurück. Der Wertebereich ist von -400 bis 1250 und wird in °C/10 angegeben, z.B. bedeutet ein Wert von 423 eine gemessene Umgebungstemperatur von 42,3 °C.

Wenn die Umgebungstemperatur periodisch abgefragt werden soll, wird empfohlen den TemperatureIrBricklet::get_ambient_temperature_callback_receiver Callback zu nutzen und die Periode mit TemperatureIrBricklet::set_ambient_temperature_callback_period vorzugeben.

pub fn TemperatureIrBricklet::get_object_temperature(&self) → ConvertingReceiver<i16>

Gibt die Objekttemperatur des Sensors zurück, z.B. die Temperatur der Oberfläche auf welche der Sensor zielt. Der Wertebereich ist von -700 bis 3800 und wird in °C/10 angegeben, z.B. bedeutet ein Wert von 3001 eine gemessene Temperatur von 300,1 °C auf der Oberfläche des Objektes.

Die Temperatur von unterschiedlichen Materialien ist abhängig von ihrem Emissionsgrad. Der Emissionsgrad des Materials kann mit TemperatureIrBricklet::set_emissivity gesetzt werden.

Wenn die Objekttemperatur periodisch abgefragt werden soll, wird empfohlen den TemperatureIrBricklet::get_object_temperature_callback_receiver Callback zu nutzen und die Periode mit TemperatureIrBricklet::set_object_temperature_callback_period vorzugeben.

Fortgeschrittene Funktionen

pub fn TemperatureIrBricklet::set_emissivity(&self, emissivity: u16) → ConvertingReceiver<()>

Setzt den Emissionsgrad, welcher zur Berechnung der Oberflächentemperatur benutzt wird, wie von TemperatureIrBricklet::get_object_temperature zurückgegeben.

Der Emissionsgrad wird normalerweise als Wert zwischen 0,0 und 1,0 angegeben. Eine Liste von Emissionsgraden unterschiedlicher Materialien ist hier zu finden.

Der Parameter von TemperatureIrBricklet::set_emissivity muss mit eine Faktor von 65535 (16-Bit) vorgegeben werden. Beispiel: Ein Emissionsgrad von 0,1 kann mit dem Wert 6553 gesetzt werden, ein Emissionsgrad von 0,5 mit dem Wert 32767 und so weiter.

Bemerkung

Wenn eine exakte Messung der Objekttemperatur notwendig ist, ist es entscheidend eine exakten Emissionsgrad anzugeben.

Der Standard Emissionsgrad ist 1,0 (Wert von 65535) und der minimale Emissionsgrad welcher der Sensor verarbeiten kann ist 0,1 (Wert von 6553).

Der Emissionsgrad wird in nicht-flüchtigem Speicher gespeichert und wird auch noch einem Neustart weiter genutzt.

pub fn TemperatureIrBricklet::get_emissivity(&self) → ConvertingReceiver<u16>

Gibt den Emissionsgrad zurück, wie von TemperatureIrBricklet::set_emissivity gesetzt.

pub fn TemperatureIrBricklet::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 TemperatureIrBricklet::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 TemperatureIrBricklet::set_response_expected. Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Siehe TemperatureIrBricklet::set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

pub fn TemperatureIrBricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

  • TEMPERATURE_IR_BRICKLET_FUNCTION_SET_EMISSIVITY = 3
  • TEMPERATURE_IR_BRICKLET_FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
  • TEMPERATURE_IR_BRICKLET_FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
  • TEMPERATURE_IR_BRICKLET_FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
  • TEMPERATURE_IR_BRICKLET_FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
  • TEMPERATURE_IR_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 13
pub fn TemperatureIrBricklet::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 TemperatureIrBricklet::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 TemperatureIrBricklet::set_ambient_temperature_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

Der TemperatureIrBricklet::get_ambient_temperature_callback_receiver Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

pub fn TemperatureIrBricklet::get_ambient_temperature_callback_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von TemperatureIrBricklet::set_ambient_temperature_callback_period gesetzt.

pub fn TemperatureIrBricklet::set_object_temperature_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

Der TemperatureIrBricklet::get_object_temperature_callback_receiver Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

pub fn TemperatureIrBricklet::get_object_temperature_callback_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von TemperatureIrBricklet::set_object_temperature_callback_period gesetzt.

pub fn TemperatureIrBricklet::set_ambient_temperature_callback_threshold(&self, option: char, min: i16, max: i16) → ConvertingReceiver<()>

Setzt den Schwellwert für den TemperatureIrBricklet::get_ambient_temperature_reached_callback_receiver Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Umgebungstemperatur außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Umgebungstemperatur innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Umgebungstemperatur kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Umgebungstemperatur 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:

  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn TemperatureIrBricklet::get_ambient_temperature_callback_threshold(&self) → ConvertingReceiver<AmbientTemperatureCallbackThreshold>

Gibt den Schwellwert zurück, wie von TemperatureIrBricklet::set_ambient_temperature_callback_threshold gesetzt.

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

  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn TemperatureIrBricklet::set_object_temperature_callback_threshold(&self, option: char, min: i16, max: i16) → ConvertingReceiver<()>

Setzt den Schwellwert für den TemperatureIrBricklet::get_object_temperature_reached_callback_receiver Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Objekttemperatur außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Objekttemperatur innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Objekttemperatur kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Objekttemperatur 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:

  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn TemperatureIrBricklet::get_object_temperature_callback_threshold(&self) → ConvertingReceiver<ObjectTemperatureCallbackThreshold>

Gibt den Schwellwert zurück, wie von TemperatureIrBricklet::set_object_temperature_callback_threshold gesetzt.

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

  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn TemperatureIrBricklet::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 TemperatureIrBricklet::get_debounce_period(&self) → ConvertingReceiver<u32>

Gibt die Entprellperiode zurück, wie von TemperatureIrBricklet::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 TemperatureIrBricklet::get_ambient_temperature_callback_receiver(&self) → ConvertingCallbackReceiver<i16>

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

Dieser Callback wird mit der Periode, wie gesetzt mit TemperatureIrBricklet::set_ambient_temperature_callback_period, ausgelöst. Der empfangene Variable ist die Temperatur des Sensors.

Der TemperatureIrBricklet::get_ambient_temperature_callback_receiver Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

pub fn TemperatureIrBricklet::get_object_temperature_callback_receiver(&self) → ConvertingCallbackReceiver<i16>

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

Dieser Callback wird mit der Periode, wie gesetzt mit TemperatureIrBricklet::set_object_temperature_callback_period, ausgelöst. Der empfangene Variable ist die Objekttemperatur des Sensors.

Der TemperatureIrBricklet::get_object_temperature_callback_receiver Callback wird nur ausgelöst, wenn sich die Objekttemperatur seit der letzten Auslösung geändert hat.

pub fn TemperatureIrBricklet::get_ambient_temperature_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i16>

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von TemperatureIrBricklet::set_ambient_temperature_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist die Umgebungstemperatur des Sensors.

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

pub fn TemperatureIrBricklet::get_object_temperature_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i16>

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von TemperatureIrBricklet::set_object_temperature_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist die Objekttemperatur des Sensors.

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

Konstanten

TemperatureIrBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Temperature IR Bricklet zu identifizieren.

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

TemperatureIrBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Temperature IR Bricklet dar.