Software / API Bindings / Rust / API Reference and Examples / Bricklets / Industrial Digital In 4 Bricklet 2.0

Rust - Industrial Digital In 4 Bricklet 2.0¶

This is the description of the Rust API bindings for the Industrial Digital In 4 Bricklet 2.0. General information and technical specifications for the Industrial Digital In 4 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_digital_in_4_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 Digital In 4 Bricklet 2.0.

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

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

    // Get current value.
    let value = idi4.get_value().recv()?;

    println!("Channel 0: {}", value[0]);
    println!("Channel 1: {}", value[1]);
    println!("Channel 2: {}", value[2]);
    println!("Channel 3: {}", value[3]);

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

Edge Count¶

Download (example_edge_count.rs)

use std::{error::Error, io, thread, time::Duration};
use tinkerforge::{industrial_digital_in_4_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 Digital In 4 Bricklet 2.0.

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

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

    // Configure rising edge count (channel 3) with 10ms debounce
    idi4.set_edge_count_configuration(3, 0, 10).recv()?;

    // Get edge count 10 times with 1s delay
    for _i in 0..10 {
        thread::sleep(Duration::from_millis(1000));

        // Get current edge count.
        let count = idi4.get_edge_count(3, false).recv()?;
        println!("Count: {}", count);
    }

    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_digital_in_4_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 Digital In 4 Bricklet 2.0.

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

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

    let value_receiver = idi4.get_value_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `idi4` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for value in value_receiver {
            if value.channel == INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_0 {
                println!("Channel: 0");
            } else if value.channel == INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_1 {
                println!("Channel: 1");
            } else if value.channel == INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_2 {
                println!("Channel: 2");
            } else if value.channel == INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_3 {
                println!("Channel: 3");
            }

            println!("Changed: {}", value.changed);
            println!("Value: {}", value.value);
            println!();
        }
    });

    // Set period for value (channel 1) callback to 0.1s (100ms).
    idi4.set_value_callback_configuration(1, 100, false);

    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 IndustrialDigitalIn4V2Bricklet::new(uid: &str, ip_connection: &IpConnection) → IndustrialDigitalIn4V2Bricklet¶

Parameters:	uid – Type: &str ip_connection – Type: &IPConnection
Returns:	industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2Bricklet

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

let industrial_digital_in_4_v2 = IndustrialDigitalIn4V2Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn IndustrialDigitalIn4V2Bricklet::get_value(&self) → ConvertingReceiver<[bool; 4]>¶

Returns:	value – Type: [bool; 4]

Returns the input value as bools, true refers to high and false refers to low.

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

Parameters:	channel – Type: u8, Range: See constants 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 is on if the channel is high and off otherwise.

By default all channel LEDs are configured as "Channel Status".

The following constants are available for this function:

For channel:

INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_0 = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_1 = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_2 = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_3 = 3

For config:

INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_LED_CONFIG_OFF = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_LED_CONFIG_ON = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

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

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

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

The following constants are available for this function:

For channel:

INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_0 = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_1 = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_2 = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_3 = 3

For config:

INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_LED_CONFIG_OFF = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_LED_CONFIG_ON = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Advanced Functions¶

pub fn IndustrialDigitalIn4V2Bricklet::get_edge_count(&self, channel: u8, reset_counter: bool) → ConvertingReceiver<u32>¶

Parameters:	channel – Type: u8, Range: See constants reset_counter – Type: bool
Returns:	count – Type: u32, Range: [0 to 2³² - 1]

Returns the current value of the edge counter for the selected channel. You can configure the edges that are counted with IndustrialDigitalIn4V2Bricklet::set_edge_count_configuration.

If you set the reset counter to true, the count is set back to 0 directly after it is read.

The following constants are available for this function:

For channel:

INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_0 = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_1 = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_2 = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_3 = 3

pub fn IndustrialDigitalIn4V2Bricklet::set_edge_count_configuration(&self, channel: u8, edge_type: u8, debounce: u8) → ConvertingReceiver<()>¶

Parameters:	channel – Type: u8, Range: See constants edge_type – Type: u8, Range: See constants, Default: 0 debounce – Type: u8, Unit: 1 ms, Range: [0 to 255], Default: 100

Configures the edge counter for a specific channel.

The edge type parameter configures if rising edges, falling edges or both are counted. Possible edge types are:

0 = rising
1 = falling
2 = both

Configuring an edge counter resets its value to 0.

If you don't know what any of this means, just leave it at default. The default configuration is very likely OK for you.

The following constants are available for this function:

For channel:

INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_0 = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_1 = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_2 = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_3 = 3

For edge_type:

INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_EDGE_TYPE_RISING = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_EDGE_TYPE_FALLING = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_EDGE_TYPE_BOTH = 2

pub fn IndustrialDigitalIn4V2Bricklet::get_edge_count_configuration(&self, channel: u8) → ConvertingReceiver<EdgeCountConfiguration>¶

Parameters:	channel – Type: u8, Range: See constants
Return Object:	edge_type – Type: u8, Range: See constants, Default: 0 debounce – Type: u8, Unit: 1 ms, Range: [0 to 255], Default: 100

