IoT Core Data Model
The IoT Core data model is divided into different areas.
The Simple IoT Core describes a data model for transmitting device and status information.
In the Logic Core Data transfer objects (DTOs) are described with reference to rules, scenes, connections and timers.
The Command Core contains all command DTOs for interaction with the gateway.
These are divided into:
The Template Core describes relevant DTOs for semi-automated administration by template.
All objects are packed into a container and transferred. The container contains basic transport information such as the sender (nodeId) and the time (timestamp).
The object type of the DTO is transferred in the "type" field.
Field | Data type | Description |
---|---|---|
nodeId | String | Eine eindeutige ID, welche das Gateway identifiziert. |
timestamp | Number | Timestamp of the message. Difference, measured in milliseconds, between the current time and 01.01.1970 00:00 based on the UTC time zone. |
type | String | Type Information of the dto object. |
dto | Object | The actual data object. |
The following types are possible for the "type" field in the DTO container.
Type | Resource Path | DTO |
---|---|---|
NODE_STATUS | node/status | |
NODE_TEMPLATE_RESULT | node/template/result | |
NODE_ENOCEAN_GATEWAY | node/enocean/gateway | |
DESCRIPTION_THING | description/thing | |
THING | thing | |
THING_DELETED | thing/deleted | |
DESCRIPTION_VALUE | description/value | |
LOGIC_RULE | logic/rule | |
LOGIC_RULE_DELETED | logic/rule/deleted | |
LOGIC_SCENE | logic/scene | |
LOGIC_SCENE_DELETED | logic/scene/deleted | |
LOGIC_CONNECTION | logic/connection | |
LOGIC_CONNECTION_DELETED | logic/connection/deleted | |
LOGIC_SCENE_RUNNING | logic/scene/running | |
COMMAND_RESULT | command/result |
Type | Resource Path | DTO |
---|---|---|
NODE_UPDATE | node/update | |
NODE_RESTART | node/restart | |
NODE_TEMPLATE_IMPORT | node/template/import | |
NODE_STATUS_INTERVAL | node/status/interval | |
NODE_PAIRING | node/pairing | |
DESCRIPTION_THING_REFRESH | description/thing/refresh | |
NODE_ENOCEAN_GATEWAY_REFRESH | node/enocean/gateway/refresh | |
NODE_ENOCEAN_GATEWAY_ACTIVE | node/enocean/gateway/active | |
THING_CREATE | thing/create | |
THING_DELETE | thing/delete | |
THING_REFRESH | thing/refresh | |
THING_RENAME | thing/rename | |
THING_CHANNEL_SET | thing/channel/set | |
THING_PARAMETER_SET | thing/parameter/set | |
THING_ENOCEAN_EURID_ASSIGN | thing/enocean/eurid/assign | |
THING_ENOCEAN_PAIRING_SEND | thing/enocean/pairing/send | |
DESCRIPTION_VALUE_REFRESH | description/value/refresh | |
TIMER_CREATE | timer/create | |
TIMER_UPDATE | timer/update | |
TIMER_ENABLE | timer/enable | |
LOGIC_RULE_ADD | logic/rule/add | |
LOGIC_RULE_UPDATE | logic/rule/update | |
LOGIC_RULE_DELETE | logic/rule/delete | |
LOGIC_RULE_REFRESH | logic/rule/refresh | |
LOGIC_SCENE_ADD | logic/scene/add | |
LOGIC_SCENE_UPDATE | logic/scene/update | |
LOGIC_SCENE_DELETE | logic/scene/delete | |
LOGIC_SCENE_REFRESH | logic/scene/refresh | |
LOGIC_SCENE_EXECUTE | logic/scene/execute | |
LOGIC_SCENE_EXECUTE_OBJECT | logic/scene/execute/object | |
LOGIC_SCENE_RUNNING_GET | logic/scene/running/get | |
LOGIC_SCENE_STOP | logic/scene/stop | |
LOGIC_SCENE_THING_CREATE | logic/scene/thing/create | |
LOGIC_CONNECTION_ADD | logic/connection/add | |
LOGIC_CONNECTION_UPDATE | logic/connection/update | |
LOGIC_CONNECTION_DELETE | logic/connection/delete | |
LOGIC_CONNECTION_REFRESH | logic/connection/refresh | |
LOGIC_CONNECTION_ENABLE | logic/connection/enable |