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 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
/* ***********************************************************
* This file was automatically generated on 2018-11-08. *
* *
* Rust Bindings Version 2.0.3 *
* *
* If you have a bugfix for this file and want to commit it, *
* please fix the bug in the generator. You can find a link *
* to the generators git repository on tinkerforge.com *
*************************************************************/
//! Passive infrared (PIR) motion sensor, 7m range
use crate::{
byte_converter::*, converting_callback_receiver::ConvertingCallbackReceiver, converting_receiver::ConvertingReceiver, device::*,
ip_connection::IpConnection,
};
pub enum MotionDetectorBrickletFunction {
GetMotionDetected,
SetStatusLedConfig,
GetStatusLedConfig,
GetIdentity,
CallbackMotionDetected,
CallbackDetectionCycleEnded,
}
impl From<MotionDetectorBrickletFunction> for u8 {
fn from(fun: MotionDetectorBrickletFunction) -> Self {
match fun {
MotionDetectorBrickletFunction::GetMotionDetected => 1,
MotionDetectorBrickletFunction::SetStatusLedConfig => 4,
MotionDetectorBrickletFunction::GetStatusLedConfig => 5,
MotionDetectorBrickletFunction::GetIdentity => 255,
MotionDetectorBrickletFunction::CallbackMotionDetected => 2,
MotionDetectorBrickletFunction::CallbackDetectionCycleEnded => 3,
}
}
}
pub const MOTION_DETECTOR_BRICKLET_MOTION_NOT_DETECTED: u8 = 0;
pub const MOTION_DETECTOR_BRICKLET_MOTION_DETECTED: u8 = 1;
pub const MOTION_DETECTOR_BRICKLET_STATUS_LED_CONFIG_OFF: u8 = 0;
pub const MOTION_DETECTOR_BRICKLET_STATUS_LED_CONFIG_ON: u8 = 1;
pub const MOTION_DETECTOR_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS: u8 = 2;
#[derive(Clone, Debug, Default, PartialEq, Eq, Hash)]
pub struct Identity {
pub uid: String,
pub connected_uid: String,
pub position: char,
pub hardware_version: [u8; 3],
pub firmware_version: [u8; 3],
pub device_identifier: u16,
}
impl FromByteSlice for Identity {
fn bytes_expected() -> usize { 25 }
fn from_le_bytes(bytes: &[u8]) -> Identity {
Identity {
uid: <String>::from_le_bytes(&bytes[0..8]),
connected_uid: <String>::from_le_bytes(&bytes[8..16]),
position: <char>::from_le_bytes(&bytes[16..17]),
hardware_version: <[u8; 3]>::from_le_bytes(&bytes[17..20]),
firmware_version: <[u8; 3]>::from_le_bytes(&bytes[20..23]),
device_identifier: <u16>::from_le_bytes(&bytes[23..25]),
}
}
}
/// Passive infrared (PIR) motion sensor, 7m range
#[derive(Clone)]
pub struct MotionDetectorBricklet {
device: Device,
}
impl MotionDetectorBricklet {
pub const DEVICE_IDENTIFIER: u16 = 233;
pub const DEVICE_DISPLAY_NAME: &'static str = "Motion Detector Bricklet";
/// Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ip_connection` is connected.
pub fn new(uid: &str, ip_connection: &IpConnection) -> MotionDetectorBricklet {
let mut result = MotionDetectorBricklet { device: Device::new([2, 0, 1], uid, ip_connection, 0) };
result.device.response_expected[u8::from(MotionDetectorBrickletFunction::GetMotionDetected) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(MotionDetectorBrickletFunction::SetStatusLedConfig) as usize] =
ResponseExpectedFlag::False;
result.device.response_expected[u8::from(MotionDetectorBrickletFunction::GetStatusLedConfig) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(MotionDetectorBrickletFunction::GetIdentity) as usize] = ResponseExpectedFlag::AlwaysTrue;
result
}
/// 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`](crate::motion_detector_bricklet::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.
///
/// See [`set_response_expected`](crate::motion_detector_bricklet::MotionDetectorBricklet::set_response_expected) for the list of function ID constants available for this function.
pub fn get_response_expected(&mut self, fun: MotionDetectorBrickletFunction) -> Result<bool, GetResponseExpectedError> {
self.device.get_response_expected(u8::from(fun))
}
/// 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.
pub fn set_response_expected(
&mut self,
fun: MotionDetectorBrickletFunction,
response_expected: bool,
) -> Result<(), SetResponseExpectedError> {
self.device.set_response_expected(u8::from(fun), response_expected)
}
/// Changes the response expected flag for all setter and callback configuration functions of this device at once.
pub fn set_response_expected_all(&mut self, response_expected: bool) { self.device.set_response_expected_all(response_expected) }
/// This receiver is called after a motion was detected.
pub fn get_motion_detected_callback_receiver(&self) -> ConvertingCallbackReceiver<()> {
self.device.get_callback_receiver(u8::from(MotionDetectorBrickletFunction::CallbackMotionDetected))
}
/// 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.
pub fn get_detection_cycle_ended_callback_receiver(&self) -> ConvertingCallbackReceiver<()> {
self.device.get_callback_receiver(u8::from(MotionDetectorBrickletFunction::CallbackDetectionCycleEnded))
}
/// 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_DETECTORBRICKLET_MOTION_NOT_DETECTED
/// * MOTION_DETECTORBRICKLET_MOTION_DETECTED
pub fn get_motion_detected(&self) -> ConvertingReceiver<u8> {
let payload = vec![0; 0];
self.device.get(u8::from(MotionDetectorBrickletFunction::GetMotionDetected), payload)
}
/// 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_DETECTORBRICKLET_STATUS_LED_CONFIG_OFF
/// * MOTION_DETECTORBRICKLET_STATUS_LED_CONFIG_ON
/// * MOTION_DETECTORBRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
pub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()> {
let mut payload = vec![0; 1];
payload[0..1].copy_from_slice(&<u8>::to_le_bytes(config));
self.device.set(u8::from(MotionDetectorBrickletFunction::SetStatusLedConfig), payload)
}
/// Returns the configuration as set by `Set Status LED Config`.
///
///
/// .. versionadded:: 2.0.1$nbsp;(Plugin)
///
/// Associated constants:
/// * MOTION_DETECTORBRICKLET_STATUS_LED_CONFIG_OFF
/// * MOTION_DETECTORBRICKLET_STATUS_LED_CONFIG_ON
/// * MOTION_DETECTORBRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
pub fn get_status_led_config(&self) -> ConvertingReceiver<u8> {
let payload = vec![0; 0];
self.device.get(u8::from(MotionDetectorBrickletFunction::GetStatusLedConfig), payload)
}
/// 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](device_identifier).
/// |device_identifier_constant|
pub fn get_identity(&self) -> ConvertingReceiver<Identity> {
let payload = vec![0; 0];
self.device.get(u8::from(MotionDetectorBrickletFunction::GetIdentity), payload)
}
}