Rust - Color Bricklet

Dies ist die Beschreibung der Rust API Bindings für das Color Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Color 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
26
27
28
29
use std::{error::Error, io};

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

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

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

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

    // Get current color.
    let color = c.get_color().recv()?;

    println!("Color [R]: {}", color.r);
    println!("Color [G]: {}", color.g);
    println!("Color [B]: {}", color.b);
    println!("Color [C]: {}", color.c);

    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
37
38
39
40
use std::{error::Error, io, thread};
use tinkerforge::{color_bricklet::*, ip_connection::IpConnection};

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

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

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

    let color_receiver = c.get_color_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `c` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for color in color_receiver {
            println!("Color [R]: {}", color.r);
            println!("Color [G]: {}", color.g);
            println!("Color [B]: {}", color.b);
            println!("Color [C]: {}", color.c);
            println!();
        }
    });

    // Set period for color receiver to 1s (1000ms).
    // Note: The color callback is only called every second
    //       if the color has changed since the last call!
    c.set_color_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
39
40
41
use std::{error::Error, io, thread};
use tinkerforge::{color_bricklet::*, ip_connection::IpConnection};

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

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

    let color_reached_receiver = c.get_color_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `c` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for color_reached in color_reached_receiver {
            println!("Color [R]: {}", color_reached.r);
            println!("Color [G]: {}", color_reached.g);
            println!("Color [B]: {}", color_reached.b);
            println!("Color [C]: {}", color_reached.c);
            println!();
        }
    });

    // Configure threshold for color "greater than 100, 200, 300, 400".
    c.set_color_callback_threshold('>', 100, 0, 200, 0, 300, 0, 400, 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 ColorBricklet::new(uid: &str, ip_connection: &IpConnection) → ColorBricklet

Erzeugt ein neues ColorBricklet-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 ColorBricklet::get_color(&self) → ConvertingReceiver<Color>

Gibt die gemessene Farbe des Sensors zurück. Der Wertebereich ist von 0 bis 65535.

Die rot (r), grün (g), blau (b) und clear (c) werden mit vier unterschiedlichen Fotodioden gemessen. Diese sind Empfindlich in unterschiedlichen Wellenlängen:

Chart Responsivity / Wavelength

Wenn die Farbe periodisch abgefragt werden soll, wird empfohlen den ColorBricklet::get_color_callback_receiver Callback zu nutzen und die Periode mit ColorBricklet::set_color_callback_period vorzugeben.

pub fn ColorBricklet::light_on(&self) → ConvertingReceiver<()>

Aktiviert die LED.

pub fn ColorBricklet::light_off(&self) → ConvertingReceiver<()>

Deaktiviert die LED.

pub fn ColorBricklet::is_light_on(&self) → ConvertingReceiver<u8>

Gibt den Zustand der LED zurück. Mögliche Werte sind:

  • 0: On
  • 1: Off

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

  • COLOR_BRICKLET_LIGHT_ON = 0
  • COLOR_BRICKLET_LIGHT_OFF = 1
pub fn ColorBricklet::set_config(&self, gain: u8, integration_time: u8) → ConvertingReceiver<()>

Setzt die Konfiguration des Sensors. Verstärkung und Integrationszeit können eingestellt werden.

Für die Konfiguration der Verstärkung:

  • 0: 1x Gain
  • 1: 4x Gain
  • 2: 16x Gain
  • 3: 60x Gain

Für die Konfiguration der Integrationszeit:

  • 0: 2,4ms
  • 1: 24ms
  • 2: 101ms
  • 3: 154ms
  • 4: 700ms

Eine Erhöhung der Verstärkung ermöglicht es dem Sensor Farben aus größeren Entfernungen zu erkennen.

Die Integrationszeit ist ein Trade-off zwischen Konvertierungszeit und Genauigkeit. Mit einer höheren Integrationszeit werden die Werte genauer, es dauert allerdings länger bis ein Resultat bereitsteht.

Die Standardwerte sind 60x Verstärkung und 154ms Integrationszeit.

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

  • COLOR_BRICKLET_GAIN_1X = 0
  • COLOR_BRICKLET_GAIN_4X = 1
  • COLOR_BRICKLET_GAIN_16X = 2
  • COLOR_BRICKLET_GAIN_60X = 3
  • COLOR_BRICKLET_INTEGRATION_TIME_2MS = 0
  • COLOR_BRICKLET_INTEGRATION_TIME_24MS = 1
  • COLOR_BRICKLET_INTEGRATION_TIME_101MS = 2
  • COLOR_BRICKLET_INTEGRATION_TIME_154MS = 3
  • COLOR_BRICKLET_INTEGRATION_TIME_700MS = 4
pub fn ColorBricklet::get_config(&self) → ConvertingReceiver<Config>

Gibt die Einstellungen zurück, wie von ColorBricklet::set_config gesetzt.

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

  • COLOR_BRICKLET_GAIN_1X = 0
  • COLOR_BRICKLET_GAIN_4X = 1
  • COLOR_BRICKLET_GAIN_16X = 2
  • COLOR_BRICKLET_GAIN_60X = 3
  • COLOR_BRICKLET_INTEGRATION_TIME_2MS = 0
  • COLOR_BRICKLET_INTEGRATION_TIME_24MS = 1
  • COLOR_BRICKLET_INTEGRATION_TIME_101MS = 2
  • COLOR_BRICKLET_INTEGRATION_TIME_154MS = 3
  • COLOR_BRICKLET_INTEGRATION_TIME_700MS = 4
pub fn ColorBricklet::get_illuminance(&self) → ConvertingReceiver<u32>

Gibt die Beleuchtungsstärke beeinflusst durch die Verstärkung und die Integrationszeit zurück. Verstärkung und Integrationszeit können mit ColorBricklet::set_config eingestellt werden. Um die Beleuchtungsstärke in Lux zu ermitteln muss folgende Formel angewendet werden:

lux = illuminance * 700 / gain / integration_time

Für eine korrekte Messung der Beleuchtungsstärke muss sichergestellt sein, dass die Farbwerte (R, G oder B) nicht saturiert sind. Ein Farbwert ist saturiert wenn der Wert 65535 beträgt. In diesem Fall kann die Verstärkung per ColorBricklet::set_config reduziert werden.

pub fn ColorBricklet::get_color_temperature(&self) → ConvertingReceiver<u16>

Gibt die Farbtemperatur in Kelvin zurück.

Für eine korrekte Messung der Farbtemperatur muss sichergestellt sein das die Farbwerte (R, G oder B) nicht saturiert sind. Ein Farbwert ist saturiert wenn der Wert 65535 beträgt. In diesem Fall kann die Verstärkung per ColorBricklet::set_config reduziert werden.

Fortgeschrittene Funktionen

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

  • COLOR_BRICKLET_FUNCTION_SET_COLOR_CALLBACK_PERIOD = 2
  • COLOR_BRICKLET_FUNCTION_SET_COLOR_CALLBACK_THRESHOLD = 4
  • COLOR_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • COLOR_BRICKLET_FUNCTION_LIGHT_ON = 10
  • COLOR_BRICKLET_FUNCTION_LIGHT_OFF = 11
  • COLOR_BRICKLET_FUNCTION_SET_CONFIG = 13
  • COLOR_BRICKLET_FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 17
  • COLOR_BRICKLET_FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_PERIOD = 19
pub fn ColorBricklet::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 Konstanten sind für diese Funktion verfügbar:

  • COLOR_BRICKLET_FUNCTION_SET_COLOR_CALLBACK_PERIOD = 2
  • COLOR_BRICKLET_FUNCTION_SET_COLOR_CALLBACK_THRESHOLD = 4
  • COLOR_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • COLOR_BRICKLET_FUNCTION_LIGHT_ON = 10
  • COLOR_BRICKLET_FUNCTION_LIGHT_OFF = 11
  • COLOR_BRICKLET_FUNCTION_SET_CONFIG = 13
  • COLOR_BRICKLET_FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 17
  • COLOR_BRICKLET_FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_PERIOD = 19
pub fn ColorBricklet::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 ColorBricklet::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 ColorBricklet::set_color_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

Der ColorBricklet::get_color_callback_receiver Callback wird nur ausgelöst, wenn sich die Color seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

pub fn ColorBricklet::get_color_callback_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von ColorBricklet::set_color_callback_period gesetzt.

pub fn ColorBricklet::set_color_callback_threshold(&self, option: char, min_r: u16, max_r: u16, min_g: u16, max_g: u16, min_b: u16, max_b: u16, min_c: u16, max_c: u16) → ConvertingReceiver<()>

Setzt den Schwellwert für den ColorBricklet::get_color_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, 0, 0, 0, 0, 0, 0).

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

  • COLOR_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • COLOR_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • COLOR_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • COLOR_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • COLOR_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn ColorBricklet::get_color_callback_threshold(&self) → ConvertingReceiver<ColorCallbackThreshold>

