Software / API Bindings / Rust / API Reference and Examples / Bricklets / Industrial Counter Bricklet

Rust - Industrial Counter Bricklet¶

This is the description of the Rust API bindings for the Industrial Counter Bricklet. General information and technical specifications for the Industrial Counter Bricklet 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_counter_bricklet::*, ip_connection::IpConnection};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Industrial Counter Bricklet.

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

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

    // Get current counter from channel 0.
    let counter = ic.get_counter(INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0).recv()?;
    println!("Counter (Channel 0): {}", counter);

    // Get current signal data from channel 0.
    let signal_data = ic.get_signal_data(INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0).recv()?;

    println!("Duty Cycle (Channel 0): {} %", signal_data.duty_cycle as f32 / 100.0);
    println!("Period (Channel 0): {} ns", signal_data.period);
    println!("Frequency (Channel 0): {} Hz", signal_data.frequency as f32 / 1000.0);
    println!("Value (Channel 0): {}", signal_data.value);

    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_counter_bricklet::*, ip_connection::IpConnection};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Industrial Counter Bricklet.

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

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

    let all_counter_receiver = ic.get_all_counter_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `ic` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for all_counter in all_counter_receiver {
            println!("Counter (Channel 0): {}", all_counter[0]);
            println!("Counter (Channel 1): {}", all_counter[1]);
            println!("Counter (Channel 2): {}", all_counter[2]);
            println!("Counter (Channel 3): {}", all_counter[3]);
            println!();
        }
    });

    // Set period for all counter callback to 1s (1000ms).
    ic.set_all_counter_callback_configuration(1000, true);

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

Parameters:	uid – Type: &str ip_connection – Type: &IPConnection
Returns:	industrial_counter – Type: IndustrialCounterBricklet

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

let industrial_counter = IndustrialCounterBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn IndustrialCounterBricklet::get_counter(&self, channel: u8) → ConvertingReceiver<i64>¶

Parameters:	channel – Type: u8, Range: See constants
Returns:	counter – Type: i64, Range: [-2⁴⁷ to 2⁴⁷ - 1]

Returns the current counter value for the given channel.

The following constants are available for this function:

For channel:

INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0 = 0
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_1 = 1
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_2 = 2
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_3 = 3

pub fn IndustrialCounterBricklet::get_all_counter(&self) → ConvertingReceiver<[i64; 4]>¶

Returns:	counter – Type: [i64; 4], Range: [-2⁴⁷ to 2⁴⁷ - 1]

Returns the current counter values for all four channels.

pub fn IndustrialCounterBricklet::set_counter(&self, channel: u8, counter: i64) → ConvertingReceiver<()>¶

Parameters:	channel – Type: u8, Range: See constants counter – Type: i64, Range: [-2⁴⁷ to 2⁴⁷ - 1]

Sets the counter value for the given channel.

The default value for the counters on startup is 0.

The following constants are available for this function:

For channel:

INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0 = 0
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_1 = 1
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_2 = 2
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_3 = 3

pub fn IndustrialCounterBricklet::set_all_counter(&self, counter: [i64; 4]) → ConvertingReceiver<()>¶

Parameters:	counter – Type: [i64; 4], Range: [-2⁴⁷ to 2⁴⁷ - 1]

Sets the counter values for all four channels.

The default value for the counters on startup is 0.

pub fn IndustrialCounterBricklet::get_signal_data(&self, channel: u8) → ConvertingReceiver<SignalData>¶

Parameters:	channel – Type: u8, Range: See constants
Return Object:	duty_cycle – Type: u16, Unit: 1/100 %, Range: [0 to 10000] period – Type: u64, Unit: 1 ns, Range: [0 to 2⁶⁴ - 1] frequency – Type: u32, Unit: 1/1000 Hz, Range: [0 to 2³² - 1] value – Type: bool

Returns the signal data (duty cycle, period, frequency and value) for the given channel.

The following constants are available for this function:

For channel:

INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0 = 0
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_1 = 1
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_2 = 2
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_3 = 3

pub fn IndustrialCounterBricklet::get_all_signal_data(&self) → ConvertingReceiver<AllSignalData>¶

Return Object:	duty_cycle – Type: [u16; 4], Unit: 1/100 %, Range: [0 to 10000] period – Type: [u64; 4], Unit: 1 ns, Range: [0 to 2⁶⁴ - 1] frequency – Type: [u32; 4], Unit: 1/1000 Hz, Range: [0 to 2³² - 1] value – Type: [bool; 4]

Returns the signal data (duty cycle, period, frequency and value) for all four channels.

pub fn IndustrialCounterBricklet::set_counter_active(&self, channel: u8, active: bool) → ConvertingReceiver<()>¶

Parameters:	channel – Type: u8, Range: See constants active – Type: bool, Default: true

Activates/deactivates the counter of the given channel.

true = activate, false = deactivate.

By default all channels are activated.

The following constants are available for this function:

For channel:

INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0 = 0
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_1 = 1
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_2 = 2
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_3 = 3

pub fn IndustrialCounterBricklet::set_all_counter_active(&self, active: [bool; 4]) → ConvertingReceiver<()>¶

