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
generic_commands [2019/10/28 10:05] ingridgeneric_commands [2022/06/16 08:26] (current) – [Reports and Gateways] ingrid
Line 1: Line 1:
 ====== Internal Commands & Status ====== ====== 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, with the 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 73: Line 74:
   * **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 252: 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**
 +  * **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 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.
 +++++
 +
 +++++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/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 487: Line 519:
   * [[#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 526: 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|  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 766: Line 809:
 ++++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 830: Line 893:
 ++++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.
 ++++ ++++
  
  • generic_commands.1572253508.txt.gz
  • Last modified: 2019/10/28 10:05
  • by ingrid