pub struct HumidityBricklet { /* private fields */ }
Expand description
Measures relative humidity
Implementations§
Source§impl HumidityBricklet
impl HumidityBricklet
pub const DEVICE_IDENTIFIER: u16 = 27u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Humidity Bricklet"
Sourcepub fn new(uid: Uid, connection: AsyncIpConnection) -> HumidityBricklet
pub fn new(uid: Uid, connection: AsyncIpConnection) -> HumidityBricklet
Creates an object with the unique device ID uid
. This object can then be used after the IP Connection ip_connection
is connected.
Sourcepub fn get_response_expected(
&mut self,
fun: HumidityBrickletFunction,
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected( &mut self, fun: HumidityBrickletFunction, ) -> 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.
Sourcepub fn set_response_expected(
&mut self,
fun: HumidityBrickletFunction,
response_expected: bool,
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected( &mut self, fun: HumidityBrickletFunction, 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.
Sourcepub fn set_response_expected_all(&mut self, response_expected: bool)
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.
Sourcepub fn get_api_version(&self) -> [u8; 3]
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.
Sourcepub async fn get_humidity_callback_receiver(
&mut self,
) -> impl Stream<Item = u16>
pub async fn get_humidity_callback_receiver( &mut self, ) -> impl Stream<Item = u16>
This receiver is triggered periodically with the period that is set by
set_humidity_callback_period
. The parameter is the humidity of
the sensor.
The get_humidity_callback_receiver
receiver is only triggered if the humidity has changed since
the last triggering.
Sourcepub async fn get_analog_value_callback_receiver(
&mut self,
) -> impl Stream<Item = u16>
pub async fn get_analog_value_callback_receiver( &mut self, ) -> impl Stream<Item = u16>
This receiver is triggered periodically with the period that is set by
[set_analog_value_callback_period
]. The parameter is the analog
value of the sensor.
The [get_analog_value_callback_receiver
] receiver is only triggered if the humidity has changed
since the last triggering.
Sourcepub async fn get_humidity_reached_callback_receiver(
&mut self,
) -> impl Stream<Item = u16>
pub async fn get_humidity_reached_callback_receiver( &mut self, ) -> impl Stream<Item = u16>
This receiver is triggered when the threshold as set by
[set_humidity_callback_threshold
] is reached.
The parameter is the humidity of the sensor.
If the threshold keeps being reached, the receiver is triggered periodically
with the period as set by [set_debounce_period
].
Sourcepub async fn get_analog_value_reached_callback_receiver(
&mut self,
) -> impl Stream<Item = u16>
pub async fn get_analog_value_reached_callback_receiver( &mut self, ) -> impl Stream<Item = u16>
This receiver is triggered when the threshold as set by
[set_analog_value_callback_threshold
] is reached.
The parameter is the analog value of the sensor.
If the threshold keeps being reached, the receiver is triggered periodically
with the period as set by [set_debounce_period
].
Sourcepub async fn get_humidity(&mut self) -> Result<u16, TinkerforgeError>
pub async fn get_humidity(&mut self) -> Result<u16, TinkerforgeError>
Returns the humidity of the sensor.
If you want to get the humidity periodically, it is recommended to use the
[get_humidity_callback_receiver
] receiver and set the period with
[set_humidity_callback_period
].
Sourcepub async fn get_analog_value(&mut self) -> Result<u16, TinkerforgeError>
pub async fn get_analog_value(&mut self) -> Result<u16, TinkerforgeError>
Returns the value as read by a 12-bit analog-to-digital converter.
§Note
If you want the analog value periodically, it is recommended to use the
[get_analog_value_callback_receiver
] receiver and set the period with
[set_analog_value_callback_period
].
Sourcepub async fn set_humidity_callback_period(
&mut self,
period: u32,
) -> Result<(), TinkerforgeError>
pub async fn set_humidity_callback_period( &mut self, period: u32, ) -> Result<(), TinkerforgeError>
Sets the period with which the [get_humidity_callback_receiver
] receiver is triggered
periodically. A value of 0 turns the receiver off.
The [get_humidity_callback_receiver
] receiver is only triggered if the humidity has changed
since the last triggering.
Sourcepub async fn get_humidity_callback_period(
&mut self,
) -> Result<u32, TinkerforgeError>
pub async fn get_humidity_callback_period( &mut self, ) -> Result<u32, TinkerforgeError>
Returns the period as set by [set_humidity_callback_period
].
Sourcepub async fn set_analog_value_callback_period(
&mut self,
period: u32,
) -> Result<(), TinkerforgeError>
pub async fn set_analog_value_callback_period( &mut self, period: u32, ) -> Result<(), TinkerforgeError>
Sets the period with which the [get_analog_value_callback_receiver
] receiver is triggered
periodically. A value of 0 turns the receiver off.
The [get_analog_value_callback_receiver
] receiver is only triggered if the analog value has
changed since the last triggering.
Sourcepub async fn get_analog_value_callback_period(
&mut self,
) -> Result<u32, TinkerforgeError>
pub async fn get_analog_value_callback_period( &mut self, ) -> Result<u32, TinkerforgeError>
Returns the period as set by [set_analog_value_callback_period
].
Sourcepub async fn set_humidity_callback_threshold(
&mut self,
option: char,
min: u16,
max: u16,
) -> Result<(), TinkerforgeError>
pub async fn set_humidity_callback_threshold( &mut self, option: char, min: u16, max: u16, ) -> Result<(), TinkerforgeError>
Sets the thresholds for the [get_humidity_reached_callback_receiver
] receiver.
The following options are possible:
Option | Description |
---|---|
‘x’ | Receiver is turned off |
‘o’ | Receiver is triggered when the humidity is outside the min and max values |
‘i’ | Receiver is triggered when the humidity is inside the min and max values |
‘<’ | Receiver is triggered when the humidity is smaller than the min value (max is ignored) |
‘>’ | Receiver is triggered when the humidity is greater than the min value (max is ignored) |
Associated constants:
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_OFF
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_INSIDE
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_SMALLER
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_GREATER
Sourcepub async fn get_humidity_callback_threshold(
&mut self,
) -> Result<HumidityCallbackThreshold, TinkerforgeError>
pub async fn get_humidity_callback_threshold( &mut self, ) -> Result<HumidityCallbackThreshold, TinkerforgeError>
Returns the threshold as set by [set_humidity_callback_threshold
].
Associated constants:
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_OFF
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_INSIDE
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_SMALLER
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_GREATER
Sourcepub async fn set_analog_value_callback_threshold(
&mut self,
option: char,
min: u16,
max: u16,
) -> Result<(), TinkerforgeError>
pub async fn set_analog_value_callback_threshold( &mut self, option: char, min: u16, max: u16, ) -> Result<(), TinkerforgeError>
Sets the thresholds for the [get_analog_value_reached_callback_receiver
] receiver.
The following options are possible:
Option | Description |
---|---|
‘x’ | Receiver is turned off |
‘o’ | Receiver is triggered when the analog value is outside the min and max values |
‘i’ | Receiver is triggered when the analog value is inside the min and max values |
‘<’ | Receiver is triggered when the analog value is smaller than the min value (max is ignored) |
‘>’ | Receiver is triggered when the analog value is greater than the min value (max is ignored) |
Associated constants:
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_OFF
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_INSIDE
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_SMALLER
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_GREATER
Sourcepub async fn get_analog_value_callback_threshold(
&mut self,
) -> Result<AnalogValueCallbackThreshold, TinkerforgeError>
pub async fn get_analog_value_callback_threshold( &mut self, ) -> Result<AnalogValueCallbackThreshold, TinkerforgeError>
Returns the threshold as set by [set_analog_value_callback_threshold
].
Associated constants:
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_OFF
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_INSIDE
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_SMALLER
- HUMIDITY_BRICKLET_THRESHOLD_OPTION_GREATER
Sourcepub async fn set_debounce_period(
&mut self,
debounce: u32,
) -> Result<(), TinkerforgeError>
pub async fn set_debounce_period( &mut self, debounce: u32, ) -> Result<(), TinkerforgeError>
Sets the period with which the threshold receivers
- [
get_humidity_reached_callback_receiver
], - [
get_analog_value_reached_callback_receiver
]
are triggered, if the thresholds
- [
set_humidity_callback_threshold
], - [
set_analog_value_callback_threshold
]
keep being reached.
Sourcepub async fn get_debounce_period(&mut self) -> Result<u32, TinkerforgeError>
pub async fn get_debounce_period(&mut self) -> Result<u32, TinkerforgeError>
Returns the debounce period as set by [set_debounce_period
].
Sourcepub async fn get_identity(&mut self) -> Result<Identity, TinkerforgeError>
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 HumidityBricklet
impl Clone for HumidityBricklet
Source§fn clone(&self) -> HumidityBricklet
fn clone(&self) -> HumidityBricklet
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more