System

7min

Gateways
SimpleIoTCoreGatewayDTO
General status information about the device itself.
Field
Data type
Description
version
String
Installed firmware version of the gateway.
availableVersion
String
Firmware version available on the update server.
online
Boolean
Flag indicating whether the gateway is online or not.
uptime
String
The current uptime of the gateway.
updateChannel
Number
Specification of the current update channel.
mobileInfo
Object
Optional field that displays information about the mobile gateway used.
statusInterval
Number
Interval in minutes after which the gateway sends its status information  
alias
String
The set system alias / host name.
hardwareId
String
Unique hardware ID of the gateway.
The update channel 0 corresponds to the release channel.
Code examples 
SimpleIoTCoreNumberLongValueDTO
{
   "version":"3.7.0",
   "availableVersion":"N/A",
   "online":true,
   "uptime":"7d 05h 07m 06s",
   "updateChannel":0,
   "statusInterval":60,
   "hardwareId":"BCDBD059EB5F",
   "alias":"EG122SN"
}
{
   "version":"3.7.0",
   "availableVersion":"N/A",
   "online":true,
   "uptime":"7d 05h 07m 06s",
   "updateChannel":0,
   "statusInterval":60,
   "hardwareId":"BCDBD059EB5F",
   "alias":"EG122SN"
}
﻿
EnOceanGatewayInfoDTO
Provides optional additional information on a gateway.
Field
Data type
Description
id
String
The ID of the EnOcean gateway
type
String
The gateway type.
active
Boolean
Indicates whether the gateway is active or not.
protocol
String
The communication protocol used.
info
String
Additional information about the gateway.
Code examples 
EnOceanGatewayInfoDTO
{
  "id": "4291825664",
  "type": "INTERN",
  "active": true,
  "protocol": "ESP3"
}
{
  "id": "4291825664",
  "type": "INTERN",
  "active": true,
  "protocol": "ESP3"
}
﻿
Supported Things
SupportedThingInfoDTO
Provides information about a supported thing.
Field
Data type
Description
referenceId
String
The unique type ID of the device.
displayName
String
The preferred display name of the device.
manufacturerNameShort
String
The manufacturer in short form.
manufacturerNameLong
String
The manufacturer in long form.
descriptionShort
String
The description in short form.
descriptionLong
String
The description in long form.
version
String
The version of the thing.
The reference ID is required to create new things.
Code examples 
SimpleIoTCoreNumberLongValueDTO
{
  "referenceId" : "enocean.enocean.eep.f6-02-02",
  "manufacturerNameShort" : "EnOcean",
  "manufacturerNameLong" : "EnOcean Alliance Inc.",
  "displayName" : "EEP F6-02-02",
  "descriptionShort" : "Switch",
  "descriptionLong" : "Switch - State top left",
  "version" : "1.1"
}

{
  "referenceId" : "enocean.enocean.eep.f6-02-02",
  "manufacturerNameShort" : "EnOcean",
  "manufacturerNameLong" : "EnOcean Alliance Inc.",
  "displayName" : "EEP F6-02-02",
  "descriptionShort" : "Switch",
  "descriptionLong" : "Switch - State top left",
  "version" : "1.1"
}
﻿
﻿

Field	Data type	Description
version	String	Installed firmware version of the gateway.
availableVersion	String	Firmware version available on the update server.
online	Boolean	Flag indicating whether the gateway is online or not.
uptime	String	The current uptime of the gateway.
updateChannel	Number	Specification of the current update channel.
mobileInfo	Object	Optional field that displays information about the mobile gateway used.
statusInterval	Number	Interval in minutes after which the gateway sends its status information
alias	String	The set system alias / host name.
hardwareId	String	Unique hardware ID of the gateway.

Field	Data type	Description
id	String	The ID of the EnOcean gateway
type	String	The gateway type.
active	Boolean	Indicates whether the gateway is active or not.
protocol	String	The communication protocol used.
info	String	Additional information about the gateway.

Field	Data type	Description
referenceId	String	The unique type ID of the device.
displayName	String	The preferred display name of the device.
manufacturerNameShort	String	The manufacturer in short form.
manufacturerNameLong	String	The manufacturer in long form.
descriptionShort	String	The description in short form.
descriptionLong	String	The description in long form.
version	String	The version of the thing.

Updated 25 Mar 2024

Did this page help you?

Values

IoT Logic Core