Struct tinkerforge::humidity_bricklet::HumidityBricklet

source ·

pub struct HumidityBricklet { /* private fields */ }

Expand description

Measures relative humidity

Implementations

source

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

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: 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 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: 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 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_humidity_callback_receiver(&self) -> ConvertingCallbackReceiver<u16>

This receiver is triggered periodically with the period that is set by Set Humidity Receiver 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.

source

pub fn get_analog_value_callback_receiver(
&self
) -> ConvertingCallbackReceiver<u16>

This receiver is triggered periodically with the period that is set by Set Analog Value Receiver 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.

source

pub fn get_humidity_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<u16>

This receiver is triggered when the threshold as set by Set Humidity Receiver 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.

source

pub fn get_analog_value_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<u16>

This receiver is triggered when the threshold as set by Set Analog Value Receiver 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.

source

pub fn get_humidity(&self) -> ConvertingReceiver<u16>

Returns the humidity of the sensor. The value has a range of 0 to 1000 and is given in %RH/10 (Relative Humidity), i.e. a value of 421 means that a humidity of 42.1 %RH is measured.

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

source

pub fn get_analog_value(&self) -> ConvertingReceiver<u16>

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

Note

The value returned by Get Humidityis averaged over several samples to yield less noise, whileGet Analog Valuegives back raw unfiltered analog values. The returned humidity value is calibrated for room temperatures, if you use the sensor in extreme cold or extreme warm environments, you might want to calculate the humidity from the analog value yourself. See theHIH 5030 datasheet __.

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

source

pub fn set_humidity_callback_period(&self, period: u32) -> ConvertingReceiver<()>

Sets the period in ms 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.

The default value is 0.

source

pub fn get_humidity_callback_period(&self) -> ConvertingReceiver<u32>

Returns the period as set by Set Humidity Receiver Period.

source

pub fn set_analog_value_callback_period(
&self,
period: u32
) -> ConvertingReceiver<()>

Sets the period in ms 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.

The default value is 0.

source

pub fn get_analog_value_callback_period(&self) -> ConvertingReceiver<u32>

Returns the period as set by Set Analog Value Receiver Period.

source

pub fn set_humidity_callback_threshold(
 &self,
 option: char,
 min: u16,
 max: u16
) -> ConvertingReceiver<()>

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)

The default value is (‘x’, 0, 0).

Associated constants:

HUMIDITYBRICKLET_THRESHOLD_OPTION_OFF
HUMIDITYBRICKLET_THRESHOLD_OPTION_OUTSIDE
HUMIDITYBRICKLET_THRESHOLD_OPTION_INSIDE
HUMIDITYBRICKLET_THRESHOLD_OPTION_SMALLER
HUMIDITYBRICKLET_THRESHOLD_OPTION_GREATER

source

pub fn get_humidity_callback_threshold(
&self
) -> ConvertingReceiver<HumidityCallbackThreshold>

Returns the threshold as set by Set Humidity Receiver Threshold.

Associated constants:

HUMIDITYBRICKLET_THRESHOLD_OPTION_OFF
HUMIDITYBRICKLET_THRESHOLD_OPTION_OUTSIDE
HUMIDITYBRICKLET_THRESHOLD_OPTION_INSIDE
HUMIDITYBRICKLET_THRESHOLD_OPTION_SMALLER
HUMIDITYBRICKLET_THRESHOLD_OPTION_GREATER

source

pub fn set_analog_value_callback_threshold(
 &self,
 option: char,
 min: u16,
 max: u16
) -> ConvertingReceiver<()>

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)