Rust - PTC Bricklet

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

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

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

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

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

    // Spawn thread to handle received callback messages.
    // This thread ends when the `ptc` 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!
    ptc.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, ptc_bricklet::*};

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

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

    let temperature_reached_receiver = ptc.get_temperature_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `ptc` 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".
    ptc.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 PtcBricklet::new(uid: &str, ip_connection: &IpConnection) → PtcBricklet

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

Gibt die Temperatur des verbundenen Sensors zurück. Der Wertebereich ist von -246 bis 849 °C und 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 PtcBricklet::get_temperature_callback_receiver Callback zu nutzen und die Periode mit PtcBricklet::set_temperature_callback_period vorzugeben.

pub fn PtcBricklet::is_sensor_connected(&self) → ConvertingReceiver<bool>

Gibt true zurück wenn ein Sensor korrekt verbunden ist.

Falls diese Funktion false zurück gibt, ist entweder kein Pt100 oder Pt1000 Sensor verbunden, der Sensor ist inkorrekt verbunden oder der Sensor selbst ist fehlerhaft.

pub fn PtcBricklet::set_wire_mode(&self, mode: u8) → ConvertingReceiver<()>

Stellt die Leiter-Konfiguration des Sensors ein. Mögliche Werte sind 2, 3 und 4, dies entspricht 2-, 3- und 4-Leiter-Sensoren. Der Wert muss er Jumper-Konfiguration am Bricklet entsprechen.

Der Standardwert ist 2 = 2-Leiter.

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

  • PTC_BRICKLET_WIRE_MODE_2 = 2
  • PTC_BRICKLET_WIRE_MODE_3 = 3
  • PTC_BRICKLET_WIRE_MODE_4 = 4
pub fn PtcBricklet::get_wire_mode(&self) → ConvertingReceiver<u8>

Gibt die Leiter-Konfiguration zurück, wie von PtcBricklet::set_wire_mode gesetzt.

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

  • PTC_BRICKLET_WIRE_MODE_2 = 2
  • PTC_BRICKLET_WIRE_MODE_3 = 3
  • PTC_BRICKLET_WIRE_MODE_4 = 4

Fortgeschrittene Funktionen

pub fn PtcBricklet::get_resistance(&self) → ConvertingReceiver<i32>

Gibt den Wert zurück, wie vom "MAX31865 Präzisions Delta-Sigma ADC" berechnet.

Der Wert kann mit den folgenden Formeln in einen Widerstand konvertiert werden:

  • Pt100: Widerstand = (Wert * 390) / 32768
  • Pt1000: Widerstand = (Wert * 3900) / 32768

Wenn der Widerstand periodisch abgefragt werden soll, wird empfohlen den PtcBricklet::get_resistance_callback_receiver Callback zu nutzen und die Periode mit PtcBricklet::set_resistance_callback_period vorzugeben.

pub fn PtcBricklet::set_noise_rejection_filter(&self, filter: u8) → ConvertingReceiver<()>

Setzt den Entstörfilter auf 50Hz (0) oder 60Hz (1). Störungen von 50Hz oder 60Hz Stromquellen (inklusive Oberwellen der Stromquellen-Grundfrequenz) werden um 82dB abgeschwächt.

Der Standardwert ist 0 = 50Hz.

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

  • PTC_BRICKLET_FILTER_OPTION_50HZ = 0
  • PTC_BRICKLET_FILTER_OPTION_60HZ = 1
pub fn PtcBricklet::get_noise_rejection_filter(&self) → ConvertingReceiver<u8>

Gibt die Einstellung des Entstörfilters zurück, wie von PtcBricklet::set_noise_rejection_filter gesetzt.

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

  • PTC_BRICKLET_FILTER_OPTION_50HZ = 0
  • PTC_BRICKLET_FILTER_OPTION_60HZ = 1
