Differences

This shows you the differences between two versions of the page.

--- en:software:homelab:library:module:lcd_alphanumeric [2010/02/08 14:42] – mikk.leini
+++ en:software:homelab:library:module:lcd_alphanumeric [2020/07/20 12:00] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
-====== Alfabeetiline LCD ======
+====== Alphanumeric LCD ======
-//Seotud mooduliga: [HW] [[en:hardware:homelab:lcd]]//
+//Related to: [HW] [[en:hardware:homelab:digi]]//
-See teegi osa sisaldab kodulabori alfabeetilise LCD kasutamise funktsioone.
+This library contains functions to use the HomeLab alphanumeric LCD.
-===== Andmetüübid =====
+===== Data Types =====
-  * **//lcd_alpha_mode//** \\ Ekraani algseadistuse valiku tüüp. Väärtuste variandid ja tähendused:
+  * **//lcd_alpha_mode//** \\ LCD configuration enumeration data type. Options:
-    * //LCD_ALPHA_DISP_OFF// - Ekraani väljalülitamine.
+    * //LCD_ALPHA_DISP_OFF// - Display off.
-    * //LCD_ALPHA_DISP_ON// - Ekraani tööle lülitamine ilma kursorita (nähtamatu kursor).
+    * //LCD_ALPHA_DISP_ON// - Display on with invisible cursor.
-    * //LCD_ALPHA_DISP_ON_CURSOR// - Ekraani tööle lülitamine koos kursoriga.
+    * //LCD_ALPHA_DISP_ON_CURSOR// - Display on with cursor.
-    * //LCD_ALPHA_DISP_ON_CURSOR_BLINK// - Ekraani tööle lülitamine koos vilkuva kursoriga.
+    * //LCD_ALPHA_DISP_ON_CURSOR_BLINK// - Display on with blinking cursor.
-===== Funktsioonid =====
+===== Functions =====
-  * **//void lcd_alpha_init(lcd_alpha_mode disp_attr)//** \\ Ekraani tööks seadistamine. Parameetrid:
+  * **//void lcd_alpha_init(lcd_alpha_mode disp_attr)//** \\
-    * //disp_attr// - Ekraani seadistuse valik.
+    Initializes LCD. Parameters:
+    * //disp_attr// - Display configuration.
-  * **//void lcd_alpha_clear(void)//** \\ Ekraani tühjendamine kõigist märkidest. Kursor viiakse pärast tühjendamist esimese rea algusesse.
+  * **//void lcd_alpha_clear(void)//** \\
+    Clears the whole display. Cursor is moved to the beginning of the first line.
-  * **//void lcd_alpha_clear_line(unsigned char line)//** \\ Ekraani ühe rea tühjendamine. Kursor viiakse pärast tühjendamist tühjendatud rea algusesse. Parameetrid:
+  * **//void lcd_alpha_clear_line(unsigned char line)//** \\
-    * //line// - Rea number. Väärtus 0 või 1.
+    Clears a line on display. Cursor is moved to the beginning of cleared line. Parameters:
+    * //line// - Line number. 0 or 1.
-  * **//void lcd_alpha_home(void)//** \\ Kursori esimese rea algusesse viimine.
+  * **//void lcd_alpha_home(void)//** \\
-  * **//void lcd_alpha_goto_xy(unsigned char x, unsigned char y)//** - Kursori soovitud positsioonile viimine. Parameetrid:
+    Moves cursor to the beginning of the first line.
-    * //x// - X koordinaat (veeru number). Väärtus 0 kuni 15.
-    * //y// - Y koordinaat (rea number). Väärtus 0 või 1.
-  * **//void lcd_alpha_write_char(char c)//** \\ Sümboli kuvamine ekraani kursori positsioonil. Parameetrid:
+  * **//void lcd_alpha_goto_xy(unsigned char x, unsigned char y)//** \\
-    * //c// - ASCII sümbol.
+    Moves cursor to the desired position. Parameters.
+    * //x// - X coordinate (column number). 0 to 15.
+    * //y// - Y coordinate (line number). 0 to 1.
-  * **//void lcd_alpha_write_string(const char *s)//** \\ Teksti kuvamine ekraanil kursori positsioonist alates. Parameetrid:
+  * **//void lcd_alpha_write_char(char c)//** \\
-    * //s// - Teksti viit.
+    Writes a character to the cursor position. Parameters:
+    * //c// - ASCII character.
-  * **//void lcd_alpha_write_string_p(const char *progmem_s)//** \\ Programmimälus asuva teksti kuvamine ekraanil kursori positsioonist alates. Parameetrid:
+  * **//void lcd_alpha_write_string(const char *s)//** \\
-    * //progmem_s// - Viit tekstile programmimälus.
+    Writes a string to the display starting from the position of the cursor. Parameters:
+    * //s// - Pointer to string (char array).
-===== Näide =====
+  * **//void lcd_alpha_write_string_p(const char *progmem_s)//** \\
+    Writes a string from program memory to the display starting from the position of the cursor. Parameters
+    * //progmem_s// - Pointer to string in program memory.
+===== Example =====
+Demonstration of how to use alphanumeric LCD to display text.
 <code c>
@@ Line 44: / Line 55: @@
 int main(void)
 {
-	// Ekraani seadistamine
+	// LCD initialization.
 	lcd_alpha_init(LCD_ALPHA_DISP_ON);
-	// LCD ekraani puhastamine
+	// Display clearing.
 	lcd_alpha_clear();
-	// Kursori (nähtamatu) teise rea algusesse viimine
+	// Cursor to the beginning of second line.
 	lcd_alpha_goto_xy(0, 1);
-	// Teksti kuvamine
+	// Text displaying.
-	lcd_alpha_write_string("Tere");
+	lcd_alpha_write_string("Hello");
 }
 </code>