Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
generic_commands [2019/06/19 18:26] – [System] ingrid | generic_commands [2022/06/16 08:26] (current) – [Reports and Gateways] ingrid | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
- | <WRAP centeralign>< | + | |
- | \\ When an object is added to the System, | + | \\ When an object is added to the System, |
+ | |||
+ | The commands/ | ||
+ | * **[[#system | System ]]** | ||
+ | * **[[# | ||
+ | * **[[# | ||
+ | * **[[# | ||
+ | * **[[# | ||
- | The commands are grouped into 5 categories: | ||
- | * **[[#system | System]]** | ||
- | * **[[# | ||
- | * **[[# | ||
- | * **[[# | ||
- | * **[[# | ||
The category will only be visible if the related objects have been added inside the System tab. | The category will only be visible if the related objects have been added inside the System tab. | ||
Line 21: | Line 22: | ||
* **KNX Group** Group address to sen the value. | * **KNX Group** Group address to sen the value. | ||
* **KNX value** Can be either 1 or 0. | * **KNX value** Can be either 1 or 0. | ||
- | A generic button can be configured to send a 1 bit KNX telegram to open a door. | + | |
++++ | ++++ | ||
++++Send KNX Byte Telegram| | ++++Send KNX Byte Telegram| | ||
Line 35: | Line 36: | ||
++++Send KNX Float 4 Byte Telegram| | ++++Send KNX Float 4 Byte Telegram| | ||
* **KNX Group** Group address to send the value. | * **KNX Group** Group address to send the value. | ||
- | * **KNX value** | + | * **KNX value** |
++++ | ++++ | ||
++++Send KNX String Telegram| | ++++Send KNX String Telegram| | ||
Line 48: | Line 49: | ||
++++Read KNX group address| | ++++Read KNX group address| | ||
* **KNX Group** Group address to read the value from. | * **KNX Group** Group address to read the value from. | ||
- | If a device installed on the KNX bus does not update its status automatically, | ||
++++ | ++++ | ||
++++Make a pause for a fixed interval| | ++++Make a pause for a fixed interval| | ||
* **Interval** Time interval 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 application | + | When saving a scene, sometimes a pause between two commands is necessary, for example, when saving the TV channel number. Another |
++++ | ++++ | ||
++++Change UI Function and Page: GENERAL| This command allows to redirect **all clients** to a specific function and page. | ++++Change UI Function and Page: GENERAL| This command allows to redirect **all clients** to a specific function and page. | ||
Line 69: | Line 69: | ||
* **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. | * **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!" | Using the Universal Gateway, a push notification can be sent to the client when a 1-bit value is received from the bus to indicate that the Water Tank Level is low. The message in that case can be "Low Water Level!" | ||
+ | <WRAP important round center 60%>Push notifications only work with internet connectivity. In addition, the server and client should both have the same version of Thinknx software (both Classic or Thinknx UP).</ | ||
++++ | ++++ | ||
++++Execute MS Windows Command: GENERAL| This command allows to launch an .exe file directly from the ThinKnx application on all Players for Windows. | ++++Execute MS Windows Command: GENERAL| This command allows to launch an .exe file directly from the ThinKnx application on all Players for Windows. | ||
- | * **<wrap hi>Command</ | + | * **Command** |
- | * **<wrap hi>Parameter</ | + | * **Parameter** |
+ | |||
+ | Example: to open a specific file or folder on Windows, fill the Command field with " | ||
++++ | ++++ | ||
++++Execute MS Windows Command: SPECIFIC CLIENT| This command allows to launch an .exe file directly from the ThinKnx application on all Players for Windows. | ++++Execute MS Windows Command: SPECIFIC CLIENT| This command allows to launch an .exe file directly from the ThinKnx application on all Players for Windows. | ||
- | * **<wrap hi>Command</ | + | * **Command** |
- | * **<wrap hi>Parameter</ | + | * **Parameter** |
+ | Example: to open a specific file or folder on Windows, fill the Command field with " | ||
++++ | ++++ | ||
++++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.\\ | ++++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.\\ | ||
Line 108: | Line 112: | ||
===== Reports and Gateways ===== | ===== Reports and Gateways ===== | ||
- | The below list contains all the possible objects that could be added to the Reports and Gateways category: | + | The list below contains all the possible objects that could be added to the Reports and Gateways category: |
<WRAP Group> | <WRAP Group> | ||
<WRAP column 30%> | <WRAP column 30%> | ||
+ | * [[# | ||
* [[# | * [[# | ||
* [[# | * [[# | ||
* [[# | * [[# | ||
* [[# | * [[# | ||
- | * Gateway MyHome | + | * [[# |
- | * Voice Control Gateway | + | * [[# |
- | * IFTTT Account | + | * [[# |
- | * SMS Gateway | + | * [[# |
</ | </ | ||
<WRAP column 50%> | <WRAP column 50%> | ||
- | <WRAP centeralign> | + | <WRAP centeralign> |
<WRAP center 60%> <WRAP centeralign> | <WRAP center 60%> <WRAP centeralign> | ||
</ | </ | ||
</ | </ | ||
+ | |||
+ | === Hue Gateway === | ||
+ | The available commands when selecting the **Hue Gateway** category under **Reports and Gateways** are the following: | ||
+ | |||
+ | ++++Turn on/off element| | ||
+ | * **Value** Write 1 to turn on, and 0 to turn off. | ||
+ | ++++ | ||
+ | ++++Dimm the element to a value| | ||
+ | * **Value** can be between 0 and 255. | ||
+ | ++++ | ||
+ | ++++Set the element color temperature (white)| | ||
+ | * **Value** Can be between 0 and 255, where 0 corresponds to Cold White (6500 K) and 255 correspond to Warm White (2000 K). | ||
+ | ++++ | ||
+ | ++++Set the element color (RGB)| | ||
+ | * **Red Value** value between 0 and 255. | ||
+ | * **Green Value** value between 0 and 255. | ||
+ | * **Blue Value** value between 0 and 255. | ||
+ | ++++ | ||
+ | |||
=== Gateway Modbus === | === Gateway Modbus === | ||
Line 213: | Line 237: | ||
The available commands when selecting the **Ethernet Gateway** category under **Reports and Gateways** are the following: | The available commands when selecting the **Ethernet Gateway** category under **Reports and Gateways** are the following: | ||
- | ++++Make an HTTP GET call to a specified 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, | ||
++++ | ++++ | ||
+ | |||
+ | ++++Make an HTTP GET call to a specified url with username and password| This command allows the sending of an HTTP GET request execute a command. | ||
+ | * **URL** | ||
+ | * **Username** used to authenticate to the server | ||
+ | * **Password** used to authenticate to the server | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Make an HTTP POST call to a specified url| This command allows the sending of an HTTP POST request to send data to a certain sever in order to execute a command. | ||
+ | * **URL** | ||
+ | * **Content to send into call** multiple form fields and values can be sent via the same URL. The encoding used by default is based on an early version of the general URI percent-encoding rules, with a number of modifications such as newline normalization and replacing spaces with + instead of %20. The media type of data encoded this way is application/ | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Make an HTTP POST call to a specified url with username and password| This command allows the sending of an HTTP POST request to send data to a 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/ | ||
+ | * **Username** used the authenticate to the server. | ||
+ | * **Password** used to authenticate to the server. | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Make an HTTP PUT call to a specified url| This command allows the sending of an HTTP PUT request to send data to a certain sever in order to execute a command. | ||
+ | * **URL** | ||
+ | * **Content to send into call** multiple form fields and values can be sent via the same URL. The encoding used by default is based on an early version of the general URI percent-encoding rules, with a number of modifications such as newline normalization and replacing spaces with + instead of %20. The media type of data encoded this way is application/ | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Make an HTTP PUT call to a specified url with username and password| This command allows the sending of an HTTP PUT request to send data to a 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/ | ||
+ | * **Username** used the authenticate to the server. | ||
+ | * **Password** used to authenticate to the server. | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Make an HTTP DELETE call to a specified url| This command allows the sending of an HTTP DELETE request to send data to an external server. | ||
+ | * **URL** | ||
+ | * **Content to send into call** multiple form fields and values can be sent via the same URL. The encoding used by default is based on an early version of the general URI percent-encoding rules, with a number of modifications such as newline normalization and replacing spaces with + instead of %20. The media type of data encoded this way is application/ | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Make an HTTP DELETE call to a specified url with username and password| This command allows the sending of an HTTP DELETE to an external server. The server in this case requires a username and password. | ||
+ | * **URL** | ||
+ | * **Content to send into call** multiple form fields and values can be sent via the same URL. The encoding used by default is based on an early version of the general URI percent-encoding rules, with a number of modifications such as newline normalization and replacing spaces with + instead of %20. The media type of data encoded this way is application/ | ||
+ | * **Username** used the authenticate to the server. | ||
+ | * **Password** used to authenticate to the server. | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Send string with no termination to TCP socket| This command allows the sending of a string to a TCP host on a defined port. | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Send string with CR termination to TCP socket| This command allows the sending of a string with CR termination, | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Send hexadecimal string with no termination to TCP socket| This command allows the sending of an hexadecimal string to a TCP host on a defined port. | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | |||
+ | To send "hello world", | ||
+ | ++++ | ||
+ | |||
+ | ++++Send hexadecimal string with CR termination to TCP socket| This command allows the sending of a string with CR termination, | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | |||
+ | To send "hello world", | ||
+ | ++++ | ||
+ | |||
+ | ++++Send string with no termination to UDP socket| This command allows the sending of an hexadecimal string to a UDP host on a defined port. | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Send string with CR termination to UDP socket| This command allows the sending of a string with CR termination, | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | ++++ | ||
+ | |||
+ | ++++Send hexadecimal string with no termination to UDP socket| This command allows the sending of an hexadecimal string to a UDP host on a defined port. | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | To send "hello world", | ||
+ | ++++ | ||
+ | |||
+ | ++++Send hexadecimal string with CR termination to UDP socket| This command allows the sending of a string with CR termination, | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | To send "hello world", | ||
+ | ++++ | ||
+ | |||
+ | ++++Send hexadecimal string with no termination to UDP socket in multicast| This command allows the sending of an hexadecimal string to a UDP host supporting multicast on a defined port. The characters should be separated by a space. | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | |||
+ | To send "hello world", | ||
+ | ++++ | ||
+ | |||
+ | ++++Send hexadecimal string with CR termination to UDP socket in multicast| This command allows the sending of a string with CR termination, | ||
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | To send "hello world", | ||
+ | ++++ | ||
+ | |||
+ | ++++Send SOAP request to the specified url| This command allows the sending of a 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 message. It is a mandatory element. | ||
+ | * **SOAP Action** indicates the intent of the SOAP HTTP request. | ||
+ | ++++ | ||
+ | |||
+ | ++++Establish SSH session and send commands| This command allows to establish an SSH session with a server to execute certain commands. Secure Socket Shell or SSH, is a network protocol that gives users, particularly system administrators, | ||
+ | * **SSH server hostname** | ||
+ | * **SSH server port** | ||
+ | * **Username** | ||
+ | * **Password** | ||
+ | * **Commands to send** Commands must be enclosed in double quotes and separeted by a space, example: "cmd one" "cmd two" " | ||
+ | |||
+ | Application: | ||
+ | ++++ | ||
+ | |||
+ | === Gateway MyHome === | ||
+ | The available commands when selecting the **Gateway MyHome** category under **Reports and Gateways** are the following: | ||
+ | |||
+ | ++++Launch a scenario| This command allows launching of a scenario configured on the MyHome system. | ||
+ | * **Scenario Number** as configured in MyHome. | ||
+ | * **Control Panel** | ||
+ | * **Interface (I)** | ||
+ | ++++ | ||
+ | ++++Lights: point to point control ON/OFF| This command allows to send an ON or OFF command to one lighting point. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Light Point (PL)** | ||
+ | * **Interface (I)** | ||
+ | * **ON/OFF** type 0 to turn off and 1 to turn on. | ||
+ | ++++ | ||
+ | ++++Lights: point to point control DIMMER| This command allows to send a dimming value to one dimmer. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Light Point (PL)** | ||
+ | * **Interface (I)** | ||
+ | * **Dimmer Level** type a value between 0 and 255 for dimmer' | ||
+ | ++++ | ||
+ | ++++Lights: point to point control TIMED| This command allows to send an ON value duration for one light point. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Light Point (PL)** | ||
+ | * **Interface (I)** | ||
+ | * **ON timed for (min)** the values can be 0.5, 1, 2, 3, 4,5, or 15 min. | ||
+ | ++++ | ||
+ | ++++Lights: control for room ON/OFF| This command allows to send an ON or OFF command to an entire room. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **ON/OFF** type 0 to turn off and 1 to turn on. | ||
+ | ++++ | ||
+ | ++++Lights: control for room TIMED| This command allows to send an ON value duration for an entire room. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **ON timed for (min)** the values can be 0.5, 1, 2, 3, 4,5, or 15 min. | ||
+ | ++++ | ||
+ | ++++Lights: control for group ON/OFF| This command allows to send an ON or OFF command to a group of lighting points. | ||
+ | * **Group** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **ON/OFF** type 0 to turn off and 1 to turn on. | ||
+ | ++++ | ||
+ | ++++Lights: control for group DIMMER| This command allows to send a dimming value to a group of lighting points. | ||
+ | * **Group** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **Dimmer Level** type a value between 0 and 255 for dimmer' | ||
+ | ++++ | ||
+ | ++++Lights: control for group TIMED| This command allows to send an ON value duration for a group of lighting points. | ||
+ | * **Group** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **ON timed for (min)** the values can be 0.5, 1, 2, 3, 4,5, or 15 min. | ||
+ | ++++ | ||
+ | ++++Lights: general control ON/OFF| This command allows to send an ON or OFF command to all lighting points. | ||
+ | * **ON/OFF** type 0 to turn off and 1 to turn on. | ||
+ | ++++ | ||
+ | ++++Lights: general control DIMMER| This command allows to send a dimming value to all lighting points. | ||
+ | * **Dimmer Level** type a value between 0 and 255 for dimmer' | ||
+ | ++++ | ||
+ | ++++Lights: general control TIMED| This command allows to send an ON value duration for all lighting points. | ||
+ | * **ON timed for (min)** the values can be 0.5, 1, 2, 3, 4,5, or 15 min. | ||
+ | ++++ | ||
+ | ++++Automation: | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Automation Point (PL)** | ||
+ | * **Interface (I)** | ||
+ | * **Stop/ | ||
+ | ++++ | ||
+ | ++++Automation: | ||
+ | * **Group** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **Stop/ | ||
+ | ++++ | ||
+ | ++++Automation: | ||
+ | * **Room** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **Stop/ | ||
+ | ++++ | ||
+ | ++++Automation: | ||
+ | * **Stop/ | ||
+ | ++++ | ||
+ | ++++Temperature Control: Setpoint| This command allows to change the setpoint in a zone. | ||
+ | * **Zone (ZA, ZB)** as configured in MyHome. | ||
+ | * **Temperature** type the value of the temperature in °C. | ||
+ | ++++ | ||
+ | ++++Temperature Control: enable or disable| This command allows to enable/ | ||
+ | * **Zone (ZA, ZB)** as configured in MyHome. | ||
+ | * **Enable or disable** type 1 to enable and 0 to disable. | ||
+ | ++++ | ||
+ | ++++Sound: Control the volume| This command allows to control the volume of a speaker. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Loudspeaker (PF)** | ||
+ | * **Volume** the number must be between 0 and 255. | ||
+ | ++++ | ||
+ | ++++Sound: control a speaker ON/OFF| This command allows to turn a speaker on or off. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Loudspeaker (PF)** | ||
+ | * **ON/OFF** insert 1 to turn on and 0 to turn off. | ||
+ | ++++ | ||
+ | |||
+ | === Voice Control Gateway === | ||
+ | The available commands when selecting the **Voice Control Gateway** category under **Reports and Gateways** are the following: | ||
+ | |||
+ | ++++Restart Homekit gateway| | ||
+ | ++++ | ||
+ | |||
+ | === IFTTT Account === | ||
+ | The available commands when selecting the **IFTTT Account** category under **Reports and Gateways** are the following: | ||
+ | |||
+ | ++++Trigger an event with parameters| | ||
+ | * **Event identification** this identification should match the one entered on the IFTTT website. | ||
+ | * **Value to pass as ingredient 1** value 1 required by the service on IFTTT. | ||
+ | * **Value to pass as ingredient 2** value 2 required by the service on IFTTT. | ||
+ | * **Value to pass as ingredient 3** value 3 required by the service on IFTTT. | ||
+ | ++++ | ||
+ | ++++Trigger an event | This function is used to send a command from Thinknx to trigger an event configured on an IFTTT service. | ||
+ | * **Event identification** this identification should match the one entered on the IFTTT website. | ||
+ | ++++ | ||
+ | |||
+ | === SMS Gateway === | ||
+ | The available commands when selecting the **SMS Gateway** category under **Reports and Gateways** are the following: | ||
+ | |||
+ | ++++Send SMS to numbers with text| This function allows the sending of an SMS to multiple phone numbers. | ||
+ | * **SMS text content** message body. | ||
+ | * **Receivers phone numbers** use " ; " to indicate more receivers. Number should be international without leading + or 00. | ||
+ | ++++ | ||
+ | |||
+ | ===== Internal Services ===== | ||
+ | The list below contains all the possible objects that could be added to the Internal Services category: | ||
+ | <WRAP Group> | ||
+ | <WRAP column 30%> | ||
+ | * [[#scene| Scene]] | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[#rgb| RGB]] | ||
+ | </ | ||
+ | <WRAP column 50%> | ||
+ | <WRAP centeralign> | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | === Scene === | ||
+ | After selecting **Scene**, a list of all the added scenes in System will be shown. The available commands when selecting one of the scenes are the following: | ||
+ | |||
+ | ++++Launch scenery| | ||
+ | ++++ | ||
+ | ++++Sop scenery execution| | ||
+ | ++++ | ||
+ | |||
+ | === Presence Simulator === | ||
+ | The available commands after selecting **Presence Simulator** and opening the Simulator tree are the following: | ||
+ | |||
+ | ++++Start the presence simulation| | ||
+ | ++++ | ||
+ | ++++Stop the presence simulation| | ||
+ | ++++ | ||
+ | |||
+ | === Chronothermostat === | ||
+ | After selecting **Chronothermostat**, | ||
+ | |||
+ | ++++Enable/ | ||
+ | * **Enable/ | ||
+ | ++++ | ||
+ | |||
+ | === Email Account === | ||
+ | After selecting **Email Account**, a list of all the email accounts created in System will be shown. The available command when selecting one of the accounts is the following: | ||
+ | |||
+ | ++++Send Email to recipients| | ||
+ | * **Email subject** | ||
+ | * **Email recipients** separate the emails using " ; ". | ||
+ | * **Email content** body of the email. | ||
+ | ++++ | ||
+ | |||
+ | === Thinknx Sensors === | ||
+ | After selecting **Thinknx Sensors**, a list of all the Thinknx Sensors created in System will be shown. The available statuses when selecting one of the sensors are the following: | ||
+ | |||
+ | ++++Get the actual humidity| | ||
+ | ++++ | ||
+ | ++++Get the actual luminosity| | ||
+ | ++++ | ||
+ | ++++Get the actual temperature| | ||
+ | ++++ | ||
+ | |||
+ | === Irrigation === | ||
+ | The available command after selecting **Irrigation** and opening the " | ||
+ | |||
+ | ++++Enable/ | ||
+ | ++++ | ||
+ | |||
+ | === RGB === | ||
+ | After selecting **RGB**, a list of all the RGB objects added in System will be shown. The available commands when selecting one of the RGB objects are the following: | ||
+ | |||
+ | ++++Start RGB sequence shuffle with time in seconds| | ||
+ | * **Time** interval before switching to a new color, in seconds | ||
+ | ++++ | ||
+ | |||
+ | ++++Start RGB sequence repeat with time in seconds| | ||
+ | * **Time** interval before switching to a new color, in seconds | ||
+ | ++++ | ||
+ | |||
+ | ++++Stop RGB sequence and turn OFF| This command allows to stop an already launched sequence and turn off the RGB light. | ||
+ | ++++ | ||
+ | |||
+ | ++++Save the current color to the selected preset position| | ||
+ | * **Preset position** number of the slot where the color should be saved (value between 0-9). | ||
+ | ++++ | ||
+ | |||
+ | ++++Recall the color previously saved to the selected preset position| | ||
+ | * **Preset position** number of the slot corresponding to the desired color (value between 0-9). | ||
+ | ++++ | ||
+ | |||
+ | ===== Multimedia ===== | ||
+ | The list below contains all the possible objects that could be added to the Internal Services category: | ||
+ | <WRAP Group> | ||
+ | <WRAP column 30%> | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[#display| Display]] | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | </ | ||
+ | <WRAP column 50%> | ||
+ | <WRAP centeralign> | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | === Video Matrix === | ||
+ | After selecting **Video Matrix**, a list of all the video matrixes added in System will be shown. The available commands when selecting one of the matrixes are the following: | ||
+ | |||
+ | ++++Disconnect input for every output| | ||
+ | ++++ | ||
+ | |||
+ | ++++Disconnect input for selected output| | ||
+ | * **Output Number** | ||
+ | |||
+ | ++++ | ||
+ | |||
+ | ++++Set the selected input to the selected output| | ||
+ | * **Input Number** | ||
+ | * **Output Number** | ||
+ | ++++ | ||
+ | |||
+ | === Audio Matrix === | ||
+ | After selecting **Audio Matrix**, a list of all the audio matrixes added in System will be shown. The available commands when selecting one of the matrixes are the following: | ||
+ | |||
+ | ++++Set the selected input ot the selected output| | ||
+ | * **Input Number** | ||
+ | * **Output Number** use comma "," | ||
+ | ++++ | ||
+ | |||
+ | ++++Disconnect input for every output| | ||
+ | ++++ | ||
+ | |||
+ | ++++Mute or unmute selected output| | ||
+ | * **Output Number** use comma "," | ||
+ | * **Mute Value** 1=muted, 0=unmuted. | ||
+ | ++++ | ||
+ | |||
+ | ++++Volume up selected output| | ||
+ | * **Output Number** use comma "," | ||
+ | ++++ | ||
+ | |||
+ | ++++Volume down selected output| | ||
+ | * **Output Number** use comma "," | ||
+ | ++++ | ||
+ | |||
+ | ++++Set volume for selected output| | ||
+ | * **Output Number** use comma "," | ||
+ | * **Volume** value between 0-100. | ||
+ | ++++ | ||
+ | |||
+ | === Display === | ||
+ | After selecting **Display**, | ||
+ | |||
+ | ++++Set the TV channel number| | ||
+ | * **Channel Number** | ||
+ | ++++ | ||
+ | |||
+ | ++++Set the video source| | ||
+ | * **Source Number** | ||
+ | ++++ | ||
+ | |||
+ | ++++On or standby the device| | ||
+ | * **Power Value** 1=Power ON, 0=Standby. | ||
+ | ++++ | ||
+ | |||
+ | ++++Set the audio volume| | ||
+ | * **Volume Level** value between 0-100. | ||
+ | ++++ | ||
+ | |||
+ | ++++Set the audio volume up| This command will allow to raise the volume on the TV. | ||
+ | ++++ | ||
+ | |||
+ | ++++Set the audio volume down| This command will allow to lower the volume on the TV. | ||
+ | ++++ | ||
+ | |||
+ | === Home Theater === | ||
+ | After selecting **Home Theater**, a list of all the home theater devices added in System will be shown. The available commands when selecting one of the devices are the following: | ||
+ | |||
+ | <WRAP important round center 80%> Depending on the brand of the Home Theater device selected in System, some commands may not be applicable. </ | ||
+ | <WRAP important round center 80%> The values entered inside the commands vary depending on the protocol specification for each brand. </ | ||
+ | |||
+ | ++++Power On or Standby device| | ||
+ | * **Subzone** | ||
+ | * **power value** this value varies depending on the Brand of the Home Theater device. For more information, | ||
+ | ++++ | ||
+ | |||
+ | ++++Mute or unmute main output| | ||
+ | * **Subzone** | ||
+ | * **mute value** this value varies depending on the Brand of the Home Theater device. For more information, | ||
+ | ++++ | ||
+ | |||
+ | ++++Volume up main output| | ||
+ | * **Subzone** | ||
+ | ++++ | ||
+ | |||
+ | ++++Volume down main output| | ||
+ | * **Subzone** | ||
+ | ++++ | ||
+ | |||
+ | ++++Set volume for main output| | ||
+ | * **Subzone** | ||
+ | * **Volume** value between 0-100. | ||
+ | ++++ | ||
+ | |||
+ | ++++Bass up main output| | ||
+ | ++++ | ||
+ | |||
+ | ++++Bass down main output| | ||
+ | ++++ | ||
+ | |||
+ | ++++Treble up main output| | ||
+ | ++++ | ||
+ | |||
+ | ++++Treble down main output| | ||
+ | ++++ | ||
+ | |||
+ | ++++Enable or disable Subwoofer| | ||
+ | * **Sub enable** | ||
+ | ++++ | ||
+ | |||
+ | ++++Select source for main output| | ||
+ | * **Subzone** | ||
+ | * **Main source** | ||
+ | ++++ | ||
+ | |||
+ | ++++Select audio source for selected main source| | ||
+ | * **Subzone** | ||
+ | * **Main source audio** | ||
+ | ++++ | ||
+ | |||
+ | ++++Select video source for selected main source| | ||
+ | * **Subzone** | ||
+ | * **Main source video** | ||
+ | ++++ | ||
+ | |||
+ | ++++Read tuner frequency| | ||
+ | ++++ | ||
+ | |||
+ | ++++Read tuner station| | ||
+ | ++++ | ||
+ | |||
+ | ++++Tuner frequency up| This command will allow to raise the tuner frequency. | ||
+ | ++++ | ||
+ | |||
+ | ++++Tuner frequency down| This command will allow to lower the tuner frequency. | ||
+ | ++++ | ||
+ | |||
+ | ++++Tuner up| This command will allow to scan for the next tuner station. | ||
+ | ++++ | ||
+ | |||
+ | ++++Tuner down| This command will allow to scan for the previous tuner station. | ||
+ | ++++ | ||
+ | |||
+ | ++++Tuner auto search| | ||
+ | ++++ | ||
+ | |||
+ | ++++Tuner stop search| | ||
+ | ++++ | ||
+ | |||
+ | ++++Select digital mode for main output| | ||
+ | * **Digital Mode** | ||
+ | ++++ | ||
+ | |||
+ | ++++Select surround mode for main output| | ||
+ | * **Digital Mode** | ||
+ | ++++ | ||
+ | |||
+ | ++++Remote setup menu show/ | ||
+ | * **OSD Setup** 1=show OSD menu, 0=hide OSD menu. | ||
+ | ++++ | ||
+ | |||
+ | ++++Remote press cursor up| This command will simulate the remote control command " | ||
+ | ++++ | ||
+ | |||
+ | ++++Remote press cursor down| This command will simulate the remote control command " | ||
+ | ++++ | ||
+ | |||
+ | ++++Remote press cursor right| | ||
+ | ++++ | ||
+ | |||
+ | ++++Remote press cursor left| This command will simulate the remote control command " | ||
+ | ++++ | ||
+ | |||
+ | ++++Remote press Enter button| | ||
+ | ++++ | ||
+ | |||
+ | ++++Remote press Back/Return button| | ||
+ | ++++ | ||
+ | |||
+ | ++++Remote press Option button| | ||
+ | ++++ | ||
+ | |||
+ | ++++Remote press Info button| | ||
+ | ++++ | ||
+ | |||
+ | ++++Send a custom command| | ||
+ | * **Command to send to the device** refer to the Denon/ | ||
+ | ++++ | ||
+ | |||
+ | \\ The available statuses to read from the Home Theater when it is configured as Denon are the following: | ||
+ | ++++Get the active input | This feedback will read the active input on the AVR. | ||
+ | ++++ | ||
+ | |||
+ | ++++Get the power status of the device| | ||
+ | ++++ | ||
+ | |||
+ | ++++Get the present volume| | ||
+ | ++++ | ||
+ | |||
+ | ++++Get the selected audio type| This feedback will read the selected audio type. | ||
+ | ++++ | ||
+ | |||
+ | ++++Get the selected video type| This feedback will read the selected video type. | ||
+ | ++++ | ||
+ | |||
+ | ++++Get the text displayed by device| | ||
+ | ++++ | ||
+ | |||
+ | === Sonos Manager === | ||
+ | After selecting **Sonos Manager**, a list of all the players created in the System tab will be shown. \\ | ||
+ | The available commands when selecting one of the players are the following: | ||
+ | |||
+ | ++++Put the device in PLAY state| | ||
+ | ++++ | ||
+ | |||
+ | ++++Put the device in STOP state| | ||
+ | ++++ | ||
+ | |||
+ | ++++Volume up the device| | ||
+ | ++++ | ||
+ | |||
+ | ++++Volume down the device| | ||
+ | ++++ | ||
+ | |||
+ | ++++Skip track forward| | ||
+ | ++++ | ||
+ | |||
+ | ++++Skip track backward| | ||
+ | ++++ | ||
+ | |||
+ | ++++Set value for volume| | ||
+ | * **Desired Volume** value between 0 and 100. | ||
+ | ++++ | ||
+ | |||
+ | ++++Put the device in MUTE state| | ||
+ | * **Mute value** 1=unmuted, 0=muted. | ||
+ | ++++ | ||
+ | |||
+ | ++++Play the audio from Audio IN plug| This command will allow to play the music coming from the analog input of the player. | ||
+ | ++++ | ||
+ | |||
+ | ++++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. | ||
+ | ++++ | ||
+ | |||
+ | ++++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 < | ||
+ | ++++ | ||
+ | |||
+ | ++++Play the audio from a streaming| | ||
+ | * **Streaming URL** should follow the form < | ||
+ | ++++ | ||
+ | |||
+ | ++++Enable/ | ||
+ | * **Repeat value** 1=enabled, 0-disabled. | ||
+ | ++++ | ||
+ | |||
+ | ++++Enable/ | ||
+ | * **Shuffle value** 1=enabled, 0-disabled. | ||
+ | ++++ | ||
+ | |||
+ | ++++Start a Playlist from its number| | ||
+ | * **Playlist number** | ||
+ | ++++ | ||
+ | |||
+ | ++++Start a Playlist from its name| This command will start playing a desired playlist from its name. | ||
+ | * **Playlist name** | ||
+ | ++++ | ||
+ | |||
+ | ++++Play a favorite item from its number| | ||
+ | * **Favorite number** | ||
+ | ++++ | ||
+ | \\ The available statuses to read from the Sonos players are the following: | ||
+ | ++++Get mute status| | ||
+ | ++++ | ||
+ | ++++Get the current track album| This feedback will read the current track album. | ||
+ | ++++ | ||
+ | ++++Get the current track artist| This feedback will read the current track artist. | ||
+ | ++++ | ||
+ | ++++Get the current track cover URL| This feedback will read the current track artist URL. | ||
+ | ++++ | ||
+ | ++++Get the current track title| This feedback will read the current track title. | ||
+ | ++++ | ||
+ | ++++Get the current volume| This feedback will read the current volume level. | ||
+ | ++++ | ||
+ | ++++Get the last invoked playlist| This feedback will give the last invoked playlist. | ||
+ | ++++ | ||
+ | ++++Get the play status| This feedback will read the play status of the player. | ||
+ | ++++ | ||
+ | ++++Get the repeat status| This feedback will read if the repeat function is enabled or disabled. | ||
+ | ++++ | ||
+ | ++++Get the shuffle status| This feedback will read if the shuffle function is enabled or disabled. | ||
+ | ++++ | ||
+ | |||
+ | === Media Player === | ||
+ | After selecting **Media Player**, a list of all the players added in System will be shown. The available commands when selecting one of the media players are the following: | ||
+ | |||
+ | ++++ Navigate up in the user interface| 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. | ||
+ | ++++ | ||
+ | === IR Transmitter === | ||
+ | After selecting **IR Transmitter**, | ||
+ | |||
+ | ++++Send the selected command for the selected remote| | ||
+ | {{ :: | ||
+ | If you want to select a defined output different from the default one, before enqueuing the command, it is possible to enable the " | ||
+ | {{ :: | ||
+ | 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. | ||
+ | {{ :: | ||
+ | |||
+ | ++++ | ||
+ | |||
+ | |||
+ | ===== Security ===== | ||
+ | The list below contains all the possible objects that could be added to the Security category: | ||
+ | <WRAP Group> | ||
+ | <WRAP column 30%> | ||
+ | * [[# | ||
+ | * [[# | ||
+ | </ | ||
+ | <WRAP column 50%> | ||
+ | <WRAP centeralign> | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | === Alarm Device === | ||
+ | After selecting **Security**, | ||
+ | |||
+ | ++++Arm a particular partition with a specified code| This command will allow to arm one partition using its related pin code. | ||
+ | * **Partition Number** | ||
+ | * **Pin Code** | ||
+ | ++++ | ||
+ | |||
+ | ++++Disarm a particular partition with a specified code| This command will allow to disarm one partition using its related pin code. | ||
+ | * **Partition Number** | ||
+ | * **Pin Code** | ||
+ | ++++ | ||
+ | |||
+ | ++++Arm all partitions with a specified code| This command will allow to arm all partition using a common pin code. | ||
+ | * **Pin Code** | ||
+ | ++++ | ||
+ | |||
+ | ++++Disarm all partitions with a specified code| This command will allow to disarm all partition using a common pin code. | ||
+ | * **Pin Code** | ||
+ | ++++ | ||
+ | |||
+ | ++++Switch ON or OFF the specified output| | ||
+ | * **Number of the output to switch** | ||
+ | * **New /state of the output** ON=1, OFF=0. | ||
+ | ++++ | ||
+ | |||
+ | === Centrale === | ||
+ | After selecting **Security**, | ||
+ | |||
+ | ++++Arm a particular partition with a specified code| This command will allow to arm one partition using its related pin code. | ||
+ | * **Partition Number** | ||
+ | * **Pin Code** | ||
+ | ++++ | ||
+ | |||
+ | ++++Disarm a particular partition with a specified code| This command will allow to disarm one partition using its related pin code. | ||
+ | * **Partition Number** | ||
+ | * **Pin Code** | ||
+ | ++++ | ||
+ | |||
+ | ++++Arm all partitions with a specified code| This command will allow to arm all partition using a common pin code. | ||
+ | * **Pin Code** | ||
+ | ++++ | ||
+ | |||
+ | ++++Disarm all partitions with a specified code| This command will allow to disarm all partition using a common pin code. | ||
+ | * **Pin Code** | ||
+ | ++++ | ||
+ | |||
+ | ++++Switch ON or OFF the specified output| | ||
+ | * **Number of the output to switch** | ||
+ | * **New /state of the output** ON=1, OFF=0. | ||
+ | ++++ | ||
+ |