Werte
Die Kanal- und Parameterdaten beinhalten immer den aktuellen Wert, welcher in einem Containerobjekt gekapselt ist.
Es gibt die folgenden internen Datentypen für Werte:
Datentyp | Beschreibung |
|---|---|
NUMBER_LONG | 64 Bit Ganzzahl mit Vorzeichen |
NUMBER_DOUBLE | 64 Bit Gleitkommazahl mit doppelter Genauigkeit und Vorzeichen |
TEXT | String mit einer maximalen Länge von 2.147.483.647 Zeichen |
STATE | Repräsentation eines Zustandes als String |
COLOR | Farbinformationen als String |
Eine genauere Beschreibung mit Wertebereichen und Einheit ist in der Wertebeschreibung (descriptionId) enthalten.
Alle Container enthalten folgende Felder, zusätzlich besitzt jeder Datentypcontainer spezifische Felder.
Feld | Datentyp | Beschreibung |
|---|---|---|
type | String | Der interne Datentyp des Wertes |
info | String | Optionale Information über Kanal/Parameter |
descriptionId | String | Die ID der Wertbeschreibung |
changeable | Boolean | Flag ob der Wert änderbar ist |
NUMBER_LONG
SimpleIoTCoreNumberLongValueDTO
Feld | Datentyp | Beschreibung |
|---|---|---|
value | Number | 64 Bit Ganzzahl mit Vorzeichen. |
NUMBER_DOUBLE
SimpleIoTCoreNumberDoubleValueDTO
Feld | Datentyp | Beschreibung |
|---|---|---|
value | Number | 64 Bit Gleitkommazahl mit doppelter Genauigkeit und Vorzeichen |
TEXT
SimpleIoTCoreTextValueDTO
Feld | Datentyp | Beschreibung |
|---|---|---|
value | String | String mit einer maximalen Länge von 2.147.483.647 Zeichen. |
STATE
SimpleIoTCoreStateValueDTO
Feld | Datentyp | Beschreibung |
|---|---|---|
value | String | Repräsentation eines Zustandes als String. |
COLOR
SimpleIoTCoreColorValueDTO
Feld | Datentyp | Beschreibung |
|---|---|---|
value | String | Farbinformationen als hexadezimaler Wert |
Beschreibungscontainer dienen dazu eine detailierte Spezifikation zu liefern wie Werte zu interpretieren sind oder welche Bereiche möglich sind. Es gibt für jeden internen Datentyp einen Beschreibungscontainer, um die spezifischen Anforderungen zu erfüllen.
Jeder Container hat eine eigene ID, welche auch von mehreren Kanälen gleichzeitig genutzt werden kann. Die ID ist systemübergreifend gleich, kann sich aber ggf. zwischen Softwareversionen unterscheiden.
Jeder Container enthält folgende Felder, zusätzlich besitzt jeder Beschreibungscontainer spezifische Felder.
Feld | Datentyp | Beschreibung |
|---|---|---|
type | String | Der interne Datentyp für welchen die Beschreibung gilt |
descriptionId | String | Die ID der Wertbeschreibung |
NUMBER_LONG
SimpleIoTCoreNumberLongDescriptionDTO
Feld | Datentyp | Beschreibung |
|---|---|---|
minValue | Number | Minimaler Wert |
maxValue | Number | Maximaler Wert |
stepSize | Number | Optional Schrittgröße beim Einstellen des Wertes. Stadardwert: 1 |
measuringUnit | String | Optional Maßeinheit des Wertes |
NUMBER_DOUBLE
SimpleIoTCoreNumberDoubleDescriptionDTO
Feld | Datentyp | Beschreibung |
|---|---|---|
minValue | Number | Minimaler Wert |
maxValue | Number | Maximaler Wert |
stepSize | Number | Optional Schrittgröße beim Einstellen des Wertes. Standardwert: 1.0 |
decimalPartDigits | Number | Optional Anzahl der Kommastellen des Wertes. Standardwert: 2 |
measuringUnit | String | Optional Maßeinheit des Wertes |
TEXT
SimpleIoTCoreTextDescriptionDTO
Feld | Datentyp | Beschreibung |
|---|---|---|
minLength | Number | Minimale Anzahl an Zeichen |
maxLength | Number | Maximale Anzahl an Zeichen |
STATE
SimpleIoTCoreStateDescriptionDTO
Feld | Datentyp | Beschreibung |
|---|---|---|
possibleStates | Array | Ein Array von Strings mit den möglichen Zuständen |
COLOR
SimpleIoTCoreHexColorDescriptionDTO
Feld | Datentyp | Beschreibung |
|---|---|---|
colorType | String | Information wie der Wert zu interpretieren ist |
Im Feld colorType sind folgende Werte möglich:
Type | Beschreibung |
|---|---|
HTML_HEX | Hexadezimaler Farbwert (RRGGBB) ohne führende Raute |
