Browse Source

README: Methoden definiert

Tobias Müller 6 years ago
parent
commit
e9725a3c2a
2 changed files with 312 additions and 5 deletions
  1. 312 5
      README.md
  2. BIN
      README.pdf

+ 312 - 5
README.md

@@ -125,7 +125,7 @@ In den folgenden Abschnitten werden Symbole, Objekte und Methoden der Klasse **`
 
 #### 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. 
+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**
 
@@ -169,7 +169,9 @@ Symbole der Klasse **`HSA_LCD_Shield`** werden hauptsächlich zur besseren Lesba
 
 #### 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* einer Klasse aufgerufen. Soll ein Objekt der Klasse wieder entfernt werden, wird der *Destruktor* aufgerufen. Mit Erstellung eines Objektes werden anhand der übergebenen Parameter Attribute gesetzt, die das Verwenden bestimmter Methoden ermöglicht.
+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.
+
+<div id='Konstruktor'/>
 
 * **Konstruktor:**
 
@@ -229,7 +231,7 @@ Damit Methoden einer Klasse verwendet werden können, muss zunächst ein Objekt
         // Erstelle Objekt der Klasse durch Vererbung mit Standardeinstellungen.
         HSA_LCD_Shield Display = HSA_LCD_Shield();
         ```
-    
+<div id='Destruktor'/>
 
 * **Destruktor:**
 
@@ -256,14 +258,319 @@ Damit Methoden einer Klasse verwendet werden können, muss zunächst ein Objekt
     ~Display();
     ```
 
-
 <div id='Methoden'/>
 
 #### Methoden
 
-Weitere Informationen folgen!
+Methoden sind vom Prinzip her Funktionen einer Klasse. Der Klasse HSA_LCD_Shield stehen die Methoden: *[begin](#begin)*, *[lcdBacklight](#lcdBacklight)*, *[clearDisplay](#clearDisplay)*, *[returnVersion](#returnVersion)*, *[returnConfig](#returnConfig)*, *[returnAddress](#returnAddress)*, *[controlLED](#controlLED)*, *[getLED](#getLED)*, *[getButton](#getButton)*, *[writeRow](#writeRow)* und *[writeXY](#writeXY)* zur Verfügung. 
+
+<div id='begin'/>
+
+* **begin:**
+
+    <u>Definition:</u>
+
+    ```arduino
+    bool HSA_LCD_Shield.begin(byte <address>);
+    ```
+
+    <u>Beschreibung:</u>
+
+
+
+    <u>Parameter:</u>
+
+
+
+    <u>Rückgabewert</u>
+
+
+
+    <u>Beispiel:</u>
+
+    ```arduino
+
+    ```
+
+<div id='lcdBacklight'/>
+
+* **lcdBacklight:**
+
+    <u>Definition:</u>
+
+    ```arduino
+    bool HSA_LCD_Shield.lcdBacklight(void);
+    ```
+
+    <u>Beschreibung:</u>
+
+
+
+    <u>Parameter:</u>
+
+
+
+    <u>Rückgabewert</u>
+
+
+
+    <u>Beispiel:</u>
+
+    ```arduino
+
+    ```
+
+<div id='clearDisplay'/>
+
+* **clearDisplay:**
+
+    <u>Definition:</u>
+
+    ```arduino
+    bool HSA_LCD_Shield.clearDisplay(byte <address>);
+    ```
+
+    <u>Beschreibung:</u>
+
+
+
+    <u>Parameter:</u>
+
+
+
+    <u>Rückgabewert</u>
+
+
+
+    <u>Beispiel:</u>
+
+    ```arduino
+
+    ```
+
+<div id='returnVersion'/>
+
+* **returnVersion:**
+
+    <u>Definition:</u>
+
+    ```arduino
+    bool HSA_LCD_Shield.returnVersion(byte <address>);
+    ```
+
+    <u>Beschreibung:</u>
+
+
+
+    <u>Parameter:</u>
+
+
+
+    <u>Rückgabewert</u>
+
+
+
+    <u>Beispiel:</u>
+
+    ```arduino
+
+    ```
+
+<div id='returnConfig'/>
+
+* **returnConfig:**
+
+    <u>Definition:</u>
+
+    ```arduino
+    bool HSA_LCD_Shield.returnConfig(byte <address>);
+    ```
+
+    <u>Beschreibung:</u>
+
+
+
+    <u>Parameter:</u>
+
+
+
+    <u>Rückgabewert</u>
+
+
+
+    <u>Beispiel:</u>
+
+    ```arduino
+
+    ```
+
+<div id='returnAddress'/>
+
+* **returnAddress:**
+
+    <u>Definition:</u>
+
+    ```arduino
+    bool HSA_LCD_Shield.returnAddress(byte <address>);
+    ```
+
+    <u>Beschreibung:</u>
+
 
 
+    <u>Parameter:</u>
+
+
+
+    <u>Rückgabewert</u>
+
+
+
+    <u>Beispiel:</u>
+
+    ```arduino
+
+    ```
+
+<div id='controlLED'/>
+
+* **controlLED:**
+
+    <u>Definition:</u>
+
+    ```arduino
+    bool HSA_LCD_Shield.controlLED(byte <address>);
+    ```
+
+    <u>Beschreibung:</u>
+
+
+
+    <u>Parameter:</u>
+
+
+
+    <u>Rückgabewert</u>
+
+
+
+    <u>Beispiel:</u>
+
+    ```arduino
+
+    ```
+
+<div id='getLED'/>
+
+* **getLED:**
+
+    <u>Definition:</u>
+
+    ```arduino
+    bool HSA_LCD_Shield.getLED(byte <address>);
+    ```
+
+    <u>Beschreibung:</u>
+
+
+
+    <u>Parameter:</u>
+
+
+
+    <u>Rückgabewert</u>
+
+
+
+    <u>Beispiel:</u>
+
+    ```arduino
+
+    ```
+
+<div id='getButton'/>
+
+* **getButton:**
+
+    <u>Definition:</u>
+
+    ```arduino
+    bool HSA_LCD_Shield.getButton(byte <address>);
+    ```
+
+    <u>Beschreibung:</u>
+
+
+
+    <u>Parameter:</u>
+
+
+
+    <u>Rückgabewert</u>
+
+
+
+    <u>Beispiel:</u>
+
+    ```arduino
+
+    ```
+
+<div id='writeRow'/>
+
+* **writeRow:**
+
+    <u>Definition:</u>
+
+    ```arduino
+    bool HSA_LCD_Shield.writeRow(byte <address>);
+    ```
+
+    <u>Beschreibung:</u>
+
+
+
+    <u>Parameter:</u>
+
+
+
+    <u>Rückgabewert</u>
+
+
+
+    <u>Beispiel:</u>
+
+    ```arduino
+
+    ```
+
+<div id='writeXY'/>
+
+* **writeXY:**
+
+    <u>Definition:</u>
+
+    ```arduino
+    bool HSA_LCD_Shield.writeXY(byte <address>);
+    ```
+
+    <u>Beschreibung:</u>
+
+
+
+    <u>Parameter:</u>
+
+
+
+    <u>Rückgabewert</u>
+
+
+
+    <u>Beispiel:</u>
+
+    ```arduino
+
+    ```
 
 <div id='Literaturverzeichnis'/>
 

BIN
README.pdf