pub struct ThermocoupleV2Bricklet { /* private fields */ }
Expand description
Measures temperature with thermocouples
Implementations
sourceimpl ThermocoupleV2Bricklet
impl ThermocoupleV2Bricklet
pub const DEVICE_IDENTIFIER: u16 = 2_109u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Thermocouple Bricklet 2.0"
sourcepub fn new(uid: &str, ip_connection: &IpConnection) -> ThermocoupleV2Bricklet
pub fn new(uid: &str, ip_connection: &IpConnection) -> ThermocoupleV2Bricklet
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: ThermocoupleV2BrickletFunction
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected(
&mut self,
fun: ThermocoupleV2BrickletFunction
) -> 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.
sourcepub fn set_response_expected(
&mut self,
fun: ThermocoupleV2BrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected(
&mut self,
fun: ThermocoupleV2BrickletFunction,
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.
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_temperature_callback_receiver(
&self
) -> ConvertingCallbackReceiver<i32>
pub fn get_temperature_callback_receiver(
&self
) -> ConvertingCallbackReceiver<i32>
This receiver is triggered periodically according to the configuration set by
Set Temperature Receiver Configuration
.
The parameter is the same as Get Temperature
.
sourcepub fn get_error_state_callback_receiver(
&self
) -> ConvertingCallbackReceiver<ErrorStateEvent>
pub fn get_error_state_callback_receiver(
&self
) -> ConvertingCallbackReceiver<ErrorStateEvent>
This Receiver is triggered every time the error state changes
(see Get Error State
).
sourcepub fn get_temperature(&self) -> ConvertingReceiver<i32>
pub fn get_temperature(&self) -> ConvertingReceiver<i32>
Returns the temperature of the thermocouple. The value is given in °C/100, e.g. a value of 4223 means that a temperature of 42.23 °C is measured.
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 Receiver Configuration
.
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
.
sourcepub fn set_temperature_callback_configuration(
&self,
period: u32,
value_has_to_change: bool,
option: char,
min: i32,
max: i32
) -> ConvertingReceiver<()>
pub fn set_temperature_callback_configuration(
&self,
period: u32,
value_has_to_change: bool,
option: char,
min: i32,
max: i32
) -> 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:
- THERMOCOUPLE_V2BRICKLET_THRESHOLD_OPTION_OFF
- THERMOCOUPLE_V2BRICKLET_THRESHOLD_OPTION_OUTSIDE
- THERMOCOUPLE_V2BRICKLET_THRESHOLD_OPTION_INSIDE
- THERMOCOUPLE_V2BRICKLET_THRESHOLD_OPTION_SMALLER
- THERMOCOUPLE_V2BRICKLET_THRESHOLD_OPTION_GREATER
sourcepub fn get_temperature_callback_configuration(
&self
) -> ConvertingReceiver<TemperatureCallbackConfiguration>
pub fn get_temperature_callback_configuration(
&self
) -> ConvertingReceiver<TemperatureCallbackConfiguration>
Returns the receiver configuration as set by Set Temperature Receiver Configuration
.
Associated constants:
- THERMOCOUPLE_V2BRICKLET_THRESHOLD_OPTION_OFF
- THERMOCOUPLE_V2BRICKLET_THRESHOLD_OPTION_OUTSIDE
- THERMOCOUPLE_V2BRICKLET_THRESHOLD_OPTION_INSIDE
- THERMOCOUPLE_V2BRICKLET_THRESHOLD_OPTION_SMALLER
- THERMOCOUPLE_V2BRICKLET_THRESHOLD_OPTION_GREATER
sourcepub fn set_configuration(
&self,
averaging: u8,
thermocouple_type: u8,
filter: u8
) -> ConvertingReceiver<()>
pub fn set_configuration(
&self,
averaging: u8,
thermocouple_type: u8,
filter: u8
) -> ConvertingReceiver<()>
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
The default configuration is 16 samples, K type and 50Hz.
Associated constants:
- THERMOCOUPLE_V2BRICKLET_AVERAGING_1
- THERMOCOUPLE_V2BRICKLET_AVERAGING_2
- THERMOCOUPLE_V2BRICKLET_AVERAGING_4
- THERMOCOUPLE_V2BRICKLET_AVERAGING_8
- THERMOCOUPLE_V2BRICKLET_AVERAGING_16
- THERMOCOUPLE_V2BRICKLET_TYPE_B
- THERMOCOUPLE_V2BRICKLET_TYPE_E
- THERMOCOUPLE_V2BRICKLET_TYPE_J
- THERMOCOUPLE_V2BRICKLET_TYPE_K
- THERMOCOUPLE_V2BRICKLET_TYPE_N
- THERMOCOUPLE_V2BRICKLET_TYPE_R
- THERMOCOUPLE_V2BRICKLET_TYPE_S
- THERMOCOUPLE_V2BRICKLET_TYPE_T
- THERMOCOUPLE_V2BRICKLET_TYPE_G8
- THERMOCOUPLE_V2BRICKLET_TYPE_G32
- THERMOCOUPLE_V2BRICKLET_FILTER_OPTION_50HZ
- THERMOCOUPLE_V2BRICKLET_FILTER_OPTION_60HZ
sourcepub fn get_configuration(&self) -> ConvertingReceiver<Configuration>
pub fn get_configuration(&self) -> ConvertingReceiver<Configuration>
Returns the configuration as set by Set Configuration
.
Associated constants:
- THERMOCOUPLE_V2BRICKLET_AVERAGING_1
- THERMOCOUPLE_V2BRICKLET_AVERAGING_2
- THERMOCOUPLE_V2BRICKLET_AVERAGING_4
- THERMOCOUPLE_V2BRICKLET_AVERAGING_8
- THERMOCOUPLE_V2BRICKLET_AVERAGING_16
- THERMOCOUPLE_V2BRICKLET_TYPE_B
- THERMOCOUPLE_V2BRICKLET_TYPE_E
- THERMOCOUPLE_V2BRICKLET_TYPE_J
- THERMOCOUPLE_V2BRICKLET_TYPE_K
- THERMOCOUPLE_V2BRICKLET_TYPE_N
- THERMOCOUPLE_V2BRICKLET_TYPE_R
- THERMOCOUPLE_V2BRICKLET_TYPE_S
- THERMOCOUPLE_V2BRICKLET_TYPE_T
- THERMOCOUPLE_V2BRICKLET_TYPE_G8
- THERMOCOUPLE_V2BRICKLET_TYPE_G32
- THERMOCOUPLE_V2BRICKLET_FILTER_OPTION_50HZ
- THERMOCOUPLE_V2BRICKLET_FILTER_OPTION_60HZ
sourcepub fn get_error_state(&self) -> ConvertingReceiver<ErrorState>
pub fn get_error_state(&self) -> ConvertingReceiver<ErrorState>
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.
sourcepub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount>
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.
sourcepub fn set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8>
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:
- THERMOCOUPLE_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER
- THERMOCOUPLE_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE
- THERMOCOUPLE_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- THERMOCOUPLE_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- THERMOCOUPLE_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
- THERMOCOUPLE_V2BRICKLET_BOOTLOADER_STATUS_OK
- THERMOCOUPLE_V2BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
- THERMOCOUPLE_V2BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
- THERMOCOUPLE_V2BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
- THERMOCOUPLE_V2BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
- THERMOCOUPLE_V2BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH
sourcepub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>
pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>
Returns the current bootloader mode, see Set Bootloader Mode
.
Associated constants:
- THERMOCOUPLE_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER
- THERMOCOUPLE_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE
- THERMOCOUPLE_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- THERMOCOUPLE_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- THERMOCOUPLE_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
sourcepub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>
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.
sourcepub fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>
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.
sourcepub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()>
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:
- THERMOCOUPLE_V2BRICKLET_STATUS_LED_CONFIG_OFF
- THERMOCOUPLE_V2BRICKLET_STATUS_LED_CONFIG_ON
- THERMOCOUPLE_V2BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
- THERMOCOUPLE_V2BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
sourcepub fn get_status_led_config(&self) -> ConvertingReceiver<u8>
pub fn get_status_led_config(&self) -> ConvertingReceiver<u8>
Returns the configuration as set by Set Status LED Config
Associated constants:
- THERMOCOUPLE_V2BRICKLET_STATUS_LED_CONFIG_OFF
- THERMOCOUPLE_V2BRICKLET_STATUS_LED_CONFIG_ON
- THERMOCOUPLE_V2BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
- THERMOCOUPLE_V2BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
sourcepub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>
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.
sourcepub fn reset(&self) -> ConvertingReceiver<()>
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!
sourcepub fn write_uid(&self, uid: u32) -> ConvertingReceiver<()>
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.
sourcepub fn read_uid(&self) -> ConvertingReceiver<u32>
pub fn read_uid(&self) -> ConvertingReceiver<u32>
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
sourcepub fn get_identity(&self) -> ConvertingReceiver<Identity>
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
sourceimpl Clone for ThermocoupleV2Bricklet
impl Clone for ThermocoupleV2Bricklet
sourcefn clone(&self) -> ThermocoupleV2Bricklet
fn clone(&self) -> ThermocoupleV2Bricklet
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more