Rust - Thermocouple Bricklet

Dies ist die Beschreibung der Rust API Bindings für das Thermocouple Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Thermocouple 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
use std::{error::Error, io};

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

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

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

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

    // Get current temperature.
    let temperature = t.get_temperature().recv()?;
    println!("Temperature: {} °C", temperature 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::{ip_connection::IpConnection, thermocouple_bricklet::*};

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

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

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

    let temperature_receiver = t.get_temperature_callback_receiver();

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

    // Set period for temperature receiver to 1s (1000ms).
    // Note: The temperature callback is only called every second
    //       if the temperature has changed since the last call!
    t.set_temperature_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
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, thermocouple_bricklet::*};

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let t = ThermocoupleBricklet::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).
    t.set_debounce_period(10000);

    let temperature_reached_receiver = t.get_temperature_reached_callback_receiver();

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

    // Configure threshold for temperature "greater than 30 °C".
    t.set_temperature_callback_threshold('>', 30 * 100, 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 ThermocoupleBricklet::new(uid: &str, ip_connection: &IpConnection) → ThermocoupleBricklet

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

Gibt die Temperatur des Thermoelements zurück. Der Wert wird in °C/100 angegeben, z.B. bedeutet ein Wert von 4223 eine gemessene Temperatur von 42,23 °C.

Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen den ThermocoupleBricklet::get_temperature_callback_receiver Callback zu nutzen und die Periode mit ThermocoupleBricklet::set_temperature_callback_period vorzugeben.

Fortgeschrittene Funktionen

pub fn ThermocoupleBricklet::set_configuration(&self, averaging: u8, thermocouple_type: u8, filter: u8) → ConvertingReceiver<()>

Konfiguriert werden können Averaging-Größe, Thermoelement-Typ und Frequenz-Filterung.

Mögliche Averaging-Größen sind 1, 2, 4, 8 und 16 Samples.

Als Thermoelement-Typ stehen B, E, J, K, N, R, S und T zur Verfügung. Falls ein anderes Thermoelement benutzt werden soll, können G8 und G32 genutzt werden. Mit diesen Typen wird der Wert nicht in °C/100 zurückgegeben sondern er wird durch folgende Formeln bestimmt:

  • G8: Wert = 8 * 1.6 * 2^17 * Vin
  • G32: Wert = 32 * 1.6 * 2^17 * Vin

dabei ist Vin die Eingangsspannung des Thermoelements.

Der Frequenz-Filter kann auf 50Hz und 60Hz konfiguriert werden. Er sollte abhängig von der lokalen Netzfrequenz gewählt werden.

Die Konvertierungszeit ist abhängig von der Averaging-Größe und der Frequenz-Filter-Konfiguration. Sie kann wie folgt bestimmt werden:

  • 60Hz: Zeit = 82 + (Samples - 1) * 16.67
  • 50Hz: Zeit = 98 + (Samples - 1) * 20

Die Standardkonfiguration ist 16 Samples, Typ K und 50Hz.

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

  • THERMOCOUPLE_BRICKLET_AVERAGING_1 = 1
  • THERMOCOUPLE_BRICKLET_AVERAGING_2 = 2
  • THERMOCOUPLE_BRICKLET_AVERAGING_4 = 4
  • THERMOCOUPLE_BRICKLET_AVERAGING_8 = 8
  • THERMOCOUPLE_BRICKLET_AVERAGING_16 = 16
  • THERMOCOUPLE_BRICKLET_TYPE_B = 0
  • THERMOCOUPLE_BRICKLET_TYPE_E = 1
  • THERMOCOUPLE_BRICKLET_TYPE_J = 2
  • THERMOCOUPLE_BRICKLET_TYPE_K = 3
  • THERMOCOUPLE_BRICKLET_TYPE_N = 4
  • THERMOCOUPLE_BRICKLET_TYPE_R = 5
  • THERMOCOUPLE_BRICKLET_TYPE_S = 6
  • THERMOCOUPLE_BRICKLET_TYPE_T = 7
  • THERMOCOUPLE_BRICKLET_TYPE_G8 = 8
  • THERMOCOUPLE_BRICKLET_TYPE_G32 = 9
  • THERMOCOUPLE_BRICKLET_FILTER_OPTION_50HZ = 0
  • THERMOCOUPLE_BRICKLET_FILTER_OPTION_60HZ = 1
pub fn ThermocoupleBricklet::get_configuration(&self) → ConvertingReceiver<Configuration>

Gibt die Konfiguration zurück, wie von ThermocoupleBricklet::set_configuration gesetzt.

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

  • THERMOCOUPLE_BRICKLET_AVERAGING_1 = 1
  • THERMOCOUPLE_BRICKLET_AVERAGING_2 = 2
  • THERMOCOUPLE_BRICKLET_AVERAGING_4 = 4
  • THERMOCOUPLE_BRICKLET_AVERAGING_8 = 8
  • THERMOCOUPLE_BRICKLET_AVERAGING_16 = 16
  • THERMOCOUPLE_BRICKLET_TYPE_B = 0
  • THERMOCOUPLE_BRICKLET_TYPE_E = 1
  • THERMOCOUPLE_BRICKLET_TYPE_J = 2
  • THERMOCOUPLE_BRICKLET_TYPE_K = 3
  • THERMOCOUPLE_BRICKLET_TYPE_N = 4
  • THERMOCOUPLE_BRICKLET_TYPE_R = 5
  • THERMOCOUPLE_BRICKLET_TYPE_S = 6
  • THERMOCOUPLE_BRICKLET_TYPE_T = 7
  • THERMOCOUPLE_BRICKLET_TYPE_G8 = 8
  • THERMOCOUPLE_BRICKLET_TYPE_G32 = 9
  • THERMOCOUPLE_BRICKLET_FILTER_OPTION_50HZ = 0
  • THERMOCOUPLE_BRICKLET_FILTER_OPTION_60HZ = 1
pub fn ThermocoupleBricklet::get_error_state(&self) → ConvertingReceiver<ErrorState>

Gibt den aktuellen Error-Status zurück. Es gibt zwei mögliche Status:

  • Over/Under Voltage und
  • Open Circuit.

Over/Under Voltage bei Spannungen unter 0V oder über 3.3V ausgelöst. In diesem Fall ist mit hoher Wahrscheinlichkeit das Thermoelement defekt. Ein Open Circuit-Error deutet darauf hin, das kein Thermoelement angeschlossen ist.

Der ThermocoupleBricklet::get_error_state_callback_receiver Callback wird automatisch jedes mal ausgelöst, wenn sich der Error-Status ändert.

pub fn ThermocoupleBricklet::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 ThermocoupleBricklet::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 ThermocoupleBricklet::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 ThermocoupleBricklet::set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

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

  • THERMOCOUPLE_BRICKLET_FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2
  • THERMOCOUPLE_BRICKLET_FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4
  • THERMOCOUPLE_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • THERMOCOUPLE_BRICKLET_FUNCTION_SET_CONFIGURATION = 10
pub fn ThermocoupleBricklet::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 ThermocoupleBricklet::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 ThermocoupleBricklet::set_temperature_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

Der ThermocoupleBricklet::get_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 ThermocoupleBricklet::get_temperature_callback_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von ThermocoupleBricklet::set_temperature_callback_period gesetzt.

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

Setzt den Schwellwert für den ThermocoupleBricklet::get_temperature_reached_callback_receiver Callback.

Die folgenden Optionen sind möglich:

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

  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn ThermocoupleBricklet::get_temperature_callback_threshold(&self) → ConvertingReceiver<TemperatureCallbackThreshold>

Gibt den Schwellwert zurück, wie von ThermocoupleBricklet::set_temperature_callback_threshold gesetzt.

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

  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn ThermocoupleBricklet::set_debounce_period(&self, debounce: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

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

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

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

Dieser Callback wird mit der Periode, wie gesetzt mit ThermocoupleBricklet::set_temperature_callback_period, ausgelöst. Der empfangene Variable ist die Temperatur des Thermoelements.

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

pub fn ThermocoupleBricklet::get_temperature_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von ThermocoupleBricklet::set_temperature_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist die Temperatur des Thermoelements.

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

pub fn ThermocoupleBricklet::get_error_state_callback_receiver(&self) → ConvertingCallbackReceiver<ErrorStateEvent>

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

Dieser Callback wird ausgelöst, wenn der Error-Status sich verändert (siehe ThermocoupleBricklet::get_error_state).

Konstanten

ThermocoupleBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Thermocouple Bricklet zu identifizieren.

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

ThermocoupleBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Thermocouple Bricklet dar.