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 
SimpleIoTCoreThingDTO 1
SimpleIoTCoreThingDTO 2
{
   "id":"78e29422-75d3-48a2-b51e-aa57cffb67a6",
   "name":"Executor1",
   "refId":"generic.actor-container",
   "type":"GENERIC",
   "channels":{
      "ExecutorCollection":{
         "type":"STATE",
         "descriptionId":"0F2E23CC08FA7A6677C8B34147134F5D",
         "changeable":true,
         "value":"STOPPED"
      }
   }
}
{
   "id":"78e29422-75d3-48a2-b51e-aa57cffb67a6",
   "name":"Executor1",
   "refId":"generic.actor-container",
   "type":"GENERIC",
   "channels":{
      "ExecutorCollection":{
         "type":"STATE",
         "descriptionId":"0F2E23CC08FA7A6677C8B34147134F5D",
         "changeable":true,
         "value":"STOPPED"
      }
   }
}
﻿
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 
SimpleIoTCoreEnOceanDTO 1
SimpleIoTCoreEnOceanDTO 2
{
   "id":"d5da720e-2ad6-4c86-88c0-f84390f76570",
   "name":"Fenstergriff",
   "refId":"enocean.hoppe.windowhandle",
   "type":"ENOCEAN",
   "channels":{
      "WindowHandle":{
         "type":"STATE",
         "descriptionId":"7F5679889E7910087244AE399DB8CECA",
         "changeable":false,
         "value":"CLOSED"
      }
   },
   "signalStrength":93,
   "assignableAcknowledgeNames":[
      "default"
   ],
   "possibleTransmissionNames":[
      
   ],
   "acknowledgeChannels":{
      "default":"1104311"
   },
   "transmissionChannels":{
      
   }
}
{
   "id":"d5da720e-2ad6-4c86-88c0-f84390f76570",
   "name":"Fenstergriff",
   "refId":"enocean.hoppe.windowhandle",
   "type":"ENOCEAN",
   "channels":{
      "WindowHandle":{
         "type":"STATE",
         "descriptionId":"7F5679889E7910087244AE399DB8CECA",
         "changeable":false,
         "value":"CLOSED"
      }
   },
   "signalStrength":93,
   "assignableAcknowledgeNames":[
      "default"
   ],
   "possibleTransmissionNames":[
      
   ],
   "acknowledgeChannels":{
      "default":"1104311"
   },
   "transmissionChannels":{
      
   }
}
﻿
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 
SimpleIoTCoreTimerDTO 1
SimpleIoTCoreTimerDTO 2
SimpleIoTCoreTimerDTO 3
{
   "id":"e9bb116f-033b-493a-a615-09712d84996e",
   "name":"Timer_sunrise",
   "refId":"generic.virtual.timer",
   "type":"TIMER",
   "channels":{
      "TimerOn":{
         "type":"STATE",
         "descriptionId":"7FF06AB573E6FA5BFF463DC19F0983E0",
         "changeable":true,
         "value":"ON"
      },
      "Trigger":{
         "type":"STATE",
         "descriptionId":"02595BE69384636622E81F8AD7978D70",
         "changeable":false,
         "value":"NOT_TRIGGERED"
      }
   },
   "parameters":{
      
   },
   "enabled":true,
   "visible":true,
   "mode":"SUNRISE",
   "time":1705317000,
   "offset":5,
   "timerType":"SELECTED_DAYS",
   "period":0,
   "selectedDays":[
      "SATURDAY",
      "SUNDAY"
   ]
}
{
   "id":"e9bb116f-033b-493a-a615-09712d84996e",
   "name":"Timer_sunrise",
   "refId":"generic.virtual.timer",
   "type":"TIMER",
   "channels":{
      "TimerOn":{
         "type":"STATE",
         "descriptionId":"7FF06AB573E6FA5BFF463DC19F0983E0",
         "changeable":true,
         "value":"ON"
      },
      "Trigger":{
         "type":"STATE",
         "descriptionId":"02595BE69384636622E81F8AD7978D70",
         "changeable":false,
         "value":"NOT_TRIGGERED"
      }
   },
   "parameters":{
      
   },
   "enabled":true,
   "visible":true,
   "mode":"SUNRISE",
   "time":1705317000,
   "offset":5,
   "timerType":"SELECTED_DAYS",
   "period":0,
   "selectedDays":[
      "SATURDAY",
      "SUNDAY"
   ]
}
﻿
SimpleIoTCoreThingDeletedDTO
Field
Data type
Description
id
String
Unique ID of the device in the system.
Code examples 
SimpleIoTCoreThingDeletedDTO
{
  "id" : "76dd6b1f-3f6a-4c02-b6d7-3539cd03201c"
}
{
  "id" : "76dd6b1f-3f6a-4c02-b6d7-3539cd03201c"
}
﻿
﻿
﻿

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.

Type	Description
GENERIC	Basic device data type for all devices.
ENOCEAN	EnOcean-based devices.
TIMER	Virtual timer device.

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.

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.

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.

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.

Day
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
SUNDAY

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

Field	Data type	Description
id	String	Unique ID of the device in the system.

Updated 25 Mar 2024

Did this page help you?

Simple IoT Core

Values

Things

Thing data

SimpleIoTCoreThingDTO

SimpleIoTCoreEnOceanDTO

SimpleIoTCoreTimerDTO

SimpleIoTCoreThingDeletedDTO

﻿