Parameters:	active – Type: [bool; 4], Default: [true, true, true, true]

Activates/deactivates the counter of all four channels.

true = activate, false = deactivate.

By default all channels are activated.

pub fn IndustrialCounterBricklet::get_counter_active(&self, channel: u8) → ConvertingReceiver<bool>¶

Parameters:	channel – Type: u8, Range: See constants
Returns:	active – Type: bool, Default: true

Returns the activation state of the given channel.

true = activated, false = deactivated.

The following constants are available for this function:

For channel:

INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0 = 0
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_1 = 1
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_2 = 2
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_3 = 3

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

Returns:	active – Type: [bool; 4], Default: [true, true, true, true]

Returns the activation state of all four channels.

true = activated, false = deactivated.

pub fn IndustrialCounterBricklet::set_counter_configuration(&self, channel: u8, count_edge: u8, count_direction: u8, duty_cycle_prescaler: u8, frequency_integration_time: u8) → ConvertingReceiver<()>¶

Parameters:	channel – Type: u8, Range: See constants count_edge – Type: u8, Range: See constants, Default: 0 count_direction – Type: u8, Range: See constants, Default: 0 duty_cycle_prescaler – Type: u8, Range: See constants, Default: 0 frequency_integration_time – Type: u8, Range: See constants, Default: 3

Sets the counter configuration for the given channel.

Count Edge: Counter can count on rising, falling or both edges.
Count Direction: Counter can count up or down. You can also use another channel as direction input, see here for details.
Duty Cycle Prescaler: Sets a divider for the internal clock. See here for details.
Frequency Integration Time: Sets the integration time for the frequency measurement. See here for details.

The following constants are available for this function:

For channel:

INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0 = 0
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_1 = 1
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_2 = 2
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_3 = 3

For count_edge:

INDUSTRIAL_COUNTER_BRICKLET_COUNT_EDGE_RISING = 0
INDUSTRIAL_COUNTER_BRICKLET_COUNT_EDGE_FALLING = 1
INDUSTRIAL_COUNTER_BRICKLET_COUNT_EDGE_BOTH = 2

For count_direction:

INDUSTRIAL_COUNTER_BRICKLET_COUNT_DIRECTION_UP = 0
INDUSTRIAL_COUNTER_BRICKLET_COUNT_DIRECTION_DOWN = 1
INDUSTRIAL_COUNTER_BRICKLET_COUNT_DIRECTION_EXTERNAL_UP = 2
INDUSTRIAL_COUNTER_BRICKLET_COUNT_DIRECTION_EXTERNAL_DOWN = 3

For duty_cycle_prescaler:

INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_1 = 0
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_2 = 1
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_4 = 2
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_8 = 3
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_16 = 4
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_32 = 5
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_64 = 6
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_128 = 7
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_256 = 8
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_512 = 9
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_1024 = 10
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_2048 = 11
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_4096 = 12
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_8192 = 13
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_16384 = 14
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_32768 = 15

For frequency_integration_time:

INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_128_MS = 0
INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_256_MS = 1
INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_512_MS = 2
INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_1024_MS = 3
INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_2048_MS = 4
INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_4096_MS = 5
INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_8192_MS = 6
INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_16384_MS = 7
INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_32768_MS = 8

pub fn IndustrialCounterBricklet::get_counter_configuration(&self, channel: u8) → ConvertingReceiver<CounterConfiguration>¶

Parameters:	channel – Type: u8, Range: See constants
Return Object:	count_edge – Type: u8, Range: See constants, Default: 0 count_direction – Type: u8, Range: See constants, Default: 0 duty_cycle_prescaler – Type: u8, Range: See constants, Default: 0 frequency_integration_time – Type: u8, Range: See constants, Default: 3

Returns the counter configuration as set by IndustrialCounterBricklet::set_counter_configuration.

The following constants are available for this function:

For channel:

INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0 = 0
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_1 = 1
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_2 = 2
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_3 = 3

For count_edge:

INDUSTRIAL_COUNTER_BRICKLET_COUNT_EDGE_RISING = 0
INDUSTRIAL_COUNTER_BRICKLET_COUNT_EDGE_FALLING = 1
INDUSTRIAL_COUNTER_BRICKLET_COUNT_EDGE_BOTH = 2

For count_direction:

INDUSTRIAL_COUNTER_BRICKLET_COUNT_DIRECTION_UP = 0
INDUSTRIAL_COUNTER_BRICKLET_COUNT_DIRECTION_DOWN = 1
INDUSTRIAL_COUNTER_BRICKLET_COUNT_DIRECTION_EXTERNAL_UP = 2
INDUSTRIAL_COUNTER_BRICKLET_COUNT_DIRECTION_EXTERNAL_DOWN = 3

For duty_cycle_prescaler:

INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_1 = 0
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_2 = 1
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_4 = 2
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_8 = 3
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_16 = 4
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_32 = 5
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_64 = 6
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_128 = 7
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_256 = 8
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_512 = 9
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_1024 = 10
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_2048 = 11
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_4096 = 12
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_8192 = 13
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_16384 = 14
INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_32768 = 15

