UI4 UI5 Migration - Revision history

A-lurker at 06:10, 8 June 2013

2013-06-08T06:10:48Z

2012-03-27T11:08:13Z

2012-03-27T11:07:26Z

‎The require() function

2012-02-23T15:20:04Z

‎New device file tags

2012-02-23T15:16:56Z

2012-02-16T16:53:46Z

‎The require() function

2012-01-09T10:21:01Z

‎Lua Files

2012-01-05T14:26:50Z

‎New device tags

2012-01-05T11:07:59Z

‎New device tags

2012-01-03T15:16:19Z

‎New control tags

← Older revision		Revision as of 06:10, 8 June 2013
Line 1:		Line 1:
−	[[Category:UI5]]	+	[[Category:Development]] [[Category:UI5]]
	Our newest Ui5 does some things differently than Ui4. This page explains the changes in Ui5 that may not be obvious to Ui4 users.		Our newest Ui5 does some things differently than Ui4. This page explains the changes in Ui5 that may not be obvious to Ui4 users.

@@ Line 222: / Line 222: @@
 In firmware version 1.5.261 the '''require''' Lua function has been overloaded to handle compressed Lua files. Also, setting the '''package.path''' variable is no longer necessary for Lua files in '''/etc/cmh-lu''' and '''/etc/cmh-ludl'''.
-<span style="color: rgb(255, 0, 0);">'''NOTE'''''':''' The compressed modules must be declared with '''module()''', and not using any of the alternative forms.</span>
+'''<span style="color: rgb(255, 0, 0);">NOTE:</span>'''<span style="color: rgb(255, 0, 0);"> The compressed modules must be declared with '''module()''', and not using any of the alternative forms.</span>
 === New device file tags  ===

@@ Line 218: / Line 218: @@
   </implementation>
-==== The '''''require()''''' function ====
+==== The '''''require()''''' function  ====
 In firmware version 1.5.261 the '''require''' Lua function has been overloaded to handle compressed Lua files. Also, setting the '''package.path''' variable is no longer necessary for Lua files in '''/etc/cmh-lu''' and '''/etc/cmh-ludl'''.
 === New device file tags  ===

@@ Line 226: / Line 226: @@
 ==== ''<Category_Num>'' and ''<SubCategory_Num>''  ====
-These tags were previously added at runtime. Starting with firmware version 1.5.308 it's possible to specify the device category and subcategory using these tags.
+These tags were previously added at runtime. Starting with firmware version 1.5.308 it's possible to specify the device [http://wiki.micasaverde.com/index.php/Luup_UPNP_Files#Device_Categories category] and [http://wiki.micasaverde.com/index.php/Luup_UPNP_Files#Device_Sub-Categories subcategory] using these tags.
 For a heater, this is how the tags look like:

@@ Line 209: / Line 209: @@
 e.g. This is how the implementation file for the Z-Wave Routing Matrix plugin looks like. The ''startup'' function is defined in the L_ZWaveRoutingMatrix.lua file. It '''must not be declared as local''', otherwise it won't be found.
-    &lt;?xml version="1.0"?&gt;
+  <implementation>
-  &lt;implementation&gt;
+     <specVersion>
-     &lt;specVersion&gt;
+         <major>1</major>
-         &lt;major&gt;1&lt;/major&gt;
+         <minor>0&</minor>
-         &lt;minor&gt;0&lt;/minor&gt;
+     </specVersion>
-     &lt;/specVersion&gt;
+     <files>L_ZWaveRoutingMatrix.lua</files>
-     &lt;files&gt;L_ZWaveRoutingMatrix.lua&lt;/files&gt;
+     <startup>startup</startup>
-     &lt;startup&gt;startup&lt;/startup&gt;
+  </implementation>
-  &lt;/implementation&gt;
 ==== The '''''require()''''' function ====
 In firmware version 1.5.261 the '''require''' Lua function has been overloaded to handle compressed Lua files. Also, setting the '''package.path''' variable is no longer necessary for Lua files in '''/etc/cmh-lu''' and '''/etc/cmh-ludl'''.

← Older revision		Revision as of 16:53, 16 February 2012
Line 220:		Line 220:

	==== The '''''require()''''' function ====		==== The '''''require()''''' function ====
−	In firmware version 1.5.~~161~~ the '''require''' Lua function has been overloaded to handle compressed Lua files. Also, setting the '''package.path''' variable is no longer necessary for Lua files in '''/etc/cmh-lu''' and '''/etc/cmh-ludl'''.	+	In firmware version 1.5.261 the '''require''' Lua function has been overloaded to handle compressed Lua files. Also, setting the '''package.path''' variable is no longer necessary for Lua files in '''/etc/cmh-lu''' and '''/etc/cmh-ludl'''.

@@ Line 202: / Line 202: @@
 === Lua Files  ===
+==== The '''''<files>''''' tag ====
 <span style="color: rgb(255, 0, 0);">'''Note:''' The Lua files must be terminated with a newline character, i.e the last code line shouldn't be the last line in the file.</span>
@@ Line 218: / Line 218: @@
      &lt;startup&gt;startup&lt;/startup&gt;
   &lt;/implementation&gt;

@@ Line 154: / Line 154: @@
 *'''inScene''': If this tag is present and has the value ''"1"'', the device will be usable in the scene editor.
-*'''x''', '''y''': These represent the device box dimensions, ''x'' and ''y'' being the width and the height respectively. 1x = 80 pixels, 1y = 25 pixels. These are used to tell the UI how much space you need to draw all the controls (excluding the header and the icon). A button has x = 1 and y = 1, an horizontal slider has x = 2 and y = 1 and a vertical slider has x = 0.5 and y = 3.
+*'''x''', '''y''': These represent the device box dimensions, ''x'' and ''y'' being the width and the height respectively. 1x = 80 pixels, 1y = 24 pixels. These are used to tell the UI how much space you need to draw all the controls (excluding the header and the icon). A button has x = 1 and y = 1, an horizontal slider has x = 2 and y = 1 and a vertical slider has x = 0.5 and y = 3.
 The device can have 0 or more ''SceneGroups''.

@@ Line 191: / Line 191: @@
 *'''x''', '''y'''
-Similar to the scene group dimensions, 1x = 80px, 1y = 24px. Dimensions are applicable to '''variables''', '''labels''' and '''buttons''' only. Buttons can't be larger than ''2x'', ''2y''. Default dimensions for a control are ''1x'' and ''1y''.
+Similar to the scene group dimensions, 1x = 80px, 1y = 24px. Dimensions are applicable to '''variables''' and '''labels''' only. Default dimensions for a control are ''1x'' and ''1y''.
 For '''variables''' and '''labels''' text alignment can be specified with:
@@ Line 199: / Line 199: @@
 '''Note:''' ''ControlPair'' and ''ControlHeader'' are not used anymore.
 [[Image:Demo grid.jpg|600px|Demo grid.jpg]]
 === Lua Files  ===