generic_commands

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
Last revisionBoth sides next revision
generic_commands [2019/08/29 09:56] – [Generic Commands] ingridgeneric_commands [2021/10/26 10:13] – [Reports and Gateways] ingrid
Line 1: Line 1:
-====== Generic Commands ======+====== Internal Commands & Status ======
  
-\\  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, in a universal gateway, etc.+\\  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, with the universal gateway, etc. Some objects, like Sonos Manager, will also allow you to read statuses from the devices by using an Analog Value interface object or an Extended Command 
 + 
 +The commands/Statuses are grouped into 5 categories: 
 +  * **[[#system | System ]]** 
 +  * **[[#reports_and_gateways | Reports and Gateways ]]** 
 +  * **[[#internal_services | Internal Services ]]** 
 +  * **[[#multimedia | Multimedia ]]** 
 +  * **[[#security | Security ]]**
  
-The commands are grouped into 5 categories: 
-  * **[[#system | System]]** 
-  * **[[#reports_and_gateways | Reports and Gateways]]** 
-  * **[[#internal_services | Internal Services]]** 
-  * **[[#multimedia | Multimedia]]** 
-  * **[[#security | Security]]** 
  
 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!". 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. 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. ++++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 "explorer.exe", and put the entire path leading to the folder or file in the Parameter field.
 ++++ ++++
 ++++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 "explorer.exe", and put the entire path leading to the folder or file in the Parameter field.
 ++++ ++++
 ++++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%>
 +  * [[#hue_gateway| Hue Gateway]]
   * [[#gateway_modbus| Gateway Modbus]]   * [[#gateway_modbus| Gateway Modbus]]
   * [[#lutron_project| Lutron Project]]   * [[#lutron_project| Lutron Project]]
Line 124: Line 130:
 </WRAP> </WRAP>
 </WRAP> </WRAP>
 +
 +=== Hue Gateway ===
 +The available commands when selecting the **Hue Gateway** category under **Reports and Gateways** are the following:
 +
 +++++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.
 +++++
 +
  
 === 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/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 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.
 +++++
 +
 +++++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**   * **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.   * **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.
Line 466: Line 505:
   * [[#chronothermostat| Chronothermostat]]   * [[#chronothermostat| Chronothermostat]]
   * [[#email_account| Email Account]]   * [[#email_account| Email Account]]
 +  * [[#thinknx_sensors| Thinknx Sensors]]
   * [[#irrigation| Irrigation]]   * [[#irrigation| Irrigation]]
   * [[#rgb| RGB]]   * [[#rgb| RGB]]
Line 505: Line 545:
   * **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|  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
 ++++ ++++
  
Line 745: Line 795:
 ++++Send a custom command|  This command will allow to send a customized command to the device. ++++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.   * **Command to send to the device** refer to the Denon/Marantz protocol specification.
 +++++
 +
 +\\ 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|  This feedback will read the power status of the device.
 +++++
 +
 +++++Get the present volume|  This feedback will read the current volume set on the device.
 +++++
 +
 +++++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|  This feedback will read the text displayed on the 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|  This command will allow to play music on the selected player. ++++Put the device in PLAY state|  This command will allow to play music on the selected player.
Line 809: Line 879:
 ++++Play a favorite item from its number|  This command will start playing a desired item from the Favorite list. ++++Play a favorite item from its number|  This command will start playing a desired item from the Favorite list.
   * **Favorite number**   * **Favorite number**
 +++++
 +\\ The available statuses to read from the Sonos players are the following:
 +++++Get mute status|  This feedback will read the 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**, a list of all the transmitters created in the System tab will be shown. The available commands when selecting one of the transmitters are the following: After selecting **IR Transmitter**, a list of all the transmitters created in the System tab will be shown. The available commands when selecting one of the transmitters are the following:
  
-++++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. It is possible to send multiple commands by pressing "Enqueue" and choosing another one from the list, as well as adding a pause between the commands. +++++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. 
-The Output Option will allow the user to send the IR commands to the selected outputs of the IR transmitter.+{{ ::ir_command_definitio.png?direct&600 |}} 
 +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  |}} 
 +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  |}} 
 ++++ ++++
 +
  
 ===== Security ===== ===== Security =====
  • generic_commands.txt
  • Last modified: 2022/06/16 08:26
  • by ingrid