Struct tinkerforge::humidity_v2_bricklet::HumidityV2Bricklet

pub struct HumidityV2Bricklet { /* private fields */ }

Measures relative humidity

Implementations

impl HumidityV2Bricklet

pub const DEVICE_IDENTIFIER: u16 = 283u16

pub const DEVICE_DISPLAY_NAME: &'static str = "Humidity Bricklet 2.0"

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

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

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 send and errors are silently ignored, because they cannot be detected.

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.

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

This receiver is triggered periodically according to the configuration set by Set Humidity Receiver Configuration.

The parameter is the same as Get Humidity.

pub fn get_temperature_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<i16>

This receiver is triggered periodically according to the configuration set by Set Temperature Receiver Configuration.

The parameter is the same as Get Temperature.

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

Returns the humidity measured by the sensor. The value has a range of 0 to 10000 and is given in %RH/100 (Relative Humidity), i.e. a value of 4223 means that a humidity of 42.23 %RH is measured.

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

pub fn set_humidity_callback_configuration(
    &self,
    period: u32,
    value_has_to_change: bool,
    option: char,
    min: u16,
    max: u16
) -> ConvertingReceiver<()>

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

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

Associated constants:

• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_OFF
• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_OUTSIDE
• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_INSIDE
• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_SMALLER
• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_GREATER

pub fn get_humidity_callback_configuration(
    &self
) -> ConvertingReceiver<HumidityCallbackConfiguration>

Returns the receiver configuration as set by Set Humidity Receiver Configuration.

Associated constants:

• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_OFF
• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_OUTSIDE
• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_INSIDE
• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_SMALLER
• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_GREATER

pub fn get_temperature(&self) -> ConvertingReceiver<i16>

Returns the temperature measured by the sensor. The value has a range of -4000 to 16500 and is given in °C/100, i.e. a value of 3200 means that a temperature of 32.00 °C is measured.

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

pub fn set_temperature_callback_configuration(
    &self,
    period: u32,
    value_has_to_change: bool,
    option: char,
    min: i16,
    max: i16
) -> ConvertingReceiver<()>

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

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

Associated constants:

• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_OFF
• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_OUTSIDE
• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_INSIDE
• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_SMALLER
• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_GREATER

pub fn get_temperature_callback_configuration(
    &self
) -> ConvertingReceiver<TemperatureCallbackConfiguration>

Returns the receiver configuration as set by Set Temperature Receiver Configuration.

Associated constants:

• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_OFF
• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_OUTSIDE
• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_INSIDE
• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_SMALLER
• HUMIDITY_V2BRICKLET_THRESHOLD_OPTION_GREATER

pub fn set_heater_configuration(
    &self,
    heater_config: u8
) -> ConvertingReceiver<()>

Enables/disables the heater. The heater can be used to dry the sensor in extremely wet conditions.

By default the heater is disabled.

Associated constants:

• HUMIDITY_V2BRICKLET_HEATER_CONFIG_DISABLED
• HUMIDITY_V2BRICKLET_HEATER_CONFIG_ENABLED

pub fn get_heater_configuration(&self) -> ConvertingReceiver<u8>

Returns the heater configuration as set by Set Heater Configuration.

Associated constants:

• HUMIDITY_V2BRICKLET_HEATER_CONFIG_DISABLED
• HUMIDITY_V2BRICKLET_HEATER_CONFIG_ENABLED

pub fn set_moving_average_configuration(
    &self,
    moving_average_length_humidity: u16,
    moving_average_length_temperature: u16
) -> ConvertingReceiver<()>

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.

The range for the averaging is 1-1000.

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.

The default value is 5.

* 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!

pub fn get_moving_average_configuration(
    &self
) -> ConvertingReceiver<MovingAverageConfiguration>

Returns the moving average configuration as set by Set Moving Average Configuration.

pub fn set_samples_per_second(&self, sps: u8) -> ConvertingReceiver<()>

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_V2BRICKLET_SPS_20
• HUMIDITY_V2BRICKLET_SPS_10
• HUMIDITY_V2BRICKLET_SPS_5
• HUMIDITY_V2BRICKLET_SPS_1
• HUMIDITY_V2BRICKLET_SPS_02
• HUMIDITY_V2BRICKLET_SPS_01

pub fn get_samples_per_second(&self) -> ConvertingReceiver<u8>

Returnes the samples per second, as set by Set Samples Per Second.

.. versionadded:: 2.0.3$nbsp;(Plugin)

Associated constants:

• HUMIDITY_V2BRICKLET_SPS_20
• HUMIDITY_V2BRICKLET_SPS_10
• HUMIDITY_V2BRICKLET_SPS_5
• HUMIDITY_V2BRICKLET_SPS_1
• HUMIDITY_V2BRICKLET_SPS_02
• HUMIDITY_V2BRICKLET_SPS_01

pub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount>

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.

pub fn set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8>

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_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• HUMIDITY_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE
• HUMIDITY_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• HUMIDITY_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• HUMIDITY_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
• HUMIDITY_V2BRICKLET_BOOTLOADER_STATUS_OK
• HUMIDITY_V2BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
• HUMIDITY_V2BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
• HUMIDITY_V2BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
• HUMIDITY_V2BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
• HUMIDITY_V2BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>

Returns the current bootloader mode, see Set Bootloader Mode.

Associated constants:

• HUMIDITY_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• HUMIDITY_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE
• HUMIDITY_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• HUMIDITY_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• HUMIDITY_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

pub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>

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.

pub fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>

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.

pub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()>

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_V2BRICKLET_STATUS_LED_CONFIG_OFF
• HUMIDITY_V2BRICKLET_STATUS_LED_CONFIG_ON
• HUMIDITY_V2BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• HUMIDITY_V2BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub fn get_status_led_config(&self) -> ConvertingReceiver<u8>

Returns the configuration as set by Set Status LED Config

Associated constants:

• HUMIDITY_V2BRICKLET_STATUS_LED_CONFIG_OFF
• HUMIDITY_V2BRICKLET_STATUS_LED_CONFIG_ON
• HUMIDITY_V2BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• HUMIDITY_V2BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>

Returns the temperature in °C 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.

pub fn reset(&self) -> ConvertingReceiver<()>

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!

pub fn write_uid(&self, uid: u32) -> ConvertingReceiver<()>

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.

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

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

pub fn get_identity(&self) -> ConvertingReceiver<Identity>

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_constant|

Trait Implementations

impl Clone for HumidityV2Bricklet

fn clone(&self) -> HumidityV2Bricklet

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.