IoT Export

Generic IoT Datenmodell

8min

Einleitung
Das BSC IoT Core Datenmodell nutzt einen generischen Ansatz um die Datenbeschreibung einzelner Kanäle von der Modellspezifikation zu entkoppeln.
Dafür sind "primitive" Datentypen definiert, welche zusammen mit weiteren Informationen die eigentliche Datenbeschreibung liefern.
Datenmodell
Thing
Die Repräsentation eines Gerätes.
Feld
Beschreibung
id
Die eindeutige ThingID um das Gerät in unserem System zu identifizieren.
name
Der vom Nutzer vergebene Name des Gerätes.
channelGroups
Ein Array von Channel Groups.
parameterGroups
Ein Array von Channel Groups welches für Konfigurations Parameter vorgesehen ist.
state
Der aktuelle Zustand des Gerätes. Mögliche Zustände:
UNKNOWN
UNINITIALIZED
INITIALIZING
ONLINE
OFFLINE
REMOVING
REMOVED
metaInfos
Angehängte Meta Informationen als Map Objekt.
Channel Group
Eine Gruppe von Channels, hauptsächlich dazu genutzt um Channels logisch zu gruppieren.
Feld
Beschreibung
channelGroupId
Auf dieses Gerät bezogen eindeutige ChannelGroupID.
channelDescriptionData
Die Beschreibungsdaten für diese Kanal Gruppe.
channels
Ein Array von Channels.
Channel
Repräsentation der Eigenschaft eines Gerätes. Das kann z.B. ein Temperatursensor sein.
Ein Gerät kann mehrere Channels besitzen. Z.B. Temperatur und Batteriespannung etc.
Feld
Beschreibung
channelId
Auf dieses Gerät bezogene eindeutige ChannelID.
channelDescriptionData
Die Datenbeschreibung des Kanals.
value
Der aktuelle Wert des Kanals.
valueDescriptionData
Die Datenbeschreibung des Im Kanal verwendeten Wertes.
writeable
Gibt an ob der Wert des Kanals verändert werden kann.
metaInfos
Optionale Meta Informationen.
Channel Description
Eine Kanalbeschreibungen dienen dazu Typ Informationen eines Kanals zu definieren. Dies wird hauptsächlich genutzt um innerhalb von UIs die visuelle Darstellung zu beeinflussen.
Feld
Beschreibung
channelTypeEnum
Type Information. Mögliche Werte:
DEFAULT
COLOR
CONTACT
DETECTION
HEATING
LIGHTING
NUMERIC
SECURITY
SETPOINT
SHADING
STATE
STRING
SWITCH
TEMPORAL
label
Anzeigename
Value Description
Die Wertebeschreibung stellt konkrete Typ Informationen bereit und bietet ggf. eine Auswahl an möglichen Werten.
Die Auswertung des Feld "value" eines Channels hängt von der gesetzen Beschreibung ab. Z.B. werden Farbwerte in einem String kodiert und in das Feld value geschrieben. Die korrekte Interpretation ist dann nur durch Auswertung des Types möglich.
Feld
Beschreibung
valueType
Type Information. Mögliche Werte:
COLOR_sRGB
GEOGRAPHIC_POSITION
NUMBER_LONG
NUMBER_DOUBLE
STATE
STATE_NUMBER_LONG
TEXT
possibleValues
Optional die möglichen Werte. Wird hauptsächlich genutzt um mögliche STATES anzugeben. Enthält eine Map mit den möglichen States sowie deren vorgesehene Übersetzung.
unit
Falls vorhanden, die Einheit des Wertes.
min
Minimum Wert.
max
Maximum Wert.
stepping
Schritte um welche Werte geändert werden können.
decimalPartDigits
Kommastellen.
Meta Informationen
Meta Informationen werden als Key(String)→Value(String) Paar übertragen.
Diese können sowohl an Things als auch an Channels angehängt werden.
Beispiel BSC IoT Thing
JSON
{
    "id": "b9f09ef8-3c3f-459e-841f-66bdaedff183",
    "name": "FSB14",
    "channelGroups": [{
        "channelGroupId": "Sensor Group",
        "channelDescriptionData": null,
        "channels": [{
            "channelId": "Jalousie",
            "channelDescriptionData": {
                "channelTypeEnum": "SHADING",
                "label": {
                    "de_DE": "Jalousie",
                    "en_US": "shutters"
                }
            },
            "value": "29.0",
            "valueDescriptionData": {
                "valueType": "NUMBER_DOUBLE",
                "unit": "%",
                "min": 0.0,
                "max": 100.0,
                "stepping": 1.0,
                "decimalPartDigits": 1,
                "possibleValues": null
            },
            "writeable": false,
            "metaInfos": {
                "METAINFO->id": "ASensor#b9f09ef8-3c3f-459e-841f-66bdaedff183#Jalousie",
                "MESSAGE->COUNT": "0",
                "EOAP->CHANGEABLE": "true",
                "MESSAGE->ENABLED": "false",
                "Sensor.Name": "Jalousie",
                "TSYSTEMS->type": "value"
            }
        }, {
            "channelId": "JalousieState",
            "channelDescriptionData": {
                "channelTypeEnum": "SHADING",
                "label": {
                    "de_DE": "Jalousie",
                    "en_US": "shutters"
                }
            },
            "value": "UNKNOWN",
            "valueDescriptionData": {
                "valueType": "STATE",
                "unit": null,
                "min": null,
                "max": null,
                "stepping": null,
                "decimalPartDigits": null,
                "possibleValues": {
                    "UNKNOWN": {
                        "de_DE": "Unbekannt",
                        "en_US": "unknown"
                    },
                    "UP": {
                        "de_DE": "Herauf",
                        "en_US": "up"
                    },
                    "DOWN": {
                        "de_DE": "Herunter",
                        "en_US": "down"
                    }
                }
            },
            "writeable": false,
            "metaInfos": {
                "METAINFO->id": "ASensor#b9f09ef8-3c3f-459e-841f-66bdaedff183#JalousieState",
                "MESSAGE->COUNT": "0",
                "EOAP->CHANGEABLE": "false",
                "MESSAGE->ENABLED": "false",
                "Sensor.Name": "Direction",
                "TSYSTEMS->type": "state"
            }
        }, {
            "channelId": "Priority",
            "channelDescriptionData": {
                "channelTypeEnum": "SWITCH",
                "label": {
                    "de_DE": "Priorität",
                    "en_US": "priority"
                }
            },
            "value": "OFF",
            "valueDescriptionData": {
                "valueType": "STATE",
                "unit": null,
                "min": null,
                "max": null,
                "stepping": null,
                "decimalPartDigits": null,
                "possibleValues": {
                    "UNKNOWN": {
                        "de_DE": "Unbekannt",
                        "en_US": "unknown"
                    },
                    "ON": {
                        "de_DE": "An",
                        "en_US": "on"
                    },
                    "OFF": {
                        "de_DE": "Aus",
                        "en_US": "off"
                    }
                }
            },
            "writeable": false,
            "metaInfos": {
                "METAINFO->id": "ASensor#b9f09ef8-3c3f-459e-841f-66bdaedff183#Priority",
                "MESSAGE->COUNT": "0",
                "EOAP->CHANGEABLE": "true",
                "MESSAGE->ENABLED": "false",
                "Sensor.Name": "Priority",
                "TSYSTEMS->type": "state"
            }
        }, {
            "channelId": "JalousieSlat",
            "channelDescriptionData": {
                "channelTypeEnum": "SHADING",
                "label": {
                    "de_DE": "Jalousie (Lamellen)",
                    "en_US": "shutters (slats)"
                }
            },
            "value": "UNKNOWN",
            "valueDescriptionData": {
                "valueType": "STATE",
                "unit": null,
                "min": null,
                "max": null,
                "stepping": null,
                "decimalPartDigits": null,
                "possibleValues": {
                    "UNKNOWN": {
                        "de_DE": "Unbekannt",
                        "en_US": "unknown"
                    },
                    "UP": {
                        "de_DE": "Herauf",
                        "en_US": "up"
                    },
                    "DOWN": {
                        "de_DE": "Herunter",
                        "en_US": "down"
                    }
                }
            },
            "writeable": false,
            "metaInfos": {
                "METAINFO->id": "ASensor#b9f09ef8-3c3f-459e-841f-66bdaedff183#JalousieSlat",
                "MESSAGE->COUNT": "0",
                "EOAP->CHANGEABLE": "true",
                "MESSAGE->ENABLED": "false",
                "Sensor.Name": "JalousieSlat",
                "TSYSTEMS->type": "state"
            }
        }]
    }],
    "state": "ONLINE",
    "parameterGroups": null,
    "metaInfos": {
        "ALEXA->ALEXA_LIVE_UPDATES": "false",
        "MONITORING->MONITORABLE": "true",
        "TEACHIN->GROUP_DISPLAYNAME": "Test",
        "BSC->SHORT_INFO": "FSB14",
        "METAINFO->id": "ADevice#b9f09ef8-3c3f-459e-841f-66bdaedff183",
        "TEACHIN->REFERENCE_ID": "enocean.eltako.fsb14",
        "EOAP->ACTIVATED": "true",
        "TEACHIN->TRANSMISSION_ID": "default=4291820288",
        "lastModified": "1636543466499",
        "EOAP->ALARM": "false"
    }
}
{
    "id": "b9f09ef8-3c3f-459e-841f-66bdaedff183",
    "name": "FSB14",
    "channelGroups": [{
        "channelGroupId": "Sensor Group",
        "channelDescriptionData": null,
        "channels": [{
            "channelId": "Jalousie",
            "channelDescriptionData": {
                "channelTypeEnum": "SHADING",
                "label": {
                    "de_DE": "Jalousie",
                    "en_US": "shutters"
                }
            },
            "value": "29.0",
            "valueDescriptionData": {
                "valueType": "NUMBER_DOUBLE",
                "unit": "%",
                "min": 0.0,
                "max": 100.0,
                "stepping": 1.0,
                "decimalPartDigits": 1,
                "possibleValues": null
            },
            "writeable": false,
            "metaInfos": {
                "METAINFO->id": "ASensor#b9f09ef8-3c3f-459e-841f-66bdaedff183#Jalousie",
                "MESSAGE->COUNT": "0",
                "EOAP->CHANGEABLE": "true",
                "MESSAGE->ENABLED": "false",
                "Sensor.Name": "Jalousie",
                "TSYSTEMS->type": "value"
            }
        }, {
            "channelId": "JalousieState",
            "channelDescriptionData": {
                "channelTypeEnum": "SHADING",
                "label": {
                    "de_DE": "Jalousie",
                    "en_US": "shutters"
                }
            },
            "value": "UNKNOWN",
            "valueDescriptionData": {
                "valueType": "STATE",
                "unit": null,
                "min": null,
                "max": null,
                "stepping": null,
                "decimalPartDigits": null,
                "possibleValues": {
                    "UNKNOWN": {
                        "de_DE": "Unbekannt",
                        "en_US": "unknown"
                    },
                    "UP": {
                        "de_DE": "Herauf",
                        "en_US": "up"
                    },
                    "DOWN": {
                        "de_DE": "Herunter",
                        "en_US": "down"
                    }
                }
            },
            "writeable": false,
            "metaInfos": {
                "METAINFO->id": "ASensor#b9f09ef8-3c3f-459e-841f-66bdaedff183#JalousieState",
                "MESSAGE->COUNT": "0",
                "EOAP->CHANGEABLE": "false",
                "MESSAGE->ENABLED": "false",
                "Sensor.Name": "Direction",
                "TSYSTEMS->type": "state"
            }
        }, {
            "channelId": "Priority",
            "channelDescriptionData": {
                "channelTypeEnum": "SWITCH",
                "label": {
                    "de_DE": "Priorität",
                    "en_US": "priority"
                }
            },
            "value": "OFF",
            "valueDescriptionData": {
                "valueType": "STATE",
                "unit": null,
                "min": null,
                "max": null,
                "stepping": null,
                "decimalPartDigits": null,
                "possibleValues": {
                    "UNKNOWN": {
                        "de_DE": "Unbekannt",
                        "en_US": "unknown"
                    },
                    "ON": {
                        "de_DE": "An",
                        "en_US": "on"
                    },
                    "OFF": {
                        "de_DE": "Aus",
                        "en_US": "off"
                    }
                }
            },
            "writeable": false,
            "metaInfos": {
                "METAINFO->id": "ASensor#b9f09ef8-3c3f-459e-841f-66bdaedff183#Priority",
                "MESSAGE->COUNT": "0",
                "EOAP->CHANGEABLE": "true",
                "MESSAGE->ENABLED": "false",
                "Sensor.Name": "Priority",
                "TSYSTEMS->type": "state"
            }
        }, {
            "channelId": "JalousieSlat",
            "channelDescriptionData": {
                "channelTypeEnum": "SHADING",
                "label": {
                    "de_DE": "Jalousie (Lamellen)",
                    "en_US": "shutters (slats)"
                }
            },
            "value": "UNKNOWN",
            "valueDescriptionData": {
                "valueType": "STATE",
                "unit": null,
                "min": null,
                "max": null,
                "stepping": null,
                "decimalPartDigits": null,
                "possibleValues": {
                    "UNKNOWN": {
                        "de_DE": "Unbekannt",
                        "en_US": "unknown"
                    },
                    "UP": {
                        "de_DE": "Herauf",
                        "en_US": "up"
                    },
                    "DOWN": {
                        "de_DE": "Herunter",
                        "en_US": "down"
                    }
                }
            },
            "writeable": false,
            "metaInfos": {
                "METAINFO->id": "ASensor#b9f09ef8-3c3f-459e-841f-66bdaedff183#JalousieSlat",
                "MESSAGE->COUNT": "0",
                "EOAP->CHANGEABLE": "true",
                "MESSAGE->ENABLED": "false",
                "Sensor.Name": "JalousieSlat",
                "TSYSTEMS->type": "state"
            }
        }]
    }],
    "state": "ONLINE",
    "parameterGroups": null,
    "metaInfos": {
        "ALEXA->ALEXA_LIVE_UPDATES": "false",
        "MONITORING->MONITORABLE": "true",
        "TEACHIN->GROUP_DISPLAYNAME": "Test",
        "BSC->SHORT_INFO": "FSB14",
        "METAINFO->id": "ADevice#b9f09ef8-3c3f-459e-841f-66bdaedff183",
        "TEACHIN->REFERENCE_ID": "enocean.eltako.fsb14",
        "EOAP->ACTIVATED": "true",
        "TEACHIN->TRANSMISSION_ID": "default=4291820288",
        "lastModified": "1636543466499",
        "EOAP->ALARM": "false"
    }
}
﻿
﻿

