Luup plugin tabs - Revision history

Gengen at 17:33, 12 June 2016

2016-06-12T17:33:30Z

Gengen at 18:13, 4 April 2015

2015-04-04T18:13:51Z

Gengen: /* ControlType slider */

2015-03-29T00:15:39Z

‎ControlType slider

Gengen: /* ControlType input */

2015-03-29T00:11:45Z

‎ControlType input

Gengen: /* ControlType slider */

2015-03-28T23:29:10Z

‎ControlType slider

Gengen: /* ControlType slider_vertical */

2015-03-28T23:26:37Z

‎ControlType slider_vertical

Gengen: /* ControlType slider */

2015-03-28T23:25:08Z

‎ControlType slider

Gengen: /* ControlType slider */

2015-03-28T23:24:29Z

‎ControlType slider

Gengen: /* ControlType slider */

2015-03-28T23:08:08Z

‎ControlType slider

Gengen: /* ControlType line_break */

2015-03-28T23:02:28Z

‎ControlType line_break

@@ Line 32: / Line 32: @@
 ;'''Control'''
 :An array of controls for each tab. Each control consists of:
 *'''ControlType''' - the Control Types are described further below.
 *'''ControlGroup''' - a reference to the control's ControlGroup
 *'''text_align''' - align left or right
@@ Line 185: / Line 186: @@
 ===ControlType js_button===
-:Used in: D_DigitalSecurityCamera1.json
+:'''js_button''' is used for certain objects baked into the Vera UI such as security camera controls in D_DigitalSecurityCamera1.json
 =UI7 Updates=

@@ Line 154: / Line 154: @@
 ** '''Variable''' (a string containing the name of a variable),
 ** '''MinValue''', '''MaxValue''' (both strings containing numbers, controlling what range of values the slider takes)
-*** '''Note:''' in firmware 1.7.541 and earlier, MinValue and MaxValue are ignored and taken to be 0 and 100 % respectively.
+*** '''Note:''' in firmware 1.7.541 and earlier, MinValue and MaxValue must be 0 and 100 % respectively.
 ** '''ID''' (a string, used in the '''Command''' to refer to the position the user has dragged the slider to). The specified variable's value is used to display the slider's current position.
 * '''Command''' A JSON object with three keys:

@@ Line 154: / Line 154: @@
 ** '''Variable''' (a string containing the name of a variable),
 ** '''MinValue''', '''MaxValue''' (both strings containing numbers, controlling what range of values the slider takes)
 ** '''ID''' (a string, used in the '''Command''' to refer to the position the user has dragged the slider to). The specified variable's value is used to display the slider's current position.
 * '''Command''' A JSON object with three keys:

@@ Line 126: / Line 126: @@
 :A string which other controls (buttons) will use to refer to the string that the user has typed into this field.
 ;'''Display'''
-:A JSON object with four keys: '''Top''', '''Left''', '''Width''', '''Height''' (all strings containing numbers). This controls where the text box is placed in the tab.
+:A JSON object containing:
 ===ControlType button===

@@ Line 143: / Line 143: @@
 With '''ControlType''' set to '''slider''', a draggable slider is placed at the specified coordinates.
-* '''Note:''' in UI5, there can only be one horizontal slider (0% - 100%) per device.
+* '''Note:''' in UI5 and in UI7 (1.7.541 - release 7.0.5 and earlier), there can only be one horizontal slider (0% - 100%) per device.
 The following additional keys must also be provided:

← Older revision		Revision as of 23:26, 28 March 2015
Line 165:		Line 165:

	:Used in: D_Heater1.json, D_HVAC_ZoneThermostat1.json		:Used in: D_Heater1.json, D_HVAC_ZoneThermostat1.json
		+
		+	Parameters for slider_vertical are similar to slider. The first slider_vertical is red and used for heating. The second slider_vertical is blue and used for cooling.

	===ControlType checkbox===		===ControlType checkbox===

@@ Line 143: / Line 143: @@
 With '''ControlType''' set to '''slider''', a draggable slider is placed at the specified coordinates.
-*Note: in UI5, there can only be one horizontal slider (0% - 100%) per device. There can be at most two verical sliders. The first is red and used for heating. The second is blue and used for cooling.
+* '''Note:''' in UI5, there can only be one horizontal slider (0% - 100%) per device. There can be at most two verical sliders. The first is red and used for heating. The second is blue and used for cooling.
 The following additional keys must also be provided:
-;'''Display'''
+* '''Display''' A JSON object with nine keys:
-:A JSON object with nine keys: '''Top''', '''Left''', '''Width''', '''Height''' (all strings containing numbers, controlling where the button is placed in the tab), '''Service''' (a string containing the Service Id of a variable), and '''Variable''' (a string containing the name of a variable), '''MinValue''' and '''MaxValue''' (both strings containing numbers, controlling what range of values the slider takes) and '''ID''' (a string, used in the '''Command''' to refer to the position the user has dragged the slider to). The specified variable's value is used to display the slider's current position.
+** '''Top''', '''Left''', '''Width''', '''Height''' (all strings containing numbers, controlling where the button is placed in the tab)
-;'''Command'''
+** '''Service''' (a string containing the Service Id of a variable)
-:A JSON object with three keys: '''Service''' (a string containing the service Id of an action that this device can perform), '''Action''' (a string containing the name of the action), and '''Parameters''' (a JSON array of JSON objects, forming the parameters to pass to the action). Each parameter object has a key '''Name''' for the parameter name, and either a key '''Value''' (for a fixed parameter value) or a key '''ID''' matching the slider's ID (for a value matching what the user has dragged the slider to).
+** '''Variable''' (a string containing the name of a variable),
-;'''ControlHeader'''
+** '''MinValue''', '''MaxValue''' (both strings containing numbers, controlling what range of values the slider takes)
-:Optional. If present, must have string value "1". When set, the slider's label and value are displayed. Otherwise only the slider is shown. (TODO: This is from reverse-engineering the JavaScript code. Test this.)
+** '''ID''' (a string, used in the '''Command''' to refer to the position the user has dragged the slider to). The specified variable's value is used to display the slider's current position.
 ===ControlType slider_vertical===

@@ Line 141: / Line 141: @@
 ===ControlType slider===
-With '''ControlType''' set to '''slider''', a draggable slider is placed at the specified coordinates. The following additional keys must also be provided:
+With '''ControlType''' set to '''slider''', a draggable slider is placed at the specified coordinates.
 ;'''Display'''

@@ Line 173: / Line 173: @@
 ===ControlType line_break===
-This is used to force the next control to appear below the previous one rather than alongside it. See [[Static JSON file]]
+This is used to force the next control to appear below the previous one rather than alongside it. See [[Luup plugins: Static JSON file]].
 * '''ControlGroup''' - an integer - has the same behaviour as in previous UIs
 * '''ControlType''' - a string which must be set to ‘line_break’