IoT Export

IoT Core Data Model

7min

Overview

The IoT Core data model is divided into different areas.

Simple IoT Core

The Simple IoT Core describes a data model for transmitting device and status information.

IoT Logic Core

In the Logic Core Data transfer objects (DTOs) are described with reference to rules, scenes, connections and timers.

IoT Command Core

The Command Core contains all command DTOs for interaction with the gateway.

These are divided into:

IoT Template Core

The Template Core describes relevant DTOs for semi-automated administration by template.



DTOContainer

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.



Object and command types

The following types are possible for the "type" field in the DTO container.

Objects

Type

Resource Path

DTO

NODE_STATUS

node/status

SimpleIoTCoreGatewayDTO

NODE_TEMPLATE_RESULT

node/template/result

TemplateImportResultDTO

NODE_ENOCEAN_GATEWAY

node/enocean/gateway

EnOceanGatewayInfoDTO

DESCRIPTION_THING

description/thing

SupportedThingInfoDTO

THING

thing

SimpleIoTCoreThingDTO

SimpleIoTCoreEnOceanDTO

SimpleIoTCoreTimerDTO

THING_DELETED

thing/deleted

DESCRIPTION_VALUE

description/value

LOGIC_RULE

logic/rule

ConditionCollectionDTO

LOGIC_RULE_DELETED

logic/rule/deleted

LOGIC_SCENE

logic/scene

ExecutorCollectionDTO

LOGIC_SCENE_DELETED

logic/scene/deleted

LOGIC_CONNECTION

logic/connection

ConnectionDTO

LOGIC_CONNECTION_DELETED

logic/connection/deleted

ConnectionDeletedDTO

LOGIC_SCENE_RUNNING

logic/scene/running

COMMAND_RESULT

command/result

CommandResultDTO



Commands

Type

Resource Path

DTO

NODE_UPDATE

node/update

UpdateFirmwareDTO

NODE_RESTART

node/restart

RestartSystemDTO

NODE_TEMPLATE_IMPORT

node/template/import

ImportTemplateDTO

NODE_STATUS_INTERVAL

node/status/interval

SetGatewayStatusIntervalDTO

NODE_PAIRING

node/pairing

SetAutoPairingEnabledDTO

DESCRIPTION_THING_REFRESH

description/thing/refresh

RefreshSupportedThingsDTO

NODE_ENOCEAN_GATEWAY_REFRESH

node/enocean/gateway/refresh

RefreshEnOceanGatewaysDTO

NODE_ENOCEAN_GATEWAY_ACTIVE

node/enocean/gateway/active

SetEnOceanGatewayActiveDTO

THING_CREATE

thing/create

CreateThingDTO

THING_DELETE

thing/delete

DeleteThingDTO

THING_REFRESH

thing/refresh

RefreshThingsDTO

THING_RENAME

thing/rename

RenameThingDTO

THING_CHANNEL_SET

thing/channel/set

SetThingChannelValueDTO

THING_PARAMETER_SET

thing/parameter/set

SetThingParameterDTO

THING_ENOCEAN_EURID_ASSIGN

thing/enocean/eurid/assign

AssignAcknowledgeIdDTO

THING_ENOCEAN_PAIRING_SEND

thing/enocean/pairing/send

SendPairingSignalDTO

DESCRIPTION_VALUE_REFRESH

description/value/refresh

RefreshDescriptionsDTO

TIMER_CREATE

timer/create

CreateTimerDTO

TIMER_UPDATE

timer/update

UpdateTimerDTO

TIMER_ENABLE

timer/enable

SetTimerEnabledDTO

LOGIC_RULE_ADD

logic/rule/add

AddConditionCollectionDTO

LOGIC_RULE_UPDATE

logic/rule/update

LOGIC_RULE_DELETE

logic/rule/delete

LOGIC_RULE_REFRESH

logic/rule/refresh

LOGIC_SCENE_ADD

logic/scene/add

AddExecutorCollectionDTO

LOGIC_SCENE_UPDATE

logic/scene/update

UpdateExecutorCollectionDTO

LOGIC_SCENE_DELETE

logic/scene/delete

DeleteExecutorCollectionDTO

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

StopExecutorCollectionDTO

LOGIC_SCENE_THING_CREATE

logic/scene/thing/create

CreateExecutorThingDTO

LOGIC_CONNECTION_ADD

logic/connection/add

AddConnectionDTO

LOGIC_CONNECTION_UPDATE

logic/connection/update

UpdateConnectionDTO

LOGIC_CONNECTION_DELETE

logic/connection/delete

DeleteConnectionDTO

LOGIC_CONNECTION_REFRESH

logic/connection/refresh

RefreshConnectionsDTO

LOGIC_CONNECTION_ENABLE

logic/connection/enable

SetConnectionEnabledDTO