Rust - Ambient Light Bricklet 3.0

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let al = AmbientLightV3Bricklet::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
use std::{error::Error, io, thread};
use tinkerforge::{ambient_light_v3_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 3.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let al = AmbientLightV3Bricklet::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 callback to 1s (1000ms) without a threshold.
    al.set_illuminance_callback_configuration(1000, false, 'x', 0, 0);

    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
use std::{error::Error, io, thread};
use tinkerforge::{ambient_light_v3_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 3.0.

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

    // Configure threshold for illuminance "greater than 500 lx"
    // with a debounce period of 1s (1000ms).
    al.set_illuminance_callback_configuration(1000, false, '>', 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 AmbientLightV3Bricklet::new(uid: &str, ip_connection: &IpConnection) → AmbientLightV3Bricklet
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • ambient_light_v3 – Typ: AmbientLightV3Bricklet

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

let ambient_light_v3 = AmbientLightV3Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden wurde (siehe Beispiele oben).

pub fn AmbientLightV3Bricklet::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. Die Beleuchtungsstärke ist in Lux/100 angegeben, d.h. bei einem Wert von 450000 wurde eine Beleuchtungsstärke von 4500Lux gemessen.

Eine Beleuchtungsstärke von 0Lux bedeutet, dass der Sensor gesättigt (saturated) ist und die Konfiguration angepasst werden sollte, siehe AmbientLightV3Bricklet::set_configuration.

Wenn der Wert periodisch benötigt wird, kann auch der AmbientLightV3Bricklet::get_illuminance_callback_receiver Callback verwendet werden. Der Callback wird mit der Funktion AmbientLightV3Bricklet::set_illuminance_callback_configuration konfiguriert.

pub fn AmbientLightV3Bricklet::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: 2

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

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.

Wenn der eigentliche Messwert außerhalb des eingestellten Helligkeitswertebereichs liegt, dann geben AmbientLightV3Bricklet::get_illuminance und der AmbientLightV3Bricklet::get_illuminance_callback_receiver Callback das Maximum des eingestellten Helligkeitswertebereichs +0,01Lux zurück. Also z.B. 800001 für den 0-8000Lux Bereich.

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 AmbientLightV3Bricklet::get_illuminance und der AmbientLightV3Bricklet::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_V3_BRICKLET_ILLUMINANCE_RANGE_UNLIMITED = 6
  • AMBIENT_LIGHT_V3_BRICKLET_ILLUMINANCE_RANGE_64000LUX = 0
  • AMBIENT_LIGHT_V3_BRICKLET_ILLUMINANCE_RANGE_32000LUX = 1
  • AMBIENT_LIGHT_V3_BRICKLET_ILLUMINANCE_RANGE_16000LUX = 2
  • AMBIENT_LIGHT_V3_BRICKLET_ILLUMINANCE_RANGE_8000LUX = 3
  • AMBIENT_LIGHT_V3_BRICKLET_ILLUMINANCE_RANGE_1300LUX = 4
  • AMBIENT_LIGHT_V3_BRICKLET_ILLUMINANCE_RANGE_600LUX = 5

Für integration_time:

  • AMBIENT_LIGHT_V3_BRICKLET_INTEGRATION_TIME_50MS = 0
  • AMBIENT_LIGHT_V3_BRICKLET_INTEGRATION_TIME_100MS = 1
  • AMBIENT_LIGHT_V3_BRICKLET_INTEGRATION_TIME_150MS = 2
  • AMBIENT_LIGHT_V3_BRICKLET_INTEGRATION_TIME_200MS = 3
  • AMBIENT_LIGHT_V3_BRICKLET_INTEGRATION_TIME_250MS = 4
  • AMBIENT_LIGHT_V3_BRICKLET_INTEGRATION_TIME_300MS = 5
  • AMBIENT_LIGHT_V3_BRICKLET_INTEGRATION_TIME_350MS = 6
  • AMBIENT_LIGHT_V3_BRICKLET_INTEGRATION_TIME_400MS = 7
pub fn AmbientLightV3Bricklet::get_configuration(&self) → ConvertingReceiver<Configuration>
Rückgabeobjekt:
  • illuminance_range – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • integration_time – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 2

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

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

Für illuminance_range:

  • AMBIENT_LIGHT_V3_BRICKLET_ILLUMINANCE_RANGE_UNLIMITED = 6
  • AMBIENT_LIGHT_V3_BRICKLET_ILLUMINANCE_RANGE_64000LUX = 0
  • AMBIENT_LIGHT_V3_BRICKLET_ILLUMINANCE_RANGE_32000LUX = 1
  • AMBIENT_LIGHT_V3_BRICKLET_ILLUMINANCE_RANGE_16000LUX = 2
  • AMBIENT_LIGHT_V3_BRICKLET_ILLUMINANCE_RANGE_8000LUX = 3
  • AMBIENT_LIGHT_V3_BRICKLET_ILLUMINANCE_RANGE_1300LUX = 4
  • AMBIENT_LIGHT_V3_BRICKLET_ILLUMINANCE_RANGE_600LUX = 5

Für integration_time:

  • AMBIENT_LIGHT_V3_BRICKLET_INTEGRATION_TIME_50MS = 0
  • AMBIENT_LIGHT_V3_BRICKLET_INTEGRATION_TIME_100MS = 1
  • AMBIENT_LIGHT_V3_BRICKLET_INTEGRATION_TIME_150MS = 2
  • AMBIENT_LIGHT_V3_BRICKLET_INTEGRATION_TIME_200MS = 3
  • AMBIENT_LIGHT_V3_BRICKLET_INTEGRATION_TIME_250MS = 4
  • AMBIENT_LIGHT_V3_BRICKLET_INTEGRATION_TIME_300MS = 5
  • AMBIENT_LIGHT_V3_BRICKLET_INTEGRATION_TIME_350MS = 6
  • AMBIENT_LIGHT_V3_BRICKLET_INTEGRATION_TIME_400MS = 7

Fortgeschrittene Funktionen

pub fn AmbientLightV3Bricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>
Rückgabeobjekt:
  • error_count_ack_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: u32, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

pub fn AmbientLightV3Bricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>
Parameter:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: u8, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

  • AMBIENT_LIGHT_V3_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • AMBIENT_LIGHT_V3_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • AMBIENT_LIGHT_V3_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • AMBIENT_LIGHT_V3_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • AMBIENT_LIGHT_V3_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • AMBIENT_LIGHT_V3_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • AMBIENT_LIGHT_V3_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • AMBIENT_LIGHT_V3_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • AMBIENT_LIGHT_V3_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • AMBIENT_LIGHT_V3_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • AMBIENT_LIGHT_V3_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn AmbientLightV3Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>
Rückgabe:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe AmbientLightV3Bricklet::set_bootloader_mode.

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

Für mode:

  • AMBIENT_LIGHT_V3_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • AMBIENT_LIGHT_V3_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • AMBIENT_LIGHT_V3_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • AMBIENT_LIGHT_V3_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • AMBIENT_LIGHT_V3_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn AmbientLightV3Bricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>
Parameter:
  • pointer – Typ: u32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für AmbientLightV3Bricklet::write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

pub fn AmbientLightV3Bricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>
Parameter:
  • data – Typ: [u8; 64], Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: u8, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von AmbientLightV3Bricklet::set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

pub fn AmbientLightV3Bricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>
Parameter:
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

  • AMBIENT_LIGHT_V3_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • AMBIENT_LIGHT_V3_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • AMBIENT_LIGHT_V3_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • AMBIENT_LIGHT_V3_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn AmbientLightV3Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>
Rückgabe:
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von AmbientLightV3Bricklet::set_status_led_config gesetzt.

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

Für config:

  • AMBIENT_LIGHT_V3_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • AMBIENT_LIGHT_V3_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • AMBIENT_LIGHT_V3_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • AMBIENT_LIGHT_V3_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn AmbientLightV3Bricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>
Rückgabe:
  • temperature – Typ: i16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

pub fn AmbientLightV3Bricklet::reset(&self) → ConvertingReceiver<()>

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

pub fn AmbientLightV3Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>
Parameter:
  • uid – Typ: u32, Wertebereich: [0 bis 232 - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

pub fn AmbientLightV3Bricklet::read_uid(&self) → ConvertingReceiver<u32>
Rückgabe:
  • uid – Typ: u32, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

pub fn AmbientLightV3Bricklet::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 AmbientLightV3Bricklet::set_illuminance_callback_configuration(&self, period: u32, value_has_to_change: bool, option: char, min: u32, max: u32) → ConvertingReceiver<()>
Parameter:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • 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

Die Periode ist die Periode mit der der AmbientLightV3Bricklet::get_illuminance_callback_receiver Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den AmbientLightV3Bricklet::get_illuminance_callback_receiver Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • AMBIENT_LIGHT_V3_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • AMBIENT_LIGHT_V3_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AMBIENT_LIGHT_V3_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • AMBIENT_LIGHT_V3_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • AMBIENT_LIGHT_V3_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn AmbientLightV3Bricklet::get_illuminance_callback_configuration(&self) → ConvertingReceiver<IlluminanceCallbackConfiguration>
Rückgabeobjekt:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • 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 die Callback-Konfiguration zurück, wie mittels AmbientLightV3Bricklet::set_illuminance_callback_configuration gesetzt.

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

Für option:

  • AMBIENT_LIGHT_V3_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • AMBIENT_LIGHT_V3_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AMBIENT_LIGHT_V3_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • AMBIENT_LIGHT_V3_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • AMBIENT_LIGHT_V3_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

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 AmbientLightV3Bricklet::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 periodisch ausgelöst abhängig von der mittels AmbientLightV3Bricklet::set_illuminance_callback_configuration gesetzten Konfiguration

Der empfangene Variable ist der gleiche wie AmbientLightV3Bricklet::get_illuminance.

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 AmbientLightV3Bricklet::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 AmbientLightV3Bricklet::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 AmbientLightV3Bricklet::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_V3_BRICKLET_FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION = 2
  • AMBIENT_LIGHT_V3_BRICKLET_FUNCTION_SET_CONFIGURATION = 5
  • AMBIENT_LIGHT_V3_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • AMBIENT_LIGHT_V3_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • AMBIENT_LIGHT_V3_BRICKLET_FUNCTION_RESET = 243
  • AMBIENT_LIGHT_V3_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn AmbientLightV3Bricklet::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_V3_BRICKLET_FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION = 2
  • AMBIENT_LIGHT_V3_BRICKLET_FUNCTION_SET_CONFIGURATION = 5
  • AMBIENT_LIGHT_V3_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • AMBIENT_LIGHT_V3_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • AMBIENT_LIGHT_V3_BRICKLET_FUNCTION_RESET = 243
  • AMBIENT_LIGHT_V3_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn AmbientLightV3Bricklet::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 AmbientLightV3Bricklet::DEVICE_IDENTIFIER

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

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

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