Rust - LCD 16x2 Bricklet¶

Hello World¶

Download (example_hello_world.rs)

 1use std::{error::Error, io};
 2
 3use tinkerforge::{ip_connection::IpConnection, lcd_16x2_bricklet::*};
 4
 5const HOST: &str = "localhost";
 6const PORT: u16 = 4223;
 7const UID: &str = "XYZ"; // Change XYZ to the UID of your LCD 16x2 Bricklet.
 8
 9fn main() -> Result<(), Box<dyn Error>> {
10    let ipcon = IpConnection::new(); // Create IP connection.
11    let lcd = Lcd16x2Bricklet::new(UID, &ipcon); // Create device object.
12
13    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
14                                          // Don't use device before ipcon is connected.
15
16    // Turn backlight on
17    lcd.backlight_on().recv()?;
18
19    // Write "Hello World"
20    lcd.write_line(0, 0, "Hello World".to_string()).recv()?;
21
22    println!("Press enter to exit.");
23    let mut _input = String::new();
24    io::stdin().read_line(&mut _input)?;
25    ipcon.disconnect();
26    Ok(())
27}

Button Callback¶

Download (example_button_callback.rs)

 1use std::{error::Error, io, thread};
 2use tinkerforge::{ip_connection::IpConnection, lcd_16x2_bricklet::*};
 3
 4const HOST: &str = "localhost";
 5const PORT: u16 = 4223;
 6const UID: &str = "XYZ"; // Change XYZ to the UID of your LCD 16x2 Bricklet.
 7
 8fn main() -> Result<(), Box<dyn Error>> {
 9    let ipcon = IpConnection::new(); // Create IP connection.
10    let lcd = Lcd16x2Bricklet::new(UID, &ipcon); // Create device object.
11
12    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
13                                          // Don't use device before ipcon is connected.
14
15    let button_pressed_receiver = lcd.get_button_pressed_callback_receiver();
16
17    // Spawn thread to handle received callback messages.
18    // This thread ends when the `lcd` object
19    // is dropped, so there is no need for manual cleanup.
20    thread::spawn(move || {
21        for button_pressed in button_pressed_receiver {
22            println!("Button Pressed: {}", button_pressed);
23        }
24    });
25
26    let button_released_receiver = lcd.get_button_released_callback_receiver();
27
28    // Spawn thread to handle received callback messages.
29    // This thread ends when the `lcd` object
30    // is dropped, so there is no need for manual cleanup.
31    thread::spawn(move || {
32        for button_released in button_released_receiver {
33            println!("Button Released: {}", button_released);
34        }
35    });
36
37    println!("Press enter to exit.");
38    let mut _input = String::new();
39    io::stdin().read_line(&mut _input)?;
40    ipcon.disconnect();
41    Ok(())
42}

Unicode¶

Download (example_unicode.rs)

 1use std::{error::Error, io};
 2
 3use tinkerforge::{ip_connection::IpConnection, lcd_16x2_bricklet::*};
 4
 5const HOST: &str = "localhost";
 6const PORT: u16 = 4223;
 7const UID: &str = "XYZ"; // Change XYZ to the UID of your LCD 16x2 Bricklet.
 8
 9/// Maps a normal UTF-8 encoded string to the LCD charset.
