Updated Readme.MD

README.md

@@ -7,8 +7,8 @@ Für eine Nutzung der Bibliothek wird eine drahtlose Schnittstelle benoetigt, wl
 Wir empfehlen unsere IR-Link-Module, die Sie selbst herstellen koennen (Schaltplan und Layout bei uns anfragen - Kontakt über [letsgoING.org](httsp://letsgoING.org)
 oder z. B. hier erwerben koennen: [Hinweise zur Bestellung bei Aisler](#bestellung-bei-aisler).
 
-
 ## Download
+
 Start download with the button on the right side. Choose the right format and start the download.
 
 ![](DownloadButton.png)
@@ -21,9 +21,11 @@ https://www.arduino.cc/en/guide/libraries section "Importing a .zip Library"
 ## Beispiele
 
 **Broker:**
+
 - sPSN_Broker.ino **->** Broker Applikation (muss nicht angepasst werden)
 
 **Clients:**
+
 - sPSN_Client1(2).ino **->** Client Applikationen die sich gegenseitig einen analogen bzw. digtalen Wert senden
 - sPSN-ClientMinimal.ino **->** Minimal-Code für den einfachen Einstieg
 - sPSN-Chat.ino **->** Chat-Applikation die Nachrichten unter eigenem Namen austauschen lässt
@@ -161,13 +163,44 @@ bool psnBroker.handleNetwork();
 
 void psnBroker.setInterval(long intervalTime);
 // param: Mindestwartezeit in ms zwischen zwei Sendevorgängen (default 0 ms)
+
+#Broker Verbose-Mode
+//verbose-Ausgabe aktivieren
+void psnBroker.setVerbose(Stream Serial);
+//param: Stream-Port auf dem die Eingehenden Nachrichten ausgegeben werden sollen
+//       möglich: SoftwareSerial-Instanz, Serial, auch Serial1 / Serial2 / ... z. B. mit Mega2560-Boards
+
+//verbose-Ausgabe deaktivieren
+void psnBroker.setNoneVerbose();
+//verbose-Ausgabe deaktivieren
+
 ```
 
 ### Hilfreiche Funktionen
+
 Die Hiflsfunktionen sind als eigenständige Klassen implementiert und koennen so mehrfach (unter verschiedenen Namen) angelegt werden.
 So koennen die Funktionen mehrfach, mit unterschiedlichen Parametern, verwendet werden.
 
 ```cpp
+
+#Vereinfachtes Eingabe-Interface für den SerialMonitor
+// Anlegen des serialMonitorUI-Objekts
+// serialUI -> moeglicher Name für Objekt
+serialMonitorUI serialUI;
+
+bool serialUI.available();
+// return: true -> wenn Eingabe vom SerialMonitor verfügbar ist (Eingabe mit Zeilenumbruch CR am SerialMonitor)
+//         false -> wenn KEINE Eingabe vom SerialMonitor verfügbar ist
+
+//gebe Steuerzeichen aus
+char serialUI.readCommand();
+// return: CHAR an erster Stelle eingegebenes Steuerzeichen
+//         möglich: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ {
+
+//speichere Eingabe
+void serialUI.readUserInput(char *);
+//param: Array in das die Eingegebenen Zeichen gespeichert werden sollen
+
 #Flankenerkennung z.B. fuer Taster
 // Anlegen des EdgeDetector-Objekts
 // eDetector -> moeglicher Name für Objekt
@@ -211,6 +244,7 @@ int sReader.readSerialData(Stream&, char*, char);
 ### Konstanten
 
 Konstanten aus der Library die fuer die Programmierung genutzt werden und angepasst werden koennen.
+
 ```cpp
 #ASCII Endezeichen
 DN_ASCII_CR "carriage return CR" (int) 13