Struct Co2V2Bricklet

Source

pub struct Co2V2Bricklet { /* private fields */ }

Expand description

Measures CO2 concentration, temperature and humidity

Implementations§

Source §

pub fn new(uid: Uid, connection: AsyncIpConnection) -> Co2V2Bricklet

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: Co2V2BrickletFunction, ) -> 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.

Source

pub fn set_response_expected( &mut self, fun: Co2V2BrickletFunction, 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.

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

Source

pub async fn get_all_values_callback_receiver( &mut self, ) -> impl Stream<Item = AllValuesEvent>

This receiver is triggered periodically according to the configuration set by set_all_values_callback_configuration.

The parameters are the same as get_all_values.

§Note

The sensor is able to messure up to 120 °C. However it is only specified up to 70 °C. Exposing the Bricklet to higher temperatures might result in permanent damage.

Source

pub async fn get_co2_concentration_callback_receiver( &mut self, ) -> impl Stream<Item = u16>

This receiver is triggered periodically according to the configuration set by [set_co2_concentration_callback_configuration].

The parameter is the same as [get_co2_concentration].

Source

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

Source

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

Source

pub async fn get_all_values(&mut self) -> Result<AllValues, TinkerforgeError>

Returns all values measured by the CO2 Bricklet 2.0.

If you want to get the values periodically, it is recommended to use the [get_all_values_callback_receiver] receiver. You can set the receiver configuration with [set_all_values_callback_configuration].

§Note

The sensor is able to messure up to 120 °C. However it is only specified up to 70 °C. Exposing the Bricklet to higher temperatures might result in permanent damage.

Source

pub async fn set_air_pressure( &mut self, air_pressure: u16, ) -> Result<(), TinkerforgeError>

The CO2 concentration depends (among other things) on the ambient air pressure.

To increase the accuracy of the CO2 Bricklet 2.0 you can set the current air pressure. You use the Barometer Bricklet 2.0 or the Air Quality Bricklet to get the current air pressure.

By default air pressure compensation is disabled. Once you set a value it will be used for compensation. You can turn the compensation off again by setting the value to 0.

It is sufficient to update the value every few minutes.

Source

pub async fn get_air_pressure(&mut self) -> Result<u16, TinkerforgeError>

Returns the ambient air pressure as set by [set_air_pressure].

Source

pub async fn set_temperature_offset( &mut self, offset: u16, ) -> Result<(), TinkerforgeError>

Sets a temperature offset. A offset of 10 will decrease the measured temperature by 0.1 °C.

If you install this Bricklet into an enclosure and you want to measure the ambient temperature, you may have to decrease the measured temperature by some value to compensate for the error because of the heating inside of the enclosure.

We recommend that you leave the parts in the enclosure running for at least 24 hours such that a temperature equilibrium can be reached. After that you can measure the temperature directly outside of enclosure and set the difference as offset.

This temperature offset is used to calculate the relative humidity and CO2 concentration. In case the Bricklet is installed in an enclosure, we recommend to measure and set the temperature offset to improve the accuracy of the measurements.

It is sufficient to set the temperature offset once. The offset is saved in non-volatile memory and is applied again after a power loss.

Source

pub async fn get_temperature_offset(&mut self) -> Result<u16, TinkerforgeError>

Returns the temperature offset as set by [set_temperature_offset].

Source

pub async fn set_all_values_callback_configuration( &mut self, period: u32, value_has_to_change: bool, ) -> Result<(), TinkerforgeError>

The period is the period with which the [get_all_values_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 at least one of the values has changed. If the values 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.

Source

pub async fn get_all_values_callback_configuration( &mut self, ) -> Result<AllValuesCallbackConfiguration, TinkerforgeError>

Returns the receiver configuration as set by [set_all_values_callback_configuration].

Source

pub async fn get_co2_concentration(&mut self) -> Result<u16, TinkerforgeError>

Returns CO2 concentration.

If you want to get the value periodically, it is recommended to use the [get_co2_concentration_callback_receiver] receiver. You can set the receiver configuration with [set_co2_concentration_callback_configuration].

Source

pub async fn set_co2_concentration_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_co2_concentration_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_co2_concentration_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:

CO2_V2_BRICKLET_THRESHOLD_OPTION_OFF
CO2_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
CO2_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
CO2_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
CO2_V2_BRICKLET_THRESHOLD_OPTION_GREATER

Source

pub async fn get_co2_concentration_callback_configuration( &mut self, ) -> Result<Co2ConcentrationCallbackConfiguration, TinkerforgeError>

Returns the receiver configuration as set by [set_co2_concentration_callback_configuration].

Associated constants:

CO2_V2_BRICKLET_THRESHOLD_OPTION_OFF
CO2_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
CO2_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
CO2_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
CO2_V2_BRICKLET_THRESHOLD_OPTION_GREATER

Source

pub async fn get_temperature(&mut self) -> Result<i16, TinkerforgeError>

Returns temperature.

§Note

The sensor is able to messure up to 120 °C. However it is only specified up to 70 °C. Exposing the Bricklet to higher temperatures might result in permanent damage.

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

Source

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:

CO2_V2_BRICKLET_THRESHOLD_OPTION_OFF
CO2_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
CO2_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
CO2_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
CO2_V2_BRICKLET_THRESHOLD_OPTION_GREATER

Source

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:

CO2_V2_BRICKLET_THRESHOLD_OPTION_OFF
CO2_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
CO2_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
CO2_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
CO2_V2_BRICKLET_THRESHOLD_OPTION_GREATER

Source

pub async fn get_humidity(&mut self) -> Result<u16, TinkerforgeError>

Returns relative humidity.

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

Source

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:

CO2_V2_BRICKLET_THRESHOLD_OPTION_OFF
CO2_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
CO2_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
CO2_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
CO2_V2_BRICKLET_THRESHOLD_OPTION_GREATER

Source

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:

CO2_V2_BRICKLET_THRESHOLD_OPTION_OFF
CO2_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
CO2_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
CO2_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
CO2_V2_BRICKLET_THRESHOLD_OPTION_GREATER

Source

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.

Source

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:

CO2_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
CO2_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
CO2_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
CO2_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
CO2_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
CO2_V2_BRICKLET_BOOTLOADER_STATUS_OK
CO2_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
CO2_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
CO2_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
CO2_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
CO2_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

Source

pub async fn get_bootloader_mode(&mut self) -> Result<u8, TinkerforgeError>

Returns the current bootloader mode, see [set_bootloader_mode].

Associated constants:

CO2_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
CO2_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
CO2_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
CO2_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
CO2_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

Source

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.

Source

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.

Source

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:

CO2_V2_BRICKLET_STATUS_LED_CONFIG_OFF
CO2_V2_BRICKLET_STATUS_LED_CONFIG_ON
CO2_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
CO2_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

Source

pub async fn get_status_led_config(&mut self) -> Result<u8, TinkerforgeError>

Returns the configuration as set by [set_status_led_config]

Associated constants:

CO2_V2_BRICKLET_STATUS_LED_CONFIG_OFF
CO2_V2_BRICKLET_STATUS_LED_CONFIG_ON
CO2_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
CO2_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

Source

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.

Source