IoT Export
...
IoT Core Data Model
Simple IoT Core

Things

11min

Thing data

Devices always have channels and parameters. Channels represent individual sensors or actuators of a device. The (operating) parameters, on the other hand, are software or hardware-based settings that influence the behaviour of the device.

SimpleIoTCoreThingDTO

All specialised devices are based on this object. It contains all the basic fields that are minimally required for a device.

Field

Data type

Description

id

String

Unique ID of the device in the system.

type

String

Basic Device Type.

name

String

The assigned name of the device.

refId

String

Reference ID for specifying the device type.

channels

Object

Each field of the object represents a channel for which a value container is stored.

parameters

Object

Each field of the object represents a parameter for which a container value is stored.

The following values can be in the "type" field.

Type

Description

GENERIC

Basic device data type for all devices.

ENOCEAN

EnOcean-based devices.

TIMER

Virtual timer device.

Code examples

SimpleIoTCoreEnOceanDTO

Extension of the SimpleIoTCoreThing with EnOcean-relevant information.

The following additional fields are available:

Field

Data type

Description

signalStrength

Number

Signal strength of the last received signal in per cent. 0 - 100%

acknowledgeChannels

Object

Each field of the object represents a receive channel. The field value is the EURID used for the channel or an empty string if no ID is assigned.

transmissionChannels

Object

Each field of the object represents a transmission channel. The field value is the transmission ID used for one of the available EnOcean gateways or an empty string if no ID is assigned.

It is possible that there are no fields in the "transmissionChannels" object. This means that this device does not support transmission channels.

Code examples

SimpleIoTCoreTimerDTO

Extension of the SimpleIoTCoreThing with timer-specific fields.

The following additional fields are available:

Field

Data type

Description

enabled

Boolean

Indicates whether the timer is enabled or not.

visible

Boolean

Specifies whether the timer is visible (clients only).

mode

String

Operating mode of the timer.

timerType

String

Type of the timer.

time

Number

A time specification as a Unix timestamp. The time stamp is specified for values with a date regardless of the local time zone in UTC+0. The time is calculated modulo 86400. The time is calculated modulo 86400. Otherwise, the day and month are calculated from the date or value set in the time field for recurring execution.

offset

Number

Time offset to be applied in minutes (+/-).

period

Number

Specification of the minutes for the periodic triggering.

selectedDays

Array

Selected days as a string array.

The following types can be used in the "timerType" field:

Type

Description

ONCE

Execution of the timer once on a day at a specific time.

DAILY

Daily execution of the timer at a specific time.

WEEKLY

Weekly execution of the timer at a specific time.

MONTHLY

Monthly execution of the timer on a specific day at a specific time.

YEARLY

Yearly execution of the timer on a specific day at a specific time.

SELECTED_DAYS

Execution of the timer on specific days of the week.

PERIODIC

Periodic execution of the timer after a defined interval.

The following values are possible in the "mode" field.

Mode

Description

NORMAL

Normal operating mode

SUNRISE

Timer triggering refers to the calculated sunrise incl. offset.

SUNSET

Timer triggering refers to the calculated sunset incl. offset.

An array with the selected days can be stored in the "selectedDays" field.

Day

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

The following table shows the evaluation of the time field depending on the timer type. As an example, timeStamp = 1707150600 is selected, this corresponds to Tuesday, 05.02.2024 16:30:00 UTC+0.

Type

Auswertung

ONCE

Tuesday, 05.02.2024 at 16:30:00

DAILY

Daily at 16:30:00

WEEKLY

Tuesdays at 16:30:00

MONTHLY

immer am 05. eines Monats um 16:30:00 Uhr

YEARLY

Always on 05.02. at 16:30:00

SELECTED_DAYS

At 16:30:00 on the selected days

PERIODIC

Field is not evaluated

Code examples

SimpleIoTCoreThingDeletedDTO

Field

Data type

Description

id

String

Unique ID of the device in the system.

Code examples





Updated 25 Mar 2024
Doc contributor
Doc contributor
Did this page help you?