Returns the edge type and debounce time for the selected channel as set by IndustrialDigitalIn4V2Bricklet::set_edge_count_configuration.

The following constants are available for this function:

For channel:

INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_0 = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_1 = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_2 = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_3 = 3

For edge_type:

INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_EDGE_TYPE_RISING = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_EDGE_TYPE_FALLING = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_EDGE_TYPE_BOTH = 2

pub fn IndustrialDigitalIn4V2Bricklet::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 IndustrialDigitalIn4V2Bricklet::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_DIGITAL_IN_4_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

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

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

Returns the configuration as set by IndustrialDigitalIn4V2Bricklet::set_status_led_config

The following constants are available for this function:

For config:

INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn IndustrialDigitalIn4V2Bricklet::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 IndustrialDigitalIn4V2Bricklet::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 IndustrialDigitalIn4V2Bricklet::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 IndustrialDigitalIn4V2Bricklet::set_value_callback_configuration(&self, channel: u8, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>¶

Parameters:	channel – Type: u8, Range: See constants period – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false

This callback can be configured per channel.

The period is the period with which the IndustrialDigitalIn4V2Bricklet::get_value_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.

The following constants are available for this function:

For channel:

INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_0 = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_1 = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_2 = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_3 = 3

pub fn IndustrialDigitalIn4V2Bricklet::get_value_callback_configuration(&self, channel: u8) → ConvertingReceiver<ValueCallbackConfiguration>¶

Parameters:	channel – Type: u8, Range: See constants
Return Object:	period – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false

Returns the callback configuration for the given channel as set by IndustrialDigitalIn4V2Bricklet::set_value_callback_configuration.

The following constants are available for this function:

For channel:

INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_0 = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_1 = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_2 = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_3 = 3

pub fn IndustrialDigitalIn4V2Bricklet::set_all_value_callback_configuration(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>¶

Parameters:	period – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false

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

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

pub fn IndustrialDigitalIn4V2Bricklet::get_all_value_callback_configuration(&self) → ConvertingReceiver<AllValueCallbackConfiguration>¶

Return Object:	period – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false

Returns the callback configuration as set by IndustrialDigitalIn4V2Bricklet::set_all_value_callback_configuration.

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 IndustrialDigitalIn4V2Bricklet::get_value_callback_receiver(&self) → ConvertingCallbackReceiver<ValueEvent>¶

Event Object:	channel – Type: u8, Range: See constants changed – Type: bool value – Type: bool

Receivers created with this function receive Value events.

This callback is triggered periodically according to the configuration set by IndustrialDigitalIn4V2Bricklet::set_value_callback_configuration.

The members of the received struct are the channel, a value-changed indicator and the actual value for the channel. The changed parameter is true if the value has changed since the last callback.

The following constants are available for this function:

For channel:

INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_0 = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_1 = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_2 = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_CHANNEL_3 = 3

pub fn IndustrialDigitalIn4V2Bricklet::get_all_value_callback_receiver(&self) → ConvertingCallbackReceiver<AllValueEvent>¶

Event Object:	changed – Type: [bool; 4] value – Type: [bool; 4]

Receivers created with this function receive All Value events.

This callback is triggered periodically according to the configuration set by IndustrialDigitalIn4V2Bricklet::set_all_value_callback_configuration.

The members of the received struct are the same as IndustrialDigitalIn4V2Bricklet::get_value. Additional the changed parameter is true if the value has changed since the last callback.

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 IndustrialDigitalIn4V2Bricklet::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 IndustrialDigitalIn4V2Bricklet::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 IndustrialDigitalIn4V2Bricklet::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_DIGITAL_IN_4_V2_BRICKLET_FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_FUNCTION_SET_CHANNEL_LED_CONFIG = 9
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_FUNCTION_RESET = 243
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_FUNCTION_WRITE_UID = 248

pub fn IndustrialDigitalIn4V2Bricklet::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_DIGITAL_IN_4_V2_BRICKLET_FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_FUNCTION_SET_CHANNEL_LED_CONFIG = 9
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_FUNCTION_RESET = 243
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_FUNCTION_WRITE_UID = 248

pub fn IndustrialDigitalIn4V2Bricklet::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 IndustrialDigitalIn4V2Bricklet::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_DIGITAL_IN_4_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5

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

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

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

The following constants are available for this function:

For mode:

INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
INDUSTRIAL_DIGITAL_IN_4_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

pub fn IndustrialDigitalIn4V2Bricklet::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 IndustrialDigitalIn4V2Bricklet::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 IndustrialDigitalIn4V2Bricklet::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 IndustrialDigitalIn4V2Bricklet::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 IndustrialDigitalIn4V2Bricklet::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 IndustrialDigitalIn4V2Bricklet::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 IndustrialDigitalIn4V2Bricklet::DEVICE_IDENTIFIER¶

This constant is used to identify a Industrial Digital In 4 Bricklet 2.0.

The IndustrialDigitalIn4V2Bricklet::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 IndustrialDigitalIn4V2Bricklet::DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Industrial Digital In 4 Bricklet 2.0.