Struct ThermocoupleBricklet

pub struct ThermocoupleBricklet { /* private fields */ }

Measures temperature with thermocouples

Implementations

impl ThermocoupleBricklet

pub const DEVICE_IDENTIFIER: u16 = 266u16

pub const DEVICE_DISPLAY_NAME: &'static str = "Thermocouple Bricklet"

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

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

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

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

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

This receiver is triggered periodically with the period that is set by set_temperature_callback_period. The parameter is the temperature of the thermocouple.

The get_temperature_callback_receiver receiver is only triggered if the temperature has changed since the last triggering.

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

This receiver is triggered when the threshold as set by [set_temperature_callback_threshold] is reached. The parameter is the temperature of the thermocouple.

If the threshold keeps being reached, the receiver is triggered periodically with the period as set by [set_debounce_period].

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

This Receiver is triggered every time the error state changes (see [get_error_state]).

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

Returns the temperature of the thermocouple.

If you want to get the temperature periodically, it is recommended to use the [get_temperature_callback_receiver] receiver and set the period with [set_temperature_callback_period].

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

Sets the period with which the [get_temperature_callback_receiver] receiver is triggered periodically. A value of 0 turns the receiver off.

The [get_temperature_callback_receiver] receiver is only triggered if the temperature has changed since the last triggering.

pub async fn get_temperature_callback_period( &mut self, ) -> Result<u32, TinkerforgeError>

Returns the period as set by [set_temperature_callback_period].

pub async fn set_temperature_callback_threshold( &mut self, option: char, min: i32, max: i32, ) -> Result<(), TinkerforgeError>

Sets the thresholds for the [get_temperature_reached_callback_receiver] receiver.

The following options are possible:

Option	Description
‘x’	Receiver is turned off
‘o’	Receiver is triggered when the temperature is outside the min and max values
‘i’	Receiver is triggered when the temperature is inside the min and max values
‘<’	Receiver is triggered when the temperature is smaller than the min value (max is ignored)
‘>’	Receiver is triggered when the temperature is greater than the min value (max is ignored)

Associated constants:

• THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_OFF
• THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_INSIDE
• THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_SMALLER
• THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_GREATER

pub async fn get_temperature_callback_threshold( &mut self, ) -> Result<TemperatureCallbackThreshold, TinkerforgeError>

Returns the threshold as set by [set_temperature_callback_threshold].

Associated constants:

• THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_OFF
• THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_INSIDE
• THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_SMALLER
• THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_GREATER

pub async fn set_debounce_period( &mut self, debounce: u32, ) -> Result<(), TinkerforgeError>

Sets the period with which the threshold receiver

• [get_temperature_reached_callback_receiver]

is triggered, if the threshold

• [set_temperature_callback_threshold]

keeps being reached.

pub async fn get_debounce_period(&mut self) -> Result<u32, TinkerforgeError>

Returns the debounce period as set by [set_debounce_period].

pub async fn set_configuration( &mut self, averaging: u8, thermocouple_type: u8, filter: u8, ) -> Result<(), TinkerforgeError>

You can configure averaging size, thermocouple type and frequency filtering.

Available averaging sizes are 1, 2, 4, 8 and 16 samples.

As thermocouple type you can use B, E, J, K, N, R, S and T. If you have a different thermocouple or a custom thermocouple you can also use G8 and G32. With these types the returned value will not be in °C/100, it will be calculated by the following formulas:

• G8: value = 8 * 1.6 * 2^17 * Vin
• G32: value = 32 * 1.6 * 2^17 * Vin

where Vin is the thermocouple input voltage.

The frequency filter can be either configured to 50Hz or to 60Hz. You should configure it according to your utility frequency.

The conversion time depends on the averaging and filter configuration, it can be calculated as follows:

• 60Hz: time = 82 + (samples - 1) * 16.67
• 50Hz: time = 98 + (samples - 1) * 20

Associated constants:

• THERMOCOUPLE_BRICKLET_AVERAGING_1
• THERMOCOUPLE_BRICKLET_AVERAGING_2
• THERMOCOUPLE_BRICKLET_AVERAGING_4
• THERMOCOUPLE_BRICKLET_AVERAGING_8
• THERMOCOUPLE_BRICKLET_AVERAGING_16
• THERMOCOUPLE_BRICKLET_TYPE_B
• THERMOCOUPLE_BRICKLET_TYPE_E
• THERMOCOUPLE_BRICKLET_TYPE_J
• THERMOCOUPLE_BRICKLET_TYPE_K
• THERMOCOUPLE_BRICKLET_TYPE_N
• THERMOCOUPLE_BRICKLET_TYPE_R
• THERMOCOUPLE_BRICKLET_TYPE_S
• THERMOCOUPLE_BRICKLET_TYPE_T
• THERMOCOUPLE_BRICKLET_TYPE_G8
• THERMOCOUPLE_BRICKLET_TYPE_G32
• THERMOCOUPLE_BRICKLET_FILTER_OPTION_50HZ
• THERMOCOUPLE_BRICKLET_FILTER_OPTION_60HZ

pub async fn get_configuration( &mut self, ) -> Result<Configuration, TinkerforgeError>

Returns the configuration as set by [set_configuration].

Associated constants:

• THERMOCOUPLE_BRICKLET_AVERAGING_1
• THERMOCOUPLE_BRICKLET_AVERAGING_2
• THERMOCOUPLE_BRICKLET_AVERAGING_4
• THERMOCOUPLE_BRICKLET_AVERAGING_8
• THERMOCOUPLE_BRICKLET_AVERAGING_16
• THERMOCOUPLE_BRICKLET_TYPE_B
• THERMOCOUPLE_BRICKLET_TYPE_E
• THERMOCOUPLE_BRICKLET_TYPE_J
• THERMOCOUPLE_BRICKLET_TYPE_K
• THERMOCOUPLE_BRICKLET_TYPE_N
• THERMOCOUPLE_BRICKLET_TYPE_R
• THERMOCOUPLE_BRICKLET_TYPE_S
• THERMOCOUPLE_BRICKLET_TYPE_T
• THERMOCOUPLE_BRICKLET_TYPE_G8
• THERMOCOUPLE_BRICKLET_TYPE_G32
• THERMOCOUPLE_BRICKLET_FILTER_OPTION_50HZ
• THERMOCOUPLE_BRICKLET_FILTER_OPTION_60HZ

pub async fn get_error_state(&mut self) -> Result<ErrorState, TinkerforgeError>

Returns the current error state. There are two possible errors:

• Over/Under Voltage and
• Open Circuit.

Over/Under Voltage happens for voltages below 0V or above 3.3V. In this case it is very likely that your thermocouple is defective. An Open Circuit error indicates that there is no thermocouple connected.

You can use the [get_error_state_callback_receiver] receiver to automatically get triggered when the error state changes.

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

impl Clone for ThermocoupleBricklet

fn clone(&self) -> ThermocoupleBricklet

Returns a duplicate of the value.

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

Performs copy-assignment from source.