Skip to content
Snippets Groups Projects
Commit be28cf27 authored by philjak's avatar philjak
Browse files

Update README.md

parent b4735122
Branches
No related tags found
No related merge requests found
......@@ -19,56 +19,30 @@ coap://<adresse>:5683/register
```
#### POST
##### Schema
##### CBOR Struktur
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Register Schema",
"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
```
{
"name": "Smart Environment",
"id" : 1,
"parameter" : [
"Temp-Sensor 1",
"Temp-Sensor2",
"Irgendein-Anderer-Wert"
]
}
[
"Smart Environment",
["Temp-Sensor 1", "integer"],
["Temp-Sensor 2", "float"],
["Irgendein-Anderer-Wert", "string"]
]
```
##### Response Codes
```
2.01 = Registrierung erfolgreich
4.00 = Anfrage konnte nicht verarbeitet werden (JSON fehlerhaft?)
4.00 = Anfrage konnte nicht verarbeitet werden (CBOR fehlerhaft?)
4.04 = Ressource nicht bekannt
4.05 = Methode nicht erlaubt
5.00 = Server- / Datenbankfehler
......@@ -79,40 +53,19 @@ coap://<adresse>:5683/register
coap://<adresse>:5683/data
```
#### PUT
##### Schema
##### CBOR Struktur
```
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Data schema.",
"description": "Schema zur Datenübertragung, z.B. von Messwerten.",
"properties": {
"id": {
"type": "integer",
"title": "Registrierungs ID",
"description": "ID des registrierten Geräts/Dienst, für den Daten übertragen werden sollen."
},
"values": {
"type": "array",
"title": "Parameterwerte",
"description": "Parameterwerte in derselben Reihenfolge, wie die Parameter registriert wurden.",
"items": {
"type": "string"
}
}
},
"required": [
"id",
"values"
]
}
1. Parameter = Wert des 1. bei der Registrierung übermittelten Parameter
2. Parameter = Wert des 2. bei der Registrierung übermittelten Parameter
N. Parameter = Wert des N. bei der Registrierung übermittelten Parameter
```
##### Beispiel
```
{
"id" : 1,
"values" : ["21°C","37°C","4.13 km/h"]
}
[
12,
42.4,
"OK"
]
```
##### Response Codes
```
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment