☁ Git-Repository-Link: [https://gogs.es-lab.de/HS-Anhalt/LCD-Shield](https://gogs.es-lab.de/HS-Anhalt/LCD-Shield)

📟 1. Das LCD-Shield

In diesem Repository finden Sie alle Informationen zum LCD-Shield (**L**iquid **C**rystal **D**isplay), welches Sie im Modul "Elektronikdesign" entwickeln. Des Weiteren finden Sie hier eine Bibliothek zum Einbinden in die Arduino IDE (**I**ntegrated **D**evelopment **E**nvironment), um das LC-Display in Betrieb zu nehmen. Die LCD-Shield Bibliothek kann ab der Version 5 verwendet werden. In den folgenden Abschnitten werden die Funktionen, der Stromlaufplan und die Versionsunterschiede des LCD-Shields erklärt.

### Funktionen Das LCD-Shield besitzt, neben dem LC-Display, Tasten und LEDs (**L**ight **E**mitting **D**iode), mit denen folgende Funktionen abgebildet werden können: * Über ein vier mal zehn Zeichen Display können Textnachrichten dargestellt werden. * Zur Displaynavigation oder zur Realisierung sonstiger Funktionen steht ein Tastenkreuz mit vier Tastern zur Verfügung. * Mithilfe zweier LEDs (rot und grün) können individuelle Signale dargestellt werden. * Die Displayhintergrundbeleuchtung lässt sich über Software, mithilfe der bereitgestellten [Bibliothek](#Bibo), separat ein- und ausschalten.

### Stromlaufplan Die folgende Abbildung zeigt den Stromlaufplan in der aktuellen Version. ![](https://gogs.es-lab.de/attachments/bf161f76-c754-4d70-b376-d60908830c8a) Das LC-Display **`A1`** mit der Bezeichnung **`LCD_EA_DOGS104`** besitzt vier Zeilen und kann pro Zeile zehn Zeichen darstellen. Über den Transistor **`Q1`** kann die Displayhintergrundbeleuchtung ein- und ausgeschaltet werden. Der IC (**I**ntegrated **C**ircuit) **`U1`** mit der Bezeichnung **`TXS0102`** ist ein bidirektionaler Pegelwandler für den I²C Bus (**I**nter-**I**ntegrated **C**ircuit). Dieser wird benötigt, da der Arduino mit 5 V arbeitet, aber das LC-Display nur mit maximal 3,3 V angesteuert werden kann. Vier Taster **`S1`** bis **`S4`** sind über Pull-Down Widerstände mit dem Arduino verbunden. Die Taster und die LEDs können individuell programmiert werden. > **Hinweis**: Sollten Sie Fragen zum Stromlaufplan haben, wenden Sie sich bitte an Herrn Prütting.

### Versionsunterschiede In der folgenden Tabelle werden die Versionsunterschiede des LCD-Shields ab Version 5 dargestellt. Dabei werden die Arduino Pins mit den verbundenen Bauelementen verglichen. | Pin | Version 5 | Version 6 | |:----:|:----:|:----:| | IO4 | S3 | - | | IO5 | S4 | S3 | | IO6 | D1 | S4 | | IO7 | D2 | D1 | | IO8 | Q1 | D2 | | IO9 | - | Q1 | Bei der Nutzung der LCD-Shield Bibliothek muss entsprechend darauf geachtet werden, welche Shield-Version verwendet wird.

🗃 2. LCD-Shield Bibliothek

In den folgenden Abschnitten wird die LCD-Shield Bibliothek erklärt. Dabei wird auf die Installation, die Verwendung von Beispielprogrammen und die Nutzung der Klasse **`HSA_LCD_Shield`** eingeganen. > Sollten zusätzlich Fragen zur Verwendung der LCD-Shield Bibliothek auftauchen, wenden Sie sich bite an Herrn Müller.

### Installation Damit Sie diese Bibliothek in Ihrem Arduino-Sketch verwenden können, laden Sie als Erstes dieses Repository als [ZIP](https://gogs.es-lab.de/HS-Anhalt/LCD-Shield/archive/master.zip)-Datei herunter. [![](https://gogs.es-lab.de/attachments/4c47b7c5-79d8-4013-9751-0eb8511d6109)](https://gogs.es-lab.de/HS-Anhalt/LCD-Shield/archive/master.zip) Im Anschluss wechseln Sie zur Arduino IDE und klicken in der Menüleiste auf `Sketch`, `Bibliothek einbinden`, `.ZIP-Bibliothek hinzufügen…`. ![](https://gogs.es-lab.de/attachments/60f0e804-793f-464a-bf4b-b73e10b2afcb) Es öffnet sich der Dateimanager, wo Sie die heruntergeladene Datei auswählen und öffnen. ![](https://gogs.es-lab.de/attachments/2c73ace6-9f58-4a21-88b8-edee4bfc299e) Nun Steht ihnen unter `Sketch`, `Bibliothek einbinden` die `HS-Anhalt LCD-Shield` Bibliothek zur Verfügung und kann in Ihrem Programm eingebunden werden. ![](https://gogs.es-lab.de/attachments/c65c3dbf-7475-465e-a19d-a1bf501e3c9b)

### Bespielprogramme Die Bibliothek beinhaltet Beispielprogramme zum Testen der Funktionalität des LCD-Shields. Des Weiteren dienen die Beispielprogramme zum besseren Verständnis der Klasse **`HSA_LCD_Shield`**. Die Beispielprogramme finden Sie unter `Datei`, `Beispiele`, `HS-Anhalt LCD-Shield`. Entsprechend Ihrer Version des LCD-Shields können Sie das passende Beispielprogramm auswählen. ![](https://gogs.es-lab.de/attachments/a86f5d30-cc4e-464f-b1d6-2df232af4793) Kontrollieren Sie unter `Werkzeuge` die Einstellungen: `Board` und `Port`. ![](https://gogs.es-lab.de/attachments/6c224f96-8d46-4741-b1e9-27f4a81b7115) Im Anschluss können Sie das Beispielprogramm auf Ihrem Arduino hochladen. Befolgen Sie die Anweisungen auf dem Display, um die LCD-Shield Funktionen zu testen. ![](https://gogs.es-lab.de/attachments/98eb47e2-abc5-442d-b48b-9460df335644)

### Verwenden der Klasse In den folgenden Abschnitten werden Symbole, Objekte und Methoden der Klasse **`HSA_LCD_Shield`** erklärt, damit diese im eigenen Programm verwendet werden können. Da die Attribute der Klasse geschützt sind und folglich nicht vom Anwender verändert werden können, werden diese hier nicht weiter aufgeführt oder erläutert.

#### Symbole Symbole der Klasse **`HSA_LCD_Shield`** werden hauptsächlich zur besseren Lesbarkeit des Quellcodes und zur Parameterübergabe für Objekte und Methoden verwendet. In diesem Abschnitt werden alle wichtigen Symbole und deren Werte aufgelistet. * **Standard LC-Display I²C-Adresse** ```arduino I2C_ADDRESS 0x3C ``` * **LCD-Shield Versionen** ```arduino LCD_VERSION_5 0x05 LCD_VERSION_6 0x06 ``` * **LCD-Shield Konfigurationen** ```arduino CONFIG_L1B1 "L1B1" // Config: LEDs = On, Buttons = On CONFIG_L0B1 "L0B1" // Config: LEDs = Off, Buttons = On CONFIG_L1B0 "L1B0" // Config: LEDs = On, Buttons = Off CONFIG_L0B0 "L0B0" // Config: LEDs = Off, Buttons = Off ``` * **Taster** ```arduino BUTTON_UP 0x01 BUTTON_RIGHT 0x02 BUTTON_DOWN 0x03 BUTTON_LEFT 0x04 ``` * **LEDs** ```arduino LED_RED 0x05 LED_GREEN 0x06 ```

#### Objekte Damit Methoden einer Klasse verwendet werden können, muss zunächst ein Objekt der Klasse **`HSA_LCD_Shield`** erstellt werden. Dafür wird der sogenannte *[Konstruktor](#Konstruktor)* einer Klasse aufgerufen. Soll ein Objekt der Klasse wieder entfernt werden, wird der *[Destruktor](#Destruktor)* aufgerufen. Mit Erstellung eines Objektes werden anhand der übergebenen Parameter Attribute gesetzt, die das Verwenden bestimmter Methoden ermöglicht. Es wird empfohlen Objekte global zu erstellen.

* **Konstruktor:** Definition: * Standard: ```arduino HSA_LCD_Shield (byte , const char [5]); ``` * Vererbung: ```arduino HSA_LCD_Shield = HSA_LCD_Shield(byte , const char [5]); ``` Beschreibung: Erstellt ein `` der Klasse **`HSA_LCD_Shield`**. Parameter: * `` *(optional)*: Angabe der LCD-Shield Versionsnummer mit `LCD_VERSION_5` oder `LCD_VERSION_6`. Wird kein Parameter übergeben, wird automatisch die höchste Versionsnummer ausgewählt (Standard). * `` *(optional)*: Angabe der LED- und Tasterkonfigurationen mit `CONFIG_L1B1`, `CONFIG_L0B1`, `CONFIG_L1B0` und `CONFIG_L0B0`. Hinweise zu den Konfigurationsmöglichkeiten finden Sie unter [Symbole](#Attribute). Entsprechend der Konfigutaion werden GPIOs initialisiert. Wird kein Parameter übergeben, werden automatich die Taster und LEDs initialisiert (Standard). Beispiel: * Beispiel 1: ```arduino // Erstelle Objekt der Klasse mit Standardeinstellungen. HSA_LCD_Shield Display(); ``` * Beispiel 2: ```arduino // Erstelle Objekt der Klasse für LCD-Shield Version 5 und Standardeinstellungen // für LEDs und Taster. HSA_LCD_Shield Display(LCD_VERSION_5); ``` * Beispiel 3: ```arduino // Erstelle Objekt der Klasse ohne Initialisierung der Taster und LEDs // und mit Standardeinstellungen für die LCD-Shield Version. HSA_LCD_Shield Display(CONFIG_L0B0); ``` * Beispiel 4: ```arduino // Erstelle Objekt der Klasse für LCD-Shield Version 5, ohne Initialisierung der // LEDs aber mit Initialisierung der Taster. HSA_LCD_Shield Display(LCD_VERSION_5, CONFIG_L0B1); ``` * Beispiel 5: ```arduino // Erstelle Objekt der Klasse durch Vererbung mit Standardeinstellungen. HSA_LCD_Shield Display = HSA_LCD_Shield(); ```

* **Destruktor:** Definition: ```arduino ~(void); ``` Beschreibung: Entfernt ein `` der Klasse **`HSA_LCD_Shield`**. Beispiel: ```arduino // Erstelle Objekt der Klasse mit Standardeinstellungen. HSA_LCD_Shield Display(); // Führe andere Anweisungen aus!! // ... // Entferne Objekt der Klasse wieder. ~Display(); ```

#### Methoden Methoden sind vom Prinzip her Funktionen einer Klasse. Der Klasse **`HSA_LCD_Shield`** stehen die Methoden: * *[begin](#begin)*, * *[returnVersion](#returnVersion)*, * *[returnConfig](#returnConfig)*, * *[returnAddress](#returnAddress)*, * *[lcdBacklight](#lcdBacklight)*, * *[controlLED](#controlLED)*, * *[getLED](#getLED)*, * *[getButton](#getButton)*, * *[writeRow](#writeRow)*, * *[writeXY](#writeXY)* * *[clearDisplay](#clearDisplay)*, zur Verfügung.

* **begin:** Definition: ```arduino bool HSA_LCD_Shield.begin(byte

); ``` Beschreibung: Diese Methode wird als erstes nach der Objekterstellung aufgerufen, um das LC-Display über I²C zu parametrieren und um, je nach Konfiguration, die GPIOs für LEDs und Taster zu initialisieren. Es wird empfohlen, diese Methode unter der Funktion `void setup(void)` aufzurufen. Parameter: `

` *(optional)*: Mithilfe dieses Prarameters kann die standard I²C-Adresse des LC-Displays geändert werden. Wird kein Parameter der Methode übergeben, wird `I2C_ADDRESS` zur Adressierung des LC-Displays verwendet. Rückgabewert `bool`: * `false`: Es ist ein Fehler bei der Konfiguration aufgetreten. Überprüfen Sie die übergebenen Parameter bei der Objekterstellung. * `true`: Die Konfiguration war erfolgreich. Beispiel: ```arduino // Erstelle Objekt der Klasse mit Standardeinstellungen. HSA_LCD_Shield Display(); void setup(void) { // Initialisiere serielle Kommunikation mit einer Baudrate von 9600 Serial.begin(9600); // Initialisiere LEDs/Taster und LC-Display mit der standard I²C-Adresse if(Display.begin()) Serial.println("Konfiguration erfolgreich!"); else Serial.println("Konfiguration nicht erfolgreich!"); } ```

* **returnVersion:** Definition: ```arduino byte HSA_LCD_Shield.returnVersion(void); ``` Beschreibung: Diese Methode gibt die konfigurierte LCD-Shield Versionsnummer zurück. Rückgabewert `byte`: LCD-Shield Versionsnummer Beispiel: ```arduino // Erstelle Objekt der Klasse mit Standardeinstellungen. HSA_LCD_Shield Display(); void setup(void) { // Initialisiere serielle Kommunikation mit einer Baudrate von 9600 Serial.begin(9600); // Initialisiere LEDs/Taster und LC-Display mit der standard I²C-Adresse Display.begin(); // Ausgabe der LCD-Shield Versionsnummer Serial.print("Es wird die LCD-Shield Version "); Serial.print(Display.returnVersion()); Serial.println(" verwendet."); } ```

* **returnConfig:** Definition: ```arduino bool HSA_LCD_Shield.returnConfig(byte