KNX.Scene

This command provides a way to simulate a KNX scene. Based on a scene number (1 byte), data point values can be stored and restored (replay) with the scene.

Although scenes are related to KNX, they can be used with any items. The concept originates from KNX, but does not require it.

Description

KNX background: Communication objects that are used for scene control have a size of 1 byte (e.g. DPT_SceneControl). For each scene object 64 different scenes are available. A value between 0 and 63 is used to restore the values of a scene. A value between 128 and 191 is used to store the current values of all data points that belong the scene at the server, where X = scene number + 128 (e.g. a value of 130 is used to stored the values of scene 2).

All scene values are stored as persistent values within the Core Server and thus are also available after restarting the server.

To predefine scene values, use KNX.SetScene. Otherwise restoring values does not have any effect, as long no values were saved before.

Inputs

Name	Type	M/O	Description

Name

Type

M/O

Description

Scene

ItemID

M

This input item is used to trigger the scene. The value will determine the scene number, as well as if values shall be saved or restored.

A value between 0 ... 63 is used to restore values of a scene with this number.
A value between 128 ... 191 is used to saved values for the scene with the number 0 … 63. The actual number to be used is the scene number + 128.
Setting the item to 128 will save the values of item Scene_Datapoint1 … Scene_Datapoint8 to scene number 0.

Outputs

Name	Type	M/O	Description

Name	Type	M/O	Description
Scene_Datapoint1	ItemID	M	Item ID of scene member 1, that gets written on restore or that gets read on save.
Scene_Datapoint2	ItemID	O	Item ID of scene member 2, that gets written on restore or that gets read on save.
…
Scene_Datapoint8	ItemID	O	Item ID of scene member 8, that gets written on restore or that gets read on save.

Parameters

Name	Type	M/O	Description

Name	Type	M/O	Description
Scene_Name	String	M	Name of the scene. The combination of this name and the scene number (in input parameter Scene) identifies the scene. Make sure that you use different names if you need to manage independent scenes.

Applies to

NETx BMS Platform, XLogic Library 1.0.12+
NETx Multi Protocol Server, XLogic Library 1.0.12+