Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
system_objs [2019/04/25 21:04] – wikiadmin | system_objs [2024/03/16 09:42] (current) – Added hint for multiple IP interfaces wikiadmin | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== System Objects ====== | ====== System Objects ====== | ||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | * [[#System| System]] | ||
+ | * [[#ets| ETS]] | ||
+ | *[[# | ||
+ | * [[# | ||
+ | * [[#scene| Scene]] | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[#RGB| RGB]] | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[#web_ui| Web UI]] | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[#Logic| Logic]] | ||
+ | * [[# | ||
+ | * [[#filter| Filter]] | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | </ | ||
+ | <WRAP column half> | ||
- | ===== System | + | * [[# |
+ | * [[#Report| Report]] | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[#Lutron| Lutron Project]] | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[#tester| Tester]] | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | |||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[#display| Display]] | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | </ | ||
+ | </ | ||
+ | ====== System | ||
{{ : | {{ : | ||
Line 19: | Line 90: | ||
* **Server client port** Number of the TCP port needed to remotely connect with the server (outside the server network). The default port is 7550. | * **Server client port** Number of the TCP port needed to remotely connect with the server (outside the server network). The default port is 7550. | ||
* **Local IP address** IP address (for example 192.168.X.X) needed to connect with the server from clients that operate in the server LAN. | * **Local IP address** IP address (for example 192.168.X.X) needed to connect with the server from clients that operate in the server LAN. | ||
+ | * **KNXNet/IP interface** if enabled, the Thinknx server can be used as a KNXNet/IP interface, allowing KNX programming from the ETS software for example. More information are available on the [[knxnet_ip| KNXnet/IP]] guide. | ||
+ | * **KNXNet/IP different IP** if enabled, permits to choose a different KNXNet/IP interface to connect and access the KNX bus. | ||
+ | * **Clients Ph. Address Base** base physical address for the clients connections. | ||
+ | * **Client number** number of supported client tunnel connections. | ||
+ | * **KNXNet/IP router** If enabled, the server will also route traffic from TP to multicast IP and vice versa, allowing to connect different parts of a KNX system together over IP. More information are available on the [[knxnet_ip| KNXnet/IP]] guide. | ||
* **System name** Name to identify the project once it has been uploaded to the server. | * **System name** Name to identify the project once it has been uploaded to the server. | ||
* **Location** Name of the location where the system is installed. | * **Location** Name of the location where the system is installed. | ||
Line 29: | Line 105: | ||
*Time Group: KNX time group address to receive or send time information. | *Time Group: KNX time group address to receive or send time information. | ||
*Date group: KNX date group address to receive or send date information. | *Date group: KNX date group address to receive or send date information. | ||
- | * **Licenses** Active licences for the current project, for more details refer to [[main_cons_ui# | + | * **Licenses** Active licences for the current project, for more details refer to [[main_cons_ui# |
- | * **Users and Groups** Groups and users for the customized exporting process, for more details refer to [[main_cons_ui# | + | * **Users and Groups** Groups and users for the customized exporting process, for more details refer to [[main_cons_ui# |
- | * **Protection PINs** List of PINs used to protect interface objects, for more details refer to [[main_cons_ui# | + | * **Protection PINs** List of PINs used to protect interface objects, for more details refer to [[main_cons_ui# |
- | ==== Object commands ==== | + | |
+ | ==== Object Commands ==== | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
+ | ++++Send KNX Bit telegram| | ||
+ | * **KNX Group** Group address to sen the value. | ||
+ | * **KNX value** Can be either 1 or 0. | ||
- | == Send KNX Bit telegram: == | + | ++++ |
+ | ++++Send KNX Byte Telegram| | ||
+ | * **KNX Group** Group address to send the value. | ||
+ | * **KNX value** Can be a value between 0-255. | ||
+ | A generic button can be configured to send a fixed dimming value to a dimming circuit, for example sending the value 128 to make the light go to 50%. | ||
+ | ++++ | ||
+ | ++++Send KNX Float 2 Byte Telegram| | ||
+ | * **KNX Group** Group address to send the value. | ||
+ | * **KNX value** Can be a value between -671088,64 and 670760, | ||
+ | A generic button can be configured to send a fixed temperature value to a thermostat, for example sending the value 21.5 as a setpoint. | ||
+ | ++++ | ||
+ | ++++Send KNX Float 4 Byte Telegram| | ||
+ | * **KNX Group** Group address to send the value. | ||
+ | * **KNX value** | ||
+ | ++++ | ||
+ | ++++Send KNX String Telegram| | ||
+ | * **KNX Group** Group address to send the value. | ||
+ | * **KNX value** string text to be entered. | ||
+ | ++++ | ||
+ | ++++Send KNX 4 Bit Telegram| | ||
+ | * **KNX Group** Group address to send the value. | ||
+ | * **KNX value** Can be a value between 0 and 15. | ||
+ | A generic button can be configured to decrease (value 0-7) or increase ( value 8-15) a light dimming value. It can also be used to change a shutter position (use values 0-7 for UP, and 8-15 for DOWN). For example, sending the value 5 to a dimmer will decrease the brightness by 6%, while sending the value 10 to a shutter will lower its position by 50%. | ||
+ | ++++ | ||
+ | ++++Read KNX group address| | ||
+ | * **KNX Group** Group address to read the value from. | ||
+ | ++++ | ||
+ | ++++Make a pause for a fixed interval| | ||
+ | * **Interval** Time interval in milliseconds. | ||
+ | When saving a scene, sometimes a pause between two commands is necessary, for example, when saving the TV channel number. Another use of the Pause application would be before turning off the final light in a Goodbye scene, making sure that the client has left the house. | ||
+ | ++++ | ||
+ | ++++Change UI Function and Page: GENERAL| This command allows to redirect **all clients** to a specific function and page. | ||
+ | * **Function** insert the Index number of the destination function. | ||
+ | * **Page** insert the Index number of the destination page. | ||
+ | Using the Universal Gateway, a scenario can be configured to redirect the users to the Main Entrance camera page whenever the doorbell rings. | ||
+ | ++++ | ||
+ | ++++Change UI Function and Page: SPECIFIC CLIENT| This command allows the **specific client** who has sent it to access a certain function and page. | ||
+ | * **Function** insert the Index number of the destination function. | ||
+ | * **Page** insert the Index number of the destination page. | ||
+ | Invisible generic buttons can be placed on the house plan for each room, allowing every single client to navigate through the rooms by clicking on each area. | ||
+ | ++++ | ||
+ | ++++Send Push Notification| This command allows to send push notifications to the clients. By accessing the web page of the server and clicking on Server --> Licenses and Codes, it is possible to enable/ | ||
+ | * **Message** insert the message to be displayed on the clients. | ||
+ | * **Maximum number of push notifications with the same identifier allowed in 10 min** This parameter is not mandatory. However, if a value has been entered, the system will make sure to limit the number of push notifications sent to this number in 10 min. It is quite useful when the trigger for sending the push notifications is being sent frequently on the bus. | ||
+ | * **Push Notification Identifier** A small descriptive text to allow the system to differentiate a push notification from another one when calculating the rate limit. Mandatory only if the previous parameter has been used. | ||
+ | Using the Universal Gateway, a push notification can be sent to the client when a 1-bit value is received from the bus to indicate that the Water Tank Level is low. The message in that case can be "Low Water Level!" | ||
+ | <WRAP important round center 60%>Push notifications only work with internet connectivity. In addition, the server and client should both have the same version of Thinknx software (both Classic or Thinknx UP).</ | ||
+ | ++++ | ||
+ | ++++Execute MS Windows Command: GENERAL| This command allows to launch an .exe file directly from the ThinKnx application on all Players for Windows. | ||
+ | * **Command** | ||
+ | * **Parameter** | ||
+ | ++++ | ||
+ | ++++Execute MS Windows Command: SPECIFIC CLIENT| This command allows to launch an .exe file directly from the ThinKnx application on all Players for Windows. | ||
+ | * **Command** | ||
+ | * **Parameter** | ||
+ | ++++ | ||
+ | ++++Recall iOS app with url| This property allows to launch a specific application on iOS devices directly from the ThinKnx app by typing the related URL.\\ | ||
+ | * **URL used to recall iOS app** Type in the correct URL to open the desired installed application, | ||
+ | A generic button can be configured for the client to open another application on the iOS device. | ||
+ | ++++ | ||
+ | ++++Send Email to recipients| This command allows to send an email message using a default ThinKnx account. | ||
+ | * **Email Subject** Enter the email title here. | ||
+ | * **Email Recipients** Enter destination email accounts. | ||
+ | * **Email Content** Enter the email content here. | ||
+ | If the client' | ||
- | This command | + | <wrap important>// |
+ | ++++ | ||
+ | ++++Send DTMF tone during intercom call| This command allows to send a DTMF tone used in telephony while an intercom call is running on the client. | ||
+ | * **DTMF tones sequence** enter the sequence of numbers to send during the intercom call. Sometimes it is necessary to end the sequence with the symbol "#", | ||
+ | A generic button can be configured in the Intercom page to send a DTMF tone to open the main gate whenever a call is established. | ||
+ | ++++ | ||
+ | ++++Make SIP call| When using the Thinknx server as PBX, it is possible to make internal calls between all the devices. | ||
+ | * **Extension to call** Enter the extension of the destination device. | ||
+ | A house owner can have a generic button on his application to call the extension of the touch screen installed in Kitchen to communication with the help. | ||
+ | ++++ | ||
+ | ++++Start audio notification sound in all the clients| This command allows to play an audio sound in all the clients. | ||
+ | * **Sound to play** Choose between different beeps to play: 0=Beep_1, 1=Beep_2, 2=Alarm_1, 3==Alarm_2, 4=Siren_1, 5=Siren_2. | ||
+ | * **Duration of the sound to play** Specify the duration of the sound to play in seconds. If 0 is entered, the sound will play endlessly until a Stop command has been sent. | ||
+ | An emergency push button can be installed in bathrooms to send a KNX 1-bit value. Using the Universal Gateway, this value received can launch the command to start audio notification | ||
+ | ++++ | ||
+ | ++++Stop audio notification sound in all clients| This command allows to stop the audio sound previously launched in all clients. | ||
+ | \\ See above command for example. | ||
+ | ++++ | ||
- | == Send KNX Byte Telegram: | + | ====== ETS ====== |
+ | ===== ETS project ===== | ||
- | Send a byte value; adjust the ”KNX group” and ”KNX value” (from 0 to 255) parameters. | + | {{ : |
- | == Send KNX Float 2 Byte Telegram: == | + | 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: |
+ | * **Label** Object name. | ||
+ | * **CSV file** This property specifies the .csv file containing the project. | ||
+ | * **Automatic encoding** if enabled, the system to try to recognize the used encoding for the selected file. In some cases, the encoding is not correctly detected, and it is better to force the encoding manually, bi disabling the " | ||
+ | * **Secondary Interfaces** If enabled, it allows the server to connect and communicate with multiple KNX IP interfaces. The server will manage the traffic from each interface using a direct 1:1 KNXnet/IP communication. The same group address can be used with multiple interfaces and can control completely different objects. It is enough to link the Thinknx switch with the group address, followed by " | ||
+ | * **Name**: Interface label. | ||
+ | * **Interface Number** specified by the user. It must be an integer value between 1 and 254. | ||
+ | * **Interface IP Address** IP address of the secondary interface. | ||
+ | * **IP Port** IP port to communicate with the secondary interface. | ||
+ | * **ETS File** The file containing the group addresses of the secondary interface. Both .csv and .esf formats are supported. | ||
- | Send a float 2 byte value; adjust | + | <WRAP round center 80% tip> |
- | == Send KNX Float 4 Byte Telegram: == | + | {{ : |
+ | <WRAP center 60%> <WRAP centeralign> | ||
- | Send a float 4 byte value; adjust the ”KNX group” and ”KNX value” parameters. | ||
- | |||
- | == Send KNX String Telegram: == | ||
- | |||
- | Send a string 14 byte value; adjust the ”KNX group” and ”KNX value” parameters. | ||
- | |||
- | == Make a pause for a fixed interval == | ||
- | |||
- | Pause the system for a specified time interval configurable by adjusting the ”Interval” parameter. | ||
- | |||
- | == Change UI Function and Page: GENERAL == | ||
- | |||
- | This command allows to configure a specific project page that will be recalled on all clients; adjust the ”Function” and ”Page” parameters. | ||
- | |||
- | == Change UI Function and Page: SPECIFIC CLIENT == | ||
- | |||
- | This command allows to configure a specific project page that will be recalled on a specific client; adjust the ”Function” and ”Page” parameters. | ||
- | |||
- | == Send Push Notification == | ||
- | |||
- | This command allows to send push notifications on the desired client; adjust the ”Message” parameter to define the notification content. | ||
- | |||
- | == Execute MS Windows Command: GENERAL == | ||
- | |||
- | This command allows to launch an .exe file directly from the ThinKnx application on all Players for Windows; adjust the ”Command” parameter. | ||
- | |||
- | == Execute MS Windows Command: SPECIFIC CLIENT == | ||
- | |||
- | This command allows to launch an .exe file directly from the ThinKnx application on a specific Player for Windows; adjust the ”Command”. | ||
- | |||
- | == Recall iOS app with url == | ||
- | |||
- | This property allows to launch a specific app on iOS devices directly from the ThinKnx app by typing the related url in the ”URL used to recall iOS app” parameter (f.e. http%%// | ||
- | |||
- | == Send Email to recipients == | ||
- | |||
- | This command allows to send an email message using a default ThinKnx account; define the email subject, content and recipients by adjusting the parameters on the right. | ||
- | |||
- | == Send DTMF tone during intercom call == | ||
- | |||
- | This command allows to send a DTMF tone or a sequence of tones while an intercom call is running on the client. | ||
- | |||
- | ===== ETS project ===== | ||
- | |||
- | {{ : | ||
- | |||
- | This object contains all KNX groups configured in the ETS software. It simplifies visualisation and selection of these groups within the Configurator thanks to a tree displaying. Following properties are displayed in the grid below: | ||
- | |||
- | * **CSV file** This property specifies the .csv file containing the project. | ||
- | * **Label** Object name. | ||
+ | | ||
+ | {{ : | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
==== Exporting .csv from ETS ==== | ==== Exporting .csv from ETS ==== | ||
Line 106: | Line 230: | ||
{{ : | {{ : | ||
- | <WRAP center 60%> <WRAP centeralign> | + | <WRAP center 60%> <WRAP centeralign> |
Line 114: | Line 238: | ||
From the ETS application, | From the ETS application, | ||
+ | |||
+ | |||
+ | |||
+ | ====== Internal Services ====== | ||
===== Scene ===== | ===== Scene ===== | ||
Line 119: | Line 247: | ||
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 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 [[inter_objs# | ||
* **KNX group** KNX group address used to recall the scene. | * **KNX group** KNX group address used to recall the scene. | ||
Line 125: | Line 255: | ||
* **Restartable** If enabled, the selected scene can be restarted if launched when already running; it is useful when the scenes is full of pauses and it is particularly long-lasting; | * **Restartable** If enabled, the selected scene can be restarted if launched when already running; it is useful when the scenes is full of pauses and it is particularly long-lasting; | ||
* **List of actions** By clicking on the button displayed on the right, the action editor will be displayed; the user can add the desired number of action by clicking on ”Add” button. Each action can be given a name and the related command can be selected by clicking on the button displayed on the right side of the dedicated slot. | * **List of actions** By clicking on the button displayed on the right, the action editor will be displayed; the user can add the desired number of action by clicking on ”Add” button. Each action can be given a name and the related command can be selected by clicking on the button displayed on the right side of the dedicated slot. | ||
+ | |||
+ | <WRAP round center 80% tip> Scenes saved by the user from the ThinKnx application are not lost after a project upload to the server. </ | ||
==== Object commands ==== | ==== Object commands ==== | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
+ | ++++Launch scenery| | ||
+ | ++++ | ||
+ | ++++Sop scenery execution| | ||
+ | ++++ | ||
- | == Launch scenery == | ||
- | |||
- | Launches the selected scene. | ||
- | |||
- | == Stop scenery execution == | ||
- | |||
- | Stops the selected scene. | ||
- | |||
- | ===== Calendar ===== | ||
- | |||
- | {{ : | ||
- | |||
- | This server service allows the user to program on/off KNX commands (switch objects) using client applications; | ||
- | |||
- | * **Force state** If this property is enabled, the server periodically sends value ”1” to the selected KNX group, basing on the pre-set timespan; the light automatically turns on if it has been manually switched off by the user. If enabled, the ”Send interval” property will be displayed: | ||
- | * [//Send interval//] Interval between two repeated messages | ||
===== HVAC Controller ===== | ===== HVAC Controller ===== | ||
Line 154: | Line 274: | ||
* **Controller type** Selection among three possible models: | * **Controller type** Selection among three possible models: | ||
- | * // | + | * //**Mitsubishi AG 150:**// This controller permits |
- | * //KNX interface simple:// This controller allows to set mode and speed using standard 1 byte objects. | + | * //**KNX interface simple:**// This controller allows to set mode and speed using standard 1 byte objects. |
- | * //KNX interface extended:// This controller allows to set mode and speed using 1 bit objects.\\ | + | * //**KNX interface extended:**// This controller allows to set mode and speed using 1 bit objects.\\ |
+ | * // | ||
- | If Controller type is ”Mitsubishi AG 150” the following | + | Select the ”Devices” property |
- | * **IP address** HVAC controller | + | |
+ | ==== CoolMaster Net ==== | ||
+ | |||
+ | 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. | ||
+ | |||
+ | <WRAP important center round 60%> This device | ||
+ | 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:\\ | ||
+ | * **IP address** HVAC Controller | ||
+ | * **Port number** TCP/IP port for Ethernet connection. For example, 10102. | ||
* **Devices** List of HVAC devices linked to the system. | * **Devices** List of HVAC devices linked to the system. | ||
- | ==== Adding a HVAC device | + | These are the properties for the single |
+ | * // | ||
+ | * // | ||
+ | * //**KNX On/Off command group**// 1-bit group to switch the device on/off from KNX | ||
+ | * //**KNX On/Off feedback group**// 1-bit group to receive feedback regarding on/off status of the device | ||
+ | * //**KNX Fan command group:**// 1-byte group to switch device fan speed from KNX. | ||
+ | * //**KNX Fan feedback group:**// 1-byte group to receive feedback regarding fan speed status of the device | ||
+ | * //**KNX Temperature setpoint command group**// 2-byte DPT9 group to set the setpoint temperature for the device from KNX | ||
+ | * //**KNX Temperature setpoint feedback group**// 2-byte DPT9 group to receive feedback regarding actual setpoint from the device. | ||
+ | * //**KNX Mode command group:**// 1-byte group to switch device modality from KNX. | ||
+ | * //**KNX Mode feedback group:**// 1-byte group to receive feedback regarding modality of the device. | ||
+ | * //**Actual temperature from internal unit KNX group**// 2-byte DPT9 group to receive actual temperature read from the device (only available if supported by the device) | ||
+ | * //**Value fan min:**// value for minimum fan speed. It will be sent to fan command group to set speed and, if received in fan feedback group, minimum speed will be recognized (1-byte value). | ||
+ | * //**value fan middle:**// value for middle fan speed. It will be sent to fan command group to set speed and, if received in fan feedback group, middle speed will be recognized (1-byte value). | ||
+ | * //**value fan max:**// value for maximum fan speed. It will be sent to fan command group to set speed and, if received in fan feedback group, maximum speed will be recognized (1-byte value). | ||
+ | * //**Value Cool Mode:**// value that corresponds to Cool Modality for mode group (1-byte). | ||
+ | * //**Value Heat Mode:**// value that corresponds to Heat Modality for mode group (1-byte). | ||
+ | * //**Value Dry Mode:**// value that corresponds to Dry Modality for mode group (1-byte). | ||
+ | * //**Value Fan Mode:**// value that corresponds to Fan Modality for mode group (1-byte). | ||
+ | * //**Enable regulator: | ||
- | 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. | ||
==== Mitsubishi device ==== | ==== Mitsubishi device ==== | ||
+ | <WRAP important center round 60%> This device requires the Automation License. </ | ||
+ | If Controller type is ”// | ||
+ | * **IP address** HVAC controller IP address.\\ | ||
+ | |||
+ | These are the properties for the single device: | ||
* **Name** Device name. | * **Name** Device name. | ||
* **Device index** Index associated to the device inside the controller. | * **Device index** Index associated to the device inside the controller. | ||
Line 260: | Line 416: | ||
* **Force state** If this property is enabled, the server periodically sends value ”1” to the selected KNX group, basing on the pre-set timespan; the light automatically turns on if it has been manually switched off by the user. If enabled, the ”Send interval” property will be displayed: | * **Force state** If this property is enabled, the server periodically sends value ”1” to the selected KNX group, basing on the pre-set timespan; the light automatically turns on if it has been manually switched off by the user. If enabled, the ”Send interval” property will be displayed: | ||
* //Send interval//: Interval between two repeated messages | * //Send interval//: Interval between two repeated messages | ||
+ | |||
+ | ===== Calendar (obsolete) ===== | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | This server service allows the user to program on/off KNX commands (switch objects) using client applications; | ||
+ | |||
+ | * **Force state** If this property is enabled, the server periodically sends value ”1” to the selected KNX group, basing on the pre-set timespan; the light automatically turns on if it has been manually switched off by the user. If enabled, the ”Send interval” property will be displayed: | ||
+ | * [//Send interval//] Interval between two repeated messages | ||
+ | |||
+ | |||
+ | ===== Voip PBX and Doorcom ===== | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | 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, | ||
===== Chronotermostat ===== | ===== Chronotermostat ===== | ||
Line 280: | Line 452: | ||
* **Mode feedback group** KNX group (1 bit DPT1) used to send the running chrono modality where 1=chrono and 0=manual. | * **Mode feedback group** KNX group (1 bit DPT1) used to send the running chrono modality where 1=chrono and 0=manual. | ||
- | + | ==== Object commands | |
- | ===== Voip PBX & Doorcom ===== | + | Commands sent to the object and recallable from other objects: |
- | + | ++++Enable/ | |
- | {{ :system_obj_-_voip.png? | + | * **Enable/ |
- | + | ++++ | |
- | Every Thinknx server embeds a software VOIP telephony PBX. It is optimized for the VOIP functionalities between clients and door communication. | + | |
===== Irrigation ===== | ===== Irrigation ===== | ||
Line 312: | Line 482: | ||
* **KNX feedback group** KNX group address used to detect the status of the zone (DPT1 - 1 = irrigating, 0 = pause). | * **KNX feedback group** KNX group address used to detect the status of the zone (DPT1 - 1 = irrigating, 0 = pause). | ||
+ | ==== Object commands ==== | ||
+ | Commands sent to the object and recallable from other objects: | ||
+ | ++++Enable/ | ||
+ | ++++ | ||
===== RGB ===== | ===== RGB ===== | ||
Line 330: | Line 504: | ||
* RGB group: KNX group address to control RGB (3 bytes) | * RGB group: KNX group address to control RGB (3 bytes) | ||
* RGB fb group: KNX group address with feedback for RGB (3 bytes) | * RGB fb group: KNX group address with feedback for RGB (3 bytes) | ||
+ | When the "RGB Data Type" is set to "RGBW 1 byte per color", | ||
+ | * Red group: Red color command KNX group address (1byte). | ||
+ | * Red fb group: Red color feedback KNX group address (1byte). | ||
+ | * Green group: Green color command KNX group address (1byte). | ||
+ | * Green fb group: Green color feedback KNX group address (1byte). | ||
+ | * Blue group: Blue color command KNX group address (1byte). | ||
+ | * Blue fb group: Blue color feedback KNX group address (1byte). | ||
+ | * White group: White color command KNX group address (1byte). | ||
+ | * White fb group: White color feedback KNX group address (1byte).\\ | ||
+ | When the "RGB Data Type" is set to "RGBW 6 bytes", | ||
+ | * Color group: KNX group address to control RGB (6 bytes) | ||
+ | * Color fb group: KNX group address with feedback for RGB (6 bytes).\\ \\ | ||
+ | | ||
+ | * **Switch feedback** if enabled, it is possible to send a 1 bit command (DPT1) to a KNX group linked to a an actuator' | ||
==== Modbus configuration ==== | ==== Modbus configuration ==== | ||
Line 348: | Line 536: | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
- | == Start RGB sequence shuffle with time in seconds | + | ++++Start RGB sequence shuffle with time in seconds| This command allows to play a sequence of all the favorite colors in a shuffle mode, while defining the time to switch from one color to another. |
+ | * **Time** interval before switching to a new color, in seconds | ||
+ | ++++ | ||
- | Starts the preconfigured colour | + | ++++Start RGB sequence |
+ | * **Time** interval before switching to a new color, in seconds | ||
+ | ++++ | ||
- | == Start RGB sequence | + | ++++Stop |
+ | ++++ | ||
- | Repeats | + | ++++Save |
+ | * **Preset position** number of the slot where the color should be saved (value | ||
+ | ++++ | ||
- | == Stop the RGB sequence and turn off == | + | ++++Recall the color previously saved to the selected preset position| |
- | + | * **Preset position** number | |
- | Stops the repetition | + | ++++ |
===== Email account ===== | ===== Email account ===== | ||
Line 367: | Line 562: | ||
* **SMTP server** Default server hostname of the desired e-mail service. For Gmail the server is " | * **SMTP server** Default server hostname of the desired e-mail service. For Gmail the server is " | ||
- | * **Server port** Default server listening port. This port is usually 25 for not encrypted connection | + | * **Server port** Default server listening port. This port is usually 25 for not encrypted connection. For Gmail, use port 465 for SSL and 587 for TLS. |
* **From** E-mail address specified in the sender field; if this property is empty in the e-mail will appear noreply@thinknx.com in the from field. For Gmail account and for many other this field must be filled with the proper sender email address (" | * **From** E-mail address specified in the sender field; if this property is empty in the e-mail will appear noreply@thinknx.com in the from field. For Gmail account and for many other this field must be filled with the proper sender email address (" | ||
- | * **Authentication** Enable or disable SMTP user authentication by means of username and password.\\ If the property ”Authentication” is set to ”Enable”, | + | * **Authentication** Enable or disable SMTP user authentication by means of username and password. It is necessary to enable it when using Gmail server. \\ If the property ”Authentication” is set to ”Enable”, |
* Username: E-mail address used as username of the e-mail account or any other authentication string. For Gmail it must be the email address (" | * Username: E-mail address used as username of the e-mail account or any other authentication string. For Gmail it must be the email address (" | ||
* Password: Password of the e-mail account. | * Password: Password of the e-mail account. | ||
- | * **Use SSL** If enabled, use SSL encription | + | * **Use SSL** If enabled, use encryption |
+ | |||
+ | As an example when using Google to send emails from Thinknx Server, it is recommended that you enable the " | ||
+ | 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" | ||
+ | <WRAP centeralign> | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | <WRAP centeralign> | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | |||
+ | The same concept applies when trying to send emails from the iCloud address, where it is necessary to generate an " | ||
+ | |||
+ | |||
+ | After configuring the Email Account in System, you can now send emails through a generic button or using the Report object as well. | ||
+ | * When using the Generic Command button, select Internal Services --> Email Account --> Your Email Account object --> Send email to recipients and fill the parameters as desired. | ||
+ | * When using the Report object, select Report from System tab, and disable the Default SMTP in the parameters. Then select your Email Account from the dropdown list instead. | ||
+ | |||
+ | If the emails are not sent using the configuration made, some possible causes could be: | ||
+ | |||
+ | * The STARTTLS is not supported by the mail server. | ||
+ | * The domain is not supported by the mail server. | ||
+ | * The server cannot establish encrypted connection because of time/date issue or certificates problems. | ||
+ | * The authentication is not valid (password/ | ||
- | Please note that when Gmail is used with Pop3 apps like Thinknx Server, it is required to enable "Allow less secure apps" from within your Gmail account. | ||
- | Here's how to find this Gmail security option: | ||
- | * Open your web browser, e.g., Internet Explorer, Safari, Mozilla Firefox, Google Chrome, Opera, etc. | ||
- | * Go to the www.gmail.com web site. | ||
- | * Sign into your account. | ||
- | * At the top right, click the colorful circle containing a capital letter (usually the first letter of your first name). | ||
- | * In the menu that appears, click "My Account." | ||
- | * A new browser tab or window will open. | ||
- | * Under " | ||
- | * Scroll down and look at the "Allow less secure apps" option on the right. Turn the option " | ||
==== Object commands ==== | ==== Object commands ==== | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
+ | ++++Send Email to recipients| | ||
+ | * **Email subject** | ||
+ | * **Email recipients** separate the emails using " ; ". | ||
+ | * **Email content** body of the email. | ||
+ | ++++ | ||
+ | |||
+ | ===== Thinknx Sensors ===== | ||
+ | This object allows to configure Thinknx sensors (temperature, | ||
+ | |||
+ | * **Label** Text to identify the object. | ||
+ | * **Thinknx devices** List of Thinknx devices used for reading sensors values. | ||
+ | |||
+ | For each I/O added, the below parameters are available: | ||
+ | * **Name** Label that identify the sensor or the device | ||
+ | * **Serial number** Serial number of the device to retrieve sensors values. | ||
+ | * **Input/ | ||
+ | * Analog Input | ||
+ | * Digital Input | ||
+ | * Digital Output | ||
+ | * Environment Ambient Sensors | ||
+ | * Relay Output | ||
+ | * Temperature Probe | ||
+ | * **KNX Gateway** If enabled, permits to send the sensors values to the KNX bus, or control the I/Os. | ||
+ | |||
+ | If **Analog Input** is selected, the below parameters are available: | ||
+ | * **Input Number** number of the input on the server. For more information, | ||
+ | * **Conversion Factor** the raw value will be multiplied by this factor to convert it into the right measurement. | ||
+ | |||
+ | If **Digital Input** is selected, the below parameter is available: | ||
+ | * **Input Number** number of the input on the server. For more information, | ||
+ | |||
+ | If **Digital Output** is selected, the below parameters are available: | ||
+ | * **Output Number** number of the output on the server. For more information, | ||
+ | * **Output Type** select the output type between monostable and bistable. | ||
+ | * **Time Base** Time base used to calculate the total ON time for the output. | ||
+ | * **Time Factor** Time factor that will be multiplied by the time base to calculate the total ON time of the output. | ||
+ | |||
+ | If **Environment Ambient Sensors** is selected, the below parameters are available: | ||
+ | * **KNX Gateway** if enabled, it will allow to assign group addresses for Temperature, | ||
+ | |||
+ | If **Relay Output** is selected, the below parameters are available: | ||
+ | * **Output Number** number of the output on the server. For more information, | ||
+ | * **Output Type** | ||
+ | |||
+ | If **Temperature Probe** is selected, the below parameters are available: | ||
+ | * **Input Number** number of the output on the server. For more information, | ||
+ | * **Probe Type** | ||
+ | * **Correction Offset** value that will be added to the raw value before multiplying it with the conversion factor and obtaining the right measurement. | ||
+ | |||
+ | ==== Object commands ==== | ||
- | == Send Email to recipients == | + | Commands recallable from other objects: |
+ | ++++Get the actual humidity| | ||
+ | ++++ | ||
+ | ++++Get the actual luminosity| | ||
+ | ++++ | ||
+ | ++++Get the actual temperature| | ||
+ | ++++ | ||
- | Allows to send an email message using a customisable personal account; define the email subject, content and recipients by adjusting the parameters on the right. | ||
- | * Subject of the mail message that will be sent to the specified recipients | ||
- | * Recipients email addresses, separeted by ; | ||
- | * Text content of the mail message. | ||
===== Web UI ===== | ===== Web UI ===== | ||
Line 444: | Line 702: | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
+ | ++++Start the presence simulation| | ||
+ | ++++ | ||
+ | ++++Stop the presence simulation| | ||
+ | ++++ | ||
- | == Start the presence simulator == | ||
- | |||
- | Starts the presence simulator sequence of actions. | ||
- | |||
- | == Stop the presence simulator == | ||
- | |||
- | Ends the presence simulator sequence of actions. | ||
===== Sun times and events ===== | ===== Sun times and events ===== | ||
Line 484: | Line 739: | ||
* **Command** Command performed by the server when the sun event occurs. | * **Command** Command performed by the server when the sun event occurs. | ||
+ | ====== Security ====== | ||
===== Alarm device ===== | ===== Alarm device ===== | ||
Line 492: | Line 747: | ||
+ | |||
+ | ===== Access Control ===== | ||
+ | The Thinknx Access Control object permits to enhance the level of automation and security of the home/ | ||
+ | For more information, | ||
+ | |||
+ | ====== Logic ====== | ||
===== Combination ===== | ===== Combination ===== | ||
Line 570: | Line 831: | ||
* //’On result change’:// | * //’On result change’:// | ||
* //’When a new input telegram is received’:// | * //’When a new input telegram is received’:// | ||
- | * **Gate** This property enables or disables the operation. See [[system_objs# | + | * **Gate** This property enables or disables the operation. See [[system_objs# |
===== Multiplexer ===== | ===== Multiplexer ===== | ||
Line 596: | Line 857: | ||
* //’0 until first telegram’:// | * //’0 until first telegram’:// | ||
* //’1 until first telegram’:// | * //’1 until first telegram’:// | ||
- | * **Gate** This property enables or disables the operation. See [[system_objs# | + | * **Gate** This property enables or disables the operation. See [[system_objs# |
===== Logic Matrix ===== | ===== Logic Matrix ===== | ||
Line 613: | Line 874: | ||
* **Update for every input control tel.** If enabled, outputs will be updated for every received telegram to the input control (selection) group. If disabled, outputs will be refreshed only when a new telegram on the selected input is received or (if enabled) when a telegram on the output control group is received. | * **Update for every input control tel.** If enabled, outputs will be updated for every received telegram to the input control (selection) group. If disabled, outputs will be refreshed only when a new telegram on the selected input is received or (if enabled) when a telegram on the output control group is received. | ||
* **Update for every output control tel.** If enabled, outputs will be updated for every received telegram to the output control (selection) group. If disabled, outputs will be refreshed only when a new telegram on the selected input is received or (if enabled) when a telegram on the input control group is received. | * **Update for every output control tel.** If enabled, outputs will be updated for every received telegram to the output control (selection) group. If disabled, outputs will be refreshed only when a new telegram on the selected input is received or (if enabled) when a telegram on the input control group is received. | ||
- | * **Gate** This property enables or disables the operation. See [[system_objs# | + | * **Gate** This property enables or disables the operation. See [[system_objs# |
==== Adding an input ==== | ==== Adding an input ==== | ||
Line 658: | Line 919: | ||
* **KNX group** This property represents the KNX group which the value of the addend can be picked from. | * **KNX group** This property represents the KNX group which the value of the addend can be picked from. | ||
- | ===== Complex | + | ===== Logic Module ===== |
+ | |||
+ | {{ : | ||
+ | |||
+ | 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|Logic Module section]]. | ||
+ | |||
+ | * **Schemes** List of schemes, each element represents a fully working block diagram. | ||
+ | |||
+ | ===== Complex | ||
{{ : | {{ : | ||
Line 757: | Line 1026: | ||
{{ : | {{ : | ||
- | 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 object represents a service to store data coming from the plant on a cloud database. All these data will be accessible through the [[inter_objs# |
<WRAP center round important 60%> | <WRAP center round important 60%> | ||
Line 808: | Line 1077: | ||
</ | </ | ||
+ | ====== Reports and Gateways ====== | ||
===== Report ===== | ===== Report ===== | ||
Line 826: | Line 1095: | ||
* **Use default SMTP** SMTP server determines the email sender address; if enabled, email messages are sent from the default SMTP; if not, the following property is displayed: | * **Use default SMTP** SMTP server determines the email sender address; if enabled, email messages are sent from the default SMTP; if not, the following property is displayed: | ||
* **Email Account** Select the ”Email account” item from the list. Please refer to the dedicated section above. | * **Email Account** Select the ”Email account” item from the list. Please refer to the dedicated section above. | ||
+ | <wrap important> | ||
==== Adding recipients ==== | ==== Adding recipients ==== | ||
Line 931: | Line 1200: | ||
==== Object commands ==== | ==== Object commands ==== | ||
- | Commands sent to the object and recallable from other objects | + | Commands sent to the object and recallable from other objects: |
- | == Turn on/off element | + | ++++Turn on/off element| This command allows to start turn on or off the Hue element. |
+ | * **Value** Write 1 to turn on, and 0 to turn off. | ||
+ | ++++ | ||
+ | ++++Dimm the element to a value| | ||
+ | * **Value** can be between 0 and 255. | ||
+ | ++++ | ||
+ | ++++Set the element color temperature (white)| | ||
+ | * **Value** Can be between 0 and 255, where 0 corresponds to Cold White (6500 K) and 255 correspond to Warm White (2000 K). | ||
+ | ++++ | ||
+ | ++++Set the element color (RGB)| | ||
+ | * **Red Value** value between 0 and 255. | ||
+ | * **Green Value** value between 0 and 255. | ||
+ | * **Blue Value** value between 0 and 255. | ||
+ | ++++ | ||
- | Turn on or off the Hue element. Set 1 as parameter turn on the element, while 0 turn off the element. | ||
- | |||
- | == Dimm the element to a value == | ||
- | |||
- | set the desired value for the dimmer through a single parameter which can assume a value between 0 and 255. | ||
- | |||
- | == Set the element color temperature (white) == | ||
- | |||
- | Set the element color temperature. A single parameter must be set with a value within 0 and 255, where 0 corresponds to Cold White (6500 K) and 255 correspond to Warm White (2000 K). | ||
- | |||
- | == Set the element color (RGB) == | ||
- | |||
- | Set the element RGB color through the definition of three parameters for Red, Green and Blue. Each color can assume a value between 0 and 255. | ||
- | |||
- | ===== MyHome 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 worlds. | ||
- | |||
- | * **IP Address** IP address of the device or of the serial server | ||
- | * **Port Number** Serial port number. It can be between 0 and 3. For USB use 10 | ||
- | * **Lights** Collection of lights | ||
- | * **Automation** | ||
- | * **Heating** Collection of heating and cooling elements. | ||
===== Load control ===== | ===== Load control ===== | ||
Line 988: | Line 1245: | ||
{{ : | {{ : | ||
- | It allows to integrate | + | This object |
+ | |||
+ | <WRAP tip round center 80%> 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/ | ||
+ | |||
+ | <WRAP important round center 80%> Do not confuse the concept of **Master-Slave** with **Client-Server**. While Master-Slave is explained from a Modbus perspective, | ||
+ | |||
* **Communication Type** Define the method and mean of communication. Serial over TCP is used when a Serial Server is used.\\ If in the property ”Communication Type” is selected the setting ”Modbus Serial”, the following properties will appear: | * **Communication Type** Define the method and mean of communication. Serial over TCP is used when a Serial Server is used.\\ If in the property ”Communication Type” is selected the setting ”Modbus Serial”, the following properties will appear: | ||
- | * Port Number: Serial port number. | + | * Port Number: Serial port number |
* Baud Rate: Modbus Baud Rate | * Baud Rate: Modbus Baud Rate | ||
* Data Length: Number of bits for data | * Data Length: Number of bits for data | ||
Line 1002: | Line 1265: | ||
* **Datapoints** Data points collection | * **Datapoints** Data points collection | ||
* **Poll Interval** Pause between two consecutive polling sequences [ms] | * **Poll Interval** Pause between two consecutive polling sequences [ms] | ||
+ | |||
+ | For each Datapoint created, the below parameters are available: | ||
+ | * **Name** datapoint label | ||
+ | * **Slave Address** Physical slave address of the device where the data is configured. | ||
+ | * **Data address** Data address where the data is stored. | ||
+ | * **Data type** type of data to read/write. | ||
+ | * **Read Function** Modbus standard function that has to be used to read the value (consult device manual). | ||
+ | * **Write Function** Modbus standard function that has to be used to write the value (consult device manual). | ||
+ | * **Bit number** number of bits inside the data that represent the value. | ||
+ | * **Conversion factor** conversion factor to multiply the read raw value. | ||
+ | * **Reuse** If several bits need to be read from the same address X, this parameter will help improve the reading speed by avoiding polling the slave every single time to read 1 different bit from the same address. For example, if multiple datapoints have been created for the same address, each datapoint with a different bit number to read from (typically each bit is a different toggle status), then only the first datapoint will have the " | ||
+ | * **Force rewrite** If enabled, permits to refresh (re-write) the last written value to the slave cyclically, based on the interval configured in "Write Refresh Interval" | ||
+ | * **Gateway KNX** if enabled, allows to read/write Modbus values from KNX system. | ||
+ | * **KNX data type** EIS data type that has to be written into the KNX group. | ||
+ | * **KNX group from Modbus** KNX group to read feedback from Modbus. Values are read from Modbus slaves and sent to this KNX group address. | ||
+ | * **Send if change** if enabled, sends value on KNX bus just in case Modbus value changes. | ||
+ | * **Enable KNX to Modbus** By default, the KNX gateway will read data from Modbus and send feedback to KNX. If bidirectional communication is needed, enable this parameter. | ||
+ | * **KNX group to Modbus** KNX group to receive value and write to Modbus. Values are received from this KNX group address and are written to Modbus. | ||
+ | |||
+ | |||
+ | ==== Object Commands ==== | ||
+ | Commands sent to the object and recallable from other objects: | ||
+ | ++++Send Modbus value with function 5| This function is used to send a value to a Modbus device supporting function 5, known as "write single coil". | ||
+ | * **Modbus address** Modbus address. | ||
+ | * **Coil Address** Discrete output address (coils are 1-bit registers). | ||
+ | * **Value** could be 1 or 0. | ||
+ | ++++ | ||
+ | ++++Send Modbus value with function 6| This function is used to send a value to a Modbus device supporting function 6, known as "Write Single Holding Register" | ||
+ | * **Modbus Address** Modbus address. | ||
+ | * **Register Address** Slave register. | ||
+ | * **Value** value to write. | ||
+ | * **N.Byte** Number of bytes. | ||
+ | ++++ | ||
+ | ++++Send Modbus value with function 16| This function is used to send a value to a Modbus device supporting function 16, known as "Write Multiple Holding Registers" | ||
+ | * **Modbus Address** Modbus address. | ||
+ | * **First Register Address** Slave register. | ||
+ | * **Value** value to write. | ||
+ | * **N.Byte** Number of bytes. | ||
+ | ++++ | ||
+ | ++++Send Modbus value with function 22| This function is used to send a value to a Modbus device supporting function 22. The function can be used to set or clear individual bits in the register. | ||
+ | * **Modbus Address** Modbus address. | ||
+ | * **Register Address** Slave register. | ||
+ | * **Value** value to write. | ||
+ | * **Selected bits mask** mask value of the selected bits to be changed. | ||
+ | ++++ | ||
+ | |||
+ | ===== Gateway Modbus Slave===== | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | It allows to communicate with Modbus slave devices when Thinknx server is used as Slave Gateway. | ||
+ | |||
+ | * **Communication Type** Define the method and mean of communication. Serial over TCP is used when a Serial Server is used.\\ If in the property ”Communication Type” is selected the setting ”Modbus Serial”, the following properties will appear: | ||
+ | * Port Number: Serial port number that changes depending on the server used. Click [[port_numbers| here]] to get the correct port number. | ||
+ | * Baud Rate: Modbus Baud Rate | ||
+ | * Data Length: Number of bits for data | ||
+ | * Parity: Parity check modality | ||
+ | * Stop Bits: Number of stop bits. | ||
+ | * Custom Timing: if enabled, it allows to change the waiting times below: | ||
+ | * waiting time after enabling RTS before the writing begins. | ||
+ | * waiting time after writing before disabling RTS. | ||
+ | * waiting time after disabling RTS before the reading begins. | ||
+ | |||
+ | * **Device Address** Address of the slave device (1byte) to be used on the bus for identification. | ||
+ | * **Modbus Type** variant of the Modbus protocol to use for communication. Select between RTU (mostly used) and ASCII. | ||
+ | * **Datapoints** Datapoints collection | ||
+ | |||
+ | For each datapoint created, the below parameters are available: | ||
+ | * **Name** datapoint label | ||
+ | * **Data address** Data address where the data is stored. | ||
+ | * **Data type** type of data to read/write. | ||
+ | * **Read Function** Modbus standard function that has to be used to read the value (consult device manual). | ||
+ | * **Write Function** Modbus standard function that has to be used to write the value (consult device manual). | ||
+ | * **Bit number** number of bits inside the data that represent the value. | ||
+ | * **Conversion factor** conversion factor to multiply the read raw value. | ||
+ | * **KNX group** KNX group to send value to. | ||
+ | * **KNX data type** EIS data type that has to be written into the KNX group. | ||
+ | * **Send if change** if enabled, sends value to KNX bus just in case Modbus value changes. | ||
+ | |||
+ | {{ : | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | \\ | ||
+ | {{ : | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | |||
+ | |||
+ | |||
+ | ===== Gateway MyHome ===== | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | 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 [[https:// | ||
+ | |||
+ | * **IP Address** IP address of the device or of the serial server | ||
+ | * **Port Number** Serial port number that changes depending on the server used. Click [[port_numbers| here]] to get the correct port number. | ||
+ | * **Lights** Collection of lights. | ||
+ | * **Automation** Collection of shutters. | ||
+ | * **Heating** Collection of heating and cooling elements. | ||
+ | |||
+ | ==== Object Commands ==== | ||
+ | Commands sent to the object and recallable from other objects: | ||
+ | |||
+ | ++++Launch a scenario| This command allows launching of a scenario configured on the MyHome system. | ||
+ | * **Scenario Number** as configured in MyHome. | ||
+ | * **Control Panel** | ||
+ | * **Interface (I)** | ||
+ | ++++ | ||
+ | ++++Lights: point to point control ON/OFF| This command allows to send an ON or OFF command to one lighting point. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Light Point (PL)** | ||
+ | * **Interface (I)** | ||
+ | * **ON/OFF** type 0 to turn off and 1 to turn on. | ||
+ | ++++ | ||
+ | ++++Lights: point to point control DIMMER| This command allows to send a dimming value to one dimmer. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Light Point (PL)** | ||
+ | * **Interface (I)** | ||
+ | * **Dimmer Level** type a value between 0 and 255 for dimmer' | ||
+ | ++++ | ||
+ | ++++Lights: point to point control TIMED| This command allows to send an ON value duration for one light point. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Light Point (PL)** | ||
+ | * **Interface (I)** | ||
+ | * **ON timed for (min)** the values can be 0.5, 1, 2, 3, 4,5, or 15 min. | ||
+ | ++++ | ||
+ | ++++Lights: control for room ON/OFF| This command allows to send an ON or OFF command to an entire room. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **ON/OFF** type 0 to turn off and 1 to turn on. | ||
+ | ++++ | ||
+ | ++++Lights: control for room TIMED| This command allows to send an ON value duration for an entire room. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **ON timed for (min)** the values can be 0.5, 1, 2, 3, 4,5, or 15 min. | ||
+ | ++++ | ||
+ | ++++Lights: control for group ON/OFF| This command allows to send an ON or OFF command to a group of lighting points. | ||
+ | * **Group** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **ON/OFF** type 0 to turn off and 1 to turn on. | ||
+ | ++++ | ||
+ | ++++Lights: control for group DIMMER| This command allows to send a dimming value to a group of lighting points. | ||
+ | * **Group** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **Dimmer Level** type a value between 0 and 255 for dimmer' | ||
+ | ++++ | ||
+ | ++++Lights: control for group TIMED| This command allows to send an ON value duration for a group of lighting points. | ||
+ | * **Group** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **ON timed for (min)** the values can be 0.5, 1, 2, 3, 4,5, or 15 min. | ||
+ | ++++ | ||
+ | ++++Lights: general control ON/OFF| This command allows to send an ON or OFF command to all lighting points. | ||
+ | * **ON/OFF** type 0 to turn off and 1 to turn on. | ||
+ | ++++ | ||
+ | ++++Lights: general control DIMMER| This command allows to send a dimming value to all lighting points. | ||
+ | * **Dimmer Level** type a value between 0 and 255 for dimmer' | ||
+ | ++++ | ||
+ | ++++Lights: general control TIMED| This command allows to send an ON value duration for all lighting points. | ||
+ | * **ON timed for (min)** the values can be 0.5, 1, 2, 3, 4,5, or 15 min. | ||
+ | ++++ | ||
+ | ++++Automation: | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Automation Point (PL)** | ||
+ | * **Interface (I)** | ||
+ | * **Stop/ | ||
+ | ++++ | ||
+ | ++++Automation: | ||
+ | * **Group** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **Stop/ | ||
+ | ++++ | ||
+ | ++++Automation: | ||
+ | * **Room** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **Stop/ | ||
+ | ++++ | ||
+ | ++++Automation: | ||
+ | * **Stop/ | ||
+ | ++++ | ||
+ | ++++Temperature Control: Setpoint| This command allows to change the setpoint in a zone. | ||
+ | * **Zone (ZA, ZB)** as configured in MyHome. | ||
+ | * **Temperature** type the value of the temperature in °C. | ||
+ | ++++ | ||
+ | ++++Temperature Control: enable or disable| This command allows to enable/ | ||
+ | * **Zone (ZA, ZB)** as configured in MyHome. | ||
+ | * **Enable or disable** type 1 to enable and 0 to disable. | ||
+ | ++++ | ||
+ | ++++Sound: Control the volume| This command allows to control the volume of a speaker. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Loudspeaker (PF)** | ||
+ | * **Volume** the number must be between 0 and 255. | ||
+ | ++++ | ||
+ | ++++Sound: control a speaker ON/OFF| This command allows to turn a speaker on or off. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Loudspeaker (PF)** | ||
+ | * **ON/OFF** insert 1 to turn on and 0 to turn off. | ||
+ | ++++ | ||
===== Z-Wave Controller ===== | ===== Z-Wave Controller ===== | ||
Line 1007: | Line 1466: | ||
{{ : | {{ : | ||
- | 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. | + | 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. |
+ | |||
+ | <WRAP important center round 60%> For a full list of all the compatible Z-wave devices with Thinknx server, visit [[zwave_db| our database]]. </ | ||
* **Use internal controller** If enable, it will be used the server internal Z-Wave controller. If disabled it will be possible to use an external Z-Wave controller. This option is only used during configuration phase. If disabled, following properties will appear: | * **Use internal controller** If enable, it will be used the server internal Z-Wave controller. If disabled it will be possible to use an external Z-Wave controller. This option is only used during configuration phase. If disabled, following properties will appear: | ||
Line 1025: | Line 1486: | ||
<WRAP center round important 60%> | <WRAP center round important 60%> | ||
- | Z-Wave Controller | + | To work, Z-Wave Controller requires the ThinKnx Z-Wave transceiver (USB dongle) provided together with the Z-Wave upgrade |
</ | </ | ||
Line 1092: | Line 1553: | ||
The association function “associates” two devices, enabling them to communicate directly without the need for controller. On the " | The association function “associates” two devices, enabling them to communicate directly without the need for controller. On the " | ||
- | + | ||
+ | ===== Velux Gateway ===== | ||
+ | |||
+ | 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. | ||
+ | |||
+ | === Web access === | ||
+ | The web access credentials and SSID can be found on the back of the Velux unit as seen in the picture below: | ||
+ | |||
+ | {{ : | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | |||
+ | From your PC, scan for available wifi networks, and connect to the Velux SSID found. | ||
+ | |||
+ | Open the browser and type the following link: http:// | ||
+ | |||
+ | {{ : | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | |||
+ | Open the Interface Mode to scan and add your products. | ||
+ | |||
+ | {{ : | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | |||
+ | {{ : | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | |||
+ | <WRAP tip center round 80%>For more information on how to setup the Velux interface, check out this video posted by Velux Commercial https:// | ||
+ | |||
+ | === Network Setup === | ||
+ | After logging into the interface, click on the gear button at the top right, and select " | ||
+ | |||
+ | {{ : | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | |||
+ | Fill in your desired IP Address, Subnet mask, Default gateway (that fits to your LAN) or click on “Use DHCP”. | ||
+ | \\ | ||
+ | \\ | ||
+ | <WRAP important center round 80%> The important thing is to configure the Velux within the same LAN as the Thinknx server to ensure communication between both parties.</ | ||
+ | |||
+ | === Thinknx Configurator === | ||
+ | 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: | ||
+ | * **IP address** IP address of Velux KLF200 interface. | ||
+ | * **TCP Port** TCP port of Velux KLF200 interface. Default value: 51200. | ||
+ | * **Password** Password of Velux KLF200 webpage (see section above). | ||
+ | * **Status** Indicates the status of the last connection request to the Velux interface. If connection cannot be established, | ||
+ | * **Controlled Elements** Collection of Velux nodes and groups to control in Thinknx. When opened, each created element will have the following properties: | ||
+ | * **Element Type** type of element added (Node or Group). | ||
+ | * **Node/ | ||
+ | * **KNX gateway** Enables KNX gateway to control element. | ||
+ | |||
+ | {{ : | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | |||
+ | {{ : | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | |||
+ | |||
===== iRoomController ===== | ===== iRoomController ===== | ||
Line 1166: | Line 1686: | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
- | == Send SMS to numbers with text == | + | ++++Send SMS to numbers with text| This function allows the sending of an SMS to multiple phone numbers. |
- | + | * **SMS text content** message body. | |
- | Sends an SMS. In the parameters specify the SMS content | + | * **Receivers phone numbers** use " |
+ | ++++ | ||
===== Lutron ===== | ===== Lutron ===== | ||
Line 1178: | Line 1698: | ||
* **Lutron Type** Type of Lutron project. There are two options available: **Lutron Homework QS** or **Lutron Homeworks** | * **Lutron Type** Type of Lutron project. There are two options available: **Lutron Homework QS** or **Lutron Homeworks** | ||
* **Lutron Project** Xml file exported from Lutron configuration system. | * **Lutron Project** Xml file exported from Lutron configuration system. | ||
+ | {{ : | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | <WRAP important round center 80%> 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. </ | ||
* **IP address** IP address of the Lutron Homeworks processor | * **IP address** IP address of the Lutron Homeworks processor | ||
* **IP port** IP port of the Lutron Homeworks processor | * **IP port** IP port of the Lutron Homeworks processor | ||
- | * **Actions from Lutron** | + | |
+ | * **Password** password used to authenticate the telnet session with the Lutron processor | ||
+ | | ||
+ | * **Virtual outputs** opens an editor to transform outputs on the Lutron system | ||
+ | * **Virtual Keys** opens an editor to transform buttons on the Lutron system to buttons on the KNX side with all the commands and feedbacks | ||
+ | |||
+ | 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. | ||
+ | {{ : | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | ==== Actions from Lutron ==== | ||
+ | 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 [[# | ||
+ | |||
+ | To create a new action, click on " | ||
+ | * **Name** customized label of the action. | ||
+ | * **Gateway type** can be configured as " | ||
+ | * **Lutron Output** / **Button Identification** if " | ||
+ | * **Button event** this parameter is only visible when the Gateway type is set to " | ||
+ | * **C1 enabling** This property allows to enable or disable the first action. If "C1 enabling" | ||
+ | * C1 command: Command to be sent if the condition is enabled. | ||
+ | * C1 condition: Condition used to compare the current value with the preset one. If " | ||
+ | * C1 condition parameters: Value to be compared with the current one. This value determines if the selected action will be performed or not. If " | ||
+ | * **C2 enabling** This property allows to enable or disable the second action. If "C2 enabling" | ||
+ | * C2 command: Command to be sent if the condition is enabled. | ||
+ | * C2 condition: Condition used to compare the current value with the preset one. If " | ||
+ | * C2 condition parameters: Value to be compared with the current one. This value determines if the selected action will be performed or not. If " | ||
+ | * **C3 enabling** This property allows to enable or disable the third action. If "C3 enabling" | ||
+ | * C3 command: Command to be sent if the condition is enabled. | ||
+ | * C3 condition: Condition used to compare the current value with the preset one. If " | ||
+ | * C3 condition parameters: Value to be compared with the current one. This value determines if the selected action will be performed or not. If " | ||
+ | |||
+ | ==== Virtual Outputs ==== | ||
+ | This editor permits to transform a Lutron output/ | ||
+ | Click on " | ||
+ | * **Name** customized label of the output. | ||
+ | * **Use shadegroup** enables to control Lutron shadegroup instead of single output. | ||
+ | |||
+ | If " | ||
+ | * **Lutron output** Lutron output to transform into a virtual KNX output. | ||
+ | * **Group for switching** KNX group (switch ON/OFF) to be used to control the Lutron output from the KNX bus (1bit). | ||
+ | * **Group for feedback** KNX group to receive feedback from Lutron to KNX (1bit-DPT1) | ||
+ | * **Group for dimming** KNX group (relative dimming) to be used to control the Lutron output from KNX bus (4bit). | ||
+ | * **Group for value** KNX group (absolute dimming) to be used to control the Lutron output from KNX bus (1byte-DPT5). | ||
+ | * **Group for value feedback** KNX group to receive the dimming level from the Lutron output to KNX (1byte-DPT5). | ||
+ | |||
+ | If " | ||
+ | * **Lutron Shadegroup** Lutron shadegroup to transform into a virtual KNX shutter. | ||
+ | * **Group for move** KNX group (Up/Down) to be used to move the Lutron shade from the KNX bus (1bit-DPT1). | ||
+ | * **Group for stop** KNX group to be used to stop the movement of the Lutron shade from the KNX bus (1bit-DPT1). | ||
+ | * **Group for dimming** KNX group (relative dimming) to be used to control the Lutron output from KNX bus (4bit). | ||
+ | * **Group for value** KNX group to be used to control the level of the Lutron shade from KNX bus (1byte-DPT5). | ||
+ | * **Group for value feedback** KNX group to receive the level from the Lutron shade to KNX (1byte-DPT5). | ||
+ | * **Enable Lamellae** enable/ | ||
+ | * **Group for move** KNX group (Up/Down) to be used to move the Lutron lamellae from the KNX bus (1bit-DPT1). | ||
+ | * **Group for stop** KNX group to be used to stop the movement of the Lutron lamellae from the KNX bus (1bit-DPT1). | ||
+ | * **Group for dimming** KNX group (relative dimming) to be used to control the Lutron lamellae from KNX bus (4bit). | ||
+ | * **Group for value** KNX group to be used to control the level of the Lutron lamellae from KNX bus (1byte-DPT5). | ||
+ | * **Group for value feedback** KNX group to receive the level from the Lutron lamellae to KNX (1byte-DPT5). | ||
+ | |||
+ | |||
+ | ==== Virtual Keypad ==== | ||
+ | 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 " | ||
+ | * **Name** customized label of the key. | ||
+ | * **Lutron button** Lutron button to transform into a virtual KNX key. | ||
+ | * **Button function** permits to configure the button function when it is pressed/ | ||
+ | * Dimm down | ||
+ | * Dimm up | ||
+ | * Dimm up/down | ||
+ | * Scene recall | ||
+ | * Scene save | ||
+ | * Switch off | ||
+ | * Switch on | ||
+ | * Switch toggle | ||
+ | * **Led behaviour** permits to configure the Led behaviour according to the selected function of the button. The behaviour can be " | ||
+ | |||
+ | If button function is set to "Dimm up", "Dimm down" or "Dimm toggle", | ||
+ | * **Group for switching** KNX group for sending a switch telegram (1bit). | ||
+ | * **Group for dimming** KNX group to send a dimming telegram (4bit). | ||
+ | * **Group for feedback** KNX group to receive feedback for LED (1bit). Only visible if "Led behaviour" | ||
+ | |||
+ | If button function is set to " | ||
+ | * **Group for switching** KNX group for sending a switch telegram (1bit). | ||
+ | * **Group for feedback** KNX group to receive feedback for LED (1bit). Only visible if "Led behaviour" | ||
+ | |||
+ | If button function is set to "scene recall" | ||
+ | * **Group for scene** KNX group for sending scene save/recall (1byte). | ||
+ | * **Scene index** number of the scene to recall/ | ||
+ | * **Group for feedback** KNX group to receive feedback for LED (1bit). Only visible if "Led behaviour" | ||
===== Serial gateway ===== | ===== Serial gateway ===== | ||
Line 1188: | Line 1799: | ||
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. | 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. | ||
- | * **Port Number** Serial port number. | + | * **Port Number** Serial port number |
* **Baud Rate** Serial port baud rate. | * **Baud Rate** Serial port baud rate. | ||
* **Data Length** Number of bits for data. | * **Data Length** Number of bits for data. | ||
Line 1198: | Line 1809: | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
- | == Send string with no termination | + | ++++Send string with no termination| This command is used to send a text without termination. |
+ | * **String to send** input the string that will be sent to the serial gateway. | ||
+ | ++++ | ||
+ | ++++Send string with CR termination| This command is used when sending a text with CR termination, | ||
+ | * **String to send** input the string that will be sent to the serial gateway. | ||
+ | ++++ | ||
+ | ++++Send hexadecimal string with no termination| This command is used to send an hexadecimal string without termination. | ||
+ | * **String to send** input the string that will be sent to the serial gateway. | ||
+ | ++++ | ||
+ | ++++Send hexadecimal string with CR termination| This command is used when sending an hexadecimal string with CR termination, | ||
+ | * **String to send** input the string that will be sent to the serial gateway. | ||
+ | ++++ | ||
- | Sends a string to the serial port without carriage return; adjust the parameter on the right to specify the string text. | ||
- | == Send string with CR termination == | ||
- | Sends a string to the serial port with carriage return; adjust the parameter on the right to specify the string text. | + | ===== Ethernet gateway ===== |
- | == Send hexadecimal string with no termination == | + | {{ : |
- | Sends a hexadecimal string | + | This object is a server service that allows |
- | == Send hexadecimal string with CR termination == | + | * **[[# |
+ | * **[[# | ||
- | Sends a hexadecimal string to the serial port with carriage return; adjust the parameter on the right to specify the string text. The string command has to be converted in hexadecimal, | + | ==== Virtual Inputs ==== |
- | ==== Serial port settings for ThinKnx servers ==== | + | * **Input Mode** Choose between HTTP request or TCP/UDP listener. |
+ | * **HTTP Request Type** Choose the HTTP method to use between GET, POST, or PUT, in case HTTP request is selected as Input Mode. | ||
+ | * **Refresh Rate** Specify the time interval after which the server should refresh data from the external service. | ||
+ | * **Base URL** Base address of the external service. All the parameters will be eventually added using the **[[# | ||
+ | * **Retry times** Permits to specify the number of consecutive attempts in case of timeout or other kind of communication failure. | ||
+ | * **Timeout** Timeout of HTTP request in milliseconds. | ||
+ | * **Use credentials** Permits to use specific credentials to authenticate with the service to get the value of the input. | ||
+ | * **[[# | ||
- | Depending on the server you are going to use, the serial | + | In case the Input Mode was configured as TCP/UDP listener, the below parameters are available: |
+ | * **Listener protocol** Select the listener protocol between UDP and TCP. | ||
+ | * **Listener | ||
+ | * **Separator** Select what kind of character separates data. | ||
- | * Compact RS232 Port Number 0 | + | \\ |
- | * Rack Serial A Port Number 2 | + | |
- | * Rack Serial B Port Number 3 | + | |
- | * Rack RS232 C Port Number 0 | + | |
- | * BrickBox RS232 Port Number 4 | + | |
- | * BrickBox RS485 Port Number 5 | + | |
- | * Serial over USB Port Number 10 | + | |
- | ===== Ethernet gateway ===== | + | === Data Format Input === |
+ | This window permits to configure the request and response parameters to match the external service requirements. | ||
- | {{ :system_obj_-_ethernetgateway.png?nolink&100 |}} | + | {{ :input_format_editor.png?direct&800 |Data Format Input - Overview}} |
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | \\ | ||
- | This object is a server service that allows | + | 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. |
- | ==== Object commands ==== | + | {{ : |
+ | <WRAP center 60%> <WRAP centeralign> | ||
- | Commands sent to the object and recallable from other objects: | + | ==== Virtual Outputs ==== |
- | == Make a http GET call to a specific url == | + | * **URL** Endpoint address. Parameters are configured inside the **Data Format Input**. |
+ | * **Request Type** Choose the HTTP method to use between | ||
+ | * **Use Specific Credentials** Specify username and password if required. | ||
+ | * **Timeout** Timeout of HTTP request in milliseconds. | ||
+ | * **Retry** In case of timeout or failure to send, specify the maximum number of consecutive attempts. | ||
+ | * **Refresh Rate** Specify the time interval after which the server should re-acquire data. | ||
+ | * **Send Trigger** Specify the kind of action that triggers the communication with the external service. | ||
+ | * **[[# | ||
+ | * **Invoke Virtual Input** | ||
+ | * **Use KNX Gateway** if enabled, it will be possible | ||
+ | \\ | ||
- | Allows to send a GET; adjust the ”URL” parameter on the right to specify the url. | + | === Data Format Output === |
- | == Make a http GET call to a specific url with username == | + | {{ : |
+ | <WRAP center 60%> <WRAP centeralign> | ||
- | Allows to send a GET; adjust the ”URL” parameter on the right to specify the url and type in the login parameters required for the authentication to the server. | + | {{ : |
+ | <WRAP center 60%> <WRAP centeralign> | ||
- | == Make a http POST call to a specific url == | + | ==== Example with Airscope Amplifier ==== |
- | Allows to send a POST; adjust | + | 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:// |
- | == Make a http POST call to a specific url with username == | + | {{ : |
+ | <WRAP center 60%> <WRAP centeralign> | ||
- | Allows to send a POST; adjust the ”URL” parameter on the right to specify the url and type in the login parameters required for the authentication to the server. | + | === Virtual Input: Get Volume from Airscope === |
- | == Send string with no termination | + | According |
+ | \\ | ||
- | Allows to send a string to a TCP socket without carriage return; adjust the parameters on the right to specify the string text and type in the IP address and port of the server. | + | **< |
- | == Send string with CR termination to TCP socket == | + | \\ |
+ | The response received from the Airscope device comes in a JSON format, following the example below: | ||
- | Allows | + | **{\\ |
+ | “mainmode”: | ||
+ | “nodetype”: | ||
+ | “mode”: “3”, | ||
+ | “sw”: “0”, | ||
+ | “status”: | ||
+ | “curpos”: | ||
+ | “totlen”: | ||
+ | “Title”: | ||
+ | “Artist”: | ||
+ | “Album”: | ||
+ | “Year”: “2005”, | ||
+ | “Track”: | ||
+ | “Genre”: | ||
+ | “locallistflag”: | ||
+ | “locallistfile”: | ||
+ | “plicount”: | ||
+ | “plicurr”: | ||
+ | “vol”: “90”, **//< | ||
+ | **“mute”: | ||
+ | “iuri”: “xxxxxxxxxxxxxxxxxxxxx”, | ||
+ | “uri”: “xxxxxxxxxxxxxxxxxxxxxx”\\ | ||
+ | }**\\ | ||
- | == Send hexadecimal string with no termination | + | To configure the virtual input inside the Configurator, |
- | Allows to send a hexadecimal string to a TCP socket without carriage return; adjust the parameters on the right to specify the string text and type in the IP address and port of the server. The string command has to be converted in hexadecimal, | + | {{ : |
+ | <WRAP center 60%> <WRAP centeralign> | ||
- | == Send hexadecimal string with CR termination to TCP socket == | + | Open the Data Format editor, and make sure you configure the request and response formats as instructed in the amplifier' |
- | Allows to send a hexadecimal string to a TCP socket with carriage return; adjust the parameters on the right to specify the string text and type in the IP address and port of the server. The string command has to be converted in hexadecimal, | + | {{ : |
+ | <WRAP center 60%> <WRAP centeralign> | ||
- | == Send string | + | To display the current volume level on the Thinknx UI, you can add an Analog Value with type " |
- | Allows to send a string to a UDP socket without carriage return; adjust the parameters on the right to specify the string text and type in the IP address and port of the server. | + | {{ : |
+ | <WRAP center 60%> <WRAP centeralign> | ||
- | == Send string with CR termination to UDP socket | + | === Virtual Output: Change Volume from Thinknx UI === |
- | Allows | + | According |
+ | \\ | ||
+ | **< | ||
+ | \\ | ||
- | == Send hexadecimal string with no termination | + | To configure the virtual output inside the Configurator, |
- | Allows to send a hexadecimal string to a UDP socket without carriage return; adjust the parameters on the right to specify the string text and type in the IP address and port of the server. The string command has to be converted in hexadecimal, | + | {{ : |
+ | <WRAP center 60%> <WRAP centeralign> | ||
- | == Send hexadecimal string with CR termination | + | Open the Data Format editor, and make sure you configure the request format correctly, by replacing the word " |
- | Allows to send a hexadecimal string to a UDP socket with carriage return; adjust the parameters on the right to specify the string text and type in the IP address and port of the server. The string command has to be converted in hexadecimal, | + | {{ : |
+ | <WRAP center 60%> <WRAP centeralign> | ||
- | == Send SOAP request | + | 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 " |
- | Allows | + | {{ : |
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | |||
+ | ==== Object commands ==== | ||
+ | |||
+ | Commands sent to the object and recallable from other objects: | ||
+ | |||
+ | ++++Make an HTTP GET call to a specified url| This command allows the sending of an HTTP GET request to execute a command. | ||
+ | * **URL** | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Make an HTTP GET call to a specified url with username and password| This command allows the sending of an HTTP GET request execute a command. | ||
+ | * **URL** | ||
+ | * **Username** used to authenticate to the server | ||
+ | * **Password** used to authenticate to the server | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Make an HTTP POST call to a specified url| This command allows the sending of an HTTP POST request | ||
+ | * **URL** | ||
+ | * **Content to send into call** multiple form fields and values can be sent via the same URL. The encoding used by default is based on an early version of the general URI percent-encoding rules, with a number of modifications such as newline normalization and replacing spaces with + instead of %20. The media type of data encoded this way is application/ | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Make an HTTP POST call to a specified url with username and password| This command allows the sending of an HTTP POST request | ||
+ | * **URL** | ||
+ | * **Content to send into call** multiple form fields and values can be sent via the same URL. The encoding used by default is based on an early version of the general URI percent-encoding rules, with a number of modifications such as newline normalization and replacing spaces with + instead of %20. The media type of data encoded this way is application/ | ||
+ | * **Username** used the authenticate | ||
+ | * **Password** used to authenticate to the server. | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Make an HTTP PUT call to a specified url| This command allows the sending of an HTTP PUT request to send data to a certain sever in order to execute a command. | ||
+ | * **URL** | ||
+ | * **Content to send into call** multiple form fields and values can be sent via the same URL. The encoding used by default is based on an early version of the general URI percent-encoding rules, with a number of modifications such as newline normalization and replacing spaces with + instead of %20. The media type of data encoded this way is application/ | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Make an HTTP PUT call to a specified url with username and password| This command allows | ||
+ | * **URL** | ||
+ | * **Content to send into call** multiple form fields and values can be sent via the same URL. The encoding used by default is based on an early version of the general URI percent-encoding rules, with a number of modifications such as newline normalization and replacing spaces with + instead of %20. The media type of data encoded this way is application/ | ||
+ | * **Username** used the authenticate to the server. | ||
+ | * **Password** used to authenticate to the server. | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Make an HTTP DELETE call to a specified url| This command allows the sending of an HTTP DELETE request to send data to an external server. | ||
+ | * **URL** | ||
+ | * **Content to send into call** multiple form fields and values can be sent via the same URL. The encoding used by default is based on an early version of the general URI percent-encoding rules, with a number of modifications such as newline normalization and replacing spaces with + instead of %20. The media type of data encoded this way is application/ | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Make an HTTP DELETE call to a specified url with username and password| This command allows the sending of an HTTP DELETE to an external server. The server in this case requires a username and password. | ||
+ | * **URL** | ||
+ | * **Content to send into call** multiple form fields and values can be sent via the same URL. The encoding used by default is based on an early version of the general URI percent-encoding rules, with a number of modifications such as newline normalization and replacing spaces with + instead of %20. The media type of data encoded this way is application/ | ||
+ | * **Username** used the authenticate to the server. | ||
+ | * **Password** used to authenticate to the server. | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Send string with no termination to TCP socket| This command allows the sending of a string to a TCP host on a defined port. | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Send string with CR termination to TCP socket| This command allows the sending of a string with CR termination, | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Send hexadecimal string with no termination to TCP socket| This command allows the sending of an hexadecimal string to a TCP host on a defined port. | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | |||
+ | To send "hello world", | ||
+ | ++++ | ||
+ | |||
+ | ++++Send hexadecimal string with CR termination to TCP socket| This command allows the sending of a string with CR termination, | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | |||
+ | To send "hello world", | ||
+ | ++++ | ||
+ | |||
+ | ++++Send string with no termination to UDP socket| This command allows the sending of an hexadecimal string to a UDP host on a defined port. | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Send string with CR termination to UDP socket| This command allows the sending of a string with CR termination, | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Send hexadecimal string with no termination to UDP socket| This command allows the sending of an hexadecimal string to a UDP host on a defined port. | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | To send "hello world", | ||
+ | ++++ | ||
+ | |||
+ | ++++Send hexadecimal string with CR termination to UDP socket| This command allows the sending of a string with CR termination, | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | To send "hello world", | ||
+ | ++++ | ||
+ | |||
+ | ++++Send hexadecimal string with no termination to UDP socket in multicast| This command allows the sending of an hexadecimal string to a UDP host supporting multicast on a defined port. The characters should be separated by a space. | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | |||
+ | To send "hello world", | ||
+ | ++++ | ||
+ | |||
+ | ++++Send hexadecimal string with CR termination to UDP socket in multicast| This command allows the sending of a string with CR termination, | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | To send "hello world", | ||
+ | ++++ | ||
+ | |||
+ | ++++Send | ||
+ | * **URL** | ||
+ | * **SOAP Envelope** Defines the start and the end of the message. It is a mandatory element. | ||
+ | * **SOAP Action** indicates the intent | ||
+ | ++++ | ||
+ | |||
+ | ++++Establish SSH session and send commands| This command allows to establish an SSH session with a server to execute certain commands. Secure Socket Shell or SSH, is a network protocol that gives users, particularly system administrators, | ||
+ | * **SSH server hostname** | ||
+ | * **SSH server port** | ||
+ | * **Username** | ||
+ | * **Password** | ||
+ | * **Commands to send** Commands must be enclosed in double quotes and separeted by a space, example: "cmd one" "cmd two" " | ||
+ | |||
+ | Application: | ||
+ | ++++ | ||
===== P1 Meter Interface ===== | ===== P1 Meter Interface ===== | ||
Line 1294: | Line 2122: | ||
Serial interface available in the new meters in the Netherlands. | Serial interface available in the new meters in the Netherlands. | ||
- | * **Serial port number** | + | * **Serial port number** |
* **KNX gateway** If enabled, the data read from the meter box will be available also on the KNX bus. If ”KNX gateway” is set to ”Enabled”, | * **KNX gateway** If enabled, the data read from the meter box will be available also on the KNX bus. If ”KNX gateway” is set to ”Enabled”, | ||
* KNX group delivered energy normal tariff: KNX group delivered energy normal tariff. | * KNX group delivered energy normal tariff: KNX group delivered energy normal tariff. | ||
Line 1308: | Line 2136: | ||
* KNX group calorie cool: KNX group calorie cool. | * KNX group calorie cool: KNX group calorie cool. | ||
* KNX water consumption: | * KNX water consumption: | ||
+ | |||
+ | ===== Voice Control Gateway ===== | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | 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|Voice Control Gateway section]]. | ||
+ | |||
+ | * **Label** Text label to identify the object | ||
+ | * **Lights** Holds the collection of Light objects added | ||
+ | * **Rollers Shutters** Holds the collection of Shutter objects added | ||
+ | * **Thermo Comfort** Holds the collection of Thermo Comfort objects added | ||
+ | * **Scenes** Holds the collection of Scene objects added | ||
+ | |||
+ | ===== IFTTT Account ===== | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | 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|IFTTT section]]. | ||
+ | |||
+ | * **Label** Text label to identify the object | ||
+ | * **Webhook Key** Webhook key of the user account to use to communicate with IFTTT service. Can be obtained visiting this URL: < | ||
===== Tester ===== | ===== Tester ===== | ||
Line 1344: | Line 2193: | ||
* **KNX Physical Addr.** KNX physical address of the test target | * **KNX Physical Addr.** KNX physical address of the test target | ||
+ | ===== OpenWeatherMap ===== | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | <WRAP important round center 80%> This object is different from the [[inter_objs# | ||
+ | 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). | ||
+ | |||
+ | * **API Key** API key taken from the user account created on www.openweathermap.org. Sign in, go to User Profile, click on My API Keys, and copy the default key. It is also possible to create as many additional key as possible. | ||
+ | {{ : | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | * ** Use System Position** When enabled, the location (latitude, longitude) will be automatically acquired by the main System object properties. If disabled, enter Latitude and Longitude in parameters below. | ||
+ | * **Latitude** Latitude of the location for which the user would like to read the weather information. | ||
+ | * **Longitude** Longitude of the location for which the user would like to read the weather information. | ||
+ | * **Language** Display language of retrieved data. | ||
+ | * **Unit of Measure** Unit of measure used to display retrieved weather data such as temperatures. | ||
+ | * **Max. Calls Every Hour** Maximum number of requests to the weather system per hour. | ||
+ | * **Alerts** Permits to create alert events in case of predefined weather condition. | ||
+ | * **KNX Gateway** If enabled, allows the user to assign KNX group addresses to OpenWeatherMap data, and use them in the local system. | ||
+ | |||
+ | ==== Alerts ==== | ||
+ | Each weather alert created (example: If there is rain within 1 day, block irrigation program), can be configured using the following parameters: | ||
+ | * **Measurement to consider** Choose between Rain, Temperature or Window Speed alert trigger. | ||
+ | * **Comparison Interval** Specify the time interval that will be considered to evaluate the alert condition. The system will compare all the forecast for the selected interval with the threshold value. | ||
+ | * **KNX Alert Group** KNX group to send alert (1 bit telegram). | ||
+ | * **Value during alert** Value to send on the KNX bus when the weather condition meets the configured alert. | ||
+ | * **Value not in alert** Value to send on the KNX bus when the weather condition doesn' | ||
+ | |||
+ | ==== Creating the UI ==== | ||
+ | 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' | ||
+ | |||
+ | {{ : | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | |||
+ | {{ : | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | |||
+ | Click on the button below to download a project template for both options: | ||
+ | <WRAP button centeralign> | ||
+ | |||
+ | |||
+ | ===== MQTT Server ===== | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | This object allows the Thinknx server to function as an MQTT broker. For more information, | ||
+ | |||
+ | ===== MQTT Client ===== | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | 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, | ||
+ | ====== Multimedia ====== | ||
===== Video Matrix ===== | ===== Video Matrix ===== | ||
Line 1362: | Line 2263: | ||
* IP address: Device IP address. | * IP address: Device IP address. | ||
* Port number: TCP/IP port number for ethernet connection.\\ If the property ”Use serial port” is set to ”Enabled”, | * Port number: TCP/IP port number for ethernet connection.\\ If the property ”Use serial port” is set to ”Enabled”, | ||
- | * Serial port: Server serial | + | * Serial port: Serial port number that changes depending on the server used. Click [[port_numbers| here]] to get the correct |
==== Object commands ==== | ==== Object commands ==== | ||
Line 1368: | Line 2269: | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
- | == Set the selected | + | ++++Disconnect |
- | + | ++++ | |
- | Associates a specified input with a specified output of the matrix; input and output numbers can be specified by adjusting | + | |
- | == Disconnect input for the selected output | + | ++++Disconnect input for selected output| This command will disconnect the input connected to the desired output. |
+ | * **Output Number** | ||
- | Disconnects a specified input from the previously specified output of the matrix; input and output numbers can be specified by adjusting the ”Input Number” and ”Output Number” on the right. | + | ++++ |
- | == Disconnect | + | ++++Set the selected |
+ | * **Input Number** | ||
+ | * **Output Number** | ||
+ | ++++ | ||
- | Resets all the previously configured connection between inputs and outputs of the video matrix. | ||
===== Audio Matrix ===== | ===== Audio Matrix ===== | ||
Line 1397: | Line 2300: | ||
* IP address: Device IP address. | * IP address: Device IP address. | ||
* Port number: TCP/IP port number for ethernet connection.\\ If the property ”Use serial port” is set to ”Enabled”, | * Port number: TCP/IP port number for ethernet connection.\\ If the property ”Use serial port” is set to ”Enabled”, | ||
- | * Serial port: Server serial | + | * Serial port: Serial port number that changes depending on the server used. Click [[port_numbers| here]] to get the correct |
* **Mute KNX Group** KNX group for mute command. | * **Mute KNX Group** KNX group for mute command. | ||
Line 1404: | Line 2307: | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
- | == Set the selected input for a selected output | + | ++++Set the selected input ot the selected output| This command will allow to set the desired input to one or more multiple outputs. |
+ | * **Input Number** | ||
+ | * **Output Number** use comma "," | ||
+ | ++++ | ||
- | Associates a specified | + | ++++Disconnect |
+ | ++++ | ||
- | == Disconnect input for the selected output == | + | ++++Mute or unmute |
+ | * **Output Number** use comma "," | ||
+ | * **Mute Value** 1=muted, 0=unmuted. | ||
+ | ++++ | ||
- | Disconnects a specified input from the previously specified | + | ++++Volume up selected |
+ | * **Output Number** use comma "," | ||
+ | ++++ | ||
- | == Disconnect input for every output | + | ++++Volume down selected |
+ | * **Output Number** use comma "," | ||
+ | ++++ | ||
- | Resets all the previously configured connection between inputs and outputs of the audio matrix. | + | ++++Set volume for selected output| This command will allow to set the a desired |
- | + | * **Output Number** use comma "," to send to multiple outputs. | |
- | == Mute or unmute | + | * **Volume** |
- | + | ++++ | |
- | Temporarily mutes a selected output; several output numbers, separated by a comma, can be typed in the ”Output number” parameter. The ”Mute” bit value can be adjusted in the related parameter as well. | + | |
- | + | ||
- | == Volume up selected output == | + | |
- | + | ||
- | Turns up the volume | + | |
- | + | ||
- | == Volume down selected output | + | |
- | + | ||
- | Turns down the volume of a specified output (several output numbers, separated by a comma, | + | |
- | + | ||
- | == Set volume for selected output == | + | |
- | + | ||
- | Configures a specified volume | + | |
===== Display ===== | ===== Display ===== | ||
Line 1442: | Line 2343: | ||
* //TV brand LCD// | * //TV brand LCD// | ||
* //TV brand NEC// | * //TV brand NEC// | ||
- | * **Serial port** | + | * **Serial port** |
==== Object Commands ==== | ==== Object Commands ==== | ||
Line 1448: | Line 2349: | ||
Commands that can be recalled from other objects: | Commands that can be recalled from other objects: | ||
- | == Set the TV channel number | + | ++++Set the TV channel number| This command will allow to change the TV channel to the desired channel entered inside the parameter. |
+ | * **Channel Number** | ||
+ | ++++ | ||
- | Change channel on the TV to the desired number. | + | ++++Set |
+ | * **Source Number** | ||
+ | ++++ | ||
- | == Set the video source | + | ++++On or standby the device| |
+ | * **Power Value** 1=Power ON, 0=Standby. | ||
+ | ++++ | ||
- | Set the video source. | + | ++++Set the audio volume| |
+ | * **Volume Level** value between 0-100. | ||
+ | ++++ | ||
- | == Muet or unmute | + | ++++Set |
+ | ++++ | ||
- | Set mute or unmute. | + | ++++Set the audio volume down| This command will allow to lower the volume on the TV. |
+ | ++++ | ||
- | == On or standby the device == | ||
- | |||
- | Turn on the device or put it in standby. | ||
- | |||
- | == Set the audio volume == | ||
- | |||
- | Set the volume | ||
- | |||
- | == Set the audio volume up == | ||
- | |||
- | Raise the volume | ||
- | |||
- | == Set the audio volume down == | ||
- | |||
- | Lower the volume | ||
===== Home theater ===== | ===== Home theater ===== | ||
Line 1489: | Line 2385: | ||
* IP address: Device IP address. | * IP address: Device IP address. | ||
* Port number: TCP/IP port number for ethernet connection.\\ If the property ”Use serial port” is set to ”Enabled”, | * Port number: TCP/IP port number for ethernet connection.\\ If the property ”Use serial port” is set to ”Enabled”, | ||
- | * Serial port: Server serial | + | * Serial port: Serial port number that changes depending on the server used. Click [[port_numbers| here]] to get the correct |
+ | <WRAP important center round 80%> When using Denon as AVR, it is necessary to disable Power Saving in the receiver' | ||
==== Object commands ==== | ==== Object commands ==== | ||
Line 1496: | Line 2393: | ||
Commands that can be recalled from other objects: | Commands that can be recalled from other objects: | ||
- | == Power On or Standby device | + | ++++Power On or Standby device| This command will allow to turn the device On or put it to Standby mode. The command is sent to each zone individually. |
+ | * **Subzone** | ||
+ | * **power value** this value varies depending on the Brand of the Home Theater device. For more information, | ||
+ | ++++ | ||
- | Power on or standby | + | ++++Mute |
+ | * **Subzone** | ||
+ | * **mute value** this value varies depending on the Brand of the Home Theater | ||
+ | ++++ | ||
- | == Mute or unmute | + | ++++Volume up main output| This command will allow to raise the volume on the selected subzone. |
+ | * **Subzone** | ||
+ | ++++ | ||
- | Mute or unmute the main output. | + | ++++Volume down main output| This command will allow to lower the volume on the selected subzone. |
+ | * **Subzone** | ||
+ | ++++ | ||
- | == Enable or disable Subwoofer == | + | ++++Set volume for main output| |
+ | * **Subzone** | ||
+ | * **Volume** value between 0-100. | ||
+ | ++++ | ||
- | Enable or disable | + | ++++Bass up main output| |
+ | ++++ | ||
- | == Enable or disable OSD == | + | ++++Bass down main output| |
+ | ++++ | ||
- | Enable or disable | + | ++++Treble up main output| |
+ | ++++ | ||
- | == Volume up main output | + | ++++Treble down main output| This command will allow to lower the treble on the output. |
+ | ++++ | ||
- | Raise the main output volume | + | ++++Enable or disable Subwoofer| |
+ | * **Sub enable** | ||
+ | ++++ | ||
- | == Volume down main output | + | ++++Select source for main output| This command will allow to set the desired source to the main output of the selected zone. |
+ | * **Subzone** | ||
+ | * **Main source** | ||
+ | ++++ | ||
- | Lower the main output volume | + | ++++Select audio source for selected main source| |
+ | * **Subzone** | ||
+ | * **Main source audio** | ||
+ | ++++ | ||
- | == Set volume | + | ++++Select video source |
+ | * **Subzone** | ||
+ | * **Main source video** | ||
+ | ++++ | ||
- | Set the main output volume | + | ++++Read tuner frequency| |
+ | ++++ | ||
- | == Bass up selected output == | + | ++++Read tuner station| |
+ | ++++ | ||
- | Raise low frequencies for the selected output. | + | ++++Tuner frequency up| This command will allow to raise the tuner frequency. |
+ | ++++ | ||
- | == Bass down selected output == | + | ++++Tuner frequency |
+ | ++++ | ||
- | Lower low frequencies | + | ++++Tuner up| This command will allow to scan for the next tuner station. |
+ | ++++ | ||
- | == Treble up main output == | + | ++++Tuner down| This command will allow to scan for the previous tuner station. |
+ | ++++ | ||
- | Raise high frequencies for the main output. | + | ++++Tuner auto search| |
+ | ++++ | ||
- | == Treble down main output == | + | ++++Tuner stop search| |
+ | ++++ | ||
- | Lower high frequencies | + | ++++Select digital mode for main output| This command will allow to select the digital mode on the device. |
+ | * **Digital Mode** | ||
+ | ++++ | ||
- | == Move OSD cursor up == | + | ++++Select surround mode for main output| |
+ | * **Digital Mode** | ||
+ | ++++ | ||
- | Move OSD up | + | ++++Remote setup menu show/ |
+ | * **OSD Setup** 1=show OSD menu, 0=hide OSD menu. | ||
+ | ++++ | ||
- | == Move OSD cursor | + | ++++Remote press cursor |
+ | ++++ | ||
- | Move l’OSD | + | ++++Remote press cursor |
+ | ++++ | ||
- | == Move OSD cursor right == | + | ++++Remote press cursor right| This command will simulate the remote control command " |
+ | ++++ | ||
- | Move l’OSD right | + | ++++Remote press cursor left| This command will simulate the remote control command " |
+ | ++++ | ||
- | == Move OSD cursor left == | + | ++++Remote press Enter button| |
+ | ++++ | ||
- | Move l’OSD left | + | ++++Remote press Back/Return button| |
+ | ++++ | ||
- | == Select Source for main output == | + | ++++Remote press Option button| |
+ | ++++ | ||
- | Select source for the main output. | + | ++++Remote press Info button| |
- | + | ++++ | |
- | == Select audio source for selected main source == | + | |
- | + | ||
- | Select audio source for main source. | + | |
- | + | ||
- | == Select video source for selected main source == | + | |
- | + | ||
- | Select video source for main source. | + | |
- | + | ||
- | == Read tuner frequency == | + | |
- | + | ||
- | Read tuner frequency. | + | |
- | + | ||
- | == Read tuner station == | + | |
- | + | ||
- | Read tuner station. | + | |
- | + | ||
- | == Tuner Frequency up == | + | |
- | + | ||
- | Tuner frequency up. | + | |
- | + | ||
- | == Tuner Frequency down == | + | |
- | + | ||
- | Tuner frequency down. | + | |
- | + | ||
- | == Tuner Preset up == | + | |
- | + | ||
- | Change to next preset. | + | |
- | + | ||
- | == Tuner Preset down == | + | |
- | + | ||
- | Change to previous preset. | + | |
- | + | ||
- | == Tuner auto search == | + | |
- | + | ||
- | Tuner auto search. | + | |
- | + | ||
- | == Tuner stop sarch == | + | |
- | + | ||
- | Tuner stop search. | + | |
- | + | ||
- | == Press Enter button | + | |
- | + | ||
- | Press Enter button on OSD. | + | |
- | + | ||
- | == Select Digital mode for main output == | + | |
- | + | ||
- | Select digital mode for main output. | + | |
- | + | ||
- | == Select Surround mode for main output == | + | |
- | + | ||
- | Select surround mode for main output. | + | |
+ | ++++Send a custom command| | ||
+ | * **Command to send to the device** refer to the Denon/ | ||
+ | ++++ | ||
===== Sonos Zone Player (Obsolete) ===== | ===== Sonos Zone Player (Obsolete) ===== | ||
Line 1674: | Line 2572: | ||
Plays audio from a streaming webradio: the streaming 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. | ||
- | ===== Mediaplayer | + | ===== Media Player |
{{ : | {{ : | ||
Line 1690: | Line 2588: | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
- | == Navigate up in the user interface | + | ++++ Navigate up in the user interface| Simulates the $\uparrow$ command. |
- | + | ++++ | |
- | Simulates the $\uparrow$ command. | + | |
- | + | ||
- | == Navigate down in the user interface == | + | |
- | + | ||
- | Simulates the $\downarrow$ command. | + | |
- | + | ||
- | == Navigate right in the user interface == | + | |
- | + | ||
- | Simulates the $\rightarrow$ command. | + | |
- | + | ||
- | == Navigate left in the user interface == | + | |
- | + | ||
- | Simulates the $\leftarrow$ command. | + | |
- | + | ||
- | == Select current item in the user interface == | + | |
- | + | ||
- | Select the current object in the user interface. (It simulates the ”OK” or ”Enter” command) | + | |
- | + | ||
- | == Goes back in the user interface == | + | |
- | + | ||
- | Return to the previous page; it simulates the ”Return” or ”Back” command. | + | |
- | + | ||
- | == Shows the context menu in the user interface == | + | |
- | + | ||
- | Visualise the current object menu; it simulates the ”Menu” button. | + | |
- | + | ||
- | == Shows the information dialogue == | + | |
- | + | ||
- | Displays a pop-up with the information related to the current program; it simulates the ”Info” button. | + | |
- | + | ||
- | == Goes to GUI homepage == | + | |
- | + | ||
- | Redirects to the GUI homepage; it simulates the ”Home” button. | + | |
- | + | ||
- | == Shows the on-screen display for the current player == | + | |
- | + | ||
- | Visualise a pop-up with the on-screen display for the current player. | + | |
- | + | ||
- | == Starts playback of a single file or an item from the database == | + | |
- | + | ||
- | Launches a specified file; the file path can be specified by adjusting the ”File path” parameter on the right. | + | |
- | + | ||
- | == Play/Pause the player == | + | |
- | + | ||
- | Play or pause the current player. | + | |
- | + | ||
- | == Stop the player == | + | |
- | + | ||
- | Stops the player. | + | |
- | + | ||
- | == Skip the current track and play the next one == | + | |
- | + | ||
- | Skips the current track and directly play the next one. | + | |
- | + | ||
- | == Skip the current track and play the previous one == | + | |
- | + | ||
- | Skips the current track and directly play the next one. | + | |
- | + | ||
- | == Make a step forward on the current playing element == | + | |
- | + | ||
- | Fast forward the current playing element. | + | |
- | + | ||
- | == Make a step backward on the current playing element == | + | |
- | + | ||
- | Fast backward the current playing element. | + | |
- | + | ||
- | == Raise the volume of the player == | + | |
- | + | ||
- | Turns the volume up. | + | |
- | + | ||
- | == Lower the volume of the player == | + | |
- | + | ||
- | Turns the volume down. | + | |
+ | ++++ Navigate down in the user interface | Simulates the $\downarrow$ command. | ||
+ | ++++ | ||
+ | ++++ Navigate right in the user interface | Simulates the $\rightarrow$ command. | ||
+ | ++++ | ||
+ | ++++ Navigate left in the user interface | Simulates the $\leftarrow$ command. | ||
+ | ++++ | ||
+ | ++++ Select current item in the user interface | Select the current object in the user interface. (It simulates the ”OK” or ”Enter” command) | ||
+ | ++++ | ||
+ | ++++ Goes back in the user interface | Return to the previous page; it simulates the ”Return” or ”Back” command. | ||
+ | ++++ | ||
+ | ++++ Shows the context menu in the user interface | Visualise the current object menu; it simulates the ”Menu” button. | ||
+ | ++++ | ||
+ | ++++ Shows the information dialogue | Displays a pop-up with the information related to the current program; it simulates the ”Info” button. | ||
+ | ++++ | ||
+ | ++++ Goes to GUI homepage | Redirects to the GUI homepage; it simulates the ”Home” button. | ||
+ | ++++ | ||
+ | ++++ Shows the on-screen display for the current player | Visualise a pop-up with the on-screen display for the current player. | ||
+ | ++++ | ||
+ | ++++ Starts playback of a single file or an item from the database | Launches a specified file; the file path can be specified by adjusting the ”File path” parameter on the right. | ||
+ | ++++ | ||
+ | ++++ Play/Pause the player | Play or pause the current player. | ||
+ | ++++ | ||
+ | ++++ Stop the player | Stops the player. | ||
+ | ++++ | ||
+ | ++++ Skip the current track and play the next one | Skips the current track and directly play the next one. | ||
+ | ++++ | ||
+ | ++++ Skip the current track and play the previous one | Skips the current track and directly play the next one. | ||
+ | ++++ | ||
+ | ++++ Make a step forward on the current playing element | Fast forward the current playing element. | ||
+ | ++++ | ||
+ | ++++ Make a step backward on the current playing element | Fast backward the current playing element. | ||
+ | ++++ | ||
+ | ++++ Raise the volume of the player | Turns the volume up. | ||
+ | ++++ | ||
+ | ++++ Lower the volume of the player | Turns the volume down. | ||
+ | ++++ | ||
===== Sonos Manager ===== | ===== Sonos Manager ===== | ||
Line 1771: | Line 2632: | ||
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 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. | ||
+ | |||
+ | <WRAP important center align round 80%> This object is currently tested with Sonos S1 system. For more information on S2, contact our support team. </ | ||
* **Players** Sonos players configured in ThinKnx system. | * **Players** Sonos players configured in ThinKnx system. | ||
Line 1829: | Line 2692: | ||
Commands sent to the Sonos Player and recallable from other objects: | Commands sent to the Sonos Player and recallable from other objects: | ||
- | == Put the device in PLAY state == | + | ++++Put the device in PLAY state| This command will allow to play music on the selected player. |
+ | ++++ | ||
- | Allows | + | ++++Put the device in STOP state| |
+ | ++++ | ||
- | == Put the device | + | ++++Volume up the device| This command will allow to raise the volume on the selected player. |
+ | ++++ | ||
- | Allows | + | ++++Volume down the device| |
+ | ++++ | ||
- | == Volume up the device == | + | ++++Skip track forward| |
+ | ++++ | ||
- | Allows to increase the Sonos Player volume. | + | ++++Skip track backward| This command will allow to play the previous track. |
- | + | ++++ | |
- | == Volume down the device == | + | |
- | + | ||
- | Allows to decrease the Sonos Player volume. | + | |
- | + | ||
- | == Set value for volume == | + | |
- | + | ||
- | Allows to directly set the value of the volume of the Sonos Player; the volume value [0-100] can be adjusted by editing the parameter on the right. | + | |
- | + | ||
- | == Skip track forward == | + | |
- | + | ||
- | Allows to skip to the next track in the Sonos Player queue. | + | |
- | + | ||
- | == Skip track backward | + | |
- | + | ||
- | Allows to skip to the previous track in the Sonos Player queue. | + | |
- | + | ||
- | == Put the device in MUTE state == | + | |
- | + | ||
- | Allows to set the Mute status on the Sonos Player; the parameter on the right indicates whether to Mute (1) or Unmute (0) the device. | + | |
- | + | ||
- | == Play the audio from AUDIO-IN plug == | + | |
- | + | ||
- | Starts playing from Audio-in source. | + | |
- | + | ||
- | == Play the audio from another player’s AUDIO-IN plug == | + | |
- | + | ||
- | Starts playing from the Audio-in source of a different player; to specify the player adjust the parameter on the right specifying the unique identifier of the source player (refer to Sonos Player properties). | + | |
- | + | ||
- | == Play the audio from a network file == | + | |
- | + | ||
- | Starts playing from a network file source; the url of the file source must be adjusted in the parameter on the right, using the format // | + | |
- | + | ||
- | == Play the audio from a streaming == | + | |
- | Starts playing from a streaming source; the streaming url must be adjusted in the parameter on the right, using the format // | + | ++++Set value for volume| |
+ | * **Desired Volume** value between 0 and 100. | ||
+ | ++++ | ||
- | == Enable/Disable Repeat PlayMode | + | ++++Put the device in MUTE state| |
+ | * **Mute value** 1=unmuted, 0=muted. | ||
+ | ++++ | ||
- | Allows | + | ++++Play the audio from Audio IN plug| This command will allow to play the music coming from the analog input of the player. |
+ | ++++ | ||
- | == Enable/ | + | ++++Play the audio from another player Audio IN plug| This command will allow to play the music coming from the analog input of another player player. |
+ | * **Zone player unique identifier** this identifier can be found when accessing the Sonos Manager in System and going to the Players collection. | ||
+ | ++++ | ||
- | Allows to set the playing modality; the parameter | + | ++++Play |
+ | * **File URL** should follow | ||
+ | ++++ | ||
- | == Start a playlist | + | ++++Play the audio from a streaming| |
+ | * **Streaming URL** should follow the form < | ||
+ | ++++ | ||
- | Recalls the playlist to play; the parameter on the right indicates the number of the desired playlist. | + | ++++Enable/ |
+ | * **Repeat value** 1=enabled, 0-disabled. | ||
+ | ++++ | ||
- | == Start a playlist from its name == | + | ++++Enable/ |
+ | * **Shuffle value** 1=enabled, 0-disabled. | ||
+ | ++++ | ||
- | Recalls the playlist to play; the parameter on the right indicates the name of the desired playlist. | + | ++++Start a Playlist from its number| |
+ | * **Playlist number** | ||
+ | ++++ | ||
- | == Start a favorite | + | ++++Start a Playlist |
+ | * **Playlist name** | ||
+ | ++++ | ||
- | Recalls the favorite | + | ++++Play a favorite |
+ | * **Favorite | ||
+ | ++++ | ||
==== Sonos Topology commands ==== | ==== Sonos Topology commands ==== | ||
Line 1911: | Line 2767: | ||
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. | 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. | ||
- | * **IR commands** List of IR commands, | + | * **IR commands** List of IR commands. Commands should be created manually in the IR Commands Editor. For each one, it is either possible to insert the code directly, or link it to an existing code from the imported database under " |
- | * **Remotes directory** This property allows to choose from a list of remotes | + | * **IR device model** Select the brand of the IR transmitter used. The user can choose between **IR Trans Transmitter** or **Global Caché Transmitter**. |
+ | * **Remotes directory** This property allows to import | ||
* **Copy in project** If this property is enabled, the system automatically saves the remotes files in the project folders. | * **Copy in project** If this property is enabled, the system automatically saves the remotes files in the project folders. | ||
* **Check for update** If this property is enabled, the system automatically checks if the remotes files are updated and immediately updates them if they are not. | * **Check for update** If this property is enabled, the system automatically checks if the remotes files are updated and immediately updates them if they are not. | ||
- | * **IP address** | + | * **IP address** IP address |
==== Adding IR commands ==== | ==== Adding IR commands ==== | ||
Line 1921: | Line 2778: | ||
Click on the button displayed on the right to open the actions editor window, click on ”Add” and adjust the properties in the grid: | Click on the button displayed on the right to open the actions editor window, click on ”Add” and adjust the properties in the grid: | ||
- | * **Alias** Alternative name used to recall the IR command. | + | * **Label** Label of text that identify this command |
- | * **Remote** Remote control which the IR Trans file has been taken from. | + | * **Alias** Alias of the command that has to be used to recall this IR command. |
- | * **Command** Command name. | + | |
- | ==== Importing and exporting | + | === Manually add IR data === |
+ | * **Remote** Leave this field empty in case you have an IR code that you are adding manually. | ||
+ | * **Command** Leave this field empty in case you have an IR code that you are adding manually. | ||
+ | * **Command Data** Content of the command in code language. In case Global Caché was selected, the command format should match the one adopted by Global Caché. If this is not the case, it is possible to convert the command using the **iConvert** tool provided by Global Caché - [[https:// | ||
+ | |||
+ | === Link command to an imported list === | ||
+ | <WRAP important round center 80%> It is important to have the remotes files saved into the remote directory selected previously. | ||
+ | * In case of a Global Caché remote file, please remove the extension " | ||
+ | * In case of IR Trans remote file, make sure to place the " | ||
+ | </ | ||
+ | * **Remote** Select the remote file available in the directory configured under " | ||
+ | * **Command** Select the IR command from the remote selected in the previous field. | ||
+ | * **Command Data** This data is automatically filled once the IR command is selected. | ||
+ | ==== Import/ | ||
This feature allows to export a list of IR commands previously created in a project and import it in another project. | This feature allows to export a list of IR commands previously created in a project and import it in another project. | ||
Line 1939: | Line 2808: | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
- | == Send the selected command for the selected remote | + | ++++Send the selected command for the selected remote| This command will allow to send an IR command |
- | + | ||
- | Allows | + | |
- | To create a sequence select the desired | + | |
{{ :: | {{ :: | ||
- | If you want to selected | + | If you want to select |
{{ :: | {{ :: | ||
It is possible to create complex macro of IR operations simply enqueuing more commands. Commands can be separated by pause adding the ”Make pause” item in order to grant a better reception. The sequence displayed in the box on the bottom of the page can be edited by deleting single items or moving them by clicking on ”Up” and ”Down” buttons. | It is possible to create complex macro of IR operations simply enqueuing more commands. Commands can be separated by pause adding the ”Make pause” item in order to grant a better reception. The sequence displayed in the box on the bottom of the page can be edited by deleting single items or moving them by clicking on ”Up” and ”Down” buttons. | ||
{{ :: | {{ :: | ||
+ | ++++ | ||
- | ===== Logic Module ===== | ||
- | {{ : | ||
- | 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|Logic Module section]]. | ||
- | * **Schemes** List of schemes, each element represents a fully working block diagram. | ||
- | ===== IFTTT ===== | ||
- | {{ : | ||
- | 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|IFTTT section]]. | ||
- | * **Label** Text label to identify the object | ||
- | * **Webhook Key** Webhook key of the user account to use to communicate with IFTTT service. Can be obtained visiting this URL: < | ||
- | |||
- | ===== Voice Control Gateway ===== | ||
- | |||
- | {{ : | ||
- | |||
- | 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|Voice Control Gateway section]]. | ||
- | |||
- | * **Label** Text label to identify the object | ||
- | * **Lights** Holds the collection of Light objects added | ||
- | * **Rollers Shutters** Holds the collection of Shutter objects added | ||
- | * **Thermo Comfort** Holds the collection of Thermo Comfort objects added | ||
- | * **Scenes** Holds the collection of Scene objects added |