Software / API Bindings / Rust / API Reference and Examples / Bricklets / Industrial Dual 0-20mA Bricklet 2.0

Rust - Industrial Dual 0-20mA Bricklet 2.0¶

This is the description of the Rust API bindings for the Industrial Dual 0-20mA Bricklet 2.0. General information and technical specifications for the Industrial Dual 0-20mA Bricklet 2.0 are summarized in its hardware description.

An installation guide for the Rust API bindings is part of their general description. Additional documentation can be found on docs.rs.

Examples¶

The example code below is Public Domain (CC0 1.0).

Simple¶

Download (example_simple.rs)

use std::{error::Error, io};

use tinkerforge::{industrial_dual_0_20ma_v2_bricklet::*, ip_connection::IpConnection};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let id020 = IndustrialDual020maV2Bricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    // Get current current from channel 0.
    let current = id020.get_current(0).recv()?;
    println!("Current (Channel 0): {} mA", current as f32 / 1000000.0);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Callback¶

Download (example_callback.rs)

use std::{error::Error, io, thread};
use tinkerforge::{industrial_dual_0_20ma_v2_bricklet::*, ip_connection::IpConnection};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let id020 = IndustrialDual020maV2Bricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    let current_receiver = id020.get_current_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `id020` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for current in current_receiver {
            println!("Channel: {}", current.channel);
            println!("Current: {} mA", current.current as f32 / 1000000.0);
            println!();
        }
    });

    // Set period for current (channel 0) callback to 1s (1000ms) without a threshold.
    id020.set_current_callback_configuration(0, 1000, false, 'x', 0, 0);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Threshold¶

Download (example_threshold.rs)

use std::{error::Error, io, thread};
use tinkerforge::{industrial_dual_0_20ma_v2_bricklet::*, ip_connection::IpConnection};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let id020 = IndustrialDual020maV2Bricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    let current_receiver = id020.get_current_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `id020` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for current in current_receiver {
            println!("Channel: {}", current.channel);
            println!("Current: {} mA", current.current as f32 / 1000000.0);
            println!();
        }
    });

    // Configure threshold for current (channel 0) "greater than 10 mA"
    // with a debounce period of 10s (10000ms).
    id020.set_current_callback_configuration(0, 10000, false, '>', 10 * 1000000, 0);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

API¶

To allow non-blocking usage, nearly every function of the Rust bindings returns a wrapper around a mpsc::Receiver. To block until the function has finished and get your result, call one of the receiver's recv variants. Those return either the result sent by the device, or any error occurred.

Functions returning a result directly will block until the device has finished processing the request.

All functions listed below are thread-safe, those which return a receiver are lock-free.

Basic Functions¶

pub fn IndustrialDual020maV2Bricklet::new(uid: &str, ip_connection: &IpConnection) → IndustrialDual020maV2Bricklet¶

Parameters:	uid – Type: &str ip_connection – Type: &IPConnection
Returns:	industrial_dual_0_20ma_v2 – Type: IndustrialDual020maV2Bricklet

Creates a new IndustrialDual020maV2Bricklet object with the unique device ID uid and adds it to the IPConnection ip_connection:

let industrial_dual_0_20ma_v2 = IndustrialDual020maV2Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

This device object can be used after the IP connection has been connected.

pub fn IndustrialDual020maV2Bricklet::get_current(&self, channel: u8) → ConvertingReceiver<i32>¶

Parameters:	channel – Type: u8, Range: [0 to 1]
Returns:	current – Type: i32, Unit: 1 nA, Range: [0 to 22505322]

Returns the current of the specified channel.

It is possible to detect if an IEC 60381-1 compatible sensor is connected and if it works probably.

If the returned current is below 4mA, there is likely no sensor connected or the connected sensor is defective. If the returned current is over 20mA, there might be a short circuit or the sensor is defective.

If you want to get the value periodically, it is recommended to use the IndustrialDual020maV2Bricklet::get_current_callback_receiver callback. You can set the callback configuration with IndustrialDual020maV2Bricklet::set_current_callback_configuration.

pub fn IndustrialDual020maV2Bricklet::set_channel_led_config(&self, channel: u8, config: u8) → ConvertingReceiver<()>¶

