IoT Export

Generic IoT Data Model

8min

Introduction
The BSC IoT Core data model uses a generic approach to decouple the data description of individual channels from the model specification.
For this purpose, "primitive" data types are defined, which together with further information provide the actual data description.
Data model
Thing
The representation of a device.
Field
Description
id
The unique ThingID to identify the device in our system.
name
The name of the device assigned by the user.
channelGroups
An array of channel groups.
parameterGroups
An array of channel groups intended for configuration parameters.
state
The current state of the device. Possible states:
UNKNOWN
UNINITIALIZED
INITIALIZING
ONLINE
OFFLINE
REMOVING
REMOVED
metaInfos
Attached meta information as a map object.
Channel Group
A group of channels, mainly used to group channels logically.
Field
Description
channelGroupId
ChannelGroupID unique to this device.
channelDescriptionData
The description data for this channel group.
channels
An array of channels.
Channel
Representation of the property of a device. This can be e.g. a temperature sensor.
A device can have several channels. E.g. temperature and battery voltage etc.
Field
Description
channelId
Unique ChannelID related to this device.
channelDescriptionData
The data description of the channel.
value
The current value of the channel.
valueDescriptionData
The data description of the value used in the channel.
writeable
Indicates whether the value of the channel can be changed.
metaInfos
Optional meta information.
Channel description
A channel description is used to define type information of a channel. This is mainly used to influence the visual representation within UIs.
Field
Description
channelTypeEnum
Type Information. Possible values:
DEFAULT
COLOR
CONTACT
DETECTION
HEATING
LIGHTING
NUMERIC
SECURITY
SETPOINT
SHADING
STATE
STRING
SWITCH
TEMPORAL
label
Display name.
Value description
The value description provides concrete type information and, if necessary, offers a selection of possible values.
The evaluation of the field "value" of a channel depends on the set description. For example, color values are encoded in a string and written to the value field. The correct interpretation is then only possible by evaluating the type.
Field
Description
valueType
Type Information. Possible values:
COLOR_sRGB
GEOGRAPHIC_POSITION
NUMBER_LONG
NUMBER_DOUBLE
STATE
STATE_NUMBER_LONG
TEXT
possibleValues
Optionally the possible values. Mainly used to specify possible STATES. Contains a map with the possible states and their intended translation.
unit
If available, the unit of the value.
min
Minimum value.
max
Maximum value.
stepping
Steps by which values can be changed.
decimalPartDigits
Decimal places.
Meta information
Meta information is transferred as a key(String)→value(String) pair.
These can be attached to Things as well as Channels.
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"
    }
}
﻿
﻿

Field	Description
id	The unique ThingID to identify the device in our system.
name	The name of the device assigned by the user.
channelGroups	An array of channel groups.
parameterGroups	An array of channel groups intended for configuration parameters.
state	The current state of the device. Possible states: UNKNOWN UNINITIALIZED INITIALIZING ONLINE OFFLINE REMOVING REMOVED
metaInfos	Attached meta information as a map object.

Field	Description
channelGroupId	ChannelGroupID unique to this device.
channelDescriptionData	The description data for this channel group.
channels	An array of channels.

Field	Description
channelId	Unique ChannelID related to this device.
channelDescriptionData	The data description of the channel.
value	The current value of the channel.
valueDescriptionData	The data description of the value used in the channel.
writeable	Indicates whether the value of the channel can be changed.
metaInfos	Optional meta information.

Field	Description
channelTypeEnum	Type Information. Possible values: DEFAULT COLOR CONTACT DETECTION HEATING LIGHTING NUMERIC SECURITY SETPOINT SHADING STATE STRING SWITCH TEMPORAL
label	Display name.

Field	Description
valueType	Type Information. Possible values: COLOR_sRGB GEOGRAPHIC_POSITION NUMBER_LONG NUMBER_DOUBLE STATE STATE_NUMBER_LONG TEXT
possibleValues	Optionally the possible values. Mainly used to specify possible STATES. Contains a map with the possible states and their intended translation.
unit	If available, the unit of the value.
min	Minimum value.
max	Maximum value.
stepping	Steps by which values can be changed.
decimalPartDigits	Decimal places.

Updated 25 Mar 2024

Did this page help you?

Template Commands

Sensor Template Import

Generic IoT Data Model

Introduction

Data model

Thing

Channel Group

Channel

Channel description

Value description

Meta information

Example thing object