pub struct HumidityV2Bricklet { /* private fields */ }Expand description
Measures relative humidity
Implementations§
Source§impl HumidityV2Bricklet
impl HumidityV2Bricklet
pub const DEVICE_IDENTIFIER: u16 = 283u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Humidity Bricklet 2.0"
Sourcepub fn new(uid: Uid, connection: AsyncIpConnection) -> HumidityV2Bricklet
pub fn new(uid: Uid, connection: AsyncIpConnection) -> HumidityV2Bricklet
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: HumidityV2BrickletFunction,
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected( &mut self, fun: HumidityV2BrickletFunction, ) -> 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: HumidityV2BrickletFunction,
response_expected: bool,
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected( &mut self, fun: HumidityV2BrickletFunction, 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 according to the configuration set by
set_humidity_callback_configuration.
The parameter is the same as get_humidity.
Sourcepub async fn get_temperature_callback_receiver(
&mut self,
) -> impl Stream<Item = i16>
pub async fn get_temperature_callback_receiver( &mut self, ) -> impl Stream<Item = i16>
This receiver is triggered periodically according to the configuration set by
[set_temperature_callback_configuration].
The parameter is the same as [get_temperature].
Sourcepub async fn get_humidity(&mut self) -> Result<u16, TinkerforgeError>
pub async fn get_humidity(&mut self) -> Result<u16, TinkerforgeError>
Returns the humidity measured by the sensor.
If you want to get the value periodically, it is recommended to use the
[get_humidity_callback_receiver] receiver. You can set the receiver configuration
with [set_humidity_callback_configuration].
Sourcepub async fn set_humidity_callback_configuration(
&mut self,
period: u32,
value_has_to_change: bool,
option: char,
min: u16,
max: u16,
) -> Result<(), TinkerforgeError>
pub async fn set_humidity_callback_configuration( &mut self, period: u32, value_has_to_change: bool, option: char, min: u16, max: u16, ) -> Result<(), TinkerforgeError>
The period is the period with which the [get_humidity_callback_receiver] receiver is triggered
periodically. A value of 0 turns the receiver off.
If the value has to change-parameter is set to true, the receiver is only
triggered after the value has changed. If the value didn’t change
within the period, the receiver is triggered immediately on change.
If it is set to false, the receiver is continuously triggered with the period, independent of the value.
It is furthermore possible to constrain the receiver with thresholds.
The option-parameter together with min/max sets a threshold for the [get_humidity_callback_receiver] receiver.
The following options are possible:
| Option | Description |
|---|---|
| ‘x’ | Threshold is turned off |
| ‘o’ | Threshold is triggered when the value is outside the min and max values |
| ‘i’ | Threshold is triggered when the value is inside or equal to the min and max values |
| ‘<’ | Threshold is triggered when the value is smaller than the min value (max is ignored) |
| ‘>’ | Threshold is triggered when the value is greater than the min value (max is ignored) |
If the option is set to ‘x’ (threshold turned off) the receiver is triggered with the fixed period.
Associated constants:
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_OFF
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_GREATER
Sourcepub async fn get_humidity_callback_configuration(
&mut self,
) -> Result<HumidityCallbackConfiguration, TinkerforgeError>
pub async fn get_humidity_callback_configuration( &mut self, ) -> Result<HumidityCallbackConfiguration, TinkerforgeError>
Returns the receiver configuration as set by [set_humidity_callback_configuration].
Associated constants:
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_OFF
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_GREATER
Sourcepub async fn get_temperature(&mut self) -> Result<i16, TinkerforgeError>
pub async fn get_temperature(&mut self) -> Result<i16, TinkerforgeError>
Returns the temperature measured by the sensor.
If you want to get the value periodically, it is recommended to use the
[get_temperature_callback_receiver] receiver. You can set the receiver configuration
with [set_temperature_callback_configuration].
Sourcepub async fn set_temperature_callback_configuration(
&mut self,
period: u32,
value_has_to_change: bool,
option: char,
min: i16,
max: i16,
) -> Result<(), TinkerforgeError>
pub async fn set_temperature_callback_configuration( &mut self, period: u32, value_has_to_change: bool, option: char, min: i16, max: i16, ) -> Result<(), TinkerforgeError>
The period is the period with which the [get_temperature_callback_receiver] receiver is triggered
periodically. A value of 0 turns the receiver off.
If the value has to change-parameter is set to true, the receiver is only
triggered after the value has changed. If the value didn’t change
within the period, the receiver is triggered immediately on change.
If it is set to false, the receiver is continuously triggered with the period, independent of the value.
It is furthermore possible to constrain the receiver with thresholds.
The option-parameter together with min/max sets a threshold for the [get_temperature_callback_receiver] receiver.
The following options are possible:
| Option | Description |
|---|---|
| ‘x’ | Threshold is turned off |
| ‘o’ | Threshold is triggered when the value is outside the min and max values |
| ‘i’ | Threshold is triggered when the value is inside or equal to the min and max values |
| ‘<’ | Threshold is triggered when the value is smaller than the min value (max is ignored) |
| ‘>’ | Threshold is triggered when the value is greater than the min value (max is ignored) |
If the option is set to ‘x’ (threshold turned off) the receiver is triggered with the fixed period.
Associated constants:
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_OFF
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_GREATER
Sourcepub async fn get_temperature_callback_configuration(
&mut self,
) -> Result<TemperatureCallbackConfiguration, TinkerforgeError>
pub async fn get_temperature_callback_configuration( &mut self, ) -> Result<TemperatureCallbackConfiguration, TinkerforgeError>
Returns the receiver configuration as set by [set_temperature_callback_configuration].
Associated constants:
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_OFF
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
- HUMIDITY_V2_BRICKLET_THRESHOLD_OPTION_GREATER
Sourcepub async fn set_heater_configuration(
&mut self,
heater_config: u8,
) -> Result<(), TinkerforgeError>
pub async fn set_heater_configuration( &mut self, heater_config: u8, ) -> Result<(), TinkerforgeError>
Enables/disables the heater. The heater can be used to dry the sensor in extremely wet conditions.
Associated constants:
- HUMIDITY_V2_BRICKLET_HEATER_CONFIG_DISABLED
- HUMIDITY_V2_BRICKLET_HEATER_CONFIG_ENABLED
Sourcepub async fn get_heater_configuration(&mut self) -> Result<u8, TinkerforgeError>
pub async fn get_heater_configuration(&mut self) -> Result<u8, TinkerforgeError>
Returns the heater configuration as set by [set_heater_configuration].
Associated constants:
- HUMIDITY_V2_BRICKLET_HEATER_CONFIG_DISABLED
- HUMIDITY_V2_BRICKLET_HEATER_CONFIG_ENABLED
Sourcepub async fn set_moving_average_configuration(
&mut self,
moving_average_length_humidity: u16,
moving_average_length_temperature: u16,
) -> Result<(), TinkerforgeError>
pub async fn set_moving_average_configuration( &mut self, moving_average_length_humidity: u16, moving_average_length_temperature: u16, ) -> Result<(), TinkerforgeError>
Sets the length of a moving averaging__ for the humidity and temperature.
Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.
New data is gathered every 50ms*. With a moving average of length 1000 the resulting averaging window has a length of 50s. If you want to do long term measurements the longest moving average will give the cleanest results.
* In firmware version 2.0.3 we added the [set_samples_per_second] function. It
configures the measurement frequency. Since high frequencies can result in self-heating
of th IC, changed the default value from 20 samples per second to 1. With 1 sample per second
a moving average length of 1000 would result in an averaging window of 1000 seconds!
Sourcepub async fn get_moving_average_configuration(
&mut self,
) -> Result<MovingAverageConfiguration, TinkerforgeError>
pub async fn get_moving_average_configuration( &mut self, ) -> Result<MovingAverageConfiguration, TinkerforgeError>
Returns the moving average configuration as set by [set_moving_average_configuration].
Sourcepub async fn set_samples_per_second(
&mut self,
sps: u8,
) -> Result<(), TinkerforgeError>
pub async fn set_samples_per_second( &mut self, sps: u8, ) -> Result<(), TinkerforgeError>
Sets the samples per second that are gathered by the humidity/temperature sensor HDC1080.
We added this function since we found out that a high measurement frequency can lead to self-heating of the sensor. Which can distort the temperature measurement.
If you don’t need a lot of measurements, you can use the lowest available measurement frequency of 0.1 samples per second for the least amount of self-heating.
Before version 2.0.3 the default was 20 samples per second. The new default is 1 sample per second.
.. versionadded:: 2.0.3$nbsp;(Plugin)
Associated constants:
- HUMIDITY_V2_BRICKLET_SPS_20
- HUMIDITY_V2_BRICKLET_SPS_10
- HUMIDITY_V2_BRICKLET_SPS_5
- HUMIDITY_V2_BRICKLET_SPS_1
- HUMIDITY_V2_BRICKLET_SPS_02
- HUMIDITY_V2_BRICKLET_SPS_01
Sourcepub async fn get_samples_per_second(&mut self) -> Result<u8, TinkerforgeError>
pub async fn get_samples_per_second(&mut self) -> Result<u8, TinkerforgeError>
Returnes the samples per second, as set by [set_samples_per_second].
.. versionadded:: 2.0.3$nbsp;(Plugin)
Associated constants:
- HUMIDITY_V2_BRICKLET_SPS_20
- HUMIDITY_V2_BRICKLET_SPS_10
- HUMIDITY_V2_BRICKLET_SPS_5
- HUMIDITY_V2_BRICKLET_SPS_1
- HUMIDITY_V2_BRICKLET_SPS_02
- HUMIDITY_V2_BRICKLET_SPS_01
Sourcepub async fn get_spitfp_error_count(
&mut self,
) -> Result<SpitfpErrorCount, TinkerforgeError>
pub async fn get_spitfp_error_count( &mut self, ) -> Result<SpitfpErrorCount, TinkerforgeError>
Returns the error count for the communication between Brick and Bricklet.
The errors are divided into
- ACK checksum errors,
- message checksum errors,
- framing errors and
- overflow errors.
The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.
Sourcepub async fn set_bootloader_mode(
&mut self,
mode: u8,
) -> Result<u8, TinkerforgeError>
pub async fn set_bootloader_mode( &mut self, mode: u8, ) -> Result<u8, TinkerforgeError>
Sets the bootloader mode and returns the status after the requested mode change was instigated.
You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
Associated constants:
- HUMIDITY_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
- HUMIDITY_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
- HUMIDITY_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- HUMIDITY_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- HUMIDITY_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
- HUMIDITY_V2_BRICKLET_BOOTLOADER_STATUS_OK
- HUMIDITY_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
- HUMIDITY_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
- HUMIDITY_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
- HUMIDITY_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
- HUMIDITY_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH
Sourcepub async fn get_bootloader_mode(&mut self) -> Result<u8, TinkerforgeError>
pub async fn get_bootloader_mode(&mut self) -> Result<u8, TinkerforgeError>
Returns the current bootloader mode, see [set_bootloader_mode].
Associated constants:
- HUMIDITY_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
- HUMIDITY_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
- HUMIDITY_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- HUMIDITY_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- HUMIDITY_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
Sourcepub async fn set_write_firmware_pointer(
&mut self,
pointer: u32,
) -> Result<(), TinkerforgeError>
pub async fn set_write_firmware_pointer( &mut self, pointer: u32, ) -> Result<(), TinkerforgeError>
Sets the firmware pointer for [write_firmware]. The pointer has
to be increased by chunks of size 64. The data is written to flash
every 4 chunks (which equals to one page of size 256).
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
Sourcepub async fn write_firmware(
&mut self,
data: &[u8; 64],
) -> Result<u8, TinkerforgeError>
pub async fn write_firmware( &mut self, data: &[u8; 64], ) -> Result<u8, TinkerforgeError>
Writes 64 Bytes of firmware at the position as written by
[set_write_firmware_pointer] before. The firmware is written
to flash every 4 chunks.
You can only write firmware in bootloader mode.
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
Sourcepub async fn set_status_led_config(
&mut self,
config: u8,
) -> Result<(), TinkerforgeError>
pub async fn set_status_led_config( &mut self, config: u8, ) -> Result<(), TinkerforgeError>
Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.
You can also turn the LED permanently on/off or show a heartbeat.
If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
Associated constants:
- HUMIDITY_V2_BRICKLET_STATUS_LED_CONFIG_OFF
- HUMIDITY_V2_BRICKLET_STATUS_LED_CONFIG_ON
- HUMIDITY_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
- HUMIDITY_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
Sourcepub async fn get_status_led_config(&mut self) -> Result<u8, TinkerforgeError>
pub async fn get_status_led_config(&mut self) -> Result<u8, TinkerforgeError>
Returns the configuration as set by [set_status_led_config]
Associated constants:
- HUMIDITY_V2_BRICKLET_STATUS_LED_CONFIG_OFF
- HUMIDITY_V2_BRICKLET_STATUS_LED_CONFIG_ON
- HUMIDITY_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
- HUMIDITY_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
Sourcepub async fn get_chip_temperature(&mut self) -> Result<i16, TinkerforgeError>
pub async fn get_chip_temperature(&mut self) -> Result<i16, TinkerforgeError>
Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!
The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.
Sourcepub async fn reset(&mut self) -> Result<(), TinkerforgeError>
pub async fn reset(&mut self) -> Result<(), TinkerforgeError>
Calling this function will reset the Bricklet. All configurations will be lost.
After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!
Sourcepub async fn write_uid(&mut self, uid: u32) -> Result<(), TinkerforgeError>
pub async fn write_uid(&mut self, uid: u32) -> Result<(), TinkerforgeError>
Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.
We recommend that you use Brick Viewer to change the UID.
Sourcepub async fn read_uid(&mut self) -> Result<u32, TinkerforgeError>
pub async fn read_uid(&mut self) -> Result<u32, TinkerforgeError>
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
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 HumidityV2Bricklet
impl Clone for HumidityV2Bricklet
Source§fn clone(&self) -> HumidityV2Bricklet
fn clone(&self) -> HumidityV2Bricklet
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more