Struct tinkerforge::motion_detector_bricklet::MotionDetectorBricklet

source ·

pub struct MotionDetectorBricklet { /* private fields */ }

Expand description

Passive infrared (PIR) motion sensor, 7m range

Implementations

source

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

Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.

source

pub fn get_response_expected(
&mut self,
fun: MotionDetectorBrickletFunction
) -> Result<bool, GetResponseExpectedError>

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 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.

See set_response_expected for the list of function ID constants available for this function.

source

pub fn set_response_expected(
 &mut self,
 fun: MotionDetectorBrickletFunction,
 response_expected: bool
) -> Result<(), SetResponseExpectedError>

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.

source

pub fn 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.

source

pub fn get_motion_detected_callback_receiver(
&self
) -> ConvertingCallbackReceiver<()>

This receiver is called after a motion was detected.

source

pub fn get_detection_cycle_ended_callback_receiver(
&self
) -> ConvertingCallbackReceiver<()>

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

source

pub fn 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 <motion_detector_bricklet_sensitivity_delay_block_time>.

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

Associated constants: