Skip to content
Snippets Groups Projects

Dev to Master

Merged Dev to Master
dev into master
Merged Anian Bühler requested to merge dev into master
Viewing commit 0fc79a98
Prev
Show latest version
1 file
+ 1
− 0
Compare changes
  • Side-by-side
  • Inline
README.md
+ 91
− 22
@@ -3,9 +3,9 @@
Bibliothek zur Implementierung von vereinfachten Netzwerken auf Arduino-Boards.
Die Funktionalitaeten entsprechen dem Stand der Technik, die Umsetzung ist didaktisch reduziert.
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: [Hinweise zur Bestellung bei Aisler](#bestellung-bei-aisler).
Für eine Nutzung der Bibliothek wird eine drahtlose Schnittstelle benoetigt, wleche sich an der Seriellen Schnittstelle betreiben lässt.
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
@@ -33,18 +33,23 @@ https://www.arduino.cc/en/guide/libraries section "Importing a .zip Library"
### Client
```cpp
#Anlegen der Client-Instanz
#Anlegen der Client-Instanz
// Anlegen des didacticPSNetClient-Objekts
// psnClient -> moeglicher Name für Objekt
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();
// return: true wenn Daten versendet / false wenn nicht
void psnClient.setInterval(long intervalTime);
// param: Mindestwartezeit in ms zwischen zwei Sendevorgängen (default 500 ms)
#Topic eines anderen Clients abbonieren
int psnClient.subscribe(char* topic);
// param: Topic String/char-Array ("example" / char topic[n])
@@ -63,30 +68,71 @@ 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 unter Topic veroeffentlichen
int psnClient.publish(char* topic, char* payload);
// param1: Topic String/char-Array; param2: payload-char-Array
// param1: Topic String/char-Array;
// param2: payload-char-Array
// return: ERROR-Wert: DN_PUBLISH_SUCCESSULL,
// DN_ERROR_TOPIC_LEN (Topic zu lang - wird abgeschnitten),
// DN_ERROR_PAYLOAD_LEN (Payload zu lange - wird abgeschnitten)
int psnClient.publish(char* topic, bool payload);
// param1: Topic String/char-Array;
// param2: payload vom Datentyp bool (wird in char-Array gewandelt)
// return: ERROR-Wert: DN_PUBLISH_SUCCESSULL,
// DN_ERROR_TOPIC_LEN (Topic zu lang - wird abgeschnitten),
// DN_ERROR_PAYLOAD_LEN (Payload zu lange - wird abgeschnitten)
int psnClient.publish(char* topic, int payload);
// param1: Topic String/char-Array;
// param2: payload vom Datentyp int (wird in char-Array gewandelt)
// return: ERROR-Wert: DN_PUBLISH_SUCCESSULL,
// DN_ERROR_TOPIC_LEN (Topic zu lang - wird abgeschnitten),
// DN_ERROR_PAYLOAD_LEN (Payload zu lange - wird abgeschnitten)
int psnClient.publish(char* topic, int topicLength, char* payload, int payloadLength);
// param1: Topic String/char-Array
// param2: Anzahl Zeichen des Topics
// param3: payload-char-Array
// param4: Anzahl Zeichen der Payload
// return: ERROR-Wert: DN_ERROR_NO_ERROR,
// return: ERROR-Wert: DN_PUBLISH_SUCCESSULL,
// DN_ERROR_TOPIC_LEN (Topic zu lang - wird abgeschnitten),
// DN_ERROR_PAYLOAD_LEN (Payload zu lange - wird abgeschnitten)
//Daten werden beim Zustandswechsel von payload (0->1 / 1->0) veroeffentlicht
int psnClient.publishOnChange(char* topic, bool payload);
// param1: Topic String/char-Array;
// param2: payload vom Datentyp bool (wird in char-Array gewandelt)
// return: ERROR-Wert: DN_PUBLISH_SUCCESSULL,
// DN_ERROR_NO_ERROR (Keine Daten veroeffentlicht und keine Fehler),
// DN_ERROR_TOPIC_LEN (Topic zu lang - wird abgeschnitten),
// DN_ERROR_PAYLOAD_LEN (Payload zu lange - wird abgeschnitten)
// Daten werden veroeffentlicht, wenn Veränderung von payload groeßer als threshold ist
int psnClient.publishOnChange(char* topic, int payload, int threshold);
// param1: Topic String/char-Array;
// param2: payload vom Datentyp bool (wird in char-Array gewandelt)
// param1: Topic String/char-Array;
// return: ERROR-Wert: DN_PUBLISH_SUCCESSULL,
// DN_ERROR_NO_ERROR (Keine Daten veroeffentlicht und keine Fehler),
// DN_ERROR_TOPIC_LEN (Topic zu lang - wird abgeschnitten),
// 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
// param3: Nutdaten der Nachricht
// param4: Laenge der
// param4: Laenge der Nachricht
```
### Broker
```cpp
#Anlegen der Broker-Instanz
// Anlegen des Broker-Objekts
// psnBroker -> moeglicher Name für Objekt
didacticPSNetBroker psnBroker;
#Starten der Broker-Instanz
@@ -95,33 +141,51 @@ void psnBroker.begin(Stream& sSerial);
#Netzwerkverwaltung Broker (Daten senden und Empfangen, Zugriffsregelung)
bool psnBroker.handleNetwork();
// return: true wenn Daten versendet / false wenn nicht
void psnBroker.setInterval(long intervalTime);
// param: Mindestwartezeit in ms zwischen zwei Sendevorgängen (default 0 ms)
```
### 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.
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
#Flankenerkennung z.B. fuer Taster
int psnClient.edgeDetected(bool currentState);
// Anlegen des EdgeDetector-Objekts
// eDetector -> moeglicher Name für Objekt
EdgeDetector eDetector;
int eDetector.edgeDetected(bool currentState);
// param: aktueller binärer Zustand
// return: 0 -> keine Flanke, RISING, FALLING
#Auf Wertaenderung groeßer Schwellwert pruefen
bool psnClient.valueChanged(int currentvalue, int threshold);
// Anlegen des ChangeDetector-Objekts
// cDetector -> moeglicher Name für Objekt
ChangeDetector cDetector
bool cDetector.valueChanged(int currentvalue, int threshold);
// param1: aktueller Wert
// param2: Schwellwert
// return: true -> Aenderung groeßer als Schwellwert; sonst false
#Nicht blockierendes Warten
bool psnClient.timeElapsed(long);
// Anlegen des UnblockingTimer-Objekts
// uTimer -> moeglicher Name für Objekt
UnblockingTimer uTimer;
bool uTimer.timeElapsed(long);
// param: zu wartende Zeit in Millisekunden
// return: true, wenn Zeit Wartezeit abgelaufen; sonst false
#Einlesen von Text ueber Serialle Schnittstelle bis Endezeichen empfangen wird
int psnClient.readSerialData(Stream&, char*, char);
// Anlegen des SerialReader-Objekts
// sReader -> moeglicher Name für Objekt
SerialReader sReader;
int sReader.readSerialData(Stream&, char*, char);
// param1: Schnittstelle (Serial | SoftSerial)
// param2: Array in das die Zeichen eingelesen werden
// param3: Endezeichen (char)
@@ -130,7 +194,7 @@ int psnClient.readSerialData(Stream&, char*, char);
### Konstanten
Konstanten aus der Library die fuer die Programmierung genutzt werden und teilweise angepasst werden koennen.
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
@@ -144,7 +208,12 @@ MAX_LEN_PAYLOAD default: 20
MAX_NR_TOPICS_CLIENT default: 5
MAX_NR_TOPICS_BROKER default: 20
#ERRORs
#Mindestwartezeiten zwischen Sendevorgängen (anpassen über psnClient.setInterval())
INTERVAL_CLIENT default: 500 ms
INTERVAL_BROKER default: 0 ms
#ERRORs (nicht verändern)
DN_PUBLISH_SUCCESSULL 1
DN_ERROR_NO_ERROR 0
DN_ERROR_TOPIC_LEN -1
DN_ERROR_PAYLOAD_LEN -2
@@ -164,11 +233,11 @@ MSG_TOPIC_MULTI '*'
# Bestellung bei Aisler
- Account anlegen
- Link öffnen: [Nachkaufprojekt bei Aisler.net](https://aisler.net/p/NBAQNHFV)
- Link oeffnen: [Nachkaufprojekt bei Aisler.net](https://aisler.net/p/NBAQNHFV)
- Projekt importieren (Fehlermeldung / Hinweis ignorieren)
- Auf eigenen Account zurück gehen
- unter "Projekte -> Sandbox" befindet sich dann die Platine und die Bauteilliste
- vor der Bestellung Bauteilliste (Preise) aktualisieren
- Bestellung der Platinen (Peautiful Boards) und der Bauteile (Precious Parts)
**Hinweis:** Das Projekt letsgoING ist in **keiner Weise** an dem **Verkauf beteiligt**.
**Hinweis:** Das Projekt letsgoING ist in **keiner Weise** an dem **Verkauf beteiligt**.
\ No newline at end of file