pub fn PtcBricklet::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 PtcBricklet::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 PtcBricklet::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 PtcBricklet::set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

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

  • PTC_BRICKLET_FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
  • PTC_BRICKLET_FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
  • PTC_BRICKLET_FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
  • PTC_BRICKLET_FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
  • PTC_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • PTC_BRICKLET_FUNCTION_SET_NOISE_REJECTION_FILTER = 17
  • PTC_BRICKLET_FUNCTION_SET_WIRE_MODE = 20
  • PTC_BRICKLET_FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22
pub fn PtcBricklet::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 PtcBricklet::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 PtcBricklet::set_temperature_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

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

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

pub fn PtcBricklet::set_resistance_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

Der PtcBricklet::get_resistance_callback_receiver Callback wird nur ausgelöst, wenn sich der Widerstand seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

pub fn PtcBricklet::get_resistance_callback_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von PtcBricklet::set_resistance_callback_period gesetzt.

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

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

  • PTC_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • PTC_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • PTC_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • PTC_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • PTC_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn PtcBricklet::get_temperature_callback_threshold(&self) → ConvertingReceiver<TemperatureCallbackThreshold>

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

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

  • PTC_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • PTC_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • PTC_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • PTC_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • PTC_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn PtcBricklet::set_resistance_callback_threshold(&self, option: char, min: i32, max: i32) → ConvertingReceiver<()>

Setzt den Schwellwert für den PtcBricklet::get_resistance_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:

  • PTC_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • PTC_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • PTC_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • PTC_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • PTC_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn PtcBricklet::get_resistance_callback_threshold(&self) → ConvertingReceiver<ResistanceCallbackThreshold>

Gibt den Schwellwert zurück, wie von PtcBricklet::set_resistance_callback_threshold gesetzt.

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

  • PTC_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • PTC_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • PTC_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • PTC_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • PTC_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn PtcBricklet::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 PtcBricklet::get_debounce_period(&self) → ConvertingReceiver<u32>

Gibt die Entprellperiode zurück, wie von PtcBricklet::set_debounce_period gesetzt.

pub fn PtcBricklet::set_sensor_connected_callback_configuration(&self, enabled: bool) → ConvertingReceiver<()>

Wenn dieser Callback aktiviert ist, wird der PtcBricklet::get_sensor_connected_callback_receiver Callback jedes mal ausgelöst, wenn ein Pt-Sensor verbunden/getrennt wird.

Standardmäßig ist dieser Callback deaktiviert.

Neu in Version 2.0.2 (Plugin).

pub fn PtcBricklet::get_sensor_connected_callback_configuration(&self) → ConvertingReceiver<bool>

Gibt die Konfiguration zurück, wie von PtcBricklet::set_sensor_connected_callback_configuration gesetzt.

Neu in Version 2.0.2 (Plugin).

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 PtcBricklet::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 PtcBricklet::set_temperature_callback_period, ausgelöst. Der empfangene Variable ist die Temperatur des verbundenen Sensors.

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

pub fn PtcBricklet::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 PtcBricklet::set_temperature_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist die Temperatur des verbundenen Sensors.

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

pub fn PtcBricklet::get_resistance_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

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

Dieser Callback wird mit der Periode, wie gesetzt mit PtcBricklet::set_resistance_callback_period, ausgelöst. Der empfangene Variable ist der Widerstand des verbundenen Sensors.

Der PtcBricklet::get_resistance_callback_receiver Callback wird nur ausgelöst, wenn sich der Widerstand seit der letzten Auslösung geändert hat.

pub fn PtcBricklet::get_resistance_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von PtcBricklet::set_resistance_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist der Widerstand des verbundenen Sensors.

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

pub fn PtcBricklet::get_sensor_connected_callback_receiver(&self) → ConvertingCallbackReceiver<bool>

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels PtcBricklet::set_sensor_connected_callback_configuration gesetzten Konfiguration

Der empfangene Variable ist der gleiche wie bei PtcBricklet::is_sensor_connected.

Neu in Version 2.0.2 (Plugin).

Konstanten

PtcBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein PTC Bricklet zu identifizieren.

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

PtcBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines PTC Bricklet dar.