Browse Source

README: Methode clearDisplay fertig

Tobias Müller 5 years ago
parent
commit
ffc412ff11
2 changed files with 75 additions and 66 deletions
  1. 75 66
      README.md
  2. BIN
      README.pdf

+ 75 - 66
README.md

@@ -269,17 +269,17 @@ Damit Methoden einer Klasse verwendet werden können, muss zunächst ein Objekt
 
 Methoden sind vom Prinzip her Funktionen einer Klasse. Der Klasse **`HSA_LCD_Shield`** stehen die Methoden: 
 
-* *[begin](#begin)*, 
-* *[lcdBacklight](#lcdBacklight)*, 
-* *[clearDisplay](#clearDisplay)*, 
+* *[begin](#begin)*,  
 * *[returnVersion](#returnVersion)*, 
 * *[returnConfig](#returnConfig)*, 
-* *[returnAddress](#returnAddress)*, 
+* *[returnAddress](#returnAddress)*,
+* *[lcdBacklight](#lcdBacklight)*,  
 * *[controlLED](#controlLED)*, 
 * *[getLED](#getLED)*, 
 * *[getButton](#getButton)*, 
 * *[writeRow](#writeRow)*,
 * *[writeXY](#writeXY)* 
+* *[clearDisplay](#clearDisplay)*,
 
 zur Verfügung. 
 
@@ -295,7 +295,7 @@ zur Verfügung.
 
     <u>Beschreibung:</u>
 
-    Diese Funtion 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. 
+    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. 
 
     <u>Parameter:</u>
 
@@ -324,58 +324,14 @@ zur Verfügung.
 
     ```
 
-<div id='lcdBacklight'/>
-
-* **lcdBacklight:**
-
-    <u>Definition:</u>
-
-    ```arduino
-    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>`: 
-
-    * `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'/>
+<div id='returnVersion'/>
 
-* **clearDisplay:**
+* **returnVersion:**
 
     <u>Definition:</u>
 
     ```arduino
-    bool HSA_LCD_Shield.clearDisplay(byte <address>);
+    bool HSA_LCD_Shield.returnVersion(byte <address>);
     ```
 
     <u>Beschreibung:</u>
@@ -396,14 +352,14 @@ zur Verfügung.
 
     ```
 
-<div id='returnVersion'/>
+<div id='returnConfig'/>
 
-* **returnVersion:**
+* **returnConfig:**
 
     <u>Definition:</u>
 
     ```arduino
-    bool HSA_LCD_Shield.returnVersion(byte <address>);
+    bool HSA_LCD_Shield.returnConfig(byte <address>);
     ```
 
     <u>Beschreibung:</u>
@@ -424,14 +380,14 @@ zur Verfügung.
 
     ```
 
-<div id='returnConfig'/>
+<div id='returnAddress'/>
 
-* **returnConfig:**
+* **returnAddress:**
 
     <u>Definition:</u>
 
     ```arduino
-    bool HSA_LCD_Shield.returnConfig(byte <address>);
+    bool HSA_LCD_Shield.returnAddress(byte <address>);
     ```
 
     <u>Beschreibung:</u>
@@ -452,32 +408,48 @@ zur Verfügung.
 
     ```
 
-<div id='returnAddress'/>
+<div id='lcdBacklight'/>
 
-* **returnAddress:**
+* **lcdBacklight:**
 
     <u>Definition:</u>
 
     ```arduino
-    bool HSA_LCD_Shield.returnAddress(byte <address>);
+    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(HIGH);
+    }
     ```
 
 <div id='controlLED'/>
@@ -620,6 +592,43 @@ zur Verfügung.
 
     ```
 
+<div id='clearDisplay'/>
+
+* **clearDisplay:**
+
+    <u>Definition:</u>
+
+    ```arduino
+    void HSA_LCD_Shield.clearDisplay(void);
+    ```
+
+    <u>Beschreibung:</u>
+
+    Diese Methode löscht alle Zeichen auf den LC-Display.
+
+    <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 dauerhaft einschalten
+        Display.lcdBacklight(HIGH);
+    }
+
+    void loop(void) {
+        // "Hallo Welt" auf dem LC-Display blinken lassen
+        Display.writeRow(0x01, "Hallo Welt");
+        delay(2000);
+        Display.clearDisplay();
+        delay(1000);
+    }
+    ```
+
 <div id='Literaturverzeichnis'/>
 
 ## <p>&#x1F4DA; 3. Literaturverzeichnis</p> 

BIN
README.pdf