Rust - Motion Detector Bricklet¶

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
41
42

use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, motion_detector_bricklet::*};

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

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

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

    let motion_detected_receiver = md.get_motion_detected_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `md` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for _motion_detected in motion_detected_receiver {
            println!("Motion Detected");
        }
    });

    let detection_cycle_ended_receiver = md.get_detection_cycle_ended_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `md` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for _detection_cycle_ended in detection_cycle_ended_receiver {
            println!("Detection Cycle Ended (next detection possible in ~3 seconds)");
        }
    });

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Grundfunktionen¶

pub fn MotionDetectorBricklet::new(uid: &str, ip_connection: &IpConnection) → MotionDetectorBricklet¶

Parameter:	uid – Typ: &str ip_connection – Typ: &IPConnection
Rückgabe:	motion_detector – Typ: MotionDetectorBricklet

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

let motion_detector = MotionDetectorBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn MotionDetectorBricklet::get_motion_detected(&self) → ConvertingReceiver<u8>¶

Rückgabe:	motion – Typ: u8, Wertebereich: Siehe Konstanten

Gibt 1 zurück wenn eine Bewegung detektiert wurde. Wie lange 1 zurückgegeben wird nachdem eine Bewegung detektiert wurde kann mit einem kleinen Poti auf dem Motion Detector Bricklet eingestellt werden, siehe hier.

Auf dem Bricklet selbst ist eine blaue LED, die leuchtet solange das Bricklet im "Bewegung detektiert" Zustand ist.

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

Für motion:

• MOTION_DETECTOR_BRICKLET_MOTION_NOT_DETECTED = 0
• MOTION_DETECTOR_BRICKLET_MOTION_DETECTED = 1

Fortgeschrittene Funktionen¶

pub fn MotionDetectorBricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>¶

Parameter:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 2

Setzt die Konfiguration der Status-LED.

Standardmäßig geht die LED an, wenn eine Bewegung erkannt wird und aus wenn keine Bewegung erkannt wird.

Die LED kann auch permanent an/aus gestellt werden.

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

Für config:

• MOTION_DETECTOR_BRICKLET_STATUS_LED_CONFIG_OFF = 0
• MOTION_DETECTOR_BRICKLET_STATUS_LED_CONFIG_ON = 1
• MOTION_DETECTOR_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 2

Neu in Version 2.0.1 (Plugin).

pub fn MotionDetectorBricklet::get_status_led_config(&self) → ConvertingReceiver<u8>¶

Rückgabe:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 2

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

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

Für config:

• MOTION_DETECTOR_BRICKLET_STATUS_LED_CONFIG_OFF = 0
• MOTION_DETECTOR_BRICKLET_STATUS_LED_CONFIG_ON = 1
• MOTION_DETECTOR_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 2

Neu in Version 2.0.1 (Plugin).

pub fn MotionDetectorBricklet::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', '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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein 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.

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.

pub fn MotionDetectorBricklet::get_motion_detected_callback_receiver(&self) → ConvertingCallbackReceiver<()>¶

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

Dieser Callback wird aufgerufen nachdem eine Bewegung detektiert wurde.

pub fn MotionDetectorBricklet::get_detection_cycle_ended_callback_receiver(&self) → ConvertingCallbackReceiver<()>¶

Receiver die mit dieser Funktion erstellt werden, empfangen Detection Cycle Ended-Events.

Dieser Callback wird aufgerufen wenn ein Bewegungserkennungszyklus beendet ist. Wenn dieser Callback aufgerufen wurde kann wieder eine weitere Bewegung erkannt werden nach ungefähr 2 Sekunden.

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 MotionDetectorBricklet::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 MotionDetectorBricklet::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 MotionDetectorBricklet::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:

• MOTION_DETECTOR_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 4

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

• MOTION_DETECTOR_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 4

pub fn MotionDetectorBricklet::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 MotionDetectorBricklet::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Motion Detector Bricklet zu identifizieren.

Die MotionDetectorBricklet::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 MotionDetectorBricklet::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Motion Detector Bricklet dar.