10fn utf8_to_ks0066u(utf8: &str) -> String {
11    let mut result = Vec::<char>::with_capacity(utf8.len());
12    for code_point in utf8.chars() {
13        // Technically these are not code points, but scalar values.
14        let mut replacement = match code_point as u32 {
15            // ASCII subset from JIS X 0201
16            // The LCD charset doesn't include '\' and '~', use similar characters instead
17            0x005c => 0xa4, // REVERSE SOLIDUS maps to IDEOGRAPHIC COMMA
18            0x007e => 0x2d, // TILDE maps to HYPHEN-MINUS
19            0x0020..=0x007d => code_point as u32,
20
21            // Katakana subset from JIS X 0201
22            0xff61..=0xff9f => code_point as u32 - 0xfec0,
23
24            // Special characters
25            0x00a5 => 0x5c, // YEN SIGN
26            0x2192 => 0x7e, // RIGHTWARDS ARROW
27            0x2190 => 0x7f, // LEFTWARDS ARROW
28            0x00b0 => 0xdf, // DEGREE SIGN maps to KATAKANA SEMI-VOICED SOUND MARK
29            0x03b1 => 0xe0, // GREEK SMALL LETTER ALPHA
30            0x00c4 => 0xe1, // LATIN CAPITAL LETTER A WITH DIAERESIS
31            0x00e4 => 0xe1, // LATIN SMALL LETTER A WITH DIAERESIS
32            0x00df => 0xe2, // LATIN SMALL LETTER SHARP S
33            0x03b5 => 0xe3, // GREEK SMALL LETTER EPSILON
34            0x00b5 => 0xe4, // MICRO SIGN
35            0x03bc => 0xe4, // GREEK SMALL LETTER MU
36            0x03c2 => 0xe5, // GREEK SMALL LETTER FINAL SIGMA
37            0x03c1 => 0xe6, // GREEK SMALL LETTER RHO
38            0x221a => 0xe8, // SQUARE ROOT
39            0x00b9 => 0xe9, // SUPERSCRIPT ONE maps to SUPERSCRIPT (minus) ONE
40            0x00a4 => 0xeb, // CURRENCY SIGN
41            0x00a2 => 0xec, // CENT SIGN
42            0x2c60 => 0xed, // LATIN CAPITAL LETTER L WITH DOUBLE BAR
43            0x00f1 => 0xee, // LATIN SMALL LETTER N WITH TILDE
44            0x00d6 => 0xef, // LATIN CAPITAL LETTER O WITH DIAERESIS
45            0x00f6 => 0xef, // LATIN SMALL LETTER O WITH DIAERESIS
46            0x03f4 => 0xf2, // GREEK CAPITAL THETA SYMBOL
47            0x221e => 0xf3, // INFINITY
48            0x03a9 => 0xf4, // GREEK CAPITAL LETTER OMEGA
49            0x00dc => 0xf5, // LATIN CAPITAL LETTER U WITH DIAERESIS
50            0x00fc => 0xf5, // LATIN SMALL LETTER U WITH DIAERESIS
51            0x03a3 => 0xf6, // GREEK CAPITAL LETTER SIGMA
52            0x03c0 => 0xf7, // GREEK SMALL LETTER PI
53            0x0304 => 0xf8, // COMBINING MACRON
54            0x00f7 => 0xfd, // DIVISION SIGN
55
56            // Default
57            _ => 0xff, // BLACK SQUARE
58        };
59
60        // Special handling for 'x' followed by COMBINING MACRON
61        if replacement == 0xf8 {
62            if result[result.len() - 1] != 'x' {
63                replacement = 0xff; // BLACK SQUARE
64            }
65
66            if result.len() > 0 {
67                result.truncate(result.len() - 1);
68            }
69        }
70        result.push(std::char::from_u32(replacement).unwrap());
71    }
72
73    result.into_iter().collect()
74}
75
76fn main() -> Result<(), Box<dyn Error>> {
77    let ipcon = IpConnection::new(); // Create IP connection.
78    let lcd = Lcd16x2Bricklet::new(UID, &ipcon); // Create device object.
79
80    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
81                                          // Don't use device before ipcon is connected.
82
83    // Turn backlight on
84    lcd.backlight_on();
85
86    // Write a string using the utf8_to_ks0066u function to map to the LCD charset
87    lcd.write_line(0, 0, utf8_to_ks0066u("Stromstärke: 5µA"));
88
89    // Write a string directly including characters from the LCD charset. \u{00e9} is the ⁻¹ character.
90    lcd.write_line(1, 0, "Drehzahl: 1000s\u{00e9}".to_string());
91
92    println!("Press enter to exit.");
93    let mut _input = String::new();
94    io::stdin().read_line(&mut _input)?;
95    ipcon.disconnect();
96    Ok(())
97}

Grundfunktionen¶

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

Parameter:	uid – Typ: &str ip_connection – Typ: &IPConnection
Rückgabe:	lcd_16x2 – Typ: Lcd16x2Bricklet

Erzeugt ein neues Lcd16x2Bricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IP-Connection ip_connection hinzu:

let lcd_16x2 = Lcd16x2Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden.

pub fn Lcd16x2Bricklet::write_line(&self, line: u8, position: u8, text: String) → ConvertingReceiver<()>¶

Parameter:	line – Typ: u8, Wertebereich: [0 bis 1] position – Typ: u8, Wertebereich: [0 bis 15] text – Typ: String, Länge: bis zu 16

Schreibt einen Text in die angegebene Zeile mit einer vorgegebenen Position. Der Text kann maximal 16 Zeichen lang sein.

Beispiel: (0, 5, "Hallo") schreibt Hallo in die Mitte der ersten Zeile des Display.

