Differences

This shows you the differences between two versions of the page.

--- generic_commands [2019/10/21 19:20] – ingrid
+++ generic_commands [2020/07/15 09:49] – [Internal Services] 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.
@@ Line 111: / Line 111: @@
 <WRAP Group>
 <WRAP column 30%>
+  * [[#hue_gateway| Hue Gateway]]
   * [[#gateway_modbus| Gateway Modbus]]
   * [[#lutron_project| Lutron Project]]
@@ Line 125: / Line 126: @@
 </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 ===
@@ Line 467: / Line 487: @@
   * [[#chronothermostat| Chronothermostat]]
   * [[#email_account| Email Account]]
+  * [[#thinknx_sensors| Thinknx Sensors]]
   * [[#irrigation| Irrigation]]
   * [[#rgb| RGB]]
@@ Line 506: / Line 527: @@
   * **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 commands 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 812: / Line 843: @@
 ++++
+=== 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**, 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: