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/08/29 09:55] – [Generic Commands] ingrid | generic_commands [2022/06/16 08:26] (current) – [Reports and Gateways] ingrid | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
- | \\ When an object is added to the System, and if this object allows it, a list of commands related to this object will be accessible | + | \\ When an object is added to the System, a list of all the commands related to this object will be accessible, if applicable. These commands can be used on a generic button, inside the logic module, |
+ | |||
+ | 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 68: | 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. | ||
* **Command** | * **Command** | ||
* **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. | ||
* **Command** | * **Command** | ||
* **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 110: | Line 115: | ||
<WRAP Group> | <WRAP Group> | ||
<WRAP column 30%> | <WRAP column 30%> | ||
+ | * [[# | ||
* [[# | * [[# | ||
* [[# | * [[# | ||
Line 124: | Line 130: | ||
</ | </ | ||
</ | </ | ||
+ | |||
+ | === 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 231: | Line 256: | ||
++++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. | ++++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** | * **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/ | * **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/ | ||
Line 466: | Line 519: | ||
* [[# | * [[# | ||
* [[# | * [[# | ||
+ | * [[# | ||
* [[# | * [[# | ||
* [[#rgb| RGB]] | * [[#rgb| RGB]] | ||
Line 505: | Line 559: | ||
* **Email recipients** separate the emails using " ; ". | * **Email recipients** separate the emails using " ; ". | ||
* **Email content** body of the email. | * **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| | ||
++++ | ++++ | ||
Line 745: | Line 809: | ||
++++Send a custom command| | ++++Send a custom command| | ||
* **Command to send to the device** refer to the Denon/ | * **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 === | === 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: | + | 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 PLAY state| | ||
Line 809: | Line 893: | ||
++++Play a favorite item from its number| | ++++Play a favorite item from its number| | ||
* **Favorite 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 === | === IR Transmitter === | ||
After selecting **IR Transmitter**, | After selecting **IR Transmitter**, | ||
- | ++++Send the selected command for the selected remote| | + | ++++Send the selected command for the selected remote| |
- | The Output Option | + | {{ :: |
+ | 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 | ||
+ | {{ :: | ||
+ | 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 | ||
+ | {{ :: | ||
++++ | ++++ | ||
+ | |||
===== Security ===== | ===== Security ===== |