Difference between revisions of "IR"

From HSYCO
Jump to navigation Jump to search
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{UI Object Header}}
 
{{UI Object Header}}
 
A button used to send infrared (IR) commands through the IRTrans IR emitter/receiver network devices.
 
A button used to send infrared (IR) commands through the IRTrans IR emitter/receiver network devices.
It has several colors (depending on the skin) and three different sizes:
+
It has three button versions with several colors (depending on the skin) and an image version with a custom image:
 
* '''ir''' (standard size)
 
* '''ir''' (standard size)
 +
:[[File:UI Object link.png]]
 
* '''irmini''' (medium size)
 
* '''irmini''' (medium size)
 +
:[[File:UI Object linkmini.png]]
 
* '''irmicro''' (small size)
 
* '''irmicro''' (small size)
 +
:[[File:UI Object linkmicro.png]]
 +
* '''irimage''' (custom image)
 +
:[[File:UI Object imagelink.png]]
  
 
== Parameters ==
 
== Parameters ==
*'''irid''': IRTrans id, as defined in the list of the IRTrans parameter in
+
*'''irid''': IRTrans id, as defined in the list of the IRTrans parameter in hsyco.ini
hsyco.ini
+
*'''com''': the sequence of IR commands to send. Every command is composed by a name that identifies the commands database, followed by a comma and the name of the command in that database. Different commands in sequence can be separated by blank spaces. It is possible to insert the special @N command, which introduces a wait time of N milliseconds before sending the next command. For example:
*'''com''': the sequence of IR commands to send. Every command is
+
:<code>denon-1036,on @4000 denon-1036,tv</code>
composed by a name that identifies the commands database, followed by a comma and the name of the command in that database. Different commands in sequence can be separated by blank spaces. It is possible to insert the special @N command, which introduces a wait time of N milliseconds before sending the next command. For example:
+
: sends the “on” command of the “denon-1036” remote control, then waits 4 seconds, and finally sends the “tv” command of the “denon-1036”
denon-1036,on @4000 denon-1036,tv
 
sends the “on” command of the “denon-1036” remote control, then waits 4 seconds, and finally sends the “tv” command of the “denon-1036”
 
 
*'''position''': the object's position. Use the pixels or rows and columns coordinates format
 
*'''position''': the object's position. Use the pixels or rows and columns coordinates format
 +
*'''label''': the text label on the button. It can contain HTML tags
 +
*'''repeat''': if true, the command will be repeat every second
 +
 +
 +
For the button versions:
 
*'''color''':  the color of the button. It can assume any of the skin's color values (E.g. for the "blue" skin, the possible values are: b - blue; g - green; gr - gray; r - red; y - yellow; glass)
 
*'''color''':  the color of the button. It can assume any of the skin's color values (E.g. for the "blue" skin, the possible values are: b - blue; g - green; gr - gray; r - red; y - yellow; glass)
*'''label''': the text label on the button. It can contain HTML tags
+
 
 +
 
 +
For the image version:
 +
*'''image filename''': the image filename
 +
 
 +
{{Note: IMG Filename}}
  
 
== Syntax ==
 
== Syntax ==
  (ir <irid>; <com>; <pos>; <color>; <label>)
+
  (ir <irid>; <com>; <pos>; <color>; <label>; <repeat>)
 
   
 
   
  (irmini <irid>; <com>; <pos>; <color>; <label>)
+
  (irmini <irid>; <com>; <pos>; <color>; <label>; <repeat>)
 
   
 
   
  (irmicro <irid>; <com>; <pos>; <color>; <label>)
+
  (irmicro <irid>; <com>; <pos>; <color>; <label>; <repeat>)
 
   
 
   
  (irimage <file>; <pos>; <width>; <height>; <irid>; <com>; <label>; <css>)
+
  (irimage <image filename>; <pos>; <width>; <height>; <irid>; <com>; <label>; <css>; <repeat>)
 
 
 
E.g.
 
E.g.
 +
(ir 1; denon-1036,on; r1c1; gr; label; enabled)
 +
 +
(irmicro 1; denon-1036,on; x193y0; gr; label)
 +
 +
(irmini 1; denon-1036,on; x113y0; gr; label)
 +
 +
(irimage apple.png; x246y0; 81; 77; 1; denon-1036,on)

Latest revision as of 12:31, 27 January 2014

Note  For a description and a complete list of UI Objects, see UI Objects.

A button used to send infrared (IR) commands through the IRTrans IR emitter/receiver network devices. It has three button versions with several colors (depending on the skin) and an image version with a custom image:

  • ir (standard size)
UI Object link.png
  • irmini (medium size)
UI Object linkmini.png
  • irmicro (small size)
UI Object linkmicro.png
  • irimage (custom image)
UI Object imagelink.png

Parameters

  • irid: IRTrans id, as defined in the list of the IRTrans parameter in hsyco.ini
  • com: the sequence of IR commands to send. Every command is composed by a name that identifies the commands database, followed by a comma and the name of the command in that database. Different commands in sequence can be separated by blank spaces. It is possible to insert the special @N command, which introduces a wait time of N milliseconds before sending the next command. For example:
denon-1036,on @4000 denon-1036,tv
sends the “on” command of the “denon-1036” remote control, then waits 4 seconds, and finally sends the “tv” command of the “denon-1036”
  • position: the object's position. Use the pixels or rows and columns coordinates format
  • label: the text label on the button. It can contain HTML tags
  • repeat: if true, the command will be repeat every second


For the button versions:

  • color: the color of the button. It can assume any of the skin's color values (E.g. for the "blue" skin, the possible values are: b - blue; g - green; gr - gray; r - red; y - yellow; glass)


For the image version:

  • image filename: the image filename
Image files are searched inside the www/<project's name>/img directory first, then inside the www/img directory.
If the filename is set with a UISet, it's possible to load an image from the web by entering the URL, or a path relative to www/<skin's name>/pic by specifying /pic/ followed by the filename


Syntax

(ir <irid>; <com>; <pos>; <color>; <label>; <repeat>)

(irmini <irid>; <com>; <pos>; <color>; <label>; <repeat>)

(irmicro <irid>; <com>; <pos>; <color>; <label>; <repeat>)

(irimage <image filename>; <pos>; <width>; <height>; <irid>; <com>; <label>; <css>; <repeat>)

E.g.

(ir 1; denon-1036,on; r1c1; gr; label; enabled)

(irmicro 1; denon-1036,on; x193y0; gr; label)

(irmini 1; denon-1036,on; x113y0; gr; label)

(irimage apple.png; x246y0; 81; 77; 1; denon-1036,on)