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 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
/* ***********************************************************
* This file was automatically generated on 2018-11-21. *
* *
* Rust Bindings Version 2.0.4 *
* *
* 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 *
*************************************************************/
//! Measures sound intensity
//! See also the documentation [here](https://www.tinkerforge.com/en/doc/Software/Bricklets/SoundIntensity_Bricklet_Rust.html).
use crate::{
byte_converter::*, converting_callback_receiver::ConvertingCallbackReceiver, converting_receiver::ConvertingReceiver, device::*,
ip_connection::IpConnection,
};
pub enum SoundIntensityBrickletFunction {
GetIntensity,
SetIntensityCallbackPeriod,
GetIntensityCallbackPeriod,
SetIntensityCallbackThreshold,
GetIntensityCallbackThreshold,
SetDebouncePeriod,
GetDebouncePeriod,
GetIdentity,
CallbackIntensity,
CallbackIntensityReached,
}
impl From<SoundIntensityBrickletFunction> for u8 {
fn from(fun: SoundIntensityBrickletFunction) -> Self {
match fun {
SoundIntensityBrickletFunction::GetIntensity => 1,
SoundIntensityBrickletFunction::SetIntensityCallbackPeriod => 2,
SoundIntensityBrickletFunction::GetIntensityCallbackPeriod => 3,
SoundIntensityBrickletFunction::SetIntensityCallbackThreshold => 4,
SoundIntensityBrickletFunction::GetIntensityCallbackThreshold => 5,
SoundIntensityBrickletFunction::SetDebouncePeriod => 6,
SoundIntensityBrickletFunction::GetDebouncePeriod => 7,
SoundIntensityBrickletFunction::GetIdentity => 255,
SoundIntensityBrickletFunction::CallbackIntensity => 8,
SoundIntensityBrickletFunction::CallbackIntensityReached => 9,
}
}
}
pub const SOUND_INTENSITY_BRICKLET_THRESHOLD_OPTION_OFF: char = 'x';
pub const SOUND_INTENSITY_BRICKLET_THRESHOLD_OPTION_OUTSIDE: char = 'o';
pub const SOUND_INTENSITY_BRICKLET_THRESHOLD_OPTION_INSIDE: char = 'i';
pub const SOUND_INTENSITY_BRICKLET_THRESHOLD_OPTION_SMALLER: char = '<';
pub const SOUND_INTENSITY_BRICKLET_THRESHOLD_OPTION_GREATER: char = '>';
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct IntensityCallbackThreshold {
pub option: char,
pub min: u16,
pub max: u16,
}
impl FromByteSlice for IntensityCallbackThreshold {
fn bytes_expected() -> usize { 5 }
fn from_le_bytes(bytes: &[u8]) -> IntensityCallbackThreshold {
IntensityCallbackThreshold {
option: <char>::from_le_bytes(&bytes[0..1]),
min: <u16>::from_le_bytes(&bytes[1..3]),
max: <u16>::from_le_bytes(&bytes[3..5]),
}
}
}
#[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]),
}
}
}
/// Measures sound intensity
#[derive(Clone)]
pub struct SoundIntensityBricklet {
device: Device,
}
impl SoundIntensityBricklet {
pub const DEVICE_IDENTIFIER: u16 = 238;
pub const DEVICE_DISPLAY_NAME: &'static str = "Sound Intensity 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) -> SoundIntensityBricklet {
let mut result = SoundIntensityBricklet { device: Device::new([2, 0, 0], uid, ip_connection, 0) };
result.device.response_expected[u8::from(SoundIntensityBrickletFunction::GetIntensity) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(SoundIntensityBrickletFunction::SetIntensityCallbackPeriod) as usize] =
ResponseExpectedFlag::True;
result.device.response_expected[u8::from(SoundIntensityBrickletFunction::GetIntensityCallbackPeriod) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(SoundIntensityBrickletFunction::SetIntensityCallbackThreshold) as usize] =
ResponseExpectedFlag::True;
result.device.response_expected[u8::from(SoundIntensityBrickletFunction::GetIntensityCallbackThreshold) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(SoundIntensityBrickletFunction::SetDebouncePeriod) as usize] = ResponseExpectedFlag::True;
result.device.response_expected[u8::from(SoundIntensityBrickletFunction::GetDebouncePeriod) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(SoundIntensityBrickletFunction::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::sound_intensity_bricklet::SoundIntensityBricklet::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::sound_intensity_bricklet::SoundIntensityBricklet::set_response_expected) for the list of function ID constants available for this function.
pub fn get_response_expected(&mut self, fun: SoundIntensityBrickletFunction) -> 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: SoundIntensityBrickletFunction,
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 triggered periodically with the period that is set by
/// [`set_intensity_callback_period`]. The parameter is the intensity
/// of the sensor.
///
/// The [`get_intensity_callback_receiver`] receiver is only triggered if the intensity has changed
/// since the last triggering.
///
/// [`set_intensity_callback_period`]: #method.set_intensity_callback_period
/// [`get_intensity_callback_receiver`]: #method.get_intensity_callback_receiver
pub fn get_intensity_callback_receiver(&self) -> ConvertingCallbackReceiver<u16> {
self.device.get_callback_receiver(u8::from(SoundIntensityBrickletFunction::CallbackIntensity))
}
/// This receiver is triggered when the threshold as set by
/// [`set_intensity_callback_threshold`] is reached.
/// The parameter is the intensity of the encoder.
///
/// If the threshold keeps being reached, the receiver is triggered periodically
/// with the period as set by [`set_debounce_period`].
///
/// [`set_intensity_callback_threshold`]: #method.set_intensity_callback_threshold
/// [`set_debounce_period`]: #method.set_debounce_period
pub fn get_intensity_reached_callback_receiver(&self) -> ConvertingCallbackReceiver<u16> {
self.device.get_callback_receiver(u8::from(SoundIntensityBrickletFunction::CallbackIntensityReached))
}
/// Returns the current sound intensity. The value has a range of
/// 0 to 4095.
///
/// The value corresponds to the
/// [upper envelop](https://en.wikipedia.org/wiki/Envelope_(waves))__
/// of the signal of the microphone capsule.
///
/// If you want to get the intensity periodically, it is recommended to use the
/// [`get_intensity_callback_receiver`] receiver and set the period with
/// [`set_intensity_callback_period`].
///
/// [`set_intensity_callback_period`]: #method.set_intensity_callback_period
/// [`get_intensity_callback_receiver`]: #method.get_intensity_callback_receiver
pub fn get_intensity(&self) -> ConvertingReceiver<u16> {
let payload = vec![0; 0];
self.device.get(u8::from(SoundIntensityBrickletFunction::GetIntensity), payload)
}
/// Sets the period in ms with which the [`get_intensity_callback_receiver`] receiver is triggered
/// periodically. A value of 0 turns the receiver off.
///
/// The [`get_intensity_callback_receiver`] receiver is only triggered if the intensity has changed
/// since the last triggering.
///
/// The default value is 0.
///
/// [`get_intensity_callback_receiver`]: #method.get_intensity_callback_receiver
pub fn set_intensity_callback_period(&self, period: u32) -> ConvertingReceiver<()> {
let mut payload = vec![0; 4];
payload[0..4].copy_from_slice(&<u32>::to_le_bytes(period));
self.device.set(u8::from(SoundIntensityBrickletFunction::SetIntensityCallbackPeriod), payload)
}
/// Returns the period as set by [`set_intensity_callback_period`].
///
/// [`set_intensity_callback_period`]: #method.set_intensity_callback_period
pub fn get_intensity_callback_period(&self) -> ConvertingReceiver<u32> {
let payload = vec![0; 0];
self.device.get(u8::from(SoundIntensityBrickletFunction::GetIntensityCallbackPeriod), payload)
}
/// Sets the thresholds for the [`get_intensity_reached_callback_receiver`] receiver.
///
/// The following options are possible:
///
/// Option| Description
/// --- | ---
/// 'x'| Receiver is turned off
/// 'o'| Receiver is triggered when the intensity is *outside* the min and max values
/// 'i'| Receiver is triggered when the intensity is *inside* the min and max values
/// '<'| Receiver is triggered when the intensity is smaller than the min value (max is ignored)
/// '>'| Receiver is triggered when the intensity is greater than the min value (max is ignored)
///
/// The default value is ('x', 0, 0).
///
/// [`get_intensity_reached_callback_receiver`]: #method.get_intensity_reached_callback_receiver
///
/// Associated constants:
/// * SOUND_INTENSITY_BRICKLET_THRESHOLD_OPTION_OFF
/// * SOUND_INTENSITY_BRICKLET_THRESHOLD_OPTION_OUTSIDE
/// * SOUND_INTENSITY_BRICKLET_THRESHOLD_OPTION_INSIDE
/// * SOUND_INTENSITY_BRICKLET_THRESHOLD_OPTION_SMALLER
/// * SOUND_INTENSITY_BRICKLET_THRESHOLD_OPTION_GREATER
pub fn set_intensity_callback_threshold(&self, option: char, min: u16, max: u16) -> ConvertingReceiver<()> {
let mut payload = vec![0; 5];
payload[0..1].copy_from_slice(&<char>::to_le_bytes(option));
payload[1..3].copy_from_slice(&<u16>::to_le_bytes(min));
payload[3..5].copy_from_slice(&<u16>::to_le_bytes(max));
self.device.set(u8::from(SoundIntensityBrickletFunction::SetIntensityCallbackThreshold), payload)
}
/// Returns the threshold as set by [`set_intensity_callback_threshold`].
///
/// [`set_intensity_callback_threshold`]: #method.set_intensity_callback_threshold
///
/// Associated constants:
/// * SOUND_INTENSITY_BRICKLET_THRESHOLD_OPTION_OFF
/// * SOUND_INTENSITY_BRICKLET_THRESHOLD_OPTION_OUTSIDE
/// * SOUND_INTENSITY_BRICKLET_THRESHOLD_OPTION_INSIDE
/// * SOUND_INTENSITY_BRICKLET_THRESHOLD_OPTION_SMALLER
/// * SOUND_INTENSITY_BRICKLET_THRESHOLD_OPTION_GREATER
pub fn get_intensity_callback_threshold(&self) -> ConvertingReceiver<IntensityCallbackThreshold> {
let payload = vec![0; 0];
self.device.get(u8::from(SoundIntensityBrickletFunction::GetIntensityCallbackThreshold), payload)
}
/// Sets the period in ms with which the threshold receiver
///
/// * [`get_intensity_reached_callback_receiver`]
///
/// is triggered, if the thresholds
///
/// * [`set_intensity_callback_threshold`]
///
/// keeps being reached.
///
/// The default value is 100.
///
/// [`set_intensity_callback_threshold`]: #method.set_intensity_callback_threshold
/// [`get_intensity_reached_callback_receiver`]: #method.get_intensity_reached_callback_receiver
pub fn set_debounce_period(&self, debounce: u32) -> ConvertingReceiver<()> {
let mut payload = vec![0; 4];
payload[0..4].copy_from_slice(&<u32>::to_le_bytes(debounce));
self.device.set(u8::from(SoundIntensityBrickletFunction::SetDebouncePeriod), payload)
}
/// Returns the debounce period as set by [`set_debounce_period`].
///
/// [`set_debounce_period`]: #method.set_debounce_period
pub fn get_debounce_period(&self) -> ConvertingReceiver<u32> {
let payload = vec![0; 0];
self.device.get(u8::from(SoundIntensityBrickletFunction::GetDebouncePeriod), 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(SoundIntensityBrickletFunction::GetIdentity), payload)
}
}