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/08/29 09:57]
ingrid [Generic Commands]
generic_commands [2019/10/28 10:05] (current)
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, 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.
Line 68: Line 68:
    * **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.
Line 110: Line 111:
 <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 126:
 </​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 811: Line 832:
 ++++ ++++
  
 +=== 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 =====