diff --git a/README.md b/README.md index dd7b8e806af17c4c34944453f038a58739d1dc5b..d8f7b2c58ec3890e2f48969dcda4af47989d4a5f 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,10 @@ Bibliothek zur Implementierung von vereinfachten Netzwerken auf Arduino-Boards. Die Funktionalitaeten entsprechen dem Stand der Technik, die Umsetzung ist didaktisch reduziert. -## Bisher unterstuetzt: -publish/subscribe network +Für eine Nutzung der Bibliothek wird eine drahtlose Schnittstelle benötigt, wleche sich an der Seriellen Schnittstelle betreiben lässt. +Wir empfehlen unsere IR-Link-Module, die Sie selbst herstellen können (Schaltplan und Layout bei uns anfragen - Kontakt über [letsgoING.org](httsp://letsgoING.org) +oder z. B. hier erwerben können: [Nachkaufprojekt bei Aisler.net](https://aisler.net/p/NBAQNHFV) +## publish/subscribe network ### Beispiele @@ -19,6 +21,7 @@ publish/subscribe network ## Funktionen und Parameter ### Client + ```cpp #Anlegen der Client-Instanz didacticPSNetClient psnClient; @@ -58,6 +61,7 @@ void clientCallback(char* topic, int topicLength, char* payload, int payloadLeng ``` ### Broker + ```cpp #Anlegen der Broker-Instanz didacticPSNetBroker psnBroker; @@ -71,6 +75,7 @@ bool psnBroker.handleNetwork(); ``` ### Hilfreiche Funktionen + Wichtiger Hinweis: Diese Funktionen koennen derzeit nur einmal pro Programm/Client-Instanz eingesetzt werden. Werden diese an verschiedenen Stellen mit verschiedenen Werten verwendet, werden Werte u. U. ueberschrieben. @@ -98,6 +103,7 @@ int psnClient.readSerialData(Stream&, char*, char); ``` ### Konstanten + Konstanten aus der Library die fuer die Programmierung genutzt werden und teilweise angepasst werden koennen. ```cpp #ASCII Endezeichen