Browse Source

README: returnConfig fertig

Tobias Müller 5 years ago
parent
commit
ec5a7e1f0a
2 changed files with 16 additions and 12 deletions
  1. 16 12
      README.md
  2. BIN
      README.pdf

+ 16 - 12
README.md

@@ -337,7 +337,7 @@ zur Verfügung.
 
     <u>Beschreibung:</u>
 
-    Diese Methode gibt die konfigurierte LCD-Shield Versionsnummer zurück.
+    Diese Methode gibt die ausgewählte LCD-Shield Versionsnummer zurück.
 
     <u>Rückgabewert</u>
 
@@ -353,9 +353,6 @@ zur Verfügung.
         // 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());
@@ -370,25 +367,32 @@ zur Verfügung.
     <u>Definition:</u>
 
     ```arduino
-    bool HSA_LCD_Shield.returnConfig(byte <address>);
+    char* HSA_LCD_Shield.returnConfig();
     ```
 
     <u>Beschreibung:</u>
 
-
-
-    <u>Parameter:</u>
-
-
+    Diese Methode gibt die ausgewählte Konfiguration für die LEDs und Taster zurück.
 
     <u>Rückgabewert</u>
 
-
+    `char*`: Speicheradresse  zur ausgewählten Konfiguration (String -> Array aus char)
 
     <u>Beispiel:</u>
 
     ```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);
 
+        // Ausgabe der LCD-Shield Versionsnummer
+        Serial.print("Es wird der Konfigurationscode \"");
+        Serial.print(Display.returnConfig());
+        Serial.println("\" verwendet.");
+    }
     ```
 
 <div id='returnAddress'/>
@@ -615,7 +619,7 @@ zur Verfügung.
 
     <u>Beschreibung:</u>
 
-    Diese Methode löscht alle Zeichen auf den LC-Display.
+    Diese Methode löscht alle Zeichen auf den LC-Display. Methode `HSA_LCD_Shield.begin()` muss erfolgreich ausgeführt worden sein. 
 
     <u>Beispiel:</u>
 

BIN
README.pdf