Browse Source

REDME: update Symbole

Tobias Müller 5 years ago
parent
commit
9db685eab9
2 changed files with 43 additions and 11 deletions
  1. 43 11
      README.md
  2. BIN
      README.pdf

+ 43 - 11
README.md

@@ -60,12 +60,12 @@ In der folgenden Tabelle werden die Versionsunterschiede des LCD-Shields ab Vers
 
 | Pin | Version 5 | Version 6 |
 |:----:|:----:|:----:|
-| <span style="color:#DF0101"> **IO4** </span> | S3 | - |
-| <span style="color:#DF0101"> **IO5** </span> | S4 | S3 |
-| <span style="color:#DF0101"> **IO6** </span> | D1 | S4 |
-| <span style="color:#DF0101"> **IO7** </span> | D2 | D1 |
-| <span style="color:#DF0101"> **IO8** </span> | Q1 | D2 |
-| <span style="color:#DF0101"> **IO9** </span> | - | Q1 |
+| IO4 | S3 | - |
+| IO5 | S4 | S3 |
+| IO6 | D1 | S4 |
+| IO7 | D2 | D1 |
+| IO8 | Q1 | D2 |
+| IO9 | - | Q1 |
 
 Bei der Nutzung der LCD-Shield Bibliothek muss entsprechend darauf geachtet werden, welche Shield-Version verwendet wird.
 
@@ -73,7 +73,7 @@ Bei der Nutzung der LCD-Shield Bibliothek muss entsprechend darauf geachtet werd
 
 ## <p>&#x1F5C3; 2. LCD-Shield Bibliothek</p>
 
-In den folgenden Abschnitten wird die LCD-Shield Bibliothek erklärt. Dabei wird auf die Installation, die Verwendung von Beispielprogrammen und die Nutzung der Klasse <span style="color:#FE9A2E"> **`HSA_LCD_Shield`** </span> eingeganen.
+In den folgenden Abschnitten wird die LCD-Shield Bibliothek erklärt. Dabei wird auf die Installation, die Verwendung von Beispielprogrammen und die Nutzung der Klasse **`HSA_LCD_Shield`** eingeganen.
 
 > Sollten zusätzlich Fragen zur Verwendung der LCD-Shield Bibliothek auftauchen, wenden Sie sich bite an Herrn <a href="mailto:Tobias.Mueller@HS-Anhalt.de">Müller</a>.
 
@@ -101,7 +101,7 @@ Nun Steht ihnen unter `Sketch`, `Bibliothek einbinden` die `HS-Anhalt LCD-Shield
 
 ### Bespielprogramme
 
-Die Bibliothek beinhaltet Beispielprogramme zum Testen der Funktionalität des LCD-Shields. Des Weiteren dienen die Beispielprogramme zum besseren Verständnis der Klasse <span style="color:#FE9A2E"> **`HSA_LCD_Shield`** </span>.
+Die Bibliothek beinhaltet Beispielprogramme zum Testen der Funktionalität des LCD-Shields. Des Weiteren dienen die Beispielprogramme zum besseren Verständnis der Klasse **`HSA_LCD_Shield`**.
 
 Die Beispielprogramme finden Sie unter `Datei`, `Beispiele`, `HS-Anhalt LCD-Shield`. Entsprechend Ihrer Version des LCD-Shields können Sie das passende Beispielprogramm auswählen.
 
@@ -119,14 +119,46 @@ Im Anschluss können Sie das Beispielprogramm auf Ihrem Arduino hochladen. Befol
 
 ### Verwenden der Klasse
 
-In den folgenden Abschnitten werden Symbole, Objekte und Methoden der Klasse 
-<span style="color:#FE9A2E"> **`HSA_LCD_Shield`** </span> erklärt, damit diese im eigenen Programm verwendet werden können. Da die Attribute der Klasse geschützt sind und folglich nicht vom Anwender verändert werden können, werden diese hier nicht weiter aufgeführt oder erläutert. 
+In den folgenden Abschnitten werden Symbole, Objekte und Methoden der Klasse **`HSA_LCD_Shield`** erklärt, damit diese im eigenen Programm verwendet werden können. Da die Attribute der Klasse geschützt sind und folglich nicht vom Anwender verändert werden können, werden diese hier nicht weiter aufgeführt oder erläutert. 
 
 <div id='Attribute'/>
 
 #### Symbole
 
-Symbole der Klasse <span style="color:#FE9A2E"> **`HSA_LCD_Shield`** </span> werden hauptsächlich zur besseren Lesbarkeit des Quellcodes und zur Parameterübergabe für Objekte und Methoden verwendet. 
+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
+```C++
+I2C_ADDRESS        0x32
+```
+
+LCD-Shield Versionen
+```C++
+LCD_VERSION_5        0x05
+LCD_VERSION_6        0x06
+```
+
+LCD-Shield Konfigurationen
+```C++
+CONFIG_L1B1        "L1B1"        // Config: LEDs = On, Buttons = On
+CONFIG_L0B1        "L0B1"        // Config: LEDs = Off, Buttons = On
+CONFIG_L1B0        "L1B0"        // Config: LEDs = On, Buttons = Off
+CONFIG_L0B0        "L0B0"        // Config: LEDs = Off, Buttons = Off
+```
+
+Taster
+```C++
+BUTTON_UP        0x01
+BUTTON_RIGHT     0x02
+BUTTON_DOWN      0x03
+BUTTON_LEFT      0x04
+```
+
+LEDs
+```C++
+LED_RED        0x05
+LED_GREEN      0x06
+```
 
 <div id='Objekte'/>
 

BIN
README.pdf