Rust - Ambient Light Bricklet 2.0

Dies ist die Beschreibung der Rust API Bindings für das Ambient Light Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Ambient Light Bricklet 2.0 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_v2_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 2.0.

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

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let al = AmbientLightV2Bricklet::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 / 100.0);
            println!("Too bright, close the curtains!");
        }
    });

    // Configure threshold for illuminance "greater than 500 lx".
    al.set_illuminance_callback_threshold('>', 500 * 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 AmbientLightV2Bricklet::new(uid: &str, ip_connection: &IpConnection) → AmbientLightV2Bricklet
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • ambient_light_v2 – Typ: AmbientLightV2Bricklet

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

let ambient_light_v2 = AmbientLightV2Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn AmbientLightV2Bricklet::get_illuminance(&self) → ConvertingReceiver<u32>
Rückgabe:
  • illuminance – Typ: u32, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1]

Gibt die Beleuchtungsstärke des Umgebungslichtsensors zurück. Der Messbereich erstreckt sich bis über 100000Lux, aber ab 64000Lux nimmt die Messgenauigkeit ab.

Geändert in Version 2.0.2 (Plugin): Eine Beleuchtungsstärke von 0Lux bedeutet, dass der Sensor gesättigt (saturated) ist und die Konfiguration angepasst werden sollte, siehe AmbientLightV2Bricklet::set_configuration.

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

Fortgeschrittene Funktionen

pub fn AmbientLightV2Bricklet::set_configuration(&self, illuminance_range: u8, integration_time: u8) → ConvertingReceiver<()>
Parameter:
  • illuminance_range – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • integration_time – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration. Es ist möglich den Helligkeitswertebereich zwischen 0-600Lux und 0-64000Lux sowie eine Integrationszeit zwischen 50ms und 400ms zu konfigurieren.

Neu in Version 2.0.2 (Plugin): Der unbeschränkt (unlimited) Helligkeitswertebereich ermöglicht es bis über 100000Lux zu messen, aber ab 64000Lux nimmt die Messgenauigkeit ab.

Ein kleinerer Helligkeitswertebereich erhöht die Auflösung der Daten. Eine längere Integrationszeit verringert das Rauschen auf den Daten.

Geändert in Version 2.0.2 (Plugin): Wenn der eigentliche Messwert außerhalb des eingestellten Helligkeitswertebereichs liegt, dann geben AmbientLightV2Bricklet::get_illuminance und der AmbientLightV2Bricklet::get_illuminance_callback_receiver Callback das Maximum des eingestellten Helligkeitswertebereichs +0,01Lux zurück. Also z.B. 800001 für den 0-8000Lux Bereich.

Geändert in Version 2.0.2 (Plugin): Bei einer langen Integrationszeit kann es sein, dass der Sensor gesättigt (saturated) ist bevor der Messwert das Maximum des ausgewählten Helligkeitswertebereichs erreicht hat. In diesem Fall geben AmbientLightV2Bricklet::get_illuminance und der AmbientLightV2Bricklet::get_illuminance_callback_receiver Callback 0Lux zurück.

Wenn der Messwert außerhalb des eingestellten Helligkeitswertebereichs liegt oder der Sensor gesättigt ist, dann sollte der nächst höhere Helligkeitswertebereich eingestellt werden. Wenn der höchste Helligkeitswertebereich schon erreicht ist, dann kann noch die Integrationszeit verringert werden.

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

Für illuminance_range:

  • AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_UNLIMITED = 6
  • AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_64000LUX = 0
  • AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_32000LUX = 1
  • AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_16000LUX = 2
  • AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_8000LUX = 3
  • AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_1300LUX = 4
  • AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_600LUX = 5

Für integration_time:

  • AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_50MS = 0
  • AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_100MS = 1
  • AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_150MS = 2
  • AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_200MS = 3
  • AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_250MS = 4
  • AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_300MS = 5
  • AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_350MS = 6
  • AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_400MS = 7
pub fn AmbientLightV2Bricklet::get_configuration(&self) → ConvertingReceiver<Configuration>
Rückgabeobjekt:
  • illuminance_range – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • integration_time – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für illuminance_range:

  • AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_UNLIMITED = 6
  • AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_64000LUX = 0
  • AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_32000LUX = 1
  • AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_16000LUX = 2
  • AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_8000LUX = 3
  • AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_1300LUX = 4
  • AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_600LUX = 5

Für integration_time:

  • AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_50MS = 0
  • AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_100MS = 1
  • AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_150MS = 2
  • AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_200MS = 3
  • AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_250MS = 4
  • AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_300MS = 5
  • AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_350MS = 6
  • AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_400MS = 7
pub fn AmbientLightV2Bricklet::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', 'i', '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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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 AmbientLightV2Bricklet::set_illuminance_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 AmbientLightV2Bricklet::get_illuminance_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

pub fn AmbientLightV2Bricklet::get_illuminance_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 AmbientLightV2Bricklet::set_illuminance_callback_period gesetzt.

pub fn AmbientLightV2Bricklet::set_illuminance_callback_threshold(&self, option: char, min: u32, max: u32) → ConvertingReceiver<()>
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: u32, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • max – Typ: u32, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

Für option:

  • AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn AmbientLightV2Bricklet::get_illuminance_callback_threshold(&self) → ConvertingReceiver<IlluminanceCallbackThreshold>
Rückgabeobjekt:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: u32, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • max – Typ: u32, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

Für option:

  • AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn AmbientLightV2Bricklet::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 Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

pub fn AmbientLightV2Bricklet::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 AmbientLightV2Bricklet::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 AmbientLightV2Bricklet::get_illuminance_callback_receiver(&self) → ConvertingCallbackReceiver<u32>
Event:
  • illuminance – Typ: u32, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1]

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

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

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

pub fn AmbientLightV2Bricklet::get_illuminance_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u32>
Event:
  • illuminance – Typ: u32, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1]

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von AmbientLightV2Bricklet::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 AmbientLightV2Bricklet::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 AmbientLightV2Bricklet::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 AmbientLightV2Bricklet::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 AmbientLightV2Bricklet::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:

  • AMBIENT_LIGHT_V2_BRICKLET_FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 2
  • AMBIENT_LIGHT_V2_BRICKLET_FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 4
  • AMBIENT_LIGHT_V2_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • AMBIENT_LIGHT_V2_BRICKLET_FUNCTION_SET_CONFIGURATION = 8
pub fn AmbientLightV2Bricklet::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:

  • AMBIENT_LIGHT_V2_BRICKLET_FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 2
  • AMBIENT_LIGHT_V2_BRICKLET_FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 4
  • AMBIENT_LIGHT_V2_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • AMBIENT_LIGHT_V2_BRICKLET_FUNCTION_SET_CONFIGURATION = 8
pub fn AmbientLightV2Bricklet::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 AmbientLightV2Bricklet::DEVICE_IDENTIFIER

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

Die AmbientLightV2Bricklet::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 AmbientLightV2Bricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Ambient Light Bricklet 2.0 dar.