Rust - Segment Display 4x7 Bricklet 2.0¶

Numeric Value¶

Download (example_numeric_value.rs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

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

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

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Segment Display 4x7 Bricklet 2.0.

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

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

    sd.set_brightness(7).recv()?; // Set to full brightness

    // Show "- 42" on the Display
    sd.set_numeric_value([-2, -1, 4, 2]).recv()?;

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

Set Segments¶

Download (example_set_segments.rs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

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

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

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Segment Display 4x7 Bricklet 2.0.

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

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

    sd.set_brightness(7).recv()?; // Set to full brightness

    // Activate all segments
    sd.set_segments(
        [true, true, true, true, true, true, true, true],
        [true, true, true, true, true, true, true, true],
        [true, true, true, true, true, true, true, true],
        [true, true, true, true, true, true, true, true],
        [true, true],
        true,
    )
    .recv()?;

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

Blink Colon¶

Download (example_blink_colon.rs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

use std::{error::Error, io, thread, time::Duration};
use tinkerforge::{ip_connection::IpConnection, segment_display_4x7_v2_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Segment Display 4x7 Bricklet 2.0.

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

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

    sd.set_brightness(7).recv()?; // Set to full brightness

    // Blink colon 10 times
    for _i in 0..10 {
        // Activate segments of colon
        sd.set_selected_segment(32, true).recv()?;
        sd.set_selected_segment(33, true).recv()?;

        thread::sleep(Duration::from_millis(250));

        // Deactivate segments of colon
        sd.set_selected_segment(32, false).recv()?;
        sd.set_selected_segment(33, false).recv()?;
    }

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

Basic Functions¶

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

Parameters:	uid – Type: &str ip_connection – Type: &IPConnection
Returns:	segment_display_4x7_v2 – Type: SegmentDisplay4x7V2Bricklet

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

let segment_display_4x7_v2 = SegmentDisplay4x7V2Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn SegmentDisplay4x7V2Bricklet::set_segments(&self, digit0: [bool; 8], digit1: [bool; 8], digit2: [bool; 8], digit3: [bool; 8], colon: [bool; 2], tick: bool) → ConvertingReceiver<()>¶

Parameters:	digit0 – Type: [bool; 8] digit1 – Type: [bool; 8] digit2 – Type: [bool; 8] digit3 – Type: [bool; 8] colon – Type: [bool; 2] tick – Type: bool

Sets the segments of the Segment Display 4x7 Bricklet 2.0 segment-by-segment.

The data is split into the four digits, two colon dots and the tick mark.

The indices of the segments in the digit and colon parameters are as follows:

pub fn SegmentDisplay4x7V2Bricklet::get_segments(&self) → ConvertingReceiver<Segments>¶

Return Object:	digit0 – Type: [bool; 8] digit1 – Type: [bool; 8] digit2 – Type: [bool; 8] digit3 – Type: [bool; 8] colon – Type: [bool; 2] tick – Type: bool

Returns the segment data as set by SegmentDisplay4x7V2Bricklet::set_segments.

pub fn SegmentDisplay4x7V2Bricklet::set_brightness(&self, brightness: u8) → ConvertingReceiver<()>¶

Parameters:	brightness – Type: u8, Range: [0 to 7], Default: 7

The brightness can be set between 0 (dark) and 7 (bright).

pub fn SegmentDisplay4x7V2Bricklet::get_brightness(&self) → ConvertingReceiver<u8>¶

Returns:	brightness – Type: u8, Range: [0 to 7], Default: 7

Returns the brightness as set by SegmentDisplay4x7V2Bricklet::set_brightness.

pub fn SegmentDisplay4x7V2Bricklet::set_numeric_value(&self, value: [i8; 4]) → ConvertingReceiver<()>¶

Parameters:	value – Type: [i8; 4], Range: [-2 to 15]

Sets a numeric value for each of the digits. They represent:

• -2: minus sign
• -1: blank
• 0-9: 0-9
• 10: A
• 11: b
• 12: C
• 13: d
• 14: E
• 15: F

Example: A call with [-2, -1, 4, 2] will result in a display of "- 42".

pub fn SegmentDisplay4x7V2Bricklet::set_selected_segment(&self, segment: u8, value: bool) → ConvertingReceiver<()>¶

Parameters:	segment – Type: u8, Range: [0 to 34] value – Type: bool

Turns one specified segment on or off.

The indices of the segments are as follows:

pub fn SegmentDisplay4x7V2Bricklet::get_selected_segment(&self, segment: u8) → ConvertingReceiver<bool>¶

Parameters:	segment – Type: u8, Range: [0 to 34]
Returns:	value – Type: bool

Returns the value of a single segment.

Advanced Functions¶

pub fn SegmentDisplay4x7V2Bricklet::start_counter(&self, value_from: i16, value_to: i16, increment: i16, length: u32) → ConvertingReceiver<()>¶

Parameters:	value_from – Type: i16, Range: [-999 to 9999] value_to – Type: i16, Range: [-999 to 9999] increment – Type: i16, Range: [-999 to 9999] length – Type: u32, Unit: 1 ms, Range: [0 to 232 - 1]

Starts a counter with the from value that counts to the to value with the each step incremented by increment. length is the pause between each increment.

Example: If you set from to 0, to to 100, increment to 1 and length to 1000, a counter that goes from 0 to 100 with one second pause between each increment will be started.

Using a negative increment allows to count backwards.

You can stop the counter at every time by calling SegmentDisplay4x7V2Bricklet::set_segments or SegmentDisplay4x7V2Bricklet::set_numeric_value.

pub fn SegmentDisplay4x7V2Bricklet::get_counter_value(&self) → ConvertingReceiver<u16>¶

Returns:	value – Type: u16, Range: [-999 to 9999]

Returns the counter value that is currently shown on the display.

If there is no counter running a 0 will be returned.

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

Return Object:	error_count_ack_checksum – Type: u32, Range: [0 to 232 - 1] error_count_message_checksum – Type: u32, Range: [0 to 232 - 1] error_count_frame – Type: u32, Range: [0 to 232 - 1] error_count_overflow – Type: u32, Range: [0 to 232 - 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 SegmentDisplay4x7V2Bricklet::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:

• SEGMENT_DISPLAY_4X7_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

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

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

Returns the configuration as set by SegmentDisplay4x7V2Bricklet::set_status_led_config

The following constants are available for this function:

For config:

• SEGMENT_DISPLAY_4X7_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

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

Returns:	temperature – Type: i16, Unit: 1 °C, Range: [-215 to 215 - 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 SegmentDisplay4x7V2Bricklet::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 SegmentDisplay4x7V2Bricklet::get_identity(&self) → ConvertingReceiver<Identity>¶

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 216 - 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.

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.

pub fn SegmentDisplay4x7V2Bricklet::get_counter_finished_callback_receiver(&self) → ConvertingCallbackReceiver<()>¶

Receivers created with this function receive Counter Finished events.

This callback is triggered when the counter (see SegmentDisplay4x7V2Bricklet::start_counter) is finished.

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 SegmentDisplay4x7V2Bricklet::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 SegmentDisplay4x7V2Bricklet::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 SegmentDisplay4x7V2Bricklet::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:

• SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_SEGMENTS = 1
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_BRIGHTNESS = 3
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_NUMERIC_VALUE = 5
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_SELECTED_SEGMENT = 6
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_START_COUNTER = 8
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_RESET = 243
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_WRITE_UID = 248

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

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:

• SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_SEGMENTS = 1
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_BRIGHTNESS = 3
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_NUMERIC_VALUE = 5
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_SELECTED_SEGMENT = 6
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_START_COUNTER = 8
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_RESET = 243
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_FUNCTION_WRITE_UID = 248

pub fn SegmentDisplay4x7V2Bricklet::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 SegmentDisplay4x7V2Bricklet::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:

• SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

• SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5

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

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

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

The following constants are available for this function:

For mode:

• SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• SEGMENT_DISPLAY_4X7_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

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

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

Sets the firmware pointer for SegmentDisplay4x7V2Bricklet::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 SegmentDisplay4x7V2Bricklet::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 SegmentDisplay4x7V2Bricklet::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 SegmentDisplay4x7V2Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>¶

Parameters:	uid – Type: u32, Range: [0 to 232 - 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 SegmentDisplay4x7V2Bricklet::read_uid(&self) → ConvertingReceiver<u32>¶

Returns:	uid – Type: u32, Range: [0 to 232 - 1]

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

Constants¶

pub const SegmentDisplay4x7V2Bricklet::DEVICE_IDENTIFIER¶

This constant is used to identify a Segment Display 4x7 Bricklet 2.0.

The SegmentDisplay4x7V2Bricklet::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 SegmentDisplay4x7V2Bricklet::DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Segment Display 4x7 Bricklet 2.0.