Das Display nutzt einen speziellen Zeichensatz der alle ASCII Zeichen beinhaltet außer Backslash und Tilde. Der Zeichensatz des LCD beinhaltet weiterhin einige Nicht-ASCII Zeichen, siehe die Zeichensatzspezifikation für Details. Das gezeigte Unicode Beispiel verdeutlicht die Verwendung von Nicht-ASCII Zeichen und wie die Wandlung von Unicode in den LCD Zeichensatz möglich ist.

pub fn Lcd16x2Bricklet::clear_display(&self) → ConvertingReceiver<()>¶

Löscht alle Zeichen auf dem Display.

pub fn Lcd16x2Bricklet::backlight_on(&self) → ConvertingReceiver<()>¶

Aktiviert die Hintergrundbeleuchtung.

pub fn Lcd16x2Bricklet::backlight_off(&self) → ConvertingReceiver<()>¶

Deaktiviert die Hintergrundbeleuchtung.

pub fn Lcd16x2Bricklet::is_backlight_on(&self) → ConvertingReceiver<bool>¶

Rückgabe:	backlight – Typ: bool

Gibt true zurück wenn die Hintergrundbeleuchtung aktiv ist, sonst false.

Fortgeschrittene Funktionen¶

pub fn Lcd16x2Bricklet::set_config(&self, cursor: bool, blinking: bool) → ConvertingReceiver<()>¶

Parameter:	cursor – Typ: bool, Standardwert: false blinking – Typ: bool, Standardwert: false

Konfiguriert ob der Cursor (angezeigt als "_") sichtbar ist und ob er blinkt (angezeigt als blinkender Block). Die Cursor Position ist ein Zeichen hinter dem zuletzt mit Lcd16x2Bricklet::write_line() geschriebenen Text.

pub fn Lcd16x2Bricklet::get_config(&self) → ConvertingReceiver<Config>¶

Rückgabeobjekt:	cursor – Typ: bool, Standardwert: false blinking – Typ: bool, Standardwert: false

Gibt die Konfiguration zurück, wie von Lcd16x2Bricklet::set_config() gesetzt.

pub fn Lcd16x2Bricklet::is_button_pressed(&self, button: u8) → ConvertingReceiver<bool>¶

Parameter:	button – Typ: u8, Wertebereich: [0 bis 2]
Rückgabe:	pressed – Typ: bool

Gibt true zurück wenn die Taste gedrückt ist.

Wenn auf Tastendrücken und -loslassen reagiert werden soll, wird empfohlen die Lcd16x2Bricklet::get_button_pressed_callback_receiver() und Lcd16x2Bricklet::get_button_released_callback_receiver() Callbacks zu nutzen.

pub fn Lcd16x2Bricklet::set_custom_character(&self, index: u8, character: [u8; 8]) → ConvertingReceiver<()>¶

Parameter:	index – Typ: u8, Wertebereich: [0 bis 7] character – Typ: [u8; 8], Wertebereich: [0 bis 31]

Das LCD 16x2 Bricklet kann bis zu 8 benutzerdefinierte Buchstaben speichern. Die Buchstaben bestehen aus 5x8 Pixel und sie können über den Index 0-7 adressiert werden. Um die Pixel zu beschreiben, werden die ersten 5 Bit von 8 Bytes verwenden. Zum Beispiel, um den Buchstaben "H" zu erzeugen, sollte das folgende Array gesendet werden:

• character[0] = 0b00010001 (Dezimalwert 17)

• character[1] = 0b00010001 (Dezimalwert 17)

• character[2] = 0b00010001 (Dezimalwert 17)

• character[3] = 0b00011111 (Dezimalwert 31)

• character[4] = 0b00010001 (Dezimalwert 17)

• character[5] = 0b00010001 (Dezimalwert 17)

• character[6] = 0b00010001 (Dezimalwert 17)

• character[7] = 0b00000000 (Dezimalwert 0)

Die Buchstaben können später mit Lcd16x2Bricklet::write_line() mit den chars mit den Byterepräsentationen 8 ("\x08" oder "\u0008") bis 15 ("\x0F" oder "\u000F") geschrieben werden.

Es ist möglich die benutzerdefinierten Buchstaben im Brick Viewer ab Version 2.0.1 einzustellen.

Benutzerdefinierte Buchstaben werden vom LCD im RAM gespeichert, daher müssen sie nach jedem Start des LCD 16x2 Bricklets gesetzt werden.

