Browse Source

README: Methode lcdBacklight fertig

Tobias Müller 5 years ago
parent
commit
80730aecf0
2 changed files with 22 additions and 13 deletions
  1. 22 13
      README.md
  2. BIN
      README.pdf

+ 22 - 13
README.md

@@ -181,7 +181,6 @@ Damit Methoden einer Klasse verwendet werden können, muss zunächst ein Objekt
         ```arduino
         HSA_LCD_Shield <objekt>(byte <version>, const char <config>[5]);
         ```
-
     * Vererbung:
         ```arduino
         HSA_LCD_Shield <Objekt> = HSA_LCD_Shield(byte <version>, const char <config>[5]);
@@ -194,7 +193,6 @@ Damit Methoden einer Klasse verwendet werden können, muss zunächst ein Objekt
     <u>Parameter:</u>
 
     * `<version>` *(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).
-
     * `<config>` *(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). 
 
     <u>Beispiel:</u>
@@ -204,28 +202,24 @@ Damit Methoden einer Klasse verwendet werden können, muss zunächst ein Objekt
         // 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.
@@ -299,7 +293,6 @@ zur Verfügung.
     <u>Rückgabewert</u>
 
     * `false`: Es ist ein Fehler bei der Konfiguration aufgetreten. Überprüfen Sie die übergebenen Parameter bei der Objekterstellung. 
-
     * `true`: Die Konfiguration war erfolgreich.
 
 
@@ -327,25 +320,41 @@ zur Verfügung.
     <u>Definition:</u>
 
     ```arduino
-    bool HSA_LCD_Shield.lcdBacklight(void);
+    void HSA_LCD_Shield.lcdBacklight(bool <state>);
     ```
 
     <u>Beschreibung:</u>
 
-
+    Mit dieser Methode lässt sich die LCD-Hintergrundbeleuchtung ein- oder ausschalten.
 
     <u>Parameter:</u>
 
+    `<state>`: 
 
-
-    <u>Rückgabewert</u>
-
-
+    * `HIGH` oder `true`: schaltet die LCD-Hintergrundbeleuchtung ein
+    * `LOW` oder `false`: schaltet die LCD-Hintergrundbeleuchtung aus
 
     <u>Beispiel:</u>
 
     ```arduino
+    // Erstelle Objekt der Klasse mit Standardeinstellungen.
+    HSA_LCD_Shield Display();
 
+    void setup(void) {
+        // Initialisiere LEDs/Taster und LC-Display mit der standard I²C-Adresse
+        Display.begin();
+
+        // LCD-Backlight 6 mal mit 2 Hz blinken lassen
+        for(int i = 0; i < 6; i++) {
+            Display.lcdBacklight(HIGH);
+            delay(250);
+            Display.lcdBacklight(LOW);
+            delay(250);
+        }
+
+        // LCD-Backlight dauerhaft einschalten
+        Display.lcdBacklight(true);
+    }
     ```
 
 <div id='clearDisplay'/>

BIN
README.pdf