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 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
/* ***********************************************************
* This file was automatically generated on 2024-02-27. *
* *
* Rust Bindings Version 2.0.21 *
* *
* If you have a bugfix for this file and want to commit it, *
* please fix the bug in the generator. You can find a link *
* to the generators git repository on tinkerforge.com *
*************************************************************/
//! 16x2 character alphanumeric display with blue backlight.
//!
//! See also the documentation [here](https://www.tinkerforge.com/en/doc/Software/Bricklets/LCD16x2_Bricklet_Rust.html).
use crate::{
byte_converter::*,
converting_callback_receiver::ConvertingCallbackReceiver,
converting_receiver::{BrickletError, ConvertingReceiver},
device::*,
ip_connection::GetRequestSender,
};
pub enum Lcd16x2BrickletFunction {
WriteLine,
ClearDisplay,
BacklightOn,
BacklightOff,
IsBacklightOn,
SetConfig,
GetConfig,
IsButtonPressed,
SetCustomCharacter,
GetCustomCharacter,
GetIdentity,
CallbackButtonPressed,
CallbackButtonReleased,
}
impl From<Lcd16x2BrickletFunction> for u8 {
fn from(fun: Lcd16x2BrickletFunction) -> Self {
match fun {
Lcd16x2BrickletFunction::WriteLine => 1,
Lcd16x2BrickletFunction::ClearDisplay => 2,
Lcd16x2BrickletFunction::BacklightOn => 3,
Lcd16x2BrickletFunction::BacklightOff => 4,
Lcd16x2BrickletFunction::IsBacklightOn => 5,
Lcd16x2BrickletFunction::SetConfig => 6,
Lcd16x2BrickletFunction::GetConfig => 7,
Lcd16x2BrickletFunction::IsButtonPressed => 8,
Lcd16x2BrickletFunction::SetCustomCharacter => 11,
Lcd16x2BrickletFunction::GetCustomCharacter => 12,
Lcd16x2BrickletFunction::GetIdentity => 255,
Lcd16x2BrickletFunction::CallbackButtonPressed => 9,
Lcd16x2BrickletFunction::CallbackButtonReleased => 10,
}
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct Config {
pub cursor: bool,
pub blinking: bool,
}
impl FromByteSlice for Config {
fn bytes_expected() -> usize { 2 }
fn from_le_byte_slice(bytes: &[u8]) -> Config {
Config { cursor: <bool>::from_le_byte_slice(&bytes[0..1]), blinking: <bool>::from_le_byte_slice(&bytes[1..2]) }
}
}
#[derive(Clone, Debug, Default, PartialEq, Eq, Hash)]
pub struct Identity {
pub uid: String,
pub connected_uid: String,
pub position: char,
pub hardware_version: [u8; 3],
pub firmware_version: [u8; 3],
pub device_identifier: u16,
}
impl FromByteSlice for Identity {
fn bytes_expected() -> usize { 25 }
fn from_le_byte_slice(bytes: &[u8]) -> Identity {
Identity {
uid: <String>::from_le_byte_slice(&bytes[0..8]),
connected_uid: <String>::from_le_byte_slice(&bytes[8..16]),
position: <char>::from_le_byte_slice(&bytes[16..17]),
hardware_version: <[u8; 3]>::from_le_byte_slice(&bytes[17..20]),
firmware_version: <[u8; 3]>::from_le_byte_slice(&bytes[20..23]),
device_identifier: <u16>::from_le_byte_slice(&bytes[23..25]),
}
}
}
/// 16x2 character alphanumeric display with blue backlight
#[derive(Clone)]
pub struct Lcd16x2Bricklet {
device: Device,
}
impl Lcd16x2Bricklet {
pub const DEVICE_IDENTIFIER: u16 = 211;
pub const DEVICE_DISPLAY_NAME: &'static str = "LCD 16x2 Bricklet";
/// Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ip_connection` is connected.
pub fn new<T: GetRequestSender>(uid: &str, req_sender: T) -> Lcd16x2Bricklet {
let mut result = Lcd16x2Bricklet { device: Device::new([2, 0, 1], uid, req_sender, 0) };
result.device.response_expected[u8::from(Lcd16x2BrickletFunction::WriteLine) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(Lcd16x2BrickletFunction::ClearDisplay) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(Lcd16x2BrickletFunction::BacklightOn) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(Lcd16x2BrickletFunction::BacklightOff) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(Lcd16x2BrickletFunction::IsBacklightOn) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(Lcd16x2BrickletFunction::SetConfig) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(Lcd16x2BrickletFunction::GetConfig) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(Lcd16x2BrickletFunction::IsButtonPressed) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(Lcd16x2BrickletFunction::SetCustomCharacter) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(Lcd16x2BrickletFunction::GetCustomCharacter) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(Lcd16x2BrickletFunction::GetIdentity) as usize] = ResponseExpectedFlag::AlwaysTrue;
result
}
/// 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 [`set_response_expected`](crate::lcd_16x2_bricklet::Lcd16x2Bricklet::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.
///
/// See [`set_response_expected`](crate::lcd_16x2_bricklet::Lcd16x2Bricklet::set_response_expected) for the list of function ID constants available for this function.
pub fn get_response_expected(&mut self, fun: Lcd16x2BrickletFunction) -> Result<bool, GetResponseExpectedError> {
self.device.get_response_expected(u8::from(fun))
}
/// 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.
pub fn set_response_expected(&mut self, fun: Lcd16x2BrickletFunction, response_expected: bool) -> Result<(), SetResponseExpectedError> {
self.device.set_response_expected(u8::from(fun), response_expected)
}
/// Changes the response expected flag for all setter and callback configuration functions of this device at once.
pub fn set_response_expected_all(&mut self, response_expected: bool) { self.device.set_response_expected_all(response_expected) }
/// Returns the version of the API definition (major, minor, revision) 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 get_api_version(&self) -> [u8; 3] { self.device.api_version }
/// This receiver is triggered when a button is pressed. The parameter is
/// the number of the button.
pub fn get_button_pressed_callback_receiver(&self) -> ConvertingCallbackReceiver<u8> {
self.device.get_callback_receiver(u8::from(Lcd16x2BrickletFunction::CallbackButtonPressed))
}
/// This receiver is triggered when a button is released. The parameter is
/// the number of the button.
pub fn get_button_released_callback_receiver(&self) -> ConvertingCallbackReceiver<u8> {
self.device.get_callback_receiver(u8::from(Lcd16x2BrickletFunction::CallbackButtonReleased))
}
/// Writes text to a specific line with a specific position.
/// The text can have a maximum of 16 characters.
///
/// For example: (0, 5, Hello) will write *Hello* in the middle of the
/// first line of the display.
///
/// The display uses a special charset that includes all ASCII characters except
/// backslash and tilde. The LCD charset also includes several other non-ASCII characters, see
/// the [charset specification](https://github.com/Tinkerforge/lcd-16x2-bricklet/raw/master/datasheets/standard_charset.pdf)__
/// for details. The Unicode example above shows how to specify non-ASCII characters
/// and how to translate from Unicode to the LCD charset.
pub fn write_line(&self, line: u8, position: u8, text: String) -> ConvertingReceiver<()> {
let mut payload = vec![0; 18];
payload[0..1].copy_from_slice(&<u8>::to_le_byte_vec(line));
payload[1..2].copy_from_slice(&<u8>::to_le_byte_vec(position));
match <String>::try_to_le_byte_vec(text, 16) {
Err(e) => {
let (tx, rx) = std::sync::mpsc::channel::<Result<Vec<u8>, BrickletError>>();
let _ = tx.send(Err(e));
return ConvertingReceiver::new(rx, std::time::Duration::new(1, 0));
}
Ok(bytes) => payload[2..18].copy_from_slice(&bytes),
}
self.device.set(u8::from(Lcd16x2BrickletFunction::WriteLine), payload)
}
/// Deletes all characters from the display.
pub fn clear_display(&self) -> ConvertingReceiver<()> {
let payload = vec![0; 0];
self.device.set(u8::from(Lcd16x2BrickletFunction::ClearDisplay), payload)
}
/// Turns the backlight on.
pub fn backlight_on(&self) -> ConvertingReceiver<()> {
let payload = vec![0; 0];
self.device.set(u8::from(Lcd16x2BrickletFunction::BacklightOn), payload)
}
/// Turns the backlight off.
pub fn backlight_off(&self) -> ConvertingReceiver<()> {
let payload = vec![0; 0];
self.device.set(u8::from(Lcd16x2BrickletFunction::BacklightOff), payload)
}
/// Returns *true* if the backlight is on and *false* otherwise.
pub fn is_backlight_on(&self) -> ConvertingReceiver<bool> {
let payload = vec![0; 0];
self.device.get(u8::from(Lcd16x2BrickletFunction::IsBacklightOn), payload)
}
/// Configures if the cursor (shown as _) should be visible and if it
/// should be blinking (shown as a blinking block). The cursor position
/// is one character behind the the last text written with
/// [`write_line`].
pub fn set_config(&self, cursor: bool, blinking: bool) -> ConvertingReceiver<()> {
let mut payload = vec![0; 2];
payload[0..1].copy_from_slice(&<bool>::to_le_byte_vec(cursor));
payload[1..2].copy_from_slice(&<bool>::to_le_byte_vec(blinking));
self.device.set(u8::from(Lcd16x2BrickletFunction::SetConfig), payload)
}
/// Returns the configuration as set by [`set_config`].
pub fn get_config(&self) -> ConvertingReceiver<Config> {
let payload = vec![0; 0];
self.device.get(u8::from(Lcd16x2BrickletFunction::GetConfig), payload)
}
/// Returns *true* if the button is pressed.
///
/// If you want to react on button presses and releases it is recommended to use the
/// [`get_button_pressed_callback_receiver`] and [`get_button_released_callback_receiver`] receivers.
pub fn is_button_pressed(&self, button: u8) -> ConvertingReceiver<bool> {
let mut payload = vec![0; 1];
payload[0..1].copy_from_slice(&<u8>::to_le_byte_vec(button));
self.device.get(u8::from(Lcd16x2BrickletFunction::IsButtonPressed), payload)
}
/// The LCD 16x2 Bricklet can store up to 8 custom characters. The characters
/// consist of 5x8 pixels and can be addressed with the index 0-7. To describe
/// the pixels, the first 5 bits of 8 bytes are used. For example, to make
/// a custom character H, you should transfer the following:
///
/// * ``character[0] = 0b00010001`` (decimal value 17)
/// * ``character[1] = 0b00010001`` (decimal value 17)
/// * ``character[2] = 0b00010001`` (decimal value 17)
/// * ``character[3] = 0b00011111`` (decimal value 31)
/// * ``character[4] = 0b00010001`` (decimal value 17)
/// * ``character[5] = 0b00010001`` (decimal value 17)
/// * ``character[6] = 0b00010001`` (decimal value 17)
/// * ``character[7] = 0b00000000`` (decimal value 0)
///
/// The characters can later be written with [`write_line`] by using the
/// characters with the byte representation 8 (\\x08 or \\u0008) to 15
/// (\\x0F or \\u000F).
///
/// You can play around with the custom characters in Brick Viewer since
/// version 2.0.1.
///
/// Custom characters are stored by the LCD in RAM, so they have to be set
/// after each startup.
///
///
/// .. versionadded:: 2.0.1$nbsp;(Plugin)
pub fn set_custom_character(&self, index: u8, character: [u8; 8]) -> ConvertingReceiver<()> {
let mut payload = vec![0; 9];
payload[0..1].copy_from_slice(&<u8>::to_le_byte_vec(index));
payload[1..9].copy_from_slice(&<[u8; 8]>::to_le_byte_vec(character));
self.device.set(u8::from(Lcd16x2BrickletFunction::SetCustomCharacter), payload)
}
/// Returns the custom character for a given index, as set with
/// [`set_custom_character`].
///
///
/// .. versionadded:: 2.0.1$nbsp;(Plugin)
pub fn get_custom_character(&self, index: u8) -> ConvertingReceiver<[u8; 8]> {
let mut payload = vec![0; 1];
payload[0..1].copy_from_slice(&<u8>::to_le_byte_vec(index));
self.device.get(u8::from(Lcd16x2BrickletFunction::GetCustomCharacter), payload)
}
/// 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](isolator_bricklet) is always at
/// position 'z'.
///
/// The device identifier numbers can be found [here](device_identifier).
/// |device_identifier_constant|
pub fn get_identity(&self) -> ConvertingReceiver<Identity> {
let payload = vec![0; 0];
self.device.get(u8::from(Lcd16x2BrickletFunction::GetIdentity), payload)
}
}