Added in version 2.0.1$nbsp;(Plugin).

pub fn Lcd16x2Bricklet::get_custom_character(&self, index: u8) → ConvertingReceiver<[u8; 8]>¶

Parameter:	index – Typ: u8, Wertebereich: [0 bis 7]
Rückgabe:	character – Typ: [u8; 8], Wertebereich: [0 bis 31]

Gibt den benutzerdefinierten Buchstaben für den gegebenen Index zurück, wie von Lcd16x2Bricklet::get_custom_character() gesetzt.

Added in version 2.0.1$nbsp;(Plugin).

pub fn Lcd16x2Bricklet::get_identity(&self) → ConvertingReceiver<Identity>¶

Rückgabeobjekt:

uid – Typ: String, Länge: bis zu 8 connected_uid – Typ: String, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardware_version – Typ: [u8; 3] 0: major – Typ: u8, Wertebereich: [0 bis 255] 1: minor – Typ: u8, Wertebereich: [0 bis 255] 2: revision – Typ: u8, Wertebereich: [0 bis 255] firmware_version – Typ: [u8; 3] 0: major – Typ: u8, Wertebereich: [0 bis 255] 1: minor – Typ: u8, Wertebereich: [0 bis 255] 2: revision – Typ: u8, Wertebereich: [0 bis 255] device_identifier – Typ: u16, Wertebereich: [0 bis 216 - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden get_*_callback_receiver-Function durchgeführt werden, welche einen Receiver für Callback-Events zurück gibt.

pub fn Lcd16x2Bricklet::get_button_pressed_callback_receiver(&self) → ConvertingCallbackReceiver<u8>¶

Event:	button – Typ: u8, Wertebereich: [0 bis 2]

Receiver die mit dieser Funktion erstellt werden, empfangen Button Pressed-Events.

Dieser Callback wird ausgelöst, wenn eine Taste gedrückt wird. Der empfangene Variable ist die Nummer der Taste.

pub fn Lcd16x2Bricklet::get_button_released_callback_receiver(&self) → ConvertingCallbackReceiver<u8>¶

Event:	button – Typ: u8, Wertebereich: [0 bis 2]

Receiver die mit dieser Funktion erstellt werden, empfangen Button Released-Events.

Dieser Callback wird ausgelöst, wenn eine Taste losgelassen wird. Der empfangene Variable ist die Nummer der Taste.

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

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

Rückgabeobjekt:	api_version – Typ: [u8; 3] 0: major – Typ: u8, Wertebereich: [0 bis 255] 1: minor – Typ: u8, Wertebereich: [0 bis 255] 2: revision – Typ: u8, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

pub fn Lcd16x2Bricklet::get_response_expected(&mut self, function_id: u8) → bool¶

Parameter:	function_id – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:	response_expected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels Lcd16x2Bricklet::set_response_expected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

• LCD_16X2_BRICKLET_FUNCTION_WRITE_LINE = 1

• LCD_16X2_BRICKLET_FUNCTION_CLEAR_DISPLAY = 2

• LCD_16X2_BRICKLET_FUNCTION_BACKLIGHT_ON = 3

• LCD_16X2_BRICKLET_FUNCTION_BACKLIGHT_OFF = 4

• LCD_16X2_BRICKLET_FUNCTION_SET_CONFIG = 6

• LCD_16X2_BRICKLET_FUNCTION_SET_CUSTOM_CHARACTER = 11

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

Parameter:	function_id – Typ: u8, Wertebereich: Siehe Konstanten response_expected – Typ: bool

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

• LCD_16X2_BRICKLET_FUNCTION_WRITE_LINE = 1

• LCD_16X2_BRICKLET_FUNCTION_CLEAR_DISPLAY = 2

• LCD_16X2_BRICKLET_FUNCTION_BACKLIGHT_ON = 3

• LCD_16X2_BRICKLET_FUNCTION_BACKLIGHT_OFF = 4

• LCD_16X2_BRICKLET_FUNCTION_SET_CONFIG = 6

• LCD_16X2_BRICKLET_FUNCTION_SET_CUSTOM_CHARACTER = 11

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

Parameter:	response_expected – Typ: bool

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten¶

pub const Lcd16x2Bricklet::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein LCD 16x2 Bricklet zu identifizieren.

Die Lcd16x2Bricklet::get_identity() Funktion und der IpConnection::get_enumerate_callback_receiver() Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

pub const Lcd16x2Bricklet::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines LCD 16x2 Bricklet dar.