Struct MotionDetectorBricklet

Source
pub struct MotionDetectorBricklet { /* private fields */ }
Expand description

Passive infrared (PIR) motion sensor with 7m range

Implementations§

Source§

impl MotionDetectorBricklet

Source

pub const DEVICE_IDENTIFIER: u16 = 233u16

Source

pub const DEVICE_DISPLAY_NAME: &'static str = "Motion Detector Bricklet"

Source

pub fn new(uid: Uid, connection: AsyncIpConnection) -> 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 sent 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 sent 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_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.

Source

pub async fn get_motion_detected_callback_receiver( &mut self, ) -> impl Stream<Item = ()>

This receiver is called after a motion was detected.

Source

pub async fn get_detection_cycle_ended_callback_receiver( &mut self, ) -> impl Stream<Item = ()>

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 async fn get_motion_detected(&mut self) -> Result<u8, TinkerforgeError>

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:

  • MOTION_DETECTOR_BRICKLET_MOTION_NOT_DETECTED
  • MOTION_DETECTOR_BRICKLET_MOTION_DETECTED
Source

pub async fn set_status_led_config( &mut self, config: u8, ) -> Result<(), TinkerforgeError>

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.

.. versionadded:: 2.0.1$nbsp;(Plugin)

Associated constants:

  • MOTION_DETECTOR_BRICKLET_STATUS_LED_CONFIG_OFF
  • MOTION_DETECTOR_BRICKLET_STATUS_LED_CONFIG_ON
  • MOTION_DETECTOR_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
Source

pub async fn get_status_led_config(&mut self) -> Result<u8, TinkerforgeError>

Returns the configuration as set by [set_status_led_config].

.. versionadded:: 2.0.1$nbsp;(Plugin)

Associated constants:

  • MOTION_DETECTOR_BRICKLET_STATUS_LED_CONFIG_OFF
  • MOTION_DETECTOR_BRICKLET_STATUS_LED_CONFIG_ON
  • MOTION_DETECTOR_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
Source

pub async fn get_identity(&mut self) -> Result<Identity, TinkerforgeError>

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’, ‘d’, ‘e’, ‘f’, ‘g’ or ‘h’ (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position ‘z’.

The device identifier numbers can be found here. |device_identifier_constant|

Trait Implementations§

Source§

impl Clone for MotionDetectorBricklet

Source§

fn clone(&self) -> MotionDetectorBricklet

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.