Rust - Segment Display 4x7 Bricklet¶

Simple¶

Download (example_simple.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_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Segment Display 4x7 Bricklet.
const DIGITS: [u8; 16] = [0x3f, 0x06, 0x5b, 0x4f, 0x66, 0x6d, 0x7d, 0x07, 0x7f, 0x6f, 0x77, 0x7c, 0x39, 0x5e, 0x79, 0x71]; // 0~9,A,b,C,d,E,F

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

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

    // Write "4223" to the display with full brightness without colon
    let segments = [DIGITS[4], DIGITS[2], DIGITS[2], DIGITS[3]];
    sd.set_segments(segments, 7, false);

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

Basic Functions¶

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

Parameters:	uid – Type: &str ip_connection – Type: &IPConnection
Returns:	segment_display_4x7 – Type: SegmentDisplay4x7Bricklet

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

let segment_display_4x7 = SegmentDisplay4x7Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn SegmentDisplay4x7Bricklet::set_segments(&self, segments: [u8; 4], brightness: u8, colon: bool) → ConvertingReceiver<()>¶

Parameters:	segments – Type: [u8; 4], Range: [0 to 127] brightness – Type: u8, Range: [0 to 7] colon – Type: bool

The 7-segment display can be set with bitmaps. Every bit controls one segment:

For example to set a "5" you would want to activate segments 0, 2, 3, 5 and 6. This is represented by the number 0b01101101 = 0x6d = 109.

The brightness can be set between 0 (dark) and 7 (bright). The colon parameter turns the colon of the display on or off.

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

Return Object:	segments – Type: [u8; 4], Range: [0 to 127] brightness – Type: u8, Range: [0 to 7] colon – Type: bool

Returns the segment, brightness and color data as set by SegmentDisplay4x7Bricklet::set_segments.

Advanced Functions¶

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

pub fn SegmentDisplay4x7Bricklet::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 SegmentDisplay4x7Bricklet::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 SegmentDisplay4x7Bricklet::get_counter_finished_callback_receiver(&self) → ConvertingCallbackReceiver<()>¶

Receivers created with this function receive Counter Finished events.

This callback is triggered when the counter (see SegmentDisplay4x7Bricklet::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 SegmentDisplay4x7Bricklet::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 SegmentDisplay4x7Bricklet::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 SegmentDisplay4x7Bricklet::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_BRICKLET_FUNCTION_SET_SEGMENTS = 1
• SEGMENT_DISPLAY_4X7_BRICKLET_FUNCTION_START_COUNTER = 3

pub fn SegmentDisplay4x7Bricklet::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_BRICKLET_FUNCTION_SET_SEGMENTS = 1
• SEGMENT_DISPLAY_4X7_BRICKLET_FUNCTION_START_COUNTER = 3

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

Constants¶

pub const SegmentDisplay4x7Bricklet::DEVICE_IDENTIFIER¶

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

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

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