Parameters:	channel – Type: u8, Range: [0 to 1] config – Type: u8, Range: See constants, Default: 3

Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to "Channel Status". In this mode the LED can either be turned on with a pre-defined threshold or the intensity of the LED can change with the measured value.

You can configure the channel status behavior with IndustrialDual020maV2Bricklet::set_channel_led_status_config.

The following constants are available for this function:

For config:

INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_CHANNEL_LED_CONFIG_OFF = 0
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_CHANNEL_LED_CONFIG_ON = 1
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

pub fn IndustrialDual020maV2Bricklet::get_channel_led_config(&self, channel: u8) → ConvertingReceiver<u8>¶

Parameters:	channel – Type: u8, Range: [0 to 1]
Returns:	config – Type: u8, Range: See constants, Default: 3

Returns the channel LED configuration as set by IndustrialDual020maV2Bricklet::set_channel_led_config

The following constants are available for this function:

For config:

INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_CHANNEL_LED_CONFIG_OFF = 0
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_CHANNEL_LED_CONFIG_ON = 1
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

pub fn IndustrialDual020maV2Bricklet::set_channel_led_status_config(&self, channel: u8, min: i32, max: i32, config: u8) → ConvertingReceiver<()>¶

Parameters:	channel – Type: u8, Range: [0 to 1] min – Type: i32, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 4000000 max – Type: i32, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 20000000 config – Type: u8, Range: See constants, Default: 1

Sets the channel LED status config. This config is used if the channel LED is configured as "Channel Status", see IndustrialDual020maV2Bricklet::set_channel_led_config.

For each channel you can choose between threshold and intensity mode.

In threshold mode you can define a positive or a negative threshold. For a positive threshold set the "min" parameter to the threshold value in nA above which the LED should turn on and set the "max" parameter to 0. Example: If you set a positive threshold of 10mA, the LED will turn on as soon as the current exceeds 10mA and turn off again if it goes below 10mA. For a negative threshold set the "max" parameter to the threshold value in nA below which the LED should turn on and set the "min" parameter to 0. Example: If you set a negative threshold of 10mA, the LED will turn on as soon as the current goes below 10mA and the LED will turn off when the current exceeds 10mA.

In intensity mode you can define a range in nA that is used to scale the brightness of the LED. Example with min=4mA and max=20mA: The LED is off at 4mA and below, on at 20mA and above and the brightness is linearly scaled between the values 4mA and 20mA. If the min value is greater than the max value, the LED brightness is scaled the other way around.

The following constants are available for this function:

For config:

INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

pub fn IndustrialDual020maV2Bricklet::get_channel_led_status_config(&self, channel: u8) → ConvertingReceiver<ChannelLedStatusConfig>¶

Parameters:	channel – Type: u8, Range: [0 to 1]
Return Object:	min – Type: i32, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 4000000 max – Type: i32, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 20000000 config – Type: u8, Range: See constants, Default: 1

Returns the channel LED status configuration as set by IndustrialDual020maV2Bricklet::set_channel_led_status_config.

The following constants are available for this function:

For config:

INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

Advanced Functions¶

pub fn IndustrialDual020maV2Bricklet::set_sample_rate(&self, rate: u8) → ConvertingReceiver<()>¶

Parameters:	rate – Type: u8, Range: See constants, Default: 3

Sets the sample rate to either 240, 60, 15 or 4 samples per second. The resolution for the rates is 12, 14, 16 and 18 bit respectively.

Value	Description
0	240 samples per second, 12 bit resolution
1	60 samples per second, 14 bit resolution
2	15 samples per second, 16 bit resolution
3	4 samples per second, 18 bit resolution

The following constants are available for this function:

For rate:

INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_SAMPLE_RATE_240_SPS = 0
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_SAMPLE_RATE_60_SPS = 1
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_SAMPLE_RATE_15_SPS = 2
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_SAMPLE_RATE_4_SPS = 3

pub fn IndustrialDual020maV2Bricklet::get_sample_rate(&self) → ConvertingReceiver<u8>¶

Returns:	rate – Type: u8, Range: See constants, Default: 3

Returns the sample rate as set by IndustrialDual020maV2Bricklet::set_sample_rate.

The following constants are available for this function:

For rate:

INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_SAMPLE_RATE_240_SPS = 0
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_SAMPLE_RATE_60_SPS = 1
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_SAMPLE_RATE_15_SPS = 2
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_SAMPLE_RATE_4_SPS = 3

pub fn IndustrialDual020maV2Bricklet::set_gain(&self, gain: u8) → ConvertingReceiver<()>¶

Parameters:	gain – Type: u8, Range: See constants, Default: 0

Sets a gain between 1x and 8x. If you want to measure a very small current, you can increase the gain to get some more resolution.

Example: If you measure 0.5mA with a gain of 8x the return value will be 4mA.

The following constants are available for this function:

For gain:

INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_GAIN_1X = 0
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_GAIN_2X = 1
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_GAIN_4X = 2
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_GAIN_8X = 3

pub fn IndustrialDual020maV2Bricklet::get_gain(&self) → ConvertingReceiver<u8>¶

Returns:	gain – Type: u8, Range: See constants, Default: 0

Returns the gain as set by IndustrialDual020maV2Bricklet::set_gain.

The following constants are available for this function:

For gain:

INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_GAIN_1X = 0
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_GAIN_2X = 1
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_GAIN_4X = 2
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_GAIN_8X = 3

pub fn IndustrialDual020maV2Bricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>¶

Return Object:	error_count_ack_checksum – Type: u32, Range: [0 to 2³² - 1] error_count_message_checksum – Type: u32, Range: [0 to 2³² - 1] error_count_frame – Type: u32, Range: [0 to 2³² - 1] error_count_overflow – Type: u32, Range: [0 to 2³² - 1]

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 IndustrialDual020maV2Bricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>¶

Parameters:	config – Type: u8, Range: See constants, Default: 3

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.

The following constants are available for this function:

For config:

INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn IndustrialDual020maV2Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>¶

Returns:	config – Type: u8, Range: See constants, Default: 3

Returns the configuration as set by IndustrialDual020maV2Bricklet::set_status_led_config

The following constants are available for this function:

For config:

INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn IndustrialDual020maV2Bricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>¶

Returns:	temperature – Type: i16, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]

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.

pub fn IndustrialDual020maV2Bricklet::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 IndustrialDual020maV2Bricklet::get_identity(&self) → ConvertingReceiver<Identity>¶

Return Object:

Return Object:	uid – Type: String, Length: up to 8 connected_uid – Type: String, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardware_version – Type: [u8; 3] 0: major – Type: u8, Range: [0 to 255] 1: minor – Type: u8, Range: [0 to 255] 2: revision – Type: u8, Range: [0 to 255] firmware_version – Type: [u8; 3] 0: major – Type: u8, Range: [0 to 255] 1: minor – Type: u8, Range: [0 to 255] 2: revision – Type: u8, Range: [0 to 255] device_identifier – Type: u16, Range: [0 to 2¹⁶ - 1]

uid – Type: String, Length: up to 8
connected_uid – Type: String, Length: up to 8
position – Type: char, Range: ['a' to 'h', 'z']
hardware_version – Type: [u8; 3]

0: major – Type: u8, Range: [0 to 255]
1: minor – Type: u8, Range: [0 to 255]
2: revision – Type: u8, Range: [0 to 255]

firmware_version – Type: [u8; 3]

0: major – Type: u8, Range: [0 to 255]
1: minor – Type: u8, Range: [0 to 255]
2: revision – Type: u8, Range: [0 to 255]

device_identifier – Type: u16, Range: [0 to 2¹⁶ - 1]

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. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions¶

pub fn IndustrialDual020maV2Bricklet::set_current_callback_configuration(&self, channel: u8, period: u32, value_has_to_change: bool, option: char, min: i32, max: i32) → ConvertingReceiver<()>¶

Parameters:	channel – Type: u8, Range: [0 to 1] period – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: i32, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: i32, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 0

The period is the period with which the IndustrialDual020maV2Bricklet::get_current_callback_receiver callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the IndustrialDual020maV2Bricklet::get_current_callback_receiver callback.

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 callback is triggered with the fixed period.

The following constants are available for this function:

For option:

INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn IndustrialDual020maV2Bricklet::get_current_callback_configuration(&self, channel: u8) → ConvertingReceiver<CurrentCallbackConfiguration>¶

