diff --git a/README.md b/README.md index cd0282d83c7a35e97445710e0873a6f478651fbb..c49717bbf2c243ee93ea2ebf7b3e727b3f5038c6 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,13 @@ # Dokumentation ## Einleitung Das Boarder-Gateway stellt zwei CoAP Ressourcen zur Verfügung. Die Ressource **/register** wird dabei von CoAP Clients verwendet, um sich am BG zu registrieren. -Im einfachsten Fall wählt der CoAP Client selbst eine ID, um den Kommunikationsoverhead als auch den Programmieraufwand auf clientseitig zu minimieren. Hierbei ist -selbstverständlich wichtig, dass die verschiedenen CoAP Client Gruppen miteinander kommunizieren, um eine doppelte Belegung der Registrations-ID auszuschließen. -Bei der Registrierung eines CoAP Clients muss neben der ID eine Liste von Parameternamen mitgesendet werden, bspw. *["Temperatur vorne", "Temperatur hinten", "Luftfeuchtigkeit"]*. +Bei der Registrierung eines CoAP Clients muss eine Liste von Parameternamen mitgesendet werden, bspw. *["Temperatur vorne", "Temperatur hinten", "Luftfeuchtigkeit"]*. - Nach der Registrierung kann ein CoAP Client die Ressource **/data** dafür verwenden, um regelmäßig Werte den entsprechend registrierten Parameter zuzuweisen. Dazu muss -der CoAP Client ausschließlich seine ID angeben und die Werte in der Reihenfolge übersenden, in welcher die Parameter registriert wurden. +der CoAP Client ausschließlich die Werte in der Reihenfolge übersenden, in welcher die Parameter registriert wurden. -Alle Ressourcen erwarten als Payload JSON formatierte Strings. +Alle Ressourcen erwarten als Payload CBOR. ## Schnittstelle ### Registrierung