Rust - Temperature 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

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

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

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

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

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

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

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

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let t = TemperatureBricklet::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);
            println!("It is too hot, we need air conditioning!");
        }
    });

    // 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(())
}

Grundfunktionen¶

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

Parameter:	uid – Typ: &str ip_connection – Typ: &IPConnection
Rückgabe:	temperature – Typ: TemperatureBricklet

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

let temperature = TemperatureBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn TemperatureBricklet::get_temperature(&self) → ConvertingReceiver<i16>¶

Rückgabe:	temperature – Typ: i16, Einheit: 1/100 °C, Wertebereich: [-2500 bis 8500]

Gibt die Temperatur des Sensors zurück.

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

Fortgeschrittene Funktionen¶

pub fn TemperatureBricklet::set_i2c_mode(&self, mode: u8) → ConvertingReceiver<()>¶

Parameter:	mode – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt den I2C Modus. Mögliche Modi sind:

• 0: Fast (400kHz)
• 1: Slow (100kHz)

Wenn Probleme mit offensichtlichen Ausreißern in den Temperature Bricklet Messungen auftreten, können diese eventuell aufgrund von elektromagnetischen Störungen sein. In diesem Fall kann es helfen die I2C Geschwindigkeit zu verringern.

Falls in einem System ein hoher Durchsatz an Nachrichten erwünscht ist, sollte die I2C Geschwindigkeit allerdings nicht verringert werden.

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

Für mode:

• TEMPERATURE_BRICKLET_I2C_MODE_FAST = 0
• TEMPERATURE_BRICKLET_I2C_MODE_SLOW = 1

Neu in Version 2.0.1 (Plugin).

pub fn TemperatureBricklet::get_i2c_mode(&self) → ConvertingReceiver<u8>¶

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

Gibt den I2C Modus zurück, wie von TemperatureBricklet::set_i2c_mode gesetzt.

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

Für mode:

• TEMPERATURE_BRICKLET_I2C_MODE_FAST = 0
• TEMPERATURE_BRICKLET_I2C_MODE_SLOW = 1

Neu in Version 2.0.1 (Plugin).

pub fn TemperatureBricklet::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 TemperatureBricklet::set_temperature_callback_period(&self, period: u32) → ConvertingReceiver<()>¶

Parameter:	period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

pub fn TemperatureBricklet::get_temperature_callback_period(&self) → ConvertingReceiver<u32>¶

Rückgabe:	period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

pub fn TemperatureBricklet::set_temperature_callback_threshold(&self, option: char, min: i16, max: i16) → ConvertingReceiver<()>¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: i16, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: i16, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Setzt den Schwellwert für den TemperatureBricklet::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)

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

Für option:

• TEMPERATURE_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
• TEMPERATURE_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
• TEMPERATURE_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
• TEMPERATURE_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
• TEMPERATURE_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn TemperatureBricklet::get_temperature_callback_threshold(&self) → ConvertingReceiver<TemperatureCallbackThreshold>¶

Rückgabeobjekt:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: i16, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: i16, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

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

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

Für option:

• TEMPERATURE_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
• TEMPERATURE_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
• TEMPERATURE_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
• TEMPERATURE_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
• TEMPERATURE_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn TemperatureBricklet::set_debounce_period(&self, debounce: u32) → ConvertingReceiver<()>¶

Parameter:	debounce – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callback

• TemperatureBricklet::get_temperature_reached_callback_receiver

ausgelöst wird, wenn der Schwellwert

• TemperatureBricklet::set_temperature_callback_threshold

weiterhin erreicht bleibt.

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

Rückgabe:	debounce – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von TemperatureBricklet::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.

pub fn TemperatureBricklet::get_temperature_callback_receiver(&self) → ConvertingCallbackReceiver<i16>¶

Event:	temperature – Typ: i16, Einheit: 1/100 °C, Wertebereich: [-2500 bis 8500]

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

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

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

pub fn TemperatureBricklet::get_temperature_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i16>¶

Event:	temperature – Typ: i16, Einheit: 1/100 °C, Wertebereich: [-2500 bis 8500]

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

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

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

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

• TEMPERATURE_BRICKLET_FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2
• TEMPERATURE_BRICKLET_FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4
• TEMPERATURE_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
• TEMPERATURE_BRICKLET_FUNCTION_SET_I2C_MODE = 10

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

• TEMPERATURE_BRICKLET_FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2
• TEMPERATURE_BRICKLET_FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4
• TEMPERATURE_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
• TEMPERATURE_BRICKLET_FUNCTION_SET_I2C_MODE = 10

pub fn TemperatureBricklet::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.

Konstanten¶

pub const TemperatureBricklet::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Temperature Bricklet zu identifizieren.

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

Diese Konstante stellt den Anzeigenamen eines Temperature Bricklet dar.