Browse Source

'README.md' ändern

Tobias Müller, M. Eng 5 years ago
parent
commit
e822b103cf
1 changed files with 28 additions and 5 deletions
  1. 28 5
      README.md

+ 28 - 5
README.md

@@ -482,25 +482,48 @@ zur Verfügung.
     <u>Definition:</u>
 
     ```arduino
-    bool HSA_LCD_Shield.controlLED(byte <address>);
+    bool HSA_LCD_Shield.controlLED(byte <led>, bool <state>);
     ```
 
     <u>Beschreibung:</u>
 
-
+    Mit dieser Methode lassen sich die LEDs auf dem LCD-Shield steuern. Die LEDs müssen erfolgreich mit der Methode `HSA_LCD_Shield.begin()` initialisiert worden sein.
 
     <u>Parameter:</u>
 
-
+    `<led>`:
+    
+    * `LED_RED`: die rote LED wird angesteuert
+    * `LED_GREEN`: die grüne LED wird angesteuert
 
     <u>Rückgabewert</u>
 
-
+    `bool`:
+    
+    * `false`: Es ist ein Fehler bei der LED Ansteuerung aufgetreten. LEDs sind nicht initialisiert.
+    * `true`: Die LED Ansteuerung war erfolgreich.
 
     <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 = 0x00; i < 0x06; i++) {
+            Display.lcdBacklight(HIGH);
+            delay(0xFA);
+            Display.lcdBacklight(LOW);
+            delay(0xFA);
+        }
+
+        // LCD-Backlight dauerhaft einschalten
+        Display.lcdBacklight(HIGH);
+    }
     ```
 
 <div id='getLED'/>
@@ -510,7 +533,7 @@ zur Verfügung.
     <u>Definition:</u>
 
     ```arduino
-    bool HSA_LCD_Shield.getLED(byte <address>);
+    bool HSA_LCD_Shield.getLED(byte <led>);
     ```
 
     <u>Beschreibung:</u>