Struct tinkerforge::analog_in_v3_bricklet::AnalogInV3Bricklet

source ·

pub struct AnalogInV3Bricklet { /* private fields */ }

Expand description

Measures DC voltage between 0V and 42V

Implementations

source

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

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: AnalogInV3BrickletFunction
) -> 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.

source

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

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_voltage_callback_receiver(&self) -> ConvertingCallbackReceiver<u16>

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

The parameter is the same as Get Voltage.

source

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

Returns the measured voltage. The value is in mV and between 0V and 42V. The resolution is approximately 10mV to 1mV depending on the oversampling configuration (Set Oversampling).

If you want to get the value periodically, it is recommended to use the get_voltage_callback_receiver receiver. You can set the receiver configuration with Set Voltage Receiver Configuration.

source

pub fn set_voltage_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_voltage_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_voltage_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:

ANALOG_IN_V3BRICKLET_THRESHOLD_OPTION_OFF
ANALOG_IN_V3BRICKLET_THRESHOLD_OPTION_OUTSIDE
ANALOG_IN_V3BRICKLET_THRESHOLD_OPTION_INSIDE
ANALOG_IN_V3BRICKLET_THRESHOLD_OPTION_SMALLER
ANALOG_IN_V3BRICKLET_THRESHOLD_OPTION_GREATER

source

pub fn get_voltage_callback_configuration(
&self
) -> ConvertingReceiver<VoltageCallbackConfiguration>

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

Associated constants:

ANALOG_IN_V3BRICKLET_THRESHOLD_OPTION_OFF
ANALOG_IN_V3BRICKLET_THRESHOLD_OPTION_OUTSIDE
ANALOG_IN_V3BRICKLET_THRESHOLD_OPTION_INSIDE
ANALOG_IN_V3BRICKLET_THRESHOLD_OPTION_SMALLER
ANALOG_IN_V3BRICKLET_THRESHOLD_OPTION_GREATER

source

pub fn set_oversampling(&self, oversampling: u8) -> ConvertingReceiver<()>

Sets the oversampling between 32x and 16384x. The Bricklet takes one 12bit sample every 17.5µs. Thus an oversampling of 32x is equivalent to an integration time of 0.56ms and a oversampling of 16384x is equivalent to an integration time of 286ms.

The oversampling uses the moving average principle. A new value is always calculated once per millisecond.

With increased oversampling the noise decreases. With decreased oversampling the reaction time increases (changes in voltage will be measured faster).

The default value is 4096x.

Associated constants:

ANALOG_IN_V3BRICKLET_OVERSAMPLING_32
ANALOG_IN_V3BRICKLET_OVERSAMPLING_64
ANALOG_IN_V3BRICKLET_OVERSAMPLING_128
ANALOG_IN_V3BRICKLET_OVERSAMPLING_256
ANALOG_IN_V3BRICKLET_OVERSAMPLING_512
ANALOG_IN_V3BRICKLET_OVERSAMPLING_1024
ANALOG_IN_V3BRICKLET_OVERSAMPLING_2048
ANALOG_IN_V3BRICKLET_OVERSAMPLING_4096
ANALOG_IN_V3BRICKLET_OVERSAMPLING_8192
ANALOG_IN_V3BRICKLET_OVERSAMPLING_16384

source

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

Returns the oversampling value as set by Set Oversampling.

Associated constants:

ANALOG_IN_V3BRICKLET_OVERSAMPLING_32
ANALOG_IN_V3BRICKLET_OVERSAMPLING_64
ANALOG_IN_V3BRICKLET_OVERSAMPLING_128
ANALOG_IN_V3BRICKLET_OVERSAMPLING_256
ANALOG_IN_V3BRICKLET_OVERSAMPLING_512
ANALOG_IN_V3BRICKLET_OVERSAMPLING_1024
ANALOG_IN_V3BRICKLET_OVERSAMPLING_2048
ANALOG_IN_V3BRICKLET_OVERSAMPLING_4096
ANALOG_IN_V3BRICKLET_OVERSAMPLING_8192
ANALOG_IN_V3BRICKLET_OVERSAMPLING_16384

source

pub fn set_calibration(
 &self,
 offset: i16,
 multiplier: u16,
 divisor: u16
) -> ConvertingReceiver<()>

Sets a calibration for the measured voltage value. The formula for the calibration is as follows::

Calibrated Value = (Value + Offset) * Multiplier / Divisor

We recommend that you use the Brick Viewer to calibrate the Bricklet. The calibration will be saved internally and only has to be done once.

source

pub fn get_calibration(&self) -> ConvertingReceiver<Calibration>

Returns the calibration as set by Set Calibration.

source

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.

source

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:

ANALOG_IN_V3BRICKLET_BOOTLOADER_MODE_BOOTLOADER
ANALOG_IN_V3BRICKLET_BOOTLOADER_MODE_FIRMWARE
ANALOG_IN_V3BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
ANALOG_IN_V3BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
ANALOG_IN_V3BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
ANALOG_IN_V3BRICKLET_BOOTLOADER_STATUS_OK
ANALOG_IN_V3BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
ANALOG_IN_V3BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
ANALOG_IN_V3BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
ANALOG_IN_V3BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
ANALOG_IN_V3BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

source

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

Returns the current bootloader mode, see Set Bootloader Mode.

Associated constants:

ANALOG_IN_V3BRICKLET_BOOTLOADER_MODE_BOOTLOADER
ANALOG_IN_V3BRICKLET_BOOTLOADER_MODE_FIRMWARE
ANALOG_IN_V3BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
ANALOG_IN_V3BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
ANALOG_IN_V3BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

source

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.

source

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.

source

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:

ANALOG_IN_V3BRICKLET_STATUS_LED_CONFIG_OFF
ANALOG_IN_V3BRICKLET_STATUS_LED_CONFIG_ON
ANALOG_IN_V3BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
ANALOG_IN_V3BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

source

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

Returns the configuration as set by Set Status LED Config

Associated constants:

ANALOG_IN_V3BRICKLET_STATUS_LED_CONFIG_OFF
ANALOG_IN_V3BRICKLET_STATUS_LED_CONFIG_ON
ANALOG_IN_V3BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
ANALOG_IN_V3BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

source

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.

source