This object is the main node of the system tree and includes all the main features and data that describe the project. All other objects, which represents the configurable services provided by the server, can be added to the project by right clicking on this node.
By selecting the object, the following properties will be displayed in the grid below:
Commands sent to the object and recallable from other objects:
Send KNX Float 2 Byte Telegram
Send KNX Float 4 Byte Telegram
Make a pause for a fixed interval
Change UI Function and Page: GENERAL
Change UI Function and Page: SPECIFIC CLIENT
Execute MS Windows Command: GENERAL
Execute MS Windows Command: SPECIFIC CLIENT
Send DTMF tone during intercom call
This object contains all KNX groups configured in the ETS software. It simplifies visualization and selection of these groups within the Configurator thanks to a tree displaying. Following properties are displayed in the grid below:
If the suffix “-255” is used, the telegram will be sent to all the configured interfaces.
Figure 2.4.1: Secondary interfaces communication
Figure 2.4.2: Secondary interface configuration
Launch ETS, then right click on ”main groups” (ETS3) or ”Group Addresses” (ETS4) and select the ”export group addresses” option. With ETS 3 use default export parameters, in ETS 4 select CSV format and activate the ”Export header information” flag.
Figure 4.3: ETS 3 export parameters
With ETS 4 and later versions, the project can be exported in OPC.
From the ETS application, click on “Other → Export OPC”: the generated “.esf” file can be imported in the Configurator at a later time.
This service allows to define a list of actions to be performed by the server on user’s demand or depending on a specific setting. These actions can be specified by the installer directly in the Configurator or in the client application by the user.
This object can be linked to a Scene icon in the user interface, or used internally with the logic module, universal gateway and others.
Scenes saved by the user from the ThinKnx application are not lost after a project upload to the server.
This object allows to control HVAC devices: an HVAC controller can control more than one device commanded using the same connection type.
Select the ”Devices” property and click on the button displayed on the right to open the devices editor window; click on ”Add” button and adjust the properties in the grid.
CoolAutomation devices permits to directly talk with many Air conditioning brands including Daikin and many others. It is connected directly to the AC bus and can control with a single interface all the units connected to the bus.
This device requires the Automation License.
Integration with Thinknx is directly through the network and permits to control devices under CoolMaster directly within Thinknx. It is not required that the CoolMaster has KNX port. The communication with the KNX devices will be through the server and the server itself will act as gateway to and from KNX. The control of all the split units connected with CoolMaster will be possible using standard HVAC pop-ups in Thinknx.
On the system node the following properties will appear:
These are the properties for the single device:
This device requires the Automation License.
If Controller type is ”Mitsubishi AG 150” the following property will appear to define the device address:
These are the properties for the single device:
This server service allows the user to program until six daily temporisations for a switch object. The server checks events planning so that value 1 is sent to the switch object at the preset time.
This server service allows the user to program on/off KNX commands (switch objects) using client applications; it is also possible to memorize the temporization on server. Different switches can be associated to the same calendar.
Every Thinknx server embeds a software VOIP telephony PBX. It is optimized for the VOIP functionalities between clients and door communication. This system object allows to configure the PBX (extensions, ring groups and door stations). For more information, please refer to our Voip PBX and Doorcom guide here.
Daily and weekly boiler programs can be configured on the server using this object.
Commands sent to the object and recallable from other objects:
The Irrigation object allows to manage different zones of the irrigation system, each of them controlled by a different KNX group. These zones can be combined for creating different irrigation programs, directly in the client application.
Click on the button displayed on the right to open the zones editor window, then click on ”Add” and adjust the properties in the grid:
Commands sent to the object and recallable from other objects:
This object allows the user to control a RGB lamp and create sequences of colors. The bus types supported are: KNX, Modbus and Philips Hue.
When the “RGB Data Type” is set to “RGBW 1 byte per color”, 8 groups are defined in order to write and read values for each color.
When the “RGB Data Type” is set to “RGBW 6 bytes”, just 2 groups are defined for a single RGBW
Commands sent to the object and recallable from other objects:
Start RGB sequence shuffle with time in seconds
Start RGB sequence repeat with time in seconds
Stop RGB sequence and turn OFF
Save the current color to the selected preset position
Recall the color previously saved to the selected preset position
This object is needed to configure SMTP server parameters to send email messages from the server (used to send alerts, reports etc.).
As an example when using Google to send emails from Thinknx Server, it is recommended that you enable the “2-step verification” from your Google Account at https://myaccount.google.com/security. A new option will appear to create additional passwords to allow third-party applications to sign in. By generating a new password for Thinknx, you can use this password to send emails from the server without the need to enable the “less secure apps access”. It is only necessary to enable this options when the 2-step verification is also disabled. In that case, the user will need to use the main Google password to send emails.
Google Account Settings
Google Account Settings
The same concept applies when trying to send emails from the iCloud address, where it is necessary to generate an “app-specific password” from the account settings on iCloud.
After configuring the Email Account in System, you can now send emails through a generic button or using the Report object as well.
If the emails are not sent using the configuration made, some possible causes could be:
Commands sent to the object and recallable from other objects:
This object allows to configure Thinknx sensors (temperature, humidity, luminosity) available on other servers such as the Envision, in addition to configuring different types of Inputs/Outputs found for example on the new Compact_20, as well as the Envision_20.
For each I/O added, the below parameters are available:
If Analog Input is selected, the below parameters are available:
If Digital Input is selected, the below parameter is available:
If Digital Output is selected, the below parameters are available:
If Environment Ambient Sensors is selected, the below parameters are available:
If Relay Output is selected, the below parameters are available:
If Temperature Probe is selected, the below parameters are available:
Commands recallable from other objects:
This server service allows to start a web server to control the plant from the web.
Click on the button displayed on the right to open the users editor window, click on ”Add” and adjust the properties in the grid:
This object is particularly useful to configure a list of actions that can simulate the presence of people even if the house is empty (f.e. turning lights on, starting the audio system etc.).
Click on the button displayed on the right to open actions editor window, click on ”Add” and then adjust the properties in the grid:
The duration fields in the presence simulator are just sample values used to schedule the actions in the simulation.
The server computes a random duration of each action by choosing a value between 70% and 130% of the value specified in the configurator. Also the maximum duration of the simulation is computed by choosing a random value between 80% and 100% of the value you specified in the Configurator. After these values are defined, the server then defines the sequence of actions the simulation will perform. The start time of each action is determined by calculating a random value between 15% and 120% of an overlapping factor. The overlapping factor is calculated as (max. simulation duration - sum of actions durations) / num of actions. The start time represents the time the server must wait before launching the action after the previous action terminated. If the random order property is enabled, the order of execution of the actions won't follow the order in which they have been defined but it will be determined randomly.
For example, 10 actions have been defined with a duration of 15 minutes that means each action will have a duration between 10.5 and 19.5 minutes. The maximum duration of the simulation has been set to 200 minutes and thus it will be a value between 160 and 200 minutes. Following the formula described before, the overlapping factor will be approximately around 5 minutes and thus the computed start time of each action will be a value between 0.75 and 18 minutes.
Commands sent to the object and recallable from other objects:
This object calculates sunrise time, sunset time, sun elevation and azimuth using geographic coordinates specified in the System properties of ThinKnx Configurator project. For example, using sun elevation and azimuth values the user can create thresholds or ranges to automate rollers and blinds controls.
Another powerful feature of this object consists of firing sun position related events and for each event the user can associate a command and specify a time period to anticipate or posticipate the command performed (for example, 20 minutes before sunset or 10 minutes after noon).
The sun related events detected from the server are:
All these data are then sent on KNX through the addresses specified in its properties:
To define an action to perform when a predefined sun event occurs, click on the button displayed on the right of the ”Sun Actions” property, click on ”Add” and then adjust the properties in the grid:
This object is used to integrate the central alarm in the project; it allows the server to arm or disarm the central, to read partitions or sensor status and to singularly control them. All alarm panels integrated in the system provide the user with the same graphical effect. To learn more about the Alarm object, visit the Alarm dedicated page here.
The Thinknx Access Control object permits to enhance the level of automation and security of the home/building where it is applied. It can be adapted to sectors where long term expirations are required such as service and industry sectors, but also applies to the hospitality sector where credentials are usually short term, and remote management is required. For more information, check out the Access Control page here.
The ”Combination” object allows to perform logical operations (AND, OR, XOR) on the values coming from KNX groups and to send the result to another KNX group.
In general, the gate behaviour is illustrated on the following flowchart. When the gate change its value and become enabled, it fires the logic calculation. The calculated output will be sent only if it match the “Output sending behaviour” (if “On result change” is chosen, the value will be sent only if different from the last sent).
In order to set up the list of the inputs of the combination, select the ”Inputs” property and click on the button displayed on the right.
In the displayed window, in order to add a new input, click and the ”Add” button below. An ”Input” object will be added to the list; select it and adjust the properties on the right.
The ’Filter’ object allows to perform operations on the value of an input KNX group and to send the result with an optional delay to an output KNX group. To set up the ”Filter” object, select from the system tree and adjust the properties displayed in the grid below.
This object, given an input and two outputs, allows to choose, through a control bit, the output which the input value has to be assigned to.
In order to set up the ’Multiplexer’ object, select it in the system tree and adjust the properties displayed in the grid below.
This object, given n inputs and n outputs, selects an input with a 1 byte selector and sends it to an output chosen with a 1 byte selector.
Click on the button displayed on the right to open inputs editor window, click on ”Add” and then adjust the properties in the grid:
Click on the button displayed on the right to open outputs editor window, click on ”Add” and then adjust the properties in the grid:
This object allows to calculate weighted sums between the bit values of specific input KNX groups and to assign the result expressed in bytes to an output KNX group. Therefore, the output value is:
C = p1 . v1 + p2 . v2 + … + pk . vk
where p1 is the load (from 0 to 255) associated to the addend v1 that is the value 0 or 1 coming from the input KNX group. It’s particularly useful in case it’s requested to modulate a KNX command through a byte because it allows to associate a different weight to each addend.
In order to set up the ’Linear combination’ object, select it in the system tree and adjust the properties displayed in the grid below.
In order to set up the addends of the sum, select the property ’Addends’ and click on the button displayed on the right. In the displayed window, to add a new addend, click on the ’Add’ button below. An object ’Addend’ is added to the list, select it and adjust the properties on the right.
This object represents a collection of block diagrams which allows you to build complex logics with a graphical editor. For more informations please refer to the Logic Module section.
The ”Complex maths expressions” object represents a collection of logical and arithmetical operations that can be written to elaborate values coming from different KNX groups. It’s possible to write expressions for the calculation of sums, balances, means, absolute values and analogical values, such as temperature and consumption, coming from KNX commands.
To write an expression, add the ”Complex maths expressions” object, select it and adjust the properties displayed in the grid below.
Click on the ”Add” button in the displayed window. An ”Expression” object is added to the list, select it and adjust the properties on the right.
To enter the math expression click on the button on the right of the property “Expression” in the “Expressions Editor” window, which contains the list of all the expressions. In the single “Expression Editor” window the math expression can be directly added, with the desired variable names.
Clicking the “Check” button variables are generated and for each variable following properties can be set.
The change of the expression doesn’t involve of the previously set properties of the variables. Renaming a variable involves the cancellation of the old one and the creation of a new one: the new variable doesn’t acquire the properties of the old one.
Whenever the text of the expression is changed, click on the ”Check” button before clicking on ”Ok”. Not doing so, the variables do not generate and the expression is not saved.
The expression can contain mathematical operators such as +, -, *, /, > (greater-than), < (less-than), = (equal), := (assignment), <> (different) and logical operators such as ”AND” and ”OR”. Decimals have to be expressed with ”.” symbol, for example 0.9, 1.5, 20.05. Each line have to end with ”;” symbol. Is possible to include mathematical functions such as mean, absolute value and rounding. For a complete list of functions with related syntax, click on the ”?” button below.
This feature allows to export a list of expressions previously created in a project and import it in another project.
To export the expressions list, open the expressions list editor window by clicking on the button displayed on the right of the ”Expressions” property. Click on the ”Export” button and choose the path of the xml file that will be created, in this way the list of expressions will be saved outside the Configurator.
To import the expressions list in a project, open the expressions list editor window by clicking on the button displayed on the right of the ”Expressions” property. Click on the ”Import” button and select the xml file previously saved and click on OK button to confirm. A list of expressions will appear in the editor window.
This object represents a collection of values stored in the server and associated to a KNX group. Through these variables it is possible to store, for example, the results of mathematical or logical operations and make them available on KNX through a group address. It is possible to choose if the value will be stored on the server in a persistent way, which means that the value will be available also after the server reboot.
In order to add a variable the variable editor must be opened. Click on the ”Add” button to define following properties:
This object represents a service to store data coming from the plant on a cloud database. All these data will be accessible through the Chart interface object.
This objects works correctly only if the ThinKnxCloud service is enabled and configured!
A database variable is an object which represent the value to store in the database. Clicking on the button on the right of the Values Collection property. Add a new value with the Add button and edit its properties to configure the saving modalities:
Since the quantity of data storable for each server in the cloud database is limited, it is highly recommended to use the filter policies.
This object defines a values collection to be saved in the internal memory according to time intervals defined by the installer. This values are sent via mail and optionally organised in charts.
it is always advised to disable the Default SMTP and create an Email Account object in System to be used here. See section Email Account for more information.
Click on the button displayed on the right to open recipients editor window, click on ”Add” and then adjust the properties in the grid:
Click on the button displayed on the right to open values editor window, click on ”Add” and then adjust the properties in the grid:
This object allows the server to control Philips Hue lamps. It is possible manage shades of white or all the colours in the spectrum from the configurator.
Clicking on the button on the right of the IP address property or MAC address it is possible to open the Hue Bridge Finder window. In this window, the configurator searches for Hue Bridges connected to the local network and displays them in a list. Every bridge can be ”Authorized” or ”Not Authorized”:
Clicking the ”Select bridge” button the selected bridge is associated to the Hue gateway object.
In the ”Hue Bridge Finder”, under each Authorized bridge node, there is a list of all the lights and groups configured in the Bridge. With a right click on the bridge is possible turn on or turn off all the lights, refresh the properties read from the bridge and create a new group of lights. Selecting a lamp node, in the property grid on the right, the properties configured in the bridge are displayed:
Every Hue lamp node has a child node, which is the lamp status node. By selecting it a list of editable properties will be displayed:
After editing these properties, to save them in the Hue Bridge, click the ”Save Properties” button.
The Configurator allows to create Hue Groups directly from the ”Hue Bridge Finder” window: right click on the Bridge node and select ”Create new lights group” in the menu that appears. This action adds a child node to the Groups node, selecting the group properties will be displayed:
Every Hue group node has a child node, which is the group status node. The properties of the status node are the same of the single Hue lamp but they apply to all the lamps of the group.
All the properties listed in the ”Hue Bridge Finder” window are used to test the Hue Bridge configuration (or edit it) but they don’t represent the real configuration needed by ThinKnx server to control the lights. The real configuration is made by adding a controlled element. Please refer to the chapter below.
Clicking on the right button of the Controlled elements property, a window will be displayed. Click on the ”Add” button, select the added object and adjust its properties:
Commands sent to the object and recallable from other objects:
This server service reads the electrical energy consumption in a specific plant point from KNX group. Basing on thresholds previously set by the installer, the server can disconnect the load for a predetermined time interval or notify the user.
Click on the button displayed on the right to open the loads editor window, click on ”Add” and adjust the properties in the grid:
This object allows to communicate with Modbus devices when Thinknx server is used as a Modbus Master.
A Modbus Master is a device that handles the entire communication with one or more slaves, whilst the Slave is completely passive and just replies to polls/commands from the Master. A Modbus Slave cannot initiate communication, either to the Master or to other Slaves.
Do not confuse the concept of Master-Slave with Client-Server. While Master-Slave is explained from a Modbus perspective, the Client-Server is interpreted from a network perspective when using TCP media. A Modbus Master connecting to a a Modbus Slave is considered a “client” to the slave device which is the “server”.
For each Datapoint created, the below parameters are available:
Commands sent to the object and recallable from other objects:
Send Modbus value with function 5
Send Modbus value with function 6
It allows to communicate with Modbus slave devices when Thinknx server is used as Slave Gateway.
For each datapoint created, the below parameters are available:
Thinknx Server as a Modbus Gateway to Other Systems
Case Study: Modbus Gateway
It allows the bidirectional connection of MyHome BTicino plants to KNX plants. Through easy-to-fit tables it is possible to set matching among the messages coming from the two systems. In order to be able to communicate with MyHome system, a MyHome Ethernet gateway is needed, similar to BT-F454 web server that supports the Open Web Net protocol.
Commands sent to the object and recallable from other objects:
Lights: point to point control ON/OFF
Lights: point to point control DIMMER
Lights: point to point control TIMED
Lights: control for room ON/OFF
Lights: control for room TIMED
Lights: control for group ON/OFF
Lights: control for group DIMMER
Lights: control for group TIMED
Lights: general control ON/OFF
Lights: general control DIMMER
Automation: point to point control
It allows to integrate Z-Wave devices. Without any gateway, the result is a reliable and easy-to-use system with a bidirectional connection between Z-Wave and other standards such as KNX.
For a full list of all the compatible Z-wave devices with Thinknx server, visit our database.
The Z-Wave license is mandatory to control Z-Wave devices. Login to the server web pages, open the Status page and verify that the Z-Wave license is enabled for the server:
Server Z-Wave license
To work, Z-Wave Controller requires the ThinKnx Z-Wave transceiver (USB dongle) provided together with the Z-Wave upgrade (license). After plugging the transceiver to the ThinKnx server, always perform a server soft-restart.
To configure the Z-Wave controller, the Configurator software needs a direct IP connection to the ThinKnx server, for this reason the properties “Password” and “Local IP address” of the System object must be filled with respectively the service user password and the local IP of ThinKnx server. For more details refer to System object.
Entering server info in configurator
To open the Z-Wave Controller window, in the “Z-Wave Controller” object property grid, open the “Nodes” editor. In the window that appears, check the little circle in bottom-left corner of the window: it is an indication of successful connection of Configurator and ThinKnx server, green means connection successful while red means connection failure. In case of red circle, check “Local IP address” and “Password” properties of System object as mentioned above.
Connection status
ThinKnx Z-Wave transceiver offers a factory reset procedure which allows to reset the Z-Wave Controller and thus remove all the nodes associated to the Controller. This procedure just resets the Controller, all the nodes will keep the association and need to be reset separately. To launch the factory reset, right click on the Controller node in the Nodes editor window and select the “Controller factory reset” menu item.
To display the list of Z-Wave nodes associated to the Controller, open the Z-Wave Controller window by clicking on the “Nodes” property editor. In the window that appears, all the Z-Wave nodes stored in the Configurator project will be listed in the treeview under the Controller treenode. Each node icon can be:
Reading nodes from controller
This section described how to include Z-Wave modules using the ThinKnx server. As an example, a NETIChome Dimmer module will be used to show the procedure.
NETIChome Dimmer
Before starting please reset your Z-Wave module to factory settings (usually done by holding reset button for a few seconds)
According to its user manual, the NETIChome Dimmer is reset as shown below:
NETIChome Dimmer reset procedure
First of all, to include the node, the Controller must enable the Inclusion procedure: in the Z-Wave Controller window, right-click on the “Controller” treenode and select “Start node acquisition”. According to the instructions on the screen, start the inclusion procedure also on the Z-Wave module and if the inclusion is successful the message “Completed! New Node included and read” will appear.
Node acquisition
NETIChome Dimmer Module Inclusion procedure
Successful node acquisition
If the inclusion of the node has been successful, the node will be added to the treeview under the Controller node. As a double check of the successful inclusion, right-click on the node and select “Ping node”. If the ping is successful the node has been included properly, otherwise it is possible that the inclusion has not been completed properly. In this case, right-click on the node and select “Remove if failed”, reset the Z-Wave module and try again the inclusion.
To start the exclusion procedure, right-click on the Controller treenode in the Z-Wave Controller window and select “Start node exclusion”. According to the instructions on the screen, start the exclusion procedure also on the Z-Wave module and when the exclusion is completed, the message “Completed!” will appear.
Each Z-Wave module included can have some Parameters to edit its functioning
In the “Device parameter editor” window, depending on the device you are configuring, you will find different parameters that can be adjusted according to your needs.
As an example you can see a couple of parameters defined by NETIChome for their dimmer device:
NETIChome Dimmer Parameters
The association function “associates” two devices, enabling them to communicate directly without the need for controller. On the “Device association editor” window, you can set an association with other Z-Wave devices and define the type of association.
This gateway allows to communicate with the Velux KLF200 interface to control the nodes and groups configured on it, whether directly or through the KNX bus.
The web access credentials and SSID can be found on the back of the Velux unit as seen in the picture below:
Velux Credentials
From your PC, scan for available wifi networks, and connect to the Velux SSID found.
Open the browser and type the following link: http://klf200.velux. Use the credentials on the device to sign in.
Velux Web Access
Open the Interface Mode to scan and add your products.
Interface Mode
Product Search
For more information on how to setup the Velux interface, check out this video posted by Velux Commercial https://youtu.be/kVmqGOMKqoM
After logging into the interface, click on the gear button at the top right, and select “LAN”.
LAN Settings
Fill in your desired IP Address, Subnet mask, Default gateway (that fits to your LAN) or click on “Use DHCP”.
The important thing is to configure the Velux within the same LAN as the Thinknx server to ensure communication between both parties.
Add the Velux interface in System and configure the correct IP address and port to communicate with the Velux interface.
The below properties are available once the object is added:
Velux Gateway
Testing Window
Thinknx integration with iBezel. KNX groups can be associated with iBezel leds and movements.
Click on the button on the right ”iBezel device”. On the device editor click on the ”Add” button and define following properties:
This service allows the server to function as gateway, performing actions based on conditions defined by the installer on KNX groups. For each KNX value three conditions can be applied so that three different actions can be defined.
Click on the button displayed on the right to open the actions editor window, click on ”Add” and adjust the properties in the grid:
This service allows the server to send messages using the external service Skebby. SMS can be used to send notifications, alerts, etc.
Commands sent to the object and recallable from other objects:
This object allows bidirectional connection of Lutron plants to KNX plants. The integration allows to associate KNX groups to Lutron lights, making the devices in the Lutron plant controllable from KNX buttons or supervision.
Lutron Project Tree
It is necessary to select the correct type of the Lutron project prior importing the XML file, otherwise the tree will be shown as empty and the only solution would be to erase the Lutron Project object from System and add it again.
After adding the Lutron object in the System, the user can proceed to create a page in the Interface section and add to it some Switch and/or Shutter objects. For each of those objects, it is possible to select Lutron as “Bus Type” in their corresponding parameters window, and link them to the Lutron Gateway and Lutron Output selected from the imported project tree.
Lutron with switch and shutter
This editor allows to create an action that will be launched whenever an event on Lutron bus is happening. The action can be set to any command from the Generic Commands inside the Thinknx server. For example, when a Lutron light is turned on, it is possible to send a push notification to the clients. For more information regarding the available actions, see our Generic Commands section.
To create a new action, click on “Add”. Each action will have the following properties to configure:
This editor permits to transform a Lutron output/shutter into a virtual KNX output/shutter with all the group addresses provided by a normal KNX actuator. Click on “Add” to create a new virtual output. Each output will have the following properties to configure:
If “Shadegroup” is disabled, the below parameters are visible:
If “Shadegroup” is enabled, the below parameters are visible:
This editor permits to transform a Lutron button into a virtual KNX button with all the group addresses provided by a normal KNX keypad. Click on “Add” to create a new virtual key/button. Each key will have the following properties to configure:
If button function is set to “Dimm up”, “Dimm down” or “Dimm toggle”, the below parameters are visible:
If button function is set to “switch on”, “switch off” or “switch toggle”, the below parameters are visible:
If button function is set to “scene recall” or “scene save”, the below parameters are visible:
This object represents the interface between ThinKnx system and a third-party device connected through serial port. It makes possible to send commands through the serial port to the device.
Commands sent to the object and recallable from other objects:
Send string with no termination
Send string with CR termination
This object is a server service that allows to send HTTP GET/POST/PUT requests and strings on TCP or UDP sockets. The command can be linked to a Generic Command for example or used inside a logic.
In case the Input Mode was configured as TCP/UDP listener, the below parameters are available:
This window permits to configure the request and response parameters to match the external service requirements.
Figure: Data Format Input - Overview
Clicking on Test Environment will open a new window allowing the user to do a Local Test or Live Simulation to check the configuration in the previous window.
Figure: Data Format Input - Local Test
In this example, we are using the Airscope Audio Network Amplifier and controlling it from the Thinknx UP application. The amplifier has an HTTP API that can be found on this link: http://airscope-audio.net/core2/pdf/airscope-module-http.pdf.
Figure: Communicating with Airscope over HTTP
According to section 2.3.1 of the Airscope manual (link above), the device will send the player's full status, including the current volume level, when it receives a GetPlayerStatus HTTP request as follows:
http://[airscope_IP_address]/httpapi.asp?command=getPlayerStatus
The response received from the Airscope device comes in a JSON format, following the example below:
{
“mainmode”: “0”,
“nodetype”: “0”,
“mode”: “3”,
“sw”: “0”,
“status”: “play”,
“curpos”: “12900”,
“totlen”: “229000”,
“Title”: “736865”,
“Artist”: “47726f6f766520436f766572616765”,
“Album”: “xxxxxxxxxx”,
“Year”: “2005”,
“Track”: “7”,
“Genre”: “Dance”,
“locallistflag”: “1”,
“locallistfile”: “”,
“plicount”: “1”,
“plicurr”: “1”,
“vol”: “90”, we need to read this one
“mute”: “0”,
“iuri”: “xxxxxxxxxxxxxxxxxxxxx”,
“uri”: “xxxxxxxxxxxxxxxxxxxxxx”
}
To configure the virtual input inside the Configurator, add the Ethernet Gateway, access the virtual Inputs window, and add a new Virtual Input. Follow the picture below to properly fill the fields requested.
Figure: Volume as Virtual Input
Open the Data Format editor, and make sure you configure the request and response formats as instructed in the amplifier's manual:
Figure: Volume Virtual Input Format
To display the current volume level on the Thinknx UI, you can add an Analog Value with type “Slider” and use it to both display and change the volume level, as seen in the picture below:
Figure: Display Volume on UI
According to section 2.3.9 of the Airscope manual (link above), it is possible to set the volume level on the amplifier by sending the following HTTP request:
http://[airscope_IP_address]/httpapi.asp?command=setPlayerCmd:vol:value where value can be from 0 to 100.
To configure the virtual output inside the Configurator, access the virtual Outputs window inside the Ethernet Gateway, and add a new Virtual Output. Follow the picture below to properly fill the fields requested.
Figure: Volume as Virtual Ouput
Open the Data Format editor, and make sure you configure the request format correctly, by replacing the word “value” in “setPlayerCmd:vol:value” by %VOL, which will correspond to the value sent by the volume slider on the Thinknx UI.
Figure: Volume Virtual Ouput Format
To change the current volume level from the Thinknx UI, you can use the same Slider added in the section above, and link the Slider “Command” parameter to the the volume virtual output created in the Ethernet Gateway.
Figure: change Volume from UI
Commands sent to the object and recallable from other objects:
Make an HTTP GET call to a specified url
Make an HTTP GET call to a specified url with username and password
Make an HTTP POST call to a specified url
Make an HTTP POST call to a specified url with username and password
Make an HTTP PUT call to a specified url
Make an HTTP PUT call to a specified url with username and password
Make an HTTP DELETE call to a specified url
Make an HTTP DELETE call to a specified url with username and password
Send string with no termination to TCP socket
Send string with CR termination to TCP socket
Send hexadecimal string with no termination to TCP socket
Send hexadecimal string with CR termination to TCP socket
Send string with no termination to UDP socket
Send string with CR termination to UDP socket
Send hexadecimal string with no termination to UDP socket
Send hexadecimal string with CR termination to UDP socket
Send hexadecimal string with no termination to UDP socket in multicast
Send hexadecimal string with CR termination to UDP socket in multicast
Serial interface available in the new meters in the Netherlands.
This object allows you to control the house by sending voice commands to your voice enabled device, whether it was via Siri (Apple Homekit), Alexa (Amazon Echo) or Google Assistant. For more information please refer to the Voice Control Gateway section.
This object allows you to connect with IFTTT service to create automated tasks between a wide array of apps, services, and devices. For more information please refer to the IFTTT section.
The Tester object allows to perform some tests (e.g. ping) and send commands to the plant depending on the result of the test.
To open the ”Test Editor”, click on the button next to the property Tests.
Clicking on the ”Add” button, a new test will be added and will appear on the left column.
To delete a test, select it in the left column and then click on the ”Remove” button.
Selecting a test on the left column a list of properties will appear on the right part of the window, which are:
If the “Test type” is set to “Ping Ethernet Device”, “Test TCP Port” or “Test UDP Port” the following properties will appear:
If the “Test type” is set to “Test TCP Port” or “Test UDP Port” the following property will appear:
If the “Test type” is set to “Ping KNX Device” the following property will appear:
This object is different from the Weather Plugin available for the UI. While The Weather Plugin is an Interface object that reads the weather information from www.ilmeteo.it and cannot be customized, the OpenWeatherMap is a System object connected to www.openweathermap.org and provides weather information that can be linked to any customized UI built by the integrator.
This object connects to www.openweathermap.org servers to retrieve weather information. It is enough that the integrator subscribe to the website with a free account, and copy their default API key (or create a new API key).
How To Copy API Key from OpenWeatherMap
Each weather alert created (example: If there is rain within 1 day, block irrigation program), can be configured using the following parameters:
Once the weather object has been configured in the System window, a weather UI should be created using the Generic Commands, Analog Values, and/or Extended Commands. A large list of commands can be linked to these bottoms by simply accessing the Command window. The user has the choice to select the command related to a specific day, for example, “read today's temperature” or “get tomorrow's wind speed”, or configure one dynamic command that can change its status depending on the selected day in the UI.
Normal View
Dynamic View
Click on the button below to download a project template for both options:
This object allows the Thinknx server to function as an MQTT broker. For more information, please visit our detailed guide on MQTT integration.
This object allows the Thinknx server to act as an MQTT client to read or publish information from/to other MQTT clients. For more information, please visit our detailed guide on MQTT integration.
This object allows to interface a video matrix with the system through serial or tcp/ip.
Commands sent to the object and recallable from other objects:
Disconnect input for every output
This object allows to interface a video matrix with the system through serial or TCP/IP.
Commands sent to the object and recallable from other objects:
Set the selected input ot the selected output
Disconnect input for every output
This object is required to interface video projectors using a serial.
Commands that can be recalled from other objects:
This object allows to interface Home Theater plants using serial or tcp/ip.
When using Denon as AVR, it is necessary to disable Power Saving in the receiver's menu to be able to send/read commands. The option is available under “Manual Setup > Network Setup > Other > Power Saving”
Commands that can be recalled from other objects:
Select audio source for selected main source
Select video source for selected main source
Select digital mode for main output
Select surround mode for main output
This object allows to control Sonos devices from server. They are interfaced by LAN network but, since the server function as KNX gateway, Sonos can be controlled also from KNX plates and not only from client applications.
Commands sent to the object and recallable from other objects:
This command allows to play the device.
This command allows to stop the device.
Turns the volume up.
Turns the volume down.
Skips to the next track.
Returns to the previous track.
Configures a specified volume value for the device; the volume value can be defined by adjusting the parameters on the right.
Mutes the device; the bit value for the mute state can be defined by adjusting the related parameter on the right.
Plays audio from any device connected using a jack.
Plays audio files from the internet; the file url can be defined by adjusting the parameter on the right.
Plays audio from a streaming webradio: the streaming url can be defined by adjusting the parameter on the right.
This object represents the ThinKnx multiplayer integration, a customised version of xbmc; it allows to associate a list of commands with interface objects.
Commands sent to the object and recallable from other objects:
Navigate up in the user interface
Navigate down in the user interface
Navigate right in the user interface
Navigate left in the user interface
Select current item in the user interface
Goes back in the user interface
Shows the context menu in the user interface
Shows the information dialogue
Shows the on-screen display for the current player
Starts playback of a single file or an item from the database
Skip the current track and play the next one
Skip the current track and play the previous one
Make a step forward on the current playing element
Make a step backward on the current playing element
This object represents the complete integration of Sonos systems in ThinKnx, it allows to control and receive feedbacks from Sonos players directly through network without creating more traffic on KNX. In this way, all the commands and feedbacks can be available on KNX only if the installer really need them.
This object is currently tested with Sonos S1 system. For more information on S2, contact our support team.
Click on the button displayed on the right of the Players property to open the players editor window. By clicking on ”Add” button, the Configurator will automatically start to search for Sonos Player in the local network and it will display them in a list. If the player to add is in the list, select it and click on ”Add Player” to add it to the Players list. Otherwise, if the player isn’t in the list, click ”Search” to restart the automatic research or click on ”Create Player” to add to the list an empty Player object. For each player it is possible to edit the following properties:
The Configurator allows to define groupings (called Topologies) among Sonos Players and to recall them directly from KNX. To create a topology, click on the button displayed on the right of the Topologies property to open the topologies editor window, click on ”Add” and adjust the properties in the grid:
Commands sent to the Sonos Player and recallable from other objects:
Play the audio from Audio IN plug
Play the audio from another player Audio IN plug
Play the audio from a network file
Play the audio from a streaming
Enable/Disable Repeat PlayMode
Enable/Disable Shuffle PlayMode
Start a Playlist from its number
Commands sent to the Sonos Topology and recallable from other objects:
Creates the grouping of players as specified in the Sonos Topology properties.
This object allows to control an IR Transmitter device integrated into the LAN network. It can be interfaced with Ethernet, Ethernet PoE and Controller LAN devices.
Click on the button displayed on the right to open the actions editor window, click on ”Add” and adjust the properties in the grid:
It is important to have the remotes files saved into the remote directory selected previously.
This feature allows to export a list of IR commands previously created in a project and import it in another project.
To export the commands list, open the commands editor window by clicking on the button displayed on the right of the ”IR commands” property. Click on the ”Export” button and choose the path of the xml file that will be created, in this way the list of IR commands will be saved outside the Configurator.
To import the commands list in a project, open the commands editor window by clicking on the button displayed on the right of the ”IR commands” property. Click on the ”Import” button and select the xml file previously saved and click on OK button to confirm. A list of commands will appear in the editor window.
During the import process, if the ”Remotes directory” property of the ”IR transmitter” object isn’t set, the commands will be added to the list with the prefix ”***” in the name and only the command alias will be set.
Commands sent to the object and recallable from other objects: