diff --git a/README.md b/README.md index 3e3b9d1479134190a9a07d8eacbb4449386ceabe..fe7be5ff40f3cf292a9e666c6ba7eed1ada8d392 100644 --- a/README.md +++ b/README.md @@ -38,9 +38,9 @@ https://www.arduino.cc/en/guide/libraries section "Importing a .zip Library" didacticPSNetClient psnClient; #Starten der Client-Instanz -void psnClient.begin(Stream& sSerial, fcn callback); +void psnClient.begin(Stream& sSerial, fcn clientCallback); // param1: Schnittstelle (Serial | SoftSerial) -// param2: Callback-Funktion +// param2: Callback-Funktion (Bezeichnung frei waehlbar) #Netzwerkverwaltung Client (Daten senden und Empfangen, Zugriffsregelung) bool psnClient.handleNetwork(); @@ -64,8 +64,7 @@ bool psnClient.unsubscribe(char* topic, int length); // param2: Anzahl Zeichen des Topics // return true wenn Daten versendet / false wenn nicht -#Daten unter Topic veroeffentlichen -Daten direkt veroeffentlichen +#Daten unter Topic veroeffentlichen int psnClient.publish(char* topic, char* payload); // param1: Topic String/char-Array; // param2: payload-char-Array @@ -116,6 +115,7 @@ int psnClient.publishOnChange(char* topic, int payload, int threshold); // DN_ERROR_PAYLOAD_LEN (Payload zu lange - wird abgeschnitten) #Callback-Funktion (wird bei neuen Daten aufgerufen) +//Bezeichnung muss mit der in psnClient.begin(...) übereinstimmen void clientCallback(char* topic, int topicLength, char* payload, int payloadLength){...} // param1: Topic der Nachricht // param2: Lange des Topics