Aktualisiert 25 Mar 2024

Hat Ihnen diese Seite geholfen?

Template Kommandos

Docs powered by Archbee

INHALT

Beispiel BSC IoT Thing

Feld	Beschreibung
id	Die eindeutige ThingID um das Gerät in unserem System zu identifizieren.
name	Der vom Nutzer vergebene Name des Gerätes.
channelGroups	Ein Array von Channel Groups.
parameterGroups	Ein Array von Channel Groups welches für Konfigurations Parameter vorgesehen ist.
state	Der aktuelle Zustand des Gerätes. Mögliche Zustände: UNKNOWN UNINITIALIZED INITIALIZING ONLINE OFFLINE REMOVING REMOVED
metaInfos	Angehängte Meta Informationen als Map Objekt.

Feld	Beschreibung
channelGroupId	Auf dieses Gerät bezogen eindeutige ChannelGroupID.
channelDescriptionData	Die Beschreibungsdaten für diese Kanal Gruppe.
channels	Ein Array von Channels.

Feld	Beschreibung
channelId	Auf dieses Gerät bezogene eindeutige ChannelID.
channelDescriptionData	Die Datenbeschreibung des Kanals.
value	Der aktuelle Wert des Kanals.
valueDescriptionData	Die Datenbeschreibung des Im Kanal verwendeten Wertes.
writeable	Gibt an ob der Wert des Kanals verändert werden kann.
metaInfos	Optionale Meta Informationen.

Feld	Beschreibung
channelTypeEnum	Type Information. Mögliche Werte: DEFAULT COLOR CONTACT DETECTION HEATING LIGHTING NUMERIC SECURITY SETPOINT SHADING STATE STRING SWITCH TEMPORAL
label	Anzeigename

Feld	Beschreibung
valueType	Type Information. Mögliche Werte: COLOR_sRGB GEOGRAPHIC_POSITION NUMBER_LONG NUMBER_DOUBLE STATE STATE_NUMBER_LONG TEXT
possibleValues	Optional die möglichen Werte. Wird hauptsächlich genutzt um mögliche STATES anzugeben. Enthält eine Map mit den möglichen States sowie deren vorgesehene Übersetzung.
unit	Falls vorhanden, die Einheit des Wertes.
min	Minimum Wert.
max	Maximum Wert.
stepping	Schritte um welche Werte geändert werden können.
decimalPartDigits	Kommastellen.