For frequency_integration_time:

INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_128_MS = 0
INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_256_MS = 1
INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_512_MS = 2
INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_1024_MS = 3
INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_2048_MS = 4
INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_4096_MS = 5
INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_8192_MS = 6
INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_16384_MS = 7
INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_32768_MS = 8

pub fn IndustrialCounterBricklet::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.

The following constants are available for this function:

For channel:

INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0 = 0
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_1 = 1
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_2 = 2
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_3 = 3

For config:

INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_LED_CONFIG_OFF = 0
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_LED_CONFIG_ON = 1
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

pub fn IndustrialCounterBricklet::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 IndustrialCounterBricklet::set_channel_led_config

The following constants are available for this function:

For channel:

INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0 = 0
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_1 = 1
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_2 = 2
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_3 = 3

For config:

INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_LED_CONFIG_OFF = 0
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_LED_CONFIG_ON = 1
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Advanced Functions¶

pub fn IndustrialCounterBricklet::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 IndustrialCounterBricklet::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_COUNTER_BRICKLET_STATUS_LED_CONFIG_OFF = 0
INDUSTRIAL_COUNTER_BRICKLET_STATUS_LED_CONFIG_ON = 1
INDUSTRIAL_COUNTER_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_COUNTER_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

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

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

Returns the configuration as set by IndustrialCounterBricklet::set_status_led_config

The following constants are available for this function:

For config:

INDUSTRIAL_COUNTER_BRICKLET_STATUS_LED_CONFIG_OFF = 0
INDUSTRIAL_COUNTER_BRICKLET_STATUS_LED_CONFIG_ON = 1
INDUSTRIAL_COUNTER_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_COUNTER_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn IndustrialCounterBricklet::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 IndustrialCounterBricklet::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 IndustrialCounterBricklet::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 IndustrialCounterBricklet::set_all_counter_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 IndustrialCounterBricklet::get_all_counter_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.

pub fn IndustrialCounterBricklet::get_all_counter_callback_configuration(&self) → ConvertingReceiver<AllCounterCallbackConfiguration>¶

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 IndustrialCounterBricklet::set_all_counter_callback_configuration.

pub fn IndustrialCounterBricklet::set_all_signal_data_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 IndustrialCounterBricklet::get_all_signal_data_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 IndustrialCounterBricklet::get_all_signal_data_callback_configuration(&self) → ConvertingReceiver<AllSignalDataCallbackConfiguration>¶

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 IndustrialCounterBricklet::set_all_signal_data_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 IndustrialCounterBricklet::get_all_counter_callback_receiver(&self) → ConvertingCallbackReceiver<[i64; 4]>¶

Event:	counter – Type: [i64; 4], Range: [-2⁴⁷ to 2⁴⁷ - 1]

Receivers created with this function receive All Counter events.

This callback is triggered periodically according to the configuration set by IndustrialCounterBricklet::set_all_counter_callback_configuration.

The members of the received struct are the same as IndustrialCounterBricklet::get_all_counter.

pub fn IndustrialCounterBricklet::get_all_signal_data_callback_receiver(&self) → ConvertingCallbackReceiver<AllSignalDataEvent>¶

Event Object:	duty_cycle – Type: [u16; 4], Unit: 1/100 %, Range: [0 to 10000] period – Type: [u64; 4], Unit: 1 ns, Range: [0 to 2⁶⁴ - 1] frequency – Type: [u32; 4], Unit: 1/1000 Hz, Range: [0 to 2³² - 1] value – Type: [bool; 4]

Receivers created with this function receive All Signal Data events.

This callback is triggered periodically according to the configuration set by IndustrialCounterBricklet::set_all_signal_data_callback_configuration.

The members of the received struct are the same as IndustrialCounterBricklet::get_all_signal_data.

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 IndustrialCounterBricklet::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 IndustrialCounterBricklet::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 IndustrialCounterBricklet::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_COUNTER_BRICKLET_FUNCTION_SET_COUNTER = 3
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_ALL_COUNTER = 4
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_COUNTER_ACTIVE = 7
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_COUNTER_CONFIGURATION = 11
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_CHANNEL_LED_CONFIG = 17
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_RESET = 243
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_WRITE_UID = 248

pub fn IndustrialCounterBricklet::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_COUNTER_BRICKLET_FUNCTION_SET_COUNTER = 3
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_ALL_COUNTER = 4
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_COUNTER_ACTIVE = 7
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_COUNTER_CONFIGURATION = 11
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_CHANNEL_LED_CONFIG = 17
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_RESET = 243
INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_WRITE_UID = 248

pub fn IndustrialCounterBricklet::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 IndustrialCounterBricklet::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_COUNTER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_STATUS_OK = 0
INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5

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

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

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

The following constants are available for this function:

For mode:

INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

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

This constant is used to identify a Industrial Counter Bricklet.

The IndustrialCounterBricklet::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 IndustrialCounterBricklet::DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Industrial Counter Bricklet.