Difference between revisions of "ButtonIcon"

From HSYCO
Jump to navigation Jump to search
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{UI Object Header}}
 
{{UI Object Header}}
Controls a [[light]] or [[device|automation device]], has the same function of the [[Button|button object]].
+
Controls a light or automation device, has the same function of the [[Button|button object]].
  
If the button object is connected to a device or light that allows it, a long press on the button will open a [[popup]] with a [[slider]]. A second long press will close the [[popup]].
+
[[File:UI Object buttonicon.png]]
If specified on [[systemtopo.txt]], it will show a thumbnail on mouse over or touch.
+
 
 +
If the buttonicon object is connected to a device or light that allows it, a long press on the button will open a [[popup]] with a [[slider]]. A second long press will close the [[popup]].
 +
If specified on systemtopo.txt, it will show a thumbnail on mouse over or touch.
  
 
== Parameters ==
 
== Parameters ==
*'''address''': device data point name
+
*'''id''': the object's ID, used by UISets. Optional
 +
*'''address''': device data point name. Supports [[Redirect variables]]
 
*'''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
 
*'''color''': the text label on the button. Can contain HTML tags
 
*'''color''': the text label on the button. Can contain HTML tags
  
 
== Syntax ==
 
== Syntax ==
  (buttonicon <address>; <position>; <color>)
+
  (buttonicon[!<id>] <address>; <position>; <label>)
 
Eg.
 
Eg.
 
  (buttonicon autom.1; x10y20; Front Door)
 
  (buttonicon autom.1; x10y20; Front Door)
Line 17: Line 20:
 
== UI Attributes ==
 
== UI Attributes ==
 
{{UI Object Attributes (Common)}}
 
{{UI Object Attributes (Common)}}
{{UI Object Attributes (Button)}}
+
 
 +
=== Button attributes ===
 +
{| class="wikitable"
 +
!Name
 +
!Value
 +
!Description
 +
|-
 +
|rowspan="2"|confirm
 +
|false
 +
|Default
 +
|-
 +
|true
 +
|Button requires confirmation with a second click, before sending the command
 +
|-
 +
|}

Latest revision as of 16:22, 13 October 2020

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

Controls a light or automation device, has the same function of the button object.

UI Object buttonicon.png

If the buttonicon object is connected to a device or light that allows it, a long press on the button will open a popup with a slider. A second long press will close the popup. If specified on systemtopo.txt, it will show a thumbnail on mouse over or touch.

Parameters

  • id: the object's ID, used by UISets. Optional
  • address: device data point name. Supports Redirect variables
  • position: the object's position. Use the pixels or rows and columns coordinates format
  • color: the text label on the button. Can contain HTML tags

Syntax

(buttonicon[!<id>] <address>; <position>; <label>)

Eg.

(buttonicon autom.1; x10y20; Front Door)

UI Attributes

Common attributes

Name Value Description
pos x<x>y<y> Position specified as x/y coordinates. E.g. x-5y10
visible true Default. Show the object
false Hide the object
blink true | slow Blink the object at a slow speed
fast Blink the object at a fast speed
false Stop the blinking
opacity 0.0 ... 1.0 Object opacity from 0 (not visible) to 1 (fully visible)
rotation 0 ... 360 Object rotation in degrees. Images are rotated around the center point, all other objects are rotated around the top left corner

Button attributes

Name Value Description
confirm false Default
true Button requires confirmation with a second click, before sending the command