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.
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
Bei der Registrierung eines CoAP Clients muss eine Liste von Parameternamen mitgesendet werden, bspw. *["Temperatur vorne", "Temperatur hinten", "Luftfeuchtigkeit"]*.
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"]*.
Nach der Registrierung kann ein CoAP Client die Ressource **/data** dafür verwenden, um regelmäßig Werte den entsprechend registrierten Parameter zuzuweisen. Dazu muss
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.
"description": "Die Ressource /register erwartet ein JSON via POST im folgenden Format",
"properties": {
"name": {
"type": "string",
"title": "Name des Services/Geräts",
"description": "Dies ist der Name des entsprechenden Dienstes oder Geräts, der im Dashboard angezeigt wird."
},
"id": {
"type": "integer",
"title": "Registrierungs ID",
"description": "Unter dieser ID wird das Gerät/Dienst registiert. Entsprechend später gesendete Werte, die im Dashboard angezeigt werden sollen, müssen sich auf diese ID beziehen."
},
"parameter": {
"type": "array",
"title": "Parameter Beschreibung",
"description": "In diesem Array werden die später gesendeten Werte beschrieben. Die Reihenfolge bei der Registrierung muss mit der Reihenfolge der gesendeten Werte übereinstimmen",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"id",
"parameter"
]
}
```
```
1. Parameter = Client Name
2. Parameter = Array für ersten Parameter
2.1 = Parameter Name
2.2 = Datentyp
N. Parameter = Array für N. Parameter
N.1 = Parameter Name
N.2 = Parameter Typ
```
##### Beispiel
##### Beispiel
```
```
{
[
"name": "Smart Environment",
"Smart Environment",
"id" : 1,
["Temp-Sensor 1", "integer"],
"parameter" : [
["Temp-Sensor 2", "float"],
"Temp-Sensor 1",
["Irgendein-Anderer-Wert", "string"]
"Temp-Sensor2",
"Irgendein-Anderer-Wert"
]
]
}
```
```
##### Response Codes
##### Response Codes
```
```
2.01 = Registrierung erfolgreich
2.01 = Registrierung erfolgreich
4.00 = Anfrage konnte nicht verarbeitet werden (JSON fehlerhaft?)
4.00 = Anfrage konnte nicht verarbeitet werden (CBOR fehlerhaft?)
