Rust - Motion Detector Bricklet

This is the description of the Rust API bindings for the Motion Detector Bricklet. General information and technical specifications for the Motion Detector Bricklet are summarized in its hardware description.

An installation guide for the Rust API bindings is part of their general description. Additional documentation can be found on docs.rs.

Examples

The example code below is Public Domain (CC0 1.0).

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(())
}

API

To allow non-blocking usage, nearly every function of the Rust bindings returns a wrapper around a mpsc::Receiver. To block until the function has finished and get your result, call one of the receiver's recv variants. Those return either the result sent by the device, or any error occured.

Functions returning a result directly will block until the device has finished processing the request.

All functions listed below are thread-safe, those which return a receiver are lock-free.

Basic Functions

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

Creates a new MotionDetectorBricklet object with the unique device ID uid and adds it to the IPConnection ipcon:

This device object can be used after the IP connection has been connected (see examples above).

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

Returns 1 if a motion was detected. How long this returns 1 after a motion was detected can be adjusted with one of the small potentiometers on the Motion Detector Bricklet, see here.

There is also a blue LED on the Bricklet that is on as long as the Bricklet is in the "motion detected" state.

The following constants are available for this function:

  • MOTION_DETECTOR_BRICKLET_MOTION_NOT_DETECTED = 0
  • MOTION_DETECTOR_BRICKLET_MOTION_DETECTED = 1

Advanced Functions

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

Sets the status led configuration.

By default the status LED turns on if a motion is detected and off is no motion is detected.

You can also turn the LED permanently on/off.

The following constants are available for this function:

  • 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

New in version 2.0.1 (Plugin).

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

Returns the configuration as set by MotionDetectorBricklet::set_status_led_config.

The following constants are available for this function:

  • 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

New in version 2.0.1 (Plugin).

pub fn MotionDetectorBricklet::get_api_version(&self) → [u8; 3]

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

pub fn MotionDetectorBricklet::get_response_expected(&mut self, function_id: u8) → bool

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by MotionDetectorBricklet::set_response_expected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

  • MOTION_DETECTOR_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 4
pub fn MotionDetectorBricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

  • MOTION_DETECTOR_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 4
pub fn MotionDetectorBricklet::set_response_expected_all(&mut self, response_expected: bool) → ()

Changes the response expected flag for all setter and callback configuration functions of this device at once.

pub fn MotionDetectorBricklet::get_identity(&self) → ConvertingReceiver<Identity>

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding get_*_callback_receiver function, which returns a receiver for callback events.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

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

Receivers created with this function receive Motion Detected events.

This callback is called after a motion was detected.
pub fn MotionDetectorBricklet::get_detection_cycle_ended_callback_receiver(&self) → ConvertingCallbackReceiver<()>

Receivers created with this function receive Detection Cycle Ended events.

This callback is called when the detection cycle ended. When this callback is called, a new motion can be detected again after approximately 2 seconds.

Constants

MotionDetectorBricklet::DEVICE_IDENTIFIER

This constant is used to identify a Motion Detector Bricklet.

The MotionDetectorBricklet::get_identity function and the IpConnection::get_enumerate_callback_receiver callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

MotionDetectorBricklet::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Motion Detector Bricklet.