Gibt den Schwellwert zurück, wie von ColorBricklet::set_color_callback_threshold gesetzt.

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

  • COLOR_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • COLOR_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • COLOR_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • COLOR_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • COLOR_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn ColorBricklet::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 ColorBricklet::get_debounce_period(&self) → ConvertingReceiver<u32>

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

pub fn ColorBricklet::set_illuminance_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

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

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

pub fn ColorBricklet::set_color_temperature_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

Der ColorBricklet::get_color_temperature_callback_receiver Callback wird nur ausgelöst, wenn sich die Farbtemperatur seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

pub fn ColorBricklet::get_color_temperature_callback_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von ColorBricklet::set_color_temperature_callback_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 ColorBricklet::get_color_callback_receiver(&self) → ConvertingCallbackReceiver<ColorEvent>

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

Dieser Callback wird mit der Periode, wie gesetzt mit ColorBricklet::set_color_callback_period, ausgelöst. Der empfangene Variable ist die Farbe des Sensors als RGBC.

Der ColorBricklet::get_color_callback_receiver Callback wird nur ausgelöst, wenn sich die Farbe seit der letzten Auslösung geändert hat.

pub fn ColorBricklet::get_color_reached_callback_receiver(&self) → ConvertingCallbackReceiver<ColorReachedEvent>

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von ColorBricklet::set_color_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist die Farbe des Sensors als RGBC.

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

pub fn ColorBricklet::get_illuminance_callback_receiver(&self) → ConvertingCallbackReceiver<u32>

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

Dieser Callback wird mit der Periode, wie gesetzt mit ColorBricklet::set_illuminance_callback_period, ausgelöst. Der empfangene Variable ist die Beleuchtungsstärke des Sensors. Siehe ColorBricklet::get_illuminance für eine Erklärung wie dieser zu interpretieren ist.

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

pub fn ColorBricklet::get_color_temperature_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

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

Dieser Callback wird mit der Periode, wie gesetzt mit ColorBricklet::set_color_temperature_callback_period, ausgelöst. Der empfangene Variable ist die Farbtemperatur des Sensors in Kelvin.

Der ColorBricklet::get_color_temperature_callback_receiver Callback wird nur ausgelöst, wenn sich die Farbtemperatur seit der letzten Auslösung geändert hat.

Konstanten

ColorBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Color Bricklet zu identifizieren.

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

ColorBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Color Bricklet dar.