Parameters:	channel – Type: u8, Range: [0 to 1]
Return Object:	period – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: i32, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: i32, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the callback configuration as set by IndustrialDual020maV2Bricklet::set_current_callback_configuration.

The following constants are available for this function:

For option:

INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding get_*_callback_receiver function, which returns a receiver for callback events.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

pub fn IndustrialDual020maV2Bricklet::get_current_callback_receiver(&self) → ConvertingCallbackReceiver<CurrentEvent>¶

Event Object:	channel – Type: u8, Range: [0 to 1] current – Type: i32, Unit: 1 nA, Range: [0 to 22505322]

Receivers created with this function receive Current events.

This callback is triggered periodically according to the configuration set by IndustrialDual020maV2Bricklet::set_current_callback_configuration.

The received variable is the same as IndustrialDual020maV2Bricklet::get_current.

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

pub fn IndustrialDual020maV2Bricklet::get_api_version(&self) → [u8; 3]¶

Return Object:	api_version – Type: [u8; 3] 0: major – Type: u8, Range: [0 to 255] 1: minor – Type: u8, Range: [0 to 255] 2: revision – Type: u8, Range: [0 to 255]

Returns the version of the API definition 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 fn IndustrialDual020maV2Bricklet::get_response_expected(&mut self, function_id: u8) → bool¶

Parameters:	function_id – Type: u8, Range: See constants
Returns:	response_expected – Type: bool

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

The following constants are available for this function:

For function_id:

INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_FUNCTION_SET_SAMPLE_RATE = 5
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_FUNCTION_SET_GAIN = 7
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_FUNCTION_SET_CHANNEL_LED_CONFIG = 9
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 11
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_FUNCTION_RESET = 243
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_FUNCTION_WRITE_UID = 248

pub fn IndustrialDual020maV2Bricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()¶

Parameters:	function_id – Type: u8, Range: See constants response_expected – Type: bool

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.

The following constants are available for this function:

For function_id:

INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_FUNCTION_SET_SAMPLE_RATE = 5
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_FUNCTION_SET_GAIN = 7
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_FUNCTION_SET_CHANNEL_LED_CONFIG = 9
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 11
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_FUNCTION_RESET = 243
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_FUNCTION_WRITE_UID = 248

pub fn IndustrialDual020maV2Bricklet::set_response_expected_all(&mut self, response_expected: bool) → ()¶

Parameters:	response_expected – Type: bool

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

pub fn IndustrialDual020maV2Bricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>¶

Parameters:	mode – Type: u8, Range: See constants
Returns:	status – Type: u8, Range: See constants

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.

The following constants are available for this function:

For mode:

INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5

pub fn IndustrialDual020maV2Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>¶

Returns:	mode – Type: u8, Range: See constants

Returns the current bootloader mode, see IndustrialDual020maV2Bricklet::set_bootloader_mode.

The following constants are available for this function:

For mode:

INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
INDUSTRIAL_DUAL_0_20MA_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

pub fn IndustrialDual020maV2Bricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>¶

Parameters:	pointer – Type: u32, Unit: 1 B, Range: [0 to 2³² - 1]

Sets the firmware pointer for IndustrialDual020maV2Bricklet::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 IndustrialDual020maV2Bricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>¶

Parameters:	data – Type: [u8; 64], Range: [0 to 255]
Returns:	status – Type: u8, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by IndustrialDual020maV2Bricklet::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 IndustrialDual020maV2Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>¶

Parameters:	uid – Type: u32, Range: [0 to 2³² - 1]

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 IndustrialDual020maV2Bricklet::read_uid(&self) → ConvertingReceiver<u32>¶

Returns:	uid – Type: u32, Range: [0 to 2³² - 1]

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

Constants¶

pub const IndustrialDual020maV2Bricklet::DEVICE_IDENTIFIER¶

This constant is used to identify a Industrial Dual 0-20mA Bricklet 2.0.

The IndustrialDual020maV2Bricklet::get_identity function and the IpConnection::get_enumerate_callback_receiver callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

pub const IndustrialDual020maV2Bricklet::DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Industrial Dual 0-20mA Bricklet 2.0.