Thing Commands

19min

System
These commands are used for basic management of the learned devices.
RefreshSupportedThingsDTO
Requests the reference IDs of the supported devices. A SupportedThingInfoDTO﻿ for each supported device is returned.
RefreshSupportedThingsDTO
{
  "commandId" : "OwnCommandId"
}
{
  "commandId" : "OwnCommandId"
}
﻿
CreateThingDTO
Create a new device based on the reference ID.
Field
Data type
Description
referenceId
String
Unique ID of the command, this is assigned by the user.
name
String
The name to be used for the new device.
CreateThingDTO
{
  "commandId" : "OwnCommandId",
  "referenceId" : "dd340905-2c7a-4d57-a702-d3758902d03b",
  "name" : "Dimmer bathroom"
}
{
  "commandId" : "OwnCommandId",
  "referenceId" : "dd340905-2c7a-4d57-a702-d3758902d03b",
  "name" : "Dimmer bathroom"
}
﻿
SetAutoPairingEnabledDTO
Automatic pairing can be activated / deactivated using this command. Optionally, it can be set to be automatically deactivated again after a specified time.
Field
Data type
Description
enabled
Boolean
Flag whether automatic teach-in should be activated or deactivated.
enabledForSec
Number
Specifies how many seconds the automatic teach-in should be active . If the value is 0, automatic teach-in remains active until it is deactivated again.
SetAutoPairingEnabledDTO
{
  "commandId" : "OwnCommandId",
  "enabled" : true,
  "enabledForSec" : 120
}
{
  "commandId" : "OwnCommandId",
  "enabled" : true,
  "enabledForSec" : 120
}
﻿
RefreshThingsDTO
Request update of one or more devices.
Field
Data type
Description
thingIds
Array
A list of device IDs. If the field does not exist or is empty, all devices are updated.
RefreshThingsDTO 1
RefreshThingsDTO 2
{
  "commandId" : "OwnCommandId",
  "thingIds" : [ "dd340905-2c7a-4d57-a702-d3758902d03b", "8d638845-6270-476f-9878-860dc7ae0bde" ]
}
{
  "commandId" : "OwnCommandId",
  "thingIds" : [ "dd340905-2c7a-4d57-a702-d3758902d03b", "8d638845-6270-476f-9878-860dc7ae0bde" ]
}
﻿
RefreshDescriptionsDTO
Request update of one or more value descriptions.
Field
Data type
Description
descriptionIds
Array
A list of description IDs. If the field does not exist or is empty, all descriptions are updated.
RefreshDescriptionsDTO 1
RefreshDescriptionsDTO 2
{
  "commandId" : "OwnCommandId",
  "descriptionIds" : [ "C59CC0096A458B4038E20E7ADDC70A0D", "E21D6D20C03D05AA9E368DD9F79BEC5A" ]
}
{
  "commandId" : "OwnCommandId",
  "descriptionIds" : [ "C59CC0096A458B4038E20E7ADDC70A0D", "E21D6D20C03D05AA9E368DD9F79BEC5A" ]
}
﻿
Device specific
Commands that refer directly to an existing device always require the ID of the device. The "id" field is therefore present in every device command object.
Field
Data type
Description
id
String
Unique ID of a device.
DeleteThingDTO
Only the device ID is required to delete a device, so there are no other fields.
DeleteThingDTO
{
  "commandId" : "OwnCommandId",
  "id" : "dd340905-2c7a-4d57-a702-d3758902d03b"
}
{
  "commandId" : "OwnCommandId",
  "id" : "dd340905-2c7a-4d57-a702-d3758902d03b"
}
﻿
RenameThingDTO
Rename a device.
Field
Data type
Description
newName
String
The new name for the device.
RenameThingDTO
{
  "commandId" : "OwnCommandId",
  "id" : "da592b04-af82-4d88-a8b2-446d4f21fb80",
  "newName" : "Renamed Device"
}
{
  "commandId" : "OwnCommandId",
  "id" : "da592b04-af82-4d88-a8b2-446d4f21fb80",
  "newName" : "Renamed Device"
}
﻿
SetThingChannelValueDTO
Sets the channel value of a device to the set value.
Field
Data type
Description
channelId
String
Unique ID of a device channel.
newValue
String
The new value to be set. This is always transferred as a string. Even with numerical values!
If the change is successful, the associated device object is updated.
SetThingChannelValueDTO 1
SetThingChannelValueDTO 2
{
  "commandId" : "OwnCommandId",
  "id" : "dd340905-2c7a-4d57-a702-d3758902d03b",
  "channelId" : "Dimmer",
  "newValue" : "80"
}
{
  "commandId" : "OwnCommandId",
  "id" : "dd340905-2c7a-4d57-a702-d3758902d03b",
  "channelId" : "Dimmer",
  "newValue" : "80"
}
﻿
SetThingParameterDTO
Change device parameters.
Field
Data type
Description
parameterId
String
Unique parameter ID related to a device.
newValue
String
The new value to be set. This is always transferred as a string. Even for numerical values!
SetThingParameterDTO 1
SetThingParameterDTO 2
{
  "commandId" : "OwnCommandId",
  "id" : "295d0951-ff6b-4cf4-9b86-add3f7d2808f",
  "parameterId" : "ShutdownTime",
  "newValue" : "60"
}
{
  "commandId" : "OwnCommandId",
  "id" : "295d0951-ff6b-4cf4-9b86-add3f7d2808f",
  "parameterId" : "ShutdownTime",
  "newValue" : "60"
}
﻿
EnOcean
These are commands that only work with EnOcean devices.
AssignAcknowledgeIdDTO
Assignment of an EnOcean ID to a receive channel.
Field
Data type
Description
eurid
String
The EURID of the EnOcean device  
acknowledgeChannelName
String
One of the possible receive channel names for the device.
AssignAcknowledgeIdDTO
{
  "commandId" : "OwnCommandId",
  "id" : "dd340905-2c7a-4d57-a702-d3758902d03b",
  "eurid" : "0x03245245",
  "acknowledgeChannelName" : "default"
}
{
  "commandId" : "OwnCommandId",
  "id" : "dd340905-2c7a-4d57-a702-d3758902d03b",
  "eurid" : "0x03245245",
  "acknowledgeChannelName" : "default"
}
﻿
SendPairingSignalDTO
Sending a learning signal for actuators. The gateway for sending the signal must be specified so that the correct send ID can be determined.
Field
Data type
Description
gatewayId
String
Unique ID of an EnOcean gateway to determine the send ID.
transmissionChannelName
String
One of the possible transmission channel names for the device.
secure
Boolean
Specifies whether a learning signal is sent with encryption.
SendPairingSignalDTO
{
  "commandId" : "OwnCommandId",
  "id" : "dd340905-2c7a-4d57-a702-d3758902d03b",
  "gatewayId" : "12342648",
  "transmissionChannelName" : "default",
  "secure" : false
}
{
  "commandId" : "OwnCommandId",
  "id" : "dd340905-2c7a-4d57-a702-d3758902d03b",
  "gatewayId" : "12342648",
  "transmissionChannelName" : "default",
  "secure" : false
}
﻿
﻿

Field	Data type	Description
referenceId	String	Unique ID of the command, this is assigned by the user.
name	String	The name to be used for the new device.

Field	Data type	Description
enabled	Boolean	Flag whether automatic teach-in should be activated or deactivated.
enabledForSec	Number	Specifies how many seconds the automatic teach-in should be active . If the value is 0, automatic teach-in remains active until it is deactivated again.

Field	Data type	Description
thingIds	Array	A list of device IDs. If the field does not exist or is empty, all devices are updated.

Field	Data type	Description
descriptionIds	Array	A list of description IDs. If the field does not exist or is empty, all descriptions are updated.

Field	Data type	Description
id	String	Unique ID of a device.

Field	Data type	Description
newName	String	The new name for the device.

Field	Data type	Description
channelId	String	Unique ID of a device channel.
newValue	String	The new value to be set. This is always transferred as a string. Even with numerical values!

Field	Data type	Description
parameterId	String	Unique parameter ID related to a device.
newValue	String	The new value to be set. This is always transferred as a string. Even for numerical values!

Field	Data type	Description
eurid	String	The EURID of the EnOcean device
acknowledgeChannelName	String	One of the possible receive channel names for the device.

Field	Data type	Description
gatewayId	String	Unique ID of an EnOcean gateway to determine the send ID.
transmissionChannelName	String	One of the possible transmission channel names for the device.
secure	Boolean	Specifies whether a learning signal is sent with encryption.

Updated 25 Mar 2024

Did this page help you?

System Commands

Logic Commands