system_objs

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
system_objs [2019/09/09 11:36] – [Lutron] ingridsystem_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]]
 +    *[[#ets_project| ETS Project]] 
 +  * [[#internal_services| Internal Services]]
 +    * [[#scene| Scene]]
 +    * [[#HVAC_controller| HVAC Controller]]
 +    * [[#Switch_schedule| Switch Schedule]]
 +    * [[#calendar_(obsolete)| Calendar (obsolete)]]
 +    * [[#Voip_PBX_and_Doorcom| VoIP PBX and Doorcom]]
 +    * [[#chronothermostat| Chronothermostat]]
 +    * [[#Irrigation| Irrigation]]
 +    * [[#RGB| RGB]]
 +    * [[#email_account| Email Account]]
 +    * [[#thinknx_sensors| Thinknx Sensors]]
 +    * [[#web_ui| Web UI]]
 +    * [[#Presence_simulator| Presence Simulator]]
 +    * [[#Sun_times_and_events| Sun Times and Events]]
 +  * [[#Security| Security]]
 +    * [[#alarm_device| Alarm Device]]
 +    * [[#access_control| Access Control (beta)]]
 +  * [[#Logic| Logic]]
 +    * [[#combination| Combination]]
 +    * [[#filter| Filter]]
 +    * [[#Multiplexer| Multiplexer]]
 +    * [[#logic_matrix| Logic Matrix]]
 +    * [[#linear_combination| Linear Combination]]
 +    * [[#logic_module| Logic Module]]
 +    * [[#complex_maths_expressions| Complex Maths Expressions]]
 +    * [[#KNX_variables| KNX Variables]]
 +    * [[#database| Database]]
 + </WRAP>
 +<WRAP column half>
  
-===== System Object =====+  * [[#Reports_and_gateways| Reports and Gateways]] 
 +    * [[#Report| Report]] 
 +    * [[#Hue_gateway| Hue Gateway]] 
 +    * [[#load_control| Load Control]] 
 +    * [[#Gateway_modbus| Gateway Modbus]] 
 +    * [[#Gateway_modbus_slave| Gateway Modbus Slave]] 
 +    * [[#gateway_duotecno| Gateway Duotecno]] 
 +    * [[#gateway_myhome| Gateway MyHome]] 
 +    * [[#z-wave_controller| Zwave Controller]] 
 +    * [[#velux_gateway| Velux Gateway]] 
 +    * [[#iroom_controller| iRoom Controller]] 
 +    * [[#universal_gateway| Universal Gateway]] 
 +    * [[#sms_gateway| SMS Gateway]] 
 +    * [[#Lutron| Lutron Project]] 
 +    * [[#Gateway_tiemme| Gateway Tiemme]] 
 +    * [[#serial_gateway| Serial Gateway]] 
 +    * [[#ethernet_gateway| Ethernet Gateway]] //<color red>new!</color>// 
 +    * [[#P1_meter_interface| P1 Meter]] 
 +    * [[#generic_counter| Generic Counter]] 
 +    * [[#voice_control_gateway| Voice Control Gateway]] 
 +    * [[#IFTTT_account| IFTTT Account]] 
 +    * [[#tester| Tester]] 
 +    * [[#openweathermap| OpenWeatherMap]] //<color red>new!</color>// 
 +    * [[#mqtt_server| MQTT Server]] //<color red> new! </color>// 
 +    * [[#mqtt_client| MQTT Client]] //<color red> new! </color>// 
 + 
 +  * [[#Multimedia| Multimedia]] 
 +    * [[#video_matrix| Video Matrix]] 
 +    * [[#audio_matrix| Audio Matrix]] 
 +    * [[#display| Display]] 
 +    * [[#Home_theater| Home Theater]] 
 +    * [[#Sonos_Zone_Player_(Obsolete)| Sonos Zone Player (obsolete)]] 
 +    * [[#media_player| Media Player]] 
 +    * [[#sonos_manager| Sonos Manager]] 
 +    * [[#ir_transmitter| IR Transmitter]] 
 +</WRAP> 
 +</WRAP> 
 +====== System ======
  
 {{ :system_obj_-_systemnode2.png?nolink&100 |}} {{ :system_obj_-_systemnode2.png?nolink&100 |}}
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#Licences|section 2.1.3]] . +  * **Licenses** Active licences for the current project, for more details refer to [[main_cons_ui#Licences|Thinknx Configurator - Licenses]] . 
-  * **Users and Groups** Groups and users for the customized exporting process, for more details refer to [[main_cons_ui#creating_editing_and_deleting_users|section 2.1.4]] . +  * **Users and Groups** Groups and users for the customized exporting process, for more details refer to [[main_cons_ui#users_and_groups|Thinknx Configurator - Users and Groups]] . 
-  * **Protection PINs** List of PINs used to protect interface objects, for more details refer to [[main_cons_ui#Protection_PINs|section 2.1.7]]. +  * **Protection PINs** List of PINs used to protect interface objects, for more details refer to [[main_cons_ui#Protection_PINs|Thinknx Configurator - Protection PINs]].
-==== 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|  This command is used to send a 1 bit value to the KNX bus.
 +    * **KNX Group** Group address to sen the value.
 +    * **KNX value** Can be either 1 or 0.
  
-== Send KNX Bit telegram==+++++ 
 +++++Send KNX Byte Telegram|  This command is used to send a 1 byte value to the KNX bus. 
 +   * **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|  This command is used to send a 2 byte float value to the KNX bus. 
 +  * **KNX Group** Group address to send the value. 
 +  * **KNX value** Can be a value between -671088,64 and 670760,96. 
 +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|  This command is used to send a 4 byte float value to the KNX bus. 
 +  * **KNX Group** Group address to send the value. 
 +  * **KNX value**  
 +++++ 
 +++++Send KNX String Telegram|  This command is used to send a string of 14 bytes to the KNX bus. 
 +  * **KNX Group** Group address to send the value. 
 +  * **KNX value** string text to be entered. 
 +++++ 
 +++++Send KNX 4 Bit Telegram|  This command is used to send a 4 bit value to the KNX bus. 
 +  * **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|  This command is used to read a value from the KNX bus. 
 +  * **KNX Group** Group address to read the value from. 
 +++++  
 +++++Make a pause for a fixed interval|  This command pauses the system for a specified time interval configurable in milliseconds. 
 +  * **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 PageGENERAL| 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/disable the receipt of push notifications for each client. 
 +   * **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!". If the 1-bit is being sent periodically to the bus with a small interval, then a maximum number of push notifications can be inserted in the related parameter. 
 +<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).</WRAP> 
 +++++ 
 +++++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, for example http://www.google.com will automatically browse the google safari page. Another example is typing <nowiki>sonos://</nowiki> to open the SONOS app. 
 +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's house is empty and a presence has been detected inside (1-bit KNX telegram), a scenario can be programmed on the Universal Gateway to send an email to the owner of the house.
  
-This command is used to send a bit value; adjust the ”KNX group” and ”KNX value” (0 or 1) parameters displayed on the right.+<wrap important>// This command might not work properly. Instead, add an Email Account under System tab, and select the command "send email to recipient" that can be found in the Internal Services. See [[system_objs#email_account| this section]] for more information. //</wrap> 
 +++++ 
 +++++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 "#", depending on the application. 
 +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 on all clients. 
 +++++  
 +++++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.+{{ :system_obj_-_ets.png?nolink&100 |}}
  
-== 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 "Automatic Encoding"
 +  * **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 "-X", where X Interface number. For example, group 0/0/1-1 controls the light on Interface-1, while group 0/0/1-2 controls the light on Interface 2. For each interface added in the editor, the below parameters are available: 
 +    * **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 the ”KNX group” and ”KNX value” parameters.+<WRAP round center 80% tip>If the suffix "-255" is used, the telegram will be sent to all the configured interfaces.</WRAP>
  
-== Send KNX Float Byte Telegram==+{{ :ets_project_3@3x.png?direct&800 |Secondary interfaces communication}} 
 +<WRAP center 60%> <WRAP centeralign> Figure 2.4.1Secondary interfaces communication </WRAP>  </WRAP>
  
-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%%//%%www.google.com will automatically browse the google safari page). 
- 
-== 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 ===== 
- 
-{{ :system_obj_-_ets.png?nolink&100 |}} 
- 
-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. 
  
 +  
 +{{ :ets_project.png?direct&850 |Secondary interface configuration}}
 +<WRAP center 60%> <WRAP centeralign> Figure 2.4.2: Secondary interface configuration</WRAP>  </WRAP>
 ==== Exporting .csv from ETS ==== ==== Exporting .csv from ETS ====
  
Line 106: Line 230:
  
 {{ :system_obj_-_figura1.png?direct&400 |ETS 3 export parameters}} {{ :system_obj_-_figura1.png?direct&400 |ETS 3 export parameters}}
-<WRAP center 60%> <WRAP centeralign> Figure 4.1: ETS 3 export parameters </WRAP>  </WRAP>+<WRAP center 60%> <WRAP centeralign> Figure 4.3: ETS 3 export parameters </WRAP>  </WRAP>
  
  
Line 114: Line 238:
 From the ETS application, click on “Other -> Export OPC”: the generated “.esf” file can be imported in the Configurator at a later time. From the ETS application, click on “Other -> Export OPC”: the generated “.esf” file can be imported in the Configurator at a later time.
  
 +
 +
 +
 +====== 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#scene| Scene icon]] in the user interface, or used internally with the logic module, universal gateway and others. 
  
   * **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; when the scenery is launched from KNX, this property has to be disabled because of telegram repetitions.   * **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; when the scenery is launched from KNX, this property has to be disabled because of telegram repetitions.
   * **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. </WRAP>
  
 ==== 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|  This command will allow to play the selected scene.
 +++++
 +++++Sop scenery execution|  This command will allow to stop a scene during execution.
 +++++
  
-== Launch scenery == 
- 
-Launches the selected scene. 
- 
-== Stop scenery execution == 
- 
-Stops the selected scene. 
- 
-===== Calendar ===== 
- 
-{{ :system_obj_-_calendar.png?nolink&100 |}} 
- 
-This server service allows the user to program on/off KNX commands (switch objects) using client applications; it is also possible to memorize the temporization on server. Different switches can be associated to the same calendar. 
- 
-  * **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:// Device IP address has to be typed in the empty slot to use this controller+    * //**Mitsubishi AG 150:**// This controller permits to interact with **Mitsubishi G50**, **AG150** and newer controllers such as **AE-200E** or the **EW-50E** with Mitsubishi XML protocol (this protocol needs to be enabled on the Mitsubishi side)
-    * //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.\\  
 +    * //**CoolMaster Net:**// This controller permits to talk with CoolAutomation devices via Ethernet. 
        
-  If Controller type is Mitsubishi AG 150” the following property will appear to define the device address:\\  +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. 
-      * **IP address** HVAC controller IP address.\\+    
 +==== 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 requires the Automation License. </WRAP> 
 +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. 
 + 
 +{{ :cmn.png?direct&400 |CoolMaster Net}} 
 + 
 +On the system node the following properties will appear:\\ 
 +    * **IP address** HVAC Controller IP address. 
 +    * **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 device
 +    * //**Name:**// Device label 
 +    * //**Internal unit ID:**// unit identification from CoolMasterNet manual. The format should be Ln.xyz. For example, for indoor unit 3 on line 2, ID will be L2.003. To control multiple units on the line, "*" can be used. Please refer to CoolAutomation documentation for more details on the internal devices naming conventions. 
 +    * //**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:**// if enabled, the regulator features will be active. This way, the object will act as a thermostat.
  
-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. </WRAP>
 +If Controller type is ”//**Mitsubishi AG 150**//” the following property will appear to define the device address:\\ 
 +    * **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) =====
 +
 +{{ :system_obj_-_calendar.png?nolink&100 |}}
 +
 +This server service allows the user to program on/off KNX commands (switch objects) using client applications; it is also possible to memorize the temporization on server. Different switches can be associated to the same calendar.
 +
 +  * **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 =====
 +
 +{{ :system_obj_-_voip.png?nolink&100 |}}
 +
 +Every Thinknx server embeds a software VOIP telephony PBX. It is optimized for the VOIP functionalities between clients and door communication. This system object allows to configure the PBX (extensions, ring groups and door stations). For more information, please refer to our Voip PBX and Doorcom guide [[pbx_doorcom|here]].
  
 ===== 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/Disable the Chrono modality|  This command allows to activate/deactivate the control of the setpoint from the schedule configured by the client 
-{{ :system_obj_-_voip.png?nolink&100 |}} +  * **Enable/Disable** send 1 to enable and 0 to disable
- +++++
-Every Thinknx server embeds a software VOIP telephony PBX. It is optimized for the VOIP functionalities between clients and door communication. This system object allows to configure the PBX (extensions, ring groups and door stations)For more information, please refer to our Voip PBX and Doorcom guide [[pbx_doorcom|here]]+
 ===== 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/Disable the Chrono modality|  This command allows to activate/deactivate the functioning of the irrigation zones from the schedule configured by the client. 
 +++++
 ===== 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", 8 groups are defined in order to write and read values for each 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", just 2 groups are defined for a single RGBW
 +    * 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's relay where the power supply of the RGB light has been connected. This will allow to remove power from the light.
 ==== 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 sequence in a random order; adjust the ”Time” parameter on the right to select the time interval between two consecutive colours.+++++Start RGB sequence repeat with time in seconds|  This command allows to play sequence of all the favorite colors in order and repeat them once done, while defining the time to switch from one color to another. 
 +  * **Time** interval before switching to a new color, in seconds 
 +++++
  
-== Start RGB sequence repeat with time in seconds ==+++++Stop RGB sequence and turn OFF|  This command allows to stop an already launched sequence and turn off the RGB light. 
 +++++
  
-Repeats the preconfigured colour sequence following the defined order; adjust the ”Time” parameter on the right to select the time interval between two consecutive colours.+++++Save the current color to the selected preset position|  This command allows to save the current color to one of the available slots in Favorites. 
 +  * **Preset position** number of the slot where the color should be saved (value between 0-9). 
 +++++
  
-== Stop the RGB sequence and turn off == +++++Recall the color previously saved to the selected preset position|  This command allows to switch the color of the RGB lights into the color saved in the requested slot below. 
- +  * **Preset position** number of the slot corresponding to the desired color (value between 0-9). 
-Stops the repetition of the colour sequence and turns the RGB lamp off.+++++
  
 ===== Email account ===== ===== Email account =====
Line 372: Line 567:
     * 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 ("my_email@gmail.com")     * 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 ("my_email@gmail.com")
     * Password: Password of the e-mail account.     * Password: Password of the e-mail account.
-  * **Use SSL** If enabled, use SSL encription to connect with the server. Must be enabled with Gmail.+  * **Use SSL** If enabled, use encryption to connect with the server. The server will use TLS to communicate with the SMTP mail server since TLS is an upgrade of SSL. When server port is configured as 587, it also enables the STARTTLS protocol that is the default one for that port. This parameter must be enabled with Gmail.  
 + 
 +As an example when using Google to send emails from Thinknx Server, it is recommended that you enable the "2-step verification" from your Google Account at https://myaccount.google.com/security. 
 +A new option will appear to create additional passwords to allow third-party applications to sign in. By generating a new password for Thinknx, you can use this password to send emails from the server without the need to enable the "less secure apps access". It is only necessary to enable this options when the 2-step verification is also disabled. In that case, the user will need to use the main Google password to send emails. 
 +<WRAP centeralign>{{ :google_acount2.png?direct600 |Google Account Settings}}</WRAP> 
 +<WRAP center 60%> <WRAP centeralign> Google Account Settings </WRAP></WRAP> 
 +<WRAP centeralign>{{ :google_acount1.png?direct600 |Google Account Settings}}</WRAP> 
 +<WRAP center 60%> <WRAP centeralign> Google Account Settings </WRAP></WRAP> 
 + 
 +The same concept applies when trying to send emails from the iCloud address, where it is necessary to generate an "app-specific password" from the account settings on iCloud.
  
-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 https://myaccount.google.com/security. 
-  * Sign into your account. 
-  * Scroll down to the "Less secure app access" section. If you are using the 2-step verification when signing in, you will not be able to see this section. Disable the 2-step verification option in order to enable the "Less secure app access". 
-  * Turn this option "ON". 
  
 After configuring the Email Account in System, you can now send emails through a generic button or using the Report object as well. 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 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.   * 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/username).
 +
 ==== 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|  This command allows to send an email to a group of recipients.
 +  * **Email subject** 
 +  * **Email recipients** separate the emails using " ; ".
 +  * **Email content** body of the email.
 +++++
  
-== Send Email to recipients ==+===== Thinknx Sensors ===== 
 +This object allows to configure Thinknx sensors (temperature, humidity, luminosity) available on other servers such as the Envision, in addition to configuring different types of Inputs/Outputs found for example on the new Compact_20, as well as the Envision_20. 
 + 
 +  * **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/Output Type** Select type of Input/Output to be configured. 
 +    * 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, visit [[port_numbers| this guide]]. 
 +  * **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, visit [[port_numbers| this guide]]. 
 + 
 +If **Digital Output** is selected, the below parameters are available: 
 +  * **Output Number** number of the output on the server. For more information, visit [[port_numbers| this guide]]. 
 +  * **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, Light, and Humidity sensors. 
 + 
 +If **Relay Output** is selected, the below parameters are available: 
 +  * **Output Number** number of the output on the server. For more information, visit [[port_numbers| this guide]]. 
 +  * **Output Type**  
 + 
 +If **Temperature Probe** is selected, the below parameters are available: 
 +  * **Input Number** number of the output on the server. For more information, visit [[port_numbers| this guide]]. 
 +  * **Probe Type**  select between NTC, PTC, PT100 and PT1000. 
 +  * **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 ==== 
 + 
 +Commands recallable from other objects: 
 +++++Get the actual humidity|  This command allows read the humidity value from the selected sensor 
 +++++ 
 +++++Get the actual luminosity|  This command allows read the luminosity value from the selected sensor 
 +++++ 
 +++++Get the actual temperature|  This command allows read the temperature value from the selected sensor 
 +++++
  
-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 445: 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|  This command allows to start playing the presence simulation configured in the Presence Simulation object in System.
 +++++
 +++++Stop the presence simulation|  This command allows to stop playing the presence simulation configured in the Presence Simulation object in System.
 +++++
  
-== 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 485: 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 493: Line 747:
  
  
 +
 +===== Access Control =====
 +The Thinknx Access Control object permits to enhance the level of automation and security of the home/building where it is applied. It can be adapted to sectors where long term expirations are required such as service and industry sectors, but also applies to the hospitality sector where credentials are usually short term, and remote management is required.
 +For more information, check out the Access Control page [[access_control| here]].
 +
 +====== Logic ======
 ===== Combination ===== ===== Combination =====
  
Line 571: Line 831:
     * //’On result change’:// indicates that the value is sent only when the result of the operation is different from the previous one.     * //’On result change’:// indicates that the value is sent only when the result of the operation is different from the previous one.
     * //’When a new input telegram is received’:// indicates that the value is sent whenever the server receives a telegram from on of the KNX groups specified in the inputs.     * //’When a new input telegram is received’:// indicates that the value is sent whenever the server receives a telegram from on of the KNX groups specified in the inputs.
-  * **Gate** This property enables or disables the operation. See [[system_objs#Combination|section 4.16]] .+  * **Gate** This property enables or disables the operation. See [[system_objs#Combination|System - Combination]] .
  
 ===== Multiplexer ===== ===== Multiplexer =====
Line 597: Line 857:
     * //’0 until first telegram’:// indicates that the control bit takes value 0 until the receiving of the first telegram.     * //’0 until first telegram’:// indicates that the control bit takes value 0 until the receiving of the first telegram.
     * //’1 until first telegram’:// indicates that the control bit takes value 1 until the receiving of the first telegram.     * //’1 until first telegram’:// indicates that the control bit takes value 1 until the receiving of the first telegram.
-  * **Gate** This property enables or disables the operation. See [[system_objs#Combination|section 4.16]] .+  * **Gate** This property enables or disables the operation. See [[system_objs#Combination|System - Combination]] .
  
 ===== Logic Matrix ===== ===== Logic Matrix =====
Line 614: 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#Combination|section 4.16]] .+  * **Gate** This property enables or disables the operation. See [[system_objs#Combination|System - Combination]] .
  
 ==== Adding an input ==== ==== Adding an input ====
Line 659: 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 maths expressions =====+===== Logic Module ===== 
 + 
 +{{ :logicmodule.png?nolink&100 |}} 
 + 
 +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 Maths Expressions =====
  
 {{ :system_obj_-_complex.png?nolink&100 |}} {{ :system_obj_-_complex.png?nolink&100 |}}
Line 758: Line 1026:
 {{ :system_obj_-_server.png?nolink&100 |}} {{ :system_obj_-_server.png?nolink&100 |}}
  
-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#chart| Chart interface object]].
  
 <WRAP center round important 60%> <WRAP center round important 60%>
Line 809: Line 1077:
 </WRAP> </WRAP>
  
 +====== Reports and Gateways ======
 ===== Report ===== ===== Report =====
  
Line 932: 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|  This command allows to set the desired value for the dimmer through a single parameter which can assume a value between 0 and 255. 
 +  * **Value** can be between 0 and 255. 
 +++++ 
 +++++Set the element color temperature (white)|  This command allows to set the element color temperature.  
 +  * **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)|  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. 
 +  * **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 ===== 
- 
-{{ :system_obj_-_bticino.png?nolink&100 |}} 
- 
-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 989: Line 1245:
 {{ :system_obj_-_modbus.png?nolink&100 |}} {{ :system_obj_-_modbus.png?nolink&100 |}}
  
-It allows to integrate Modbus devices.+This object allows to communicate with Modbus devices when Thinknx server is used as a Modbus Master. 
 + 
 +<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/commands from the Master. A Modbus Slave cannot initiate communication, either to the Master or to other Slaves. </WRAP> 
 + 
 +<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, the Client-Server is interpreted from a network perspective when using TCP media. A Modbus Master connecting to a a Modbus Slave is considered a "client" to the slave device which is the "server"</WRAP> 
 + 
  
   * **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. It can be between 0 and 3. For USB use 10.+    * Port Number: Serial port number that changes depending on the server usedClick [[port_numbers| here]] to get the correct 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 1003: 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 "Reuse" parameter set to "False", while the other datapoints will have the "Reuse" parameter set to "True". The driver will read the 2 bytes from address X only the first time and will extract all the subsequent bits from this read value to populate the other datapoints.
 +  * **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" in the main settings.
 +  * **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=====
 +
 +{{ :system_obj_-_modbus.png?nolink&100 |}}
 +
 +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.
 +
 +{{ :modbus_slave_1.png?direct850 |Thinknx server as a Modbus gateway to other systems }}
 +<WRAP center 60%> <WRAP centeralign> Thinknx Server as a Modbus Gateway to Other Systems </WRAP>  </WRAP>
 +\\
 +{{ :modbus_slave_2.png?direct850 |Case study: Modbus gateway }}
 +<WRAP center 60%> <WRAP centeralign> Case Study: Modbus Gateway </WRAP>  </WRAP>
 +
 +
 +
 +===== Gateway MyHome =====
 +
 +{{ :system_obj_-_bticino.png?nolink&100 |}}
 +
 +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://catalogue.bticino.com/BTI-F454-EN| BT-F454 web server]] that supports the Open Web Net protocol.
 +
 +  * **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's level.
 +++++
 +++++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's level.
 +++++
 +++++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's level.
 +++++
 +++++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: point to point control| This command allows to control a single shutter by sending Up, Down or Stop.
 +  * **Room (A)** as configured in MyHome.
 +  * **Automation Point (PL)**
 +  * **Interface (I)**
 +  * **Stop/Up/Down** Stop=0, Up=1, Down=2.
 +++++
 +++++Automation: control for group| This command allows to control a group of shutters by sending Up, Down or Stop.
 +  * **Group** as configured in MyHome.
 +  * **Interface (I)**
 +  * **Stop/Up/Down** Stop=0, Up=1, Down=2.
 +++++
 +++++Automation: control for room| This command allows to control all shutters in a single room.
 +  * **Room** as configured in MyHome.
 +  * **Interface (I)**
 +  * **Stop/Up/Down** Stop=0, Up=1, Down=2.
 +++++
 +++++Automation: general control| This command allows to control all shutters.
 +  * **Stop/Up/Down** Stop=0, Up=1, Down=2.
 +++++
 +++++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/disable the thermostat.
 +  * **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 1008: Line 1466:
 {{ :system_obj_-_zwave.png?nolink&100 |}} {{ :system_obj_-_zwave.png?nolink&100 |}}
  
-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]]. </WRAP>
  
   * **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 1026: Line 1486:
  
 <WRAP center round important 60%> <WRAP center round important 60%>
-Z-Wave Controller to work requires the ThinKnx Z-Wave transceiver (USB dongle) provided together with the Z-Wave upgrade. After plugging the transceiver to the ThinKnx server always perform a server soft-restart.+To work, Z-Wave Controller requires the ThinKnx Z-Wave transceiver (USB dongle) provided together with the Z-Wave upgrade (license). After plugging the transceiver to the ThinKnx serveralways perform a server soft-restart.
 </WRAP> </WRAP>
  
Line 1093: Line 1553:
  
 The association function “associates” two devices, enabling them to communicate directly without the need for controller. On the "Device association editor" window, you can set an association with other Z-Wave devices and define the type of association. The association function “associates” two devices, enabling them to communicate directly without the need for controller. On the "Device association editor" window, you can set an association with other Z-Wave devices and define the type of association.
- + 
 +===== 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: 
 + 
 +{{ :velux_1.jpg?direct500 |Velux Credentials}} 
 +<WRAP center 60%> <WRAP centeralign> Velux Credentials </WRAP>  </WRAP> 
 + 
 +From your PC, scan for available wifi networks, and connect to the Velux SSID found.  
 + 
 +Open the browser and type the following link: http://klf200.velux. Use the credentials on the device to sign in. 
 + 
 +{{ :velux_2.png?direct500 |Velux Web Access}} 
 +<WRAP center 60%> <WRAP centeralign> Velux Web Access </WRAP>  </WRAP> 
 + 
 +Open the Interface Mode to scan and add your products. 
 + 
 +{{ :velux_3.png?direct300 | Interface Mode }} 
 +<WRAP center 60%> <WRAP centeralign> Interface Mode </WRAP>  </WRAP> 
 + 
 +{{ :velux_4.png?direct500 | Product Search }} 
 +<WRAP center 60%> <WRAP centeralign> Product Search</WRAP>  </WRAP> 
 + 
 +<WRAP tip center round 80%>For more information on how to setup the Velux interface, check out this video posted by Velux Commercial https://youtu.be/kVmqGOMKqoM</WRAP> 
 + 
 +=== Network Setup === 
 +After logging into the interface, click on the gear button at the top right, and select "LAN"
 + 
 +{{ :velux_5.png?direct850 | LAN Settings }} 
 +<WRAP center 60%> <WRAP centeralign> LAN Settings </WRAP>  </WRAP> 
 + 
 +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.</WRAP> 
 + 
 +=== 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, review the IP address, port and password. Also take into consideration that the Velux interface can accept two connections at most. 
 +  * **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/Group** link to the Node/Group in list. 
 +    * **KNX gateway** Enables KNX gateway to control element. 
 + 
 +{{ :velux_6.png?direct850 | Velux Gateway }} 
 +<WRAP center 60%> <WRAP centeralign> Velux Gateway </WRAP>  </WRAP> 
 + 
 +{{ :velux_7.png?direct850 | Testing Window }} 
 +<WRAP center 60%> <WRAP centeralign> Testing Window </WRAP>  </WRAP> 
 + 
 + 
 ===== iRoomController ===== ===== iRoomController =====
  
Line 1167: 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 and the recipients’ numberthe number should be preceded by the national code without leading + nor 00. +  * **Receivers phone numbers** use " " to indicate more receivers. Number should be international without leading + or 00. 
 +++++
 ===== Lutron ===== ===== Lutron =====
  
Line 1280: 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. It can be between 0 and 3. For USB use 10.+  * **Port Number** Serial port number that changes depending on the server usedClick [[port_numbers| here]] to get the correct 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 1290: 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, marking the end of the line. 
 +  * **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, marking the end of the line. 
 +  * **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 ==+{{ :system_obj_-_ethernetgateway.png?nolink&100 |}}
  
-Sends hexadecimal string to the serial port without carriage return; adjust the parameter on the right to specify the string text. The string command has to be converted in hexadecimal, and each byte must be separated by space. In case of absence of CR, also the termination characters must be expressed in hexadecimal.+This object is server service that allows to send HTTP GET/POST/PUT requests and strings on TCP or UDP sockets. The command can be linked to a [[inter_objs#generic_command| Generic Command]] for example or used inside a logic
  
-== Send hexadecimal string with CR termination ==+  * **[[#virtual_inputs|Virtual Inputs:]]** Display and manage Virtual Inputs of the KNX system. Each Virtual Input is a KNX system input that receives data from an external service. 
 +  * **[[#virtual_outputs| Virtual Outputs:]]** Display and manage Virtual Outputs of the KNX system. Each Virtual Output is a KNX system output that sends data to an external service.
  
-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, and each byte must be separated by a space.+==== 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 **[[#data_format_input| Data Format Input]]** option. 
 +    * **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. 
 +    * **[[#data_format_input| Data Format Input]]** Opens the data format editor to customize both request and response parameters.
  
-Depending on the server you are going to use, the serial port number should be set according to the following settings:+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 port** Select the number of the port to listen on for incoming data. 
 +    * **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> Figure: Data Format Input Overview </WRAP>  </WRAP> 
 +\\ 
 + 
 +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. 
 + 
 +{{ :ethgw_local_test_input.png?direct&800 |Data Format Input - Local Test}} 
 +<WRAP center 60%> <WRAP centeralign> Figure: Data Format Input - Local Test </WRAP>  </WRAP> 
 + 
 +==== Virtual Outputs ==== 
 + 
 +    * **URL** Endpoint address. Parameters are configured inside the **Data Format Input**. 
 +    * **Request Type** Choose the HTTP method to use between GET, POST, or PUT. 
 +    * **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. 
 +    * **[[#data_format_output|Data Format Output]]** Opens the data format manager window. 
 +    * **Invoke Virtual Input**  
 +    * **Use KNX Gateway** if enabled, it will be possible to control the currently element directly from KNX. 
 +\\ 
 + 
 +=== Data Format Output === 
 + 
 +{{ :output_format_editor.jpg?direct&800 |Data Format Output- Overview }} 
 +<WRAP center 60%> <WRAP centeralign> Figure: Data Format Input - Overview</WRAP>  </WRAP> 
 + 
 +{{ :output_format_editor2.jpg?direct&800 |Data Format Output- Simulation}} 
 +<WRAP center 60%> <WRAP centeralign> Figure: Data Format Input - Simulation</WRAP>  </WRAP> 
 + 
 +==== Example with Airscope Amplifier ==== 
 + 
 +In this example, we are using the Airscope Audio Network Amplifier and controlling it from the Thinknx UP application. The amplifier has an HTTP API that can be found on this link: http://airscope-audio.net/core2/pdf/airscope-module-http.pdf. 
 + 
 +{{ :ethernet_gateway_airscope.png?direct&800 |Communicating with Airscope over HTTP}} 
 +<WRAP center 60%> <WRAP centeralign> Figure: Communicating with Airscope over HTTP</WRAP>  </WRAP> 
 + 
 +=== Virtual Input: Get Volume from Airscope === 
 + 
 +According to section 2.3.1 of the Airscope manual (link above), the device will send the player's full status, including the current volume level, when it receives a GetPlayerStatus HTTP request as follows: 
 +\\ 
 + 
 +**<nowiki> http://[airscope_IP_address]/httpapi.asp?command=getPlayerStatus </nowiki>** 
 + 
 +\\ 
 +The response received from the Airscope device comes in a JSON format, following the example below: 
 + 
 +**{\\ 
 +“mainmode”: “0”,\\ 
 +“nodetype”: “0”,\\ 
 +“mode”: “3”,\\ 
 +“sw”: “0”,\\ 
 +“status”: “play”,\\ 
 +“curpos”: “12900”,\\ 
 +“totlen”: “229000”,\\ 
 +“Title”: “736865”,\\ 
 +“Artist”: “47726f6f766520436f766572616765”,\\ 
 +“Album”: “xxxxxxxxxx”,\\ 
 +“Year”: “2005”,\\ 
 +“Track”: “7”,\\ 
 +“Genre”: “Dance”,\\ 
 +“locallistflag”: “1”,\\ 
 +“locallistfile”: “”,\\ 
 +“plicount”: “1”,\\ 
 +“plicurr”: “1”,\\ 
 +“vol”: “90”, **//<color red> we need to read this one </color>// \\ 
 +**“mute”: “0”,\\ 
 +“iuri”: “xxxxxxxxxxxxxxxxxxxxx”,\\ 
 +“uri”: “xxxxxxxxxxxxxxxxxxxxxx”\\ 
 +}**\\ 
 + 
 +To configure the virtual input inside the Configurator, add the Ethernet Gateway, access the virtual Inputs window, and add a new Virtual Input. Follow the picture below to properly fill the fields requested. 
 + 
 +{{ :airscope_vi_volume.png?direct&800 |Volume Virtual Input}} 
 +<WRAP center 60%> <WRAP centeralign> Figure: Volume as Virtual Input</WRAP>  </WRAP> 
 + 
 +Open the Data Format editor, and make sure you configure the request and response formats as instructed in the amplifier's manual: 
 + 
 +{{ :airscope_vi_format.png?direct&600 |Volume Virtual Input Format}} 
 +<WRAP center 60%> <WRAP centeralign> Figure: Volume Virtual Input Format</WRAP>  </WRAP> 
 + 
 +To display the current volume level on the Thinknx UI, you can add an Analog Value with type "Slider" and use it to both display and change the volume level, as seen in the picture below: 
 + 
 +{{ :airscope_getVolume.png?direct&800 |Display Volume on UI}} 
 +<WRAP center 60%> <WRAP centeralign> Figure: Display Volume on UI</WRAP>  </WRAP> 
 + 
 +=== Virtual Output: Change Volume from Thinknx UI === 
 + 
 +According to section 2.3.9 of the Airscope manual (link above), it is possible to set the volume level on the amplifier by sending the following HTTP request:  
 +\\ 
 +**<nowiki> http://[airscope_IP_address]/httpapi.asp?command=setPlayerCmd:vol:value </nowiki>**  where value can be from 0 to 100.  
 +\\ 
 + 
 +To configure the virtual output inside the Configurator, access the virtual Outputs window inside the Ethernet Gateway, and add a new Virtual Output. Follow the picture below to properly fill the fields requested. 
 + 
 +{{ :airscope_vo_volume.png?direct&800 |Volume Virtual Output}} 
 +<WRAP center 60%> <WRAP centeralign> Figure: Volume as Virtual Ouput</WRAP>  </WRAP> 
 + 
 +Open the Data Format editor, and make sure you configure the request format correctly, by replacing the word "value" in "setPlayerCmd:vol:value" by %VOL, which will correspond to the value sent by the volume slider on the Thinknx UI. 
 + 
 +{{ :airscope_vo_format.png?direct&600 |Volume Virtual Output Format}} 
 +<WRAP center 60%> <WRAP centeralign> Figure: Volume Virtual Ouput Format</WRAP>  </WRAP> 
 + 
 +To change the current volume level from the Thinknx UI, you can use the same Slider added in the section above, and link the Slider "Command" parameter to the the volume virtual output created in the Ethernet Gateway.
  
-This object is a server service that allows to send GET and POST requests, and strings on TCP or UDP sockets.+{{ :airscope_setVolume.png?direct&800 |Change Volume from UI}} 
 +<WRAP center 60%> <WRAP centeralign> Figure: change Volume from UI</WRAP>  </WRAP>
  
 ==== Object commands ==== ==== Object commands ====
Line 1328: Line 1967:
 Commands sent to the object and recallable from other objects: Commands sent to the object and recallable from other objects:
  
-== Make a http GET call to a specific url ==+++++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, default 3000 ms. 
 +++++
  
-Allows to send GET; adjust the URL” parameter on the right to specify the url.+++++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, default 3000 ms. 
 +++++
  
-== Make a http GET call to a specific url with username ==+++++Make an HTTP POST call to a specified url| This command allows the sending of an HTTP POST 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/x-www-form-urlencoded. 
 +  * **Timeout for connection** in milliseconds, default 3000 ms. 
 +++++
  
-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.+++++Make an HTTP POST call to a specified url with username and password| This command allows the sending of an HTTP POST request to send data to certain sever in order to execute a command. 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/x-www-form-urlencoded. 
 +  * **Username** used the authenticate to the server. 
 +  * **Password** used to authenticate to the server. 
 +  * **Timeout for connection** in milliseconds, default 3000 ms. 
 +++++
  
-== Make a http POST call to a specific url ==+++++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/x-www-form-urlencoded. 
 +  * **Timeout for connection** in milliseconds, default 3000 ms. 
 +++++
  
-Allows to send a POST; adjust the URL” parameter on the right to specify the url.+++++Make an HTTP PUT call to a specified url with username and password| This command allows the sending of an HTTP PUT request to send data to certain sever in order to execute a command. 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/x-www-form-urlencoded. 
 +  * **Username** used the authenticate to the server. 
 +  * **Password** used to authenticate to the server. 
 +  * **Timeout for connection** in milliseconds, default 3000 ms. 
 +++++
  
-== Make a http POST call to a specific url with username ==+++++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/x-www-form-urlencoded. 
 +  * **Timeout for connection** in milliseconds, default 3000 ms. 
 +++++
  
-Allows to send 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.+++++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/x-www-form-urlencoded. 
 +  * **Username** used the authenticate to the server. 
 +  * **Password** used to authenticate to the server. 
 +  * **Timeout for connection** in milliseconds, default 3000 ms. 
 +++++
  
-== Send string with no termination to TCP socket ==+++++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:port** 
 +  * **Timeout for connection** in milliseconds, default 3000 ms. 
 +  * **Time to wait before closing connection after data sending** in milliseconds, default 100 ms. 
 +++++
  
-Allows to send a string to 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| This command allows the sending of a string with CR termination, marking the end of the line, to a TCP host on a defined port. 
 +  * **String to send** 
 +  * **Host:port** 
 +  * **Timeout for connection** in milliseconds, default 3000 ms. 
 +  * **Time to wait before closing connection after data sending** in milliseconds, default 100 ms. 
 +++++
  
-== Send string with CR termination to TCP socket ==+++++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:port** 
 +  * **Timeout for connection** in milliseconds, default 3000 ms. 
 +  * **Time to wait before closing connection after data sending** in milliseconds, default 100 ms.
  
-Allows to send a 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.+To send "hello world", it is enough to convert this ASCII text to HEX using simple tool such as https://www.rapidtables.com/convert/number/ascii-to-hex.html, and the HEX string to send would be "68 65 6c 6c 6f 20 77 6f 72 6c 64". 
 +++++
  
-== Send hexadecimal string with no termination to TCP socket ==+++++Send hexadecimal string with CR termination to TCP socket| This command allows the sending of a string with CR termination, marking the end of the line, to a TCP host on a defined port. 
 +  * **String to send** 
 +  * **Host:port** 
 +  * **Timeout for connection** in milliseconds, default 3000 ms. 
 +  * **Time to wait before closing connection after data sending** in milliseconds, default 100 ms.
  
-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, and each byte must be separated by a space. In case of absence of CR, also the termination characters must be expressed in hexadecimal.+To send "hello world", it is enough to convert this ASCII text to HEX using simple tool such as https://www.rapidtables.com/convert/number/ascii-to-hex.html, and the HEX string to send would be "68 65 6c 6c 6f 20 77 6f 72 6c 64". 
 +++++
  
-== Send hexadecimal string with CR termination to TCP socket ==+++++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:port** 
 +  * **Timeout for connection** in milliseconds, default 3000 ms. 
 +  * **Time to wait before closing connection after data sending** in milliseconds, default 100 ms. 
 +++++
  
-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 serverThe string command has to be converted in hexadecimaland each byte must be separated by a space.+++++Send string with CR termination to UDP socket| This command allows the sending of a string with CR termination, marking the end of the line, to a UDP host on a defined port. 
 +  * **String to send** 
 +  * **Host:port** 
 +  * **Timeout for connection** in millisecondsdefault 3000 ms. 
 +  * **Time to wait before closing connection after data sending** in milliseconds, default 100 ms. 
 +++++
  
-== Send string with no termination to UDP socket ==+++++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:port** 
 +  * **Timeout for connection** in milliseconds, default 3000 ms. 
 +  * **Time to wait before closing connection after data sending** in milliseconds, default 100 ms. 
 +To send "hello world", it is enough to convert this ASCII text to HEX using a simple tool such as https://www.rapidtables.com/convert/number/ascii-to-hex.html, and the HEX string to send would be "68 65 6c 6c 6f 20 77 6f 72 6c 64". 
 +++++
  
-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.+++++Send hexadecimal string with CR termination to UDP socket| This command allows the sending of a string with CR termination, marking the end of the line, to a UDP host on a defined port. 
 +  * **String to send** 
 +  * **Host:port** 
 +  * **Timeout for connection** in milliseconds, default 3000 ms. 
 +  * **Time to wait before closing connection after data sending** in milliseconds, default 100 ms. 
 +To send "hello world", it is enough to convert this ASCII text to HEX using a simple tool such as https://www.rapidtables.com/convert/number/ascii-to-hex.html, and the HEX string to send would be "68 65 6c 6c 6f 20 77 6f 72 6c 64". 
 +++++
  
-== Send string with CR termination to UDP socket ==+++++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:port** 
 +  * **Timeout for connection** in milliseconds, default 3000 ms. 
 +  * **Time to wait before closing connection after data sending** in milliseconds, default 100 ms.
  
-Allows to send a 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.+To send "hello world", it is enough to convert this ASCII text to HEX using simple tool such as https://www.rapidtables.com/convert/number/ascii-to-hex.html, and the HEX string to send would be "68 65 6c 6c 6f 20 77 6f 72 6c 64". 
 +++++
  
-== Send hexadecimal string with no termination to UDP socket ==+++++Send hexadecimal string with CR termination to UDP socket in multicast| This command allows the sending of a string with CR termination, marking the end of the line, to a UDP host supporting multicast on a defined port. 
 +  * **String to send** 
 +  * **Host:port** 
 +  * **Timeout for connection** in milliseconds, default 3000 ms. 
 +  * **Time to wait before closing connection after data sending** in milliseconds, default 100 ms. 
 +To send "hello world", it is enough to convert this ASCII text to HEX using a simple tool such as https://www.rapidtables.com/convert/number/ascii-to-hex.html, and the HEX string to send would be "68 65 6c 6c 6f 20 77 6f 72 6c 64". 
 +++++
  
-Allows to send 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 serverThe string command has to be converted in hexadecimal, and each byte must be separated by spaceIn case of absence of CR, also the termination characters must be expressed in hexadecimal.+++++Send SOAP request to the specified url| This command allows the sending of SOAP (Simple Object Access Protocol) request to a URL. SOAP is an XML-based messaging protocol for exchanging information among computers. 
 +  * **URL** 
 +  * **SOAP Envelope** Defines the start and the end of the messageIt is mandatory element. 
 +  * **SOAP Action** indicates the intent of the SOAP HTTP request. 
 +++++
  
-== Send hexadecimal string with CR termination to UDP socket ==+++++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, a secure way to access a computer over an unsecured network. 
 +  * **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" "etc"
  
-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, and each byte must be separated by a space+Application: This session can be used to connect to the home router/access point through Thinknx
- +++++
-== Send SOAP request to the specified URL == +
- +
-Allows to send a SOAP request; adjust the parameters on the right to specify the destination URL, the SOAP envelope and the SOAP action of the request.+
  
 ===== P1 Meter Interface ===== ===== P1 Meter Interface =====
Line 1386: 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** Number of the serial port used to connect the meter box.+  * **Serial port number** Serial port number that changes depending on the server used. Click [[port_numbers| here]] to get the correct 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”, the following properties will appear:   * **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”, the following properties will appear:
     * 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 1400: Line 2136:
     * KNX group calorie cool: KNX group calorie cool.     * KNX group calorie cool: KNX group calorie cool.
     * KNX water consumption: KNX water consumption.     * KNX water consumption: KNX water consumption.
 +
 +===== Voice Control Gateway =====
 +
 +{{ :voice_cntrl.png?nolink&70 |}}
 +
 +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 =====
 +
 +{{ :ifttt_32.png?nolink&50 |}}
 +
 +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: <nowiki> https://ifttt.com/services/maker_webhooks/settings </nowiki>
  
 ===== Tester ===== ===== Tester =====
Line 1436: Line 2193:
   * **KNX Physical Addr.** KNX physical address of the test target   * **KNX Physical Addr.** KNX physical address of the test target
  
 +===== OpenWeatherMap =====
 +
 +{{ :weather_32x.png?nolink&50 |}}
 +
 +<WRAP important round center 80%> This object is different from the [[inter_objs#weather| Weather Plugin]] available for the UI. While The **Weather Plugin** is an Interface object that reads the weather information from www.ilmeteo.it and cannot be customized, the **OpenWeatherMap** is a System object connected to www.openweathermap.org and provides weather information that can be linked to any customized UI built by the integrator. </WRAP> 
 +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.
 +{{ :openweatherapi_1.png?direct850 |How To Copy API Key from OpenWeatherMap }}
 +<WRAP center 60%> <WRAP centeralign> How To Copy API Key from OpenWeatherMap </WRAP>  </WRAP>
 +  * ** 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't meet the configured alert.
 +
 +==== 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's temperature" or "get tomorrow's wind speed", or configure one **dynamic** command that can change its status depending on the selected day in the UI. 
 +
 +{{ :openweatherapi_3.png?direct800 |Normal View}}
 +<WRAP center 60%> <WRAP centeralign> Normal View </WRAP>  </WRAP>
 +
 +{{ :openweatherapi_2.png?direct850 |Dynamic View }}
 +<WRAP center 60%> <WRAP centeralign> Dynamic View </WRAP>  </WRAP>
 +
 +Click on the button below to download a project template for both options:
 +<WRAP button centeralign> \\ {{:weather_template_clients.zip|Download Template}}</WRAP>
 +
 + 
 +===== MQTT Server =====
 +
 +{{ :mqtt_32.png?nolink&50 |}}
 +
 +This object allows the Thinknx server to function as an MQTT broker. For more information, please visit our detailed [[mqtt| guide on MQTT integration]].
 +
 +===== MQTT Client =====
 +
 +{{ :mqtt_32.png?nolink&50 |}}
 +
 +This object allows the Thinknx server to act as an MQTT client to read or publish information from/to other MQTT clients. For more information, please visit our detailed [[mqtt| guide on MQTT integration]].
 +====== Multimedia ======
 ===== Video Matrix ===== ===== Video Matrix =====
  
Line 1454: 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”, the following property will be displayed:      * Port number: TCP/IP port number for ethernet connection.\\ If the property ”Use serial port” is set to ”Enabled”, the following property will be displayed:
-     * Serial port: Server serial port number.+     * Serial port: Serial port number that changes depending on the server used. Click [[port_numbers| here]] to get the correct port number.
  
 ==== Object commands ==== ==== Object commands ====
Line 1460: 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 input for a selected output ==+++++Disconnect input for every output|  This command will disconnect all the inputs connected to the outputs. 
 +++++
  
-Associates a specified input with a specified output of the matrix; input and output numbers can be specified by adjusting the ”Input Number” and ”Output Number” on the right.+++++Disconnect input for selected output|  This command will disconnect the input connected to the desired output
 +  * **Output Number**
  
-== Disconnect input for the selected output ==+++++
  
-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.+++++Set the selected input to the selected output|  This command will allow to set the desired input to a selected output
 +  * **Input Number** 
 +  * **Output Number** 
 +++++
  
-== Disconnect input for every output == 
- 
-Resets all the previously configured connection between inputs and outputs of the video matrix. 
  
 ===== Audio Matrix ===== ===== Audio Matrix =====
Line 1489: 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”, the following property will be displayed:     * Port number: TCP/IP port number for ethernet connection.\\ If the property ”Use serial port” is set to ”Enabled”, the following property will be displayed:
-    * Serial port: Server serial port number.+    * Serial port: Serial port number that changes depending on the server used. Click [[port_numbers| here]] to get the correct port number.
   * **Mute KNX Group** KNX group for mute command.   * **Mute KNX Group** KNX group for mute command.
  
Line 1496: 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 "," to send to multiple outputs. 
 +++++
  
-Associates a specified input with a specified output of the matrix; input and output numbers can be specified by adjusting the ”Input Number” and ”Output Number” on the right.+++++Disconnect input for every output|  This command will allow to disconnect the inputs on all outputs. 
 +++++
  
-== Disconnect input for the selected output ==+++++Mute or unmute selected output|  This command will allow to mute or unmute one or more outputs. 
 +  * **Output Number** use comma "," to send to multiple outputs. 
 +  * **Mute Value** 1=muted, 0=unmuted. 
 +++++
  
-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.+++++Volume up selected output|  This command will allow to raise the volume on the selected output. The volume is raised by 1. 
 +  * **Output Number** use comma "," to send to multiple outputs. 
 +++++
  
-== Disconnect input for every output ==+++++Volume down selected output|  This command will allow to lower the volume on the selected output. The volume is lowered by 1. 
 +  * **Output Number** use comma "," to send to multiple outputs. 
 +++++
  
-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 desired value to the volume on the selected output. 
- +  * **Output Number** use comma "," to send to multiple outputs
-== Mute or unmute selected output == +  * **Volume** value between 0-100. 
- +++++
-Temporarily mutes 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 of a specified output (several output numbers, separated by a comma, can be typed in the ”Output number” parameter). +
- +
-== Volume down selected output == +
- +
-Turns down the volume of a specified output (several output numbers, separated by a comma, can be typed in the ”Output number” parameter)+
- +
-== Set volume for selected output == +
- +
-Configures a specified volume value for the selected output; the volume value and the output number(s) can be defined by adjusting the parameters on the right.+
  
 ===== Display ===== ===== Display =====
Line 1534: Line 2343:
     * //TV brand LCD//     * //TV brand LCD//
     * //TV brand NEC//     * //TV brand NEC//
-  * **Serial port** Server serial port number.+  * **Serial port** Serial port number that changes depending on the server used. Click [[port_numbers| here]] to get the correct port number.
  
 ==== Object Commands ==== ==== Object Commands ====
Line 1540: 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 the video source == +
- +
-Set the video source+
- +
-== Muet or unmute the audio == +
- +
-Set mute or unmute. +
- +
-== On or standby the device == +
- +
-Turn on the device or put it in standby.+
  
-== Set the audio volume ==+++++Set the video source|  This command will allow to set the video source on the TV. 
 +  * **Source Number** 
 +++++
  
-Set the volume+++++On or standby the device|  This command will allow to turn ON the TV or put it to Standby mode. 
 +  * **Power Value** 1=Power ON, 0=Standby. 
 +++++
  
-== Set the audio volume up ==+++++Set the audio volume|  This command will allow to send a value to the TV volume. 
 +  * **Volume Level** value between 0-100. 
 +++++
  
-Raise the volume+++++Set the audio volume up|  This command will allow to raise the volume on the TV.  
 +++++
  
-== Set the audio volume down ==+++++Set the audio volume down|  This command will allow to lower the volume on the TV. 
 +++++
  
-Lower the volume 
  
 ===== Home theater ===== ===== Home theater =====
Line 1581: 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”, the following property will be displayed:     * Port number: TCP/IP port number for ethernet connection.\\ If the property ”Use serial port” is set to ”Enabled”, the following property will be displayed:
-    * Serial port: Server serial port number.+    * Serial port: Serial port number that changes depending on the server used. Click [[port_numbers| here]] to get the correct port number.
  
 +<WRAP important center round 80%> When using Denon as AVR, it is necessary to disable Power Saving in the receiver's menu to be able to send/read commands. The option is available under "Manual Setup > Network Setup > Other > Power Saving" </WRAP>
  
 ==== Object commands ==== ==== Object commands ====
Line 1588: 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, contact support@thinknx.com. 
 +++++
  
-Power on or standby the device.+++++Mute or unmute main output|  This command will allow to mute or unmute the output on the selected subzone. 
 +  * **Subzone**  
 +  * **mute value** this value varies depending on the Brand of the Home Theater device. For more information, contact support@thinknx.com. 
 +++++
  
-== Mute or unmute main output ==+++++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|  This command will allow to send a desired value to the output's volume. 
 +  * **Subzone**  
 +  * **Volume** value between 0-100. 
 +++++
  
-Enable or disable the subwoofer.+++++Bass up main output|  This command will allow to raise the bass on the output. 
 +++++
  
-== Enable or disable OSD ==+++++Bass down main output|  This command will allow to lower the bass on the output. 
 +++++
  
-Enable or disable the OSD.+++++Treble up main output|  This command will allow to raise the treble on the 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|  This command will allow to enable or disable the 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|  This command will allow to set the main audio source. 
 +  * **Subzone**  
 +  * **Main source audio** 
 +++++
  
-== Set volume for main output ==+++++Select video source for selected main source|  This command will allow to set the main video source. 
 +  * **Subzone**  
 +  * **Main source video** 
 +++++
  
-Set the main output volume+++++Read tuner frequency|  This command will allow to get a feedback on the current tuner frequency. 
 +++++
  
-== Bass up selected output ==+++++Read tuner station|  This command will allow to get a feedback on the current 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 down|  This command will allow to lower the tuner frequency. 
 +++++
  
-Lower low frequencies for the selected output.+++++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|  This command will allow to launch the tuner auto search. 
 +++++
  
-== Treble down main output ==+++++Tuner stop search|  This command will allow to stop the tuner auto search. 
 +++++
  
-Lower high frequencies for the main output.+++++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|  This command will allow to select the surround mode on the device. 
 +  * **Digital Mode** 
 +++++
  
-Move OSD up+++++Remote setup menu show/hide|  This command will allow show/hide the on screen display menu for the remote. 
 +  * **OSD Setup** 1=show OSD menu, 0=hide OSD menu. 
 +++++
  
-== Move OSD cursor down ==+++++Remote press cursor up|  This command will simulate the remote control command "Cursor Up". 
 +++++
  
-Move l’OSD down+++++Remote press cursor down|  This command will simulate the remote control command "Cursor Down"
 +++++
  
-== Move OSD cursor right ==+++++Remote press cursor right|  This command will simulate the remote control command "Cursor Right"
 +++++
  
-Move l’OSD right+++++Remote press cursor left|  This command will simulate the remote control command "Cursor Left"
 +++++
  
-== Move OSD cursor left ==+++++Remote press Enter button|  This command will simulate the remote control button "Enter"
 +++++
  
-Move l’OSD left+++++Remote press Back/Return button|  This command will simulate the remote control button "Back/Return"
 +++++
  
-== Select Source for main output ==+++++Remote press Option button|  This command will simulate the remote control button "Option"
 +++++
  
-Select source for the main output. +++++Remote press Info button|  This command will simulate the remote control button "Info"
- +++++
-== 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 on OSD == +
- +
-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|  This command will allow to send a customized command to the device.
 +  * **Command to send to the device** refer to the Denon/Marantz protocol specification.
 +++++
 ===== Sonos Zone Player (Obsolete) ===== ===== Sonos Zone Player (Obsolete) =====
  
Line 1766: 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 =====
  
 {{ :system_obj_-_mediaplayer.png?nolink&100 |}} {{ :system_obj_-_mediaplayer.png?nolink&100 |}}
Line 1782: 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 interfaceSimulates 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 1863: 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. </WRAP>
  
   * **Players** Sonos players configured in ThinKnx system.   * **Players** Sonos players configured in ThinKnx system.
Line 1921: 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 to set the Play status on the Sonos Player.+++++Put the device in STOP state|  This command will allow to stop the music from playing on the selected player. 
 +++++
  
-== Put the device in STOP state ==+++++Volume up the device|  This command will allow to raise the volume on the selected player. 
 +++++
  
-Allows to set the Stop status on the Sonos Player.+++++Volume down the device|  This command will allow to lower the volume on the selected player. 
 +++++
  
-== Volume up the device ==+++++Skip track forward|  This command will allow to play the next track. 
 +++++
  
-Allows to increase the Sonos Player volume.+++++Skip track backward|  This command will allow to play the previous track. 
 +++++
  
-== Volume down the device ==+++++Set value for volume|  This command will allow to set the volume to a desired level. 
 +  * **Desired Volume** value between 0 and 100. 
 +++++
  
-Allows to decrease the Sonos Player volume.+++++Put the device in MUTE state|  This command will allow to mute/unmute the player. 
 +  * **Mute value** 1=unmuted, 0=muted. 
 +++++
  
-== Set value for volume ==+++++Play the audio from Audio IN plug|  This command will allow to play the music coming from the analog input of the player. 
 +++++
  
-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.+++++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. 
 +++++
  
-== Skip track forward ==+++++Play the audio from a network file|  This command will allow to play a shared file on the network using its URL. 
 +  * **File URL** should follow the form <nowiki>://192.168.2.5/Music/abc.mp3 </nowiki> 
 +++++
  
-Allows to skip to the next track in the Sonos Player queue.+++++Play the audio from a streaming|  This command will allow to play from a streaming URL. 
 +  * **Streaming URL** should follow the form <nowiki>://myradiostream.com:800</nowiki> 
 +++++
  
-== Skip track backward ==+++++Enable/Disable Repeat PlayMode|  This command will enable/disable the repeat mode. 
 +  * **Repeat value** 1=enabled, 0-disabled. 
 +++++
  
-Allows to skip to the previous track in the Sonos Player queue.+++++Enable/Disable Shuffle PlayMode|  This command will enable/disable the Shuffle mode. 
 +  * **Shuffle value** 1=enabled, 0-disabled. 
 +++++
  
-== Put the device in MUTE state ==+++++Start a Playlist from its number|  This command will start playing a desired playlist from its number. 
 +  * **Playlist number** 
 +++++
  
-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.+++++Start a Playlist from its name|  This command will start playing a desired playlist from its name. 
 +  * **Playlist name** 
 +++++
  
-== Play the audio from AUDIO-IN plug == +++++Play a favorite item from its number|  This command will start playing desired item from the Favorite list
- +  * **Favorite number** 
-Starts playing from Audio-in source. +++++
- +
-== Play the audio from another player’s AUDIO-IN plug == +
- +
-Starts playing from the Audio-in source of 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 //%%//%%192.168.2.5/Music/abc.mp3// +
- +
-== 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 //%%//%%myradiostream.com/stream.pl// +
- +
-== Enable/Disable Repeat PlayMode == +
- +
-Allows to set the playing modality; the parameter on the right indicates whether to Enable (1) or Disable (0) the Repeat modality. +
- +
-== Enable/Disable Shuffle PlayMode == +
- +
-Allows to set the playing modality; the parameter on the right indicates whether to Enable (1) or Disable (0) the Shuffle modality. +
- +
-== Start a playlist from its number == +
- +
-Recalls the playlist to play; the parameter on the right indicates the number of the desired playlist. This command only works if the playlist’s name in Sonos starts with “Num -” where Num is the number used to recall the playlist. +
- +
-== Start playlist from its name == +
- +
-Recalls the playlist to play; the parameter on the right indicates the name of the desired playlist. This command only works if the playlist’s name in Sonos is equal to the specified parameter+
- +
-== Start a favorite from its number == +
- +
-Recalls the favorite to play; the parameter on the right indicates the number of the desired favorite. This command only works if the favorite’s name in Sonos starts with “Num -” where Num is the number used to recall the favorite.+
  
 ==== Sonos Topology commands ==== ==== Sonos Topology commands ====
Line 2003: 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, see next [[system_objs#adding_ir_commands|subsection 4.45.1]] . +  * **IR commands** List of IR commands. Commands should be created manually in the IR Commands Editor. For each oneit is either possible to insert the code directly, or link it to an existing code from the imported database under "Remote Directory". Learn more in section [[system_objs#adding_ir_commands|"Adding IR Commands"]]
-  * **Remotes directory** This property allows to choose from a list of remotes files exported from IRTrans.+  * **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 a list of IR commands (remotesexported from an IR Trans or a Global Cache device.
   * **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** IR Transmitter device IP address.+  * **IP address** IP address of the IR transmitter used.
  
 ==== Adding IR commands ==== ==== Adding IR commands ====
Line 2013: 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 (as memo tag). 
-  * **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.+ 
 +=== 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://www.globalcache.com/files/software/iConvert.zip| Download link]].
  
-==== Importing and exporting IR commands ====+=== 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 ".txt" from the file's name. 
 +  * In case of IR Trans remote file, make sure to place the ".rem" file containing the commands inside a folder under the selected directory. 
 + </WRAP> 
 +  * **Remote** Select the remote file available in the directory configured under "Remotes Directory". Make sure that "Check for Update" is enabled. 
 +  * **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/Export commands from/to another project ====
  
 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 2031: 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 by selecting it from the list to the right.
- +
-Allows to create sequences using the commands previously configured in the relates system object properties (please refer to the dedicated section).  +
-To create a sequence select the desired command from the list of the available commands and the click on ”Enqueue” as in the following picture. The selected command will be sent to the default output LED of the IR transmitter.+
 {{ ::ir_command_definitio.png?direct&600 |}} {{ ::ir_command_definitio.png?direct&600 |}}
-If you want to selected a defined output different from the default one, before enqueuing the command, it is possible to enable the "Output option" and select the desired output from the list. The enqueued command will appair on the list of the commands to execute with an appended index corresponding to the selected output.+If you want to select a defined output different from the default one, before enqueuing the command, it is possible to enable the "Output option" and select the desired output from the list. The enqueued command will appear on the list of the commands to execute with an appended index corresponding to the selected output.
 {{ ::ir_command_definition_with_output_option.png?direct&600  |}} {{ ::ir_command_definition_with_output_option.png?direct&600  |}}
 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. 
 {{ ::ir_command_definition_with_macro.png?direct&600  |}} {{ ::ir_command_definition_with_macro.png?direct&600  |}}
  
 +++++
  
  
-===== Logic Module ===== 
  
-{{ :logicmodule.png?nolink&100 |}} 
  
-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 ===== 
  
-{{ :ifttt_32.png?nolink&50 |}} 
  
-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: <nowiki> https://ifttt.com/services/maker_webhooks/settings </nowiki> 
- 
-===== Voice Control Gateway ===== 
- 
-{{ :voice_cntrl.png?nolink&70 |}} 
- 
-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 
  • system_objs.1568021804.txt.gz
  • Last modified: 2019/09/09 11:36
  • by ingrid