Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description - INTERNAL DOCUMENTATION

This function is used to execute an XLogic command within LUA. This version takes a single string as parameter which includes all parameters.

Signature

Code Block
nxa.ExecuteXCommand (string,

...

 ...)

Parameters

...

NameTypeMandatory/OptionalDescription
 
XCommandNamestringM
Namd
Name of XCommand. The variable scope is encoded as " : " . If no scope is needed only the XCommand name shall be given.
 
InputsParametersOutputs 
string
...
M
OInputs, Parameters and Outputs

...

Provide a function call argument for each input, parameter, and output.

Refer to this table to choose the correct format for passing arguments:

XLogic typeLUA typenotes
BOOLboolean, number, string

valid expressions for true are:

Code Block
true, "T", "TRUE", 1

valid expressions for false are:

Code Block
false, "F", "FALSE", 0

String expressions are non-case-sensitive.

ITEM IDstringA backslash inside the string has to be escaped by a backslash: "NETx\\XIO\\KNX\\172.16.1.3\\05/8/012"
NUMBERnumber
STRINGstring
ANYstring

A type indicator prefix is required in the string:

Code Block
"{<type indicator>}:<value>"

Type indicators:

  • S: String
  • B: Boolean
  • I: Item
  • N: Number

Example

Following XCommand is to be called:

XCommand argumentXLogic typeValue
InputITEM IDNETx\XIO\KNX\172.16.1.3\05/8/012
InputNUMBER123
InputBOOLTRUE
ParameterANYnumber: 987
ParameterANYboolean: true
OutputITEM IDNETx\XIO\KNX\172.16.1.3\05/8/013

The respective call from LUA is

Code Block
nxa.ExecuteXCommand ("NETx\\XIO\\KNX\\172.16.1.3\\05/8/012", 123, true, "{N}:987", "{B}:T", "NETx\\XIO\\KNX\\172.16.1.3\\05/8/013")

Return

None.