Rust - Ambient Light Bricklet

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

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

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

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

    // Get current illuminance.
    let illuminance = al.get_illuminance().recv()?;
    println!("Illuminance: {} lx", illuminance 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::{ambient_light_bricklet::*, ip_connection::IpConnection};

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

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

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

    let illuminance_receiver = al.get_illuminance_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `al` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for illuminance in illuminance_receiver {
            println!("Illuminance: {} lx", illuminance as f32 / 10.0);
        }
    });

    // Set period for illuminance receiver to 1s (1000ms).
    // Note: The illuminance callback is only called every second
    //       if the illuminance has changed since the last call!
    al.set_illuminance_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::{ambient_light_bricklet::*, ip_connection::IpConnection};

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

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

    let illuminance_reached_receiver = al.get_illuminance_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `al` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for illuminance_reached in illuminance_reached_receiver {
            println!("Illuminance: {} lx", illuminance_reached as f32 / 10.0);
            println!("Too bright, close the curtains!");
        }
    });

    // Configure threshold for illuminance "greater than 200 lx".
    al.set_illuminance_callback_threshold('>', 200 * 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 AmbientLightBricklet::new(uid: &str, ip_connection: &IpConnection) → AmbientLightBricklet

Erzeugt ein neues AmbientLightBricklet-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 AmbientLightBricklet::get_illuminance(&self) → ConvertingReceiver<u16>

Gibt die Beleuchtungsstärke des Umgebungslichtsensors zurück. Der Wertbereich ist von 0 bis 9000 und ist in Lux/10 angegeben, d.h. bei einem Wert von 4500 wurde eine Beleuchtungsstärke von 450Lux gemessen.

Wenn die Beleuchtungsstärke periodisch abgefragt werden soll, wird empfohlen den AmbientLightBricklet::get_illuminance_callback_receiver Callback zu nutzen und die Periode mit AmbientLightBricklet::set_illuminance_callback_period vorzugeben.

Fortgeschrittene Funktionen

pub fn AmbientLightBricklet::get_analog_value(&self) → ConvertingReceiver<u16>

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück. Der Wertebereich ist 0 bis 4095.

Bemerkung

Der von AmbientLightBricklet::get_illuminance zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während AmbientLightBricklet::get_analog_value unverarbeitete Analogwerte zurück gibt. Der einzige Grund AmbientLightBricklet::get_analog_value zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Weiterhin deckt der Analog-Digital-Wandler drei unterschiedliche Bereiche ab, welche dynamisch gewechselt werden abhängig von der Lichtintensität. Es ist nicht möglich, anhand der Analogwerte, zwischen diesen Bereichen zu unterscheiden.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den AmbientLightBricklet::get_analog_value_callback_receiver Callback zu nutzen und die Periode mit AmbientLightBricklet::set_analog_value_callback_period vorzugeben.

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

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

  • AMBIENT_LIGHT_BRICKLET_FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 3
  • AMBIENT_LIGHT_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • AMBIENT_LIGHT_BRICKLET_FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 7
  • AMBIENT_LIGHT_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • AMBIENT_LIGHT_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 11
pub fn AmbientLightBricklet::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 AmbientLightBricklet::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 AmbientLightBricklet::set_illuminance_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

Der AmbientLightBricklet::get_illuminance_callback_receiver Callback wird nur ausgelöst wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

pub fn AmbientLightBricklet::get_illuminance_callback_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von AmbientLightBricklet::set_illuminance_callback_period gesetzt.

pub fn AmbientLightBricklet::set_analog_value_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

Der AmbientLightBricklet::get_analog_value_callback_receiver Callback wird nur ausgelöst wenn sich der Analogwert seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

pub fn AmbientLightBricklet::get_analog_value_callback_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von AmbientLightBricklet::set_analog_value_callback_period gesetzt.

pub fn AmbientLightBricklet::set_illuminance_callback_threshold(&self, option: char, min: u16, max: u16) → ConvertingReceiver<()>

Setzt den Schwellwert für den AmbientLightBricklet::get_illuminance_reached_callback_receiver Callback.

Die folgenden Optionen sind möglich:

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

  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn AmbientLightBricklet::get_illuminance_callback_threshold(&self) → ConvertingReceiver<IlluminanceCallbackThreshold>

Gibt den Schwellwert zurück, wie von AmbientLightBricklet::set_illuminance_callback_threshold gesetzt.

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

  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn AmbientLightBricklet::set_analog_value_callback_threshold(&self, option: char, min: u16, max: u16) → ConvertingReceiver<()>

Setzt den Schwellwert für den AmbientLightBricklet::get_analog_value_reached_callback_receiver Callback.

Die folgenden Optionen sind möglich:

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

  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn AmbientLightBricklet::get_analog_value_callback_threshold(&self) → ConvertingReceiver<AnalogValueCallbackThreshold>

Gibt den Schwellwert zurück, wie von AmbientLightBricklet::set_analog_value_callback_threshold gesetzt.

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

  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn AmbientLightBricklet::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 AmbientLightBricklet::get_debounce_period(&self) → ConvertingReceiver<u32>

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

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

Dieser Callback wird mit der Periode, wie gesetzt mit AmbientLightBricklet::set_illuminance_callback_period, ausgelöst. Der empfangene Variable ist die Beleuchtungsstärke des Umgebungslichtsensors.

Der AmbientLightBricklet::get_illuminance_callback_receiver Callback wird nur ausgelöst wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

pub fn AmbientLightBricklet::get_analog_value_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

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

Dieser Callback wird mit der Periode, wie gesetzt mit AmbientLightBricklet::set_analog_value_callback_period, ausgelöst. Der empfangene Variable ist der Analogwert des Umgebungslichtsensors.

Der AmbientLightBricklet::get_analog_value_callback_receiver Callback wird nur ausgelöst wenn sich der Analogwert seit der letzten Auslösung geändert hat.

pub fn AmbientLightBricklet::get_illuminance_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von AmbientLightBricklet::set_illuminance_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist die Beleuchtungsstärke des Umgebungslichtsensors.

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

pub fn AmbientLightBricklet::get_analog_value_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von AmbientLightBricklet::set_analog_value_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist der Analogwert des Umgebungslichtsensors.

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

Konstanten

AmbientLightBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Ambient Light Bricklet zu identifizieren.

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

AmbientLightBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Ambient Light Bricklet dar.