KNX.SetScene
This XLogic command can be used to define saved values that get used by KNX.Scene. Using it without using KNX.Scene will not make sense.
Executing this XLogic does not have any effect on the Item tree.
Description
KNX.Scene allows to restore values (write values to items). However, if the command was not yet used to save values, restoring does not set values at any item, just because there are no values stored at the server. For this reason KNX.SetScene can be used, which makes sure that values are defined when restoring. This can be seen as default values for the scene items.
This functionality is similar to specify scene values via KNX ETS parameters. But instead of storing the values at the devices, they are stored in they server.
Values will be saved for a certain scene name (parameter Scene_Name), a scene id (parameter Scene_Number) and up to 8 item paths (output parameter Scene_Datapoint1 … Scene_Datapoint8). KNX.Scene must use the same configuration parameters, so that the values can be restored.
Using this command as XCommand, ON_START as trigger type will make most sense.
Inputs
Name | Type | M/O | Description |
|---|---|---|---|
Trigger | ItemID | O | If the XLogic is used as an XCommand with type ON_INPUT, the specified item triggers the setting of the values when it changes. It is just about the triggering, the items value does not matter and has no effect. |
Outputs
Please note: Although these configuration values are defined as output values, they will be only used to identify the items to which values will be written when KNX.Scene is used for restoring. None of these items will changed when KNX.SetScene gets executed.
Name | Type | M/O | Description |
|---|---|---|---|
Scene_Datapoint1 | ItemID | M | Item ID of scene member 1. |
Scene_Datapoint2 | ItemID | O | Item ID of scene member 2. |
… |
|
|
|
Scene_Datapoint8 | ItemID | O | Item ID of scene member 8. |
Parameters
Name | Type | M/O | Description |
|---|---|---|---|
Scene_Name | String | M | This name is used to identify the scene. |
Scene_Number | Number | M | This parameter specifies the scene number for which the values shall be stored. |
Datapoint1_Value | Any | M | Value for scene member 1 (specified in Scene_Datapoint1). |
Datapoint2_Value | Any | O | Value for scene member 2 (specified in Scene_Datapoint2). |
… |
|
|
|
Datapoint8_Value | Any | O | Value for scene member 8 (specified in Scene_Datapoint8). |
Applies to
NETx BMS Platform, XLogic Library 1.0.12+
NETx Multi Protocol Server, XLogic Library 1.0.12+