Luup Declarations - Revision history

Mcvflorin: /* */

2017-06-16T12:57:36Z

‎

Mcvflorin at 12:55, 16 June 2017

2017-06-16T12:55:08Z

Mcvflorin: /* (callback) */

2017-06-16T12:40:51Z

‎(callback)

Mcvflorin: /* (callback) */

2017-06-16T12:39:16Z

‎(callback)

Mcvflorin: /* (callback) */

2017-06-16T12:37:20Z

‎(callback)

Mcvflorin: /* */

2016-01-07T15:38:40Z

‎

Mcvflorin: /* */

2016-01-07T15:38:29Z

‎

Mcvflorin: /* */

2016-01-07T15:30:02Z

‎

Mcvflorin: /* */

2016-01-07T15:26:09Z

‎

Mcvflorin: /* */

2016-01-07T15:25:53Z

‎

@@ Line 119: / Line 119: @@
 return values: return 3 variables with the syntax return a,b,c where the first is true if the startup was successful or false if not, followed by 2 strings for the comments and the name of the module
-If this function is called in the startup sequence specified in the 'startup' XML tag, return true if the startup was ok, false if it wasn't, followed by some comments and the name of the module, like this: <source lang="lua>return false,'Cannot get state','gc100'</source> or <source lang="lua>return true,'ok','gc100'</source>
+If this function is called in the startup sequence specified in the 'startup' XML tag, return true if the startup was ok, false if it wasn't, followed by some comments and the name of the module, like this: <source lang="lua">return false,'Cannot get state','gc100'</source> or <source lang="lua">return true,'ok','gc100'</source>
 ==<ir>==

@@ Line 1: / Line 1: @@
 [[Category:Development]]
-When the Luup engine calls your Lua code it will pass your code some variables relevant to whatever the code is supposed to do.  You can see how your code looks with the full function declarations by bringing up this page in a web browser: http://ip_of_vera:49451/data_request?id=lu_lua&DeviceNum=8
+When the Luup engine calls your Lua code it will pass your code some variables relevant to whatever the code is supposed to do.  You can see how your code looks with the full function declarations by bringing up this page in a web browser: http://IP_of_Vera:3480/data_request?id=lua&DeviceNum=8
 Here is a list of the variables that are passed to your Lua code, and also a list of what return values the Lua code should send back.  The tag names are explained here: [[Luup_Plugins_ByHand#The_Luup_XML_implementation_file|The Luup XML implementation file]].
@@ Line 93: / Line 93: @@
 return values: lul_data,lul_outputformat
-When you call lu_RegisterHandler (see [[Luup_Lua_extensions]]) to handle a request on a URL, you pass in a function name that will handle the request.  This function is called with lul_request as a string containing the request ID, lul_parameters is a table with all the arguments on the URL, and lul_outputformat is the requested format of the data passed on the &output_format= in the URL.
+When you call [[Luup_Lua_extensions#function:_register_handler|luup.register_handler]] to handle a request on a URL, you pass in a function name that will handle the request.  This function is called with lul_request as a string containing the request ID, lul_parameters is a table with all the arguments on the URL, and lul_outputformat is the requested format of the data passed on the &output_format= in the URL.
 You return lul_data which is a string containing the response which is forwarded to the client, and optionally lul_outputformat, which is the document type put in the HTML response.
@@ Line 119: / Line 119: @@
 return values: return 3 variables with the syntax return a,b,c where the first is true if the startup was successful or false if not, followed by 2 strings for the comments and the name of the module
-If this function is called in the startup sequence specified in the 'startup' XML tag, return true if the startup was ok, false if it wasn't, followed by some comments and the name of the module, like this: return false,'Cannot get state','gc100' or return true,'ok','gc100'
+If this function is called in the startup sequence specified in the 'startup' XML tag, return true if the startup was ok, false if it wasn't, followed by some comments and the name of the module, like this: <source lang="lua>return false,'Cannot get state','gc100'</source> or <source lang="lua>return true,'ok','gc100'</source>
 ==<ir>==

@@ Line 103: / Line 103: @@
 return values: none
-When you pass a Lua function to be called at a later time with [[Luup_Lua_extensions#function:_call_delay|luup.call_delay]] or [[Luup_Lua_extensions#function:_call_timer|luup.call_timer]] (see [[Luup_Lua_extensions]]), the function is called with the data (a string) you past.
+When you pass a Lua function to be called at a later time with [[Luup_Lua_extensions#function:_call_delay|luup.call_delay]] or [[Luup_Lua_extensions#function:_call_timer|luup.call_timer]], the function is called with the data (a string) you past.
 ==<watch> (callback)==

@@ Line 103: / Line 103: @@
 return values: none
-When you pass a Lua function to be called at a later time with lu_CallFunctionDelay or lu_CallFunctionTimer (see [[Luup_Lua_extensions]]), the function is called with the data (a string) you past.
+When you pass a Lua function to be called at a later time with [[Luup_Lua_extensions#function:_call_delay|luup.call_delay]] or [[Luup_Lua_extensions#function:_call_timer|luup.call_timer]] (see [[Luup_Lua_extensions]]), the function is called with the data (a string) you past.
 ==<watch> (callback)==

@@ Line 111: / Line 111: @@
 return values: none
-When you watch a variable with lu_WatchVariable (see [[Luup_Lua_extensions]]), and the variable changes, your callback is called with the information on the variable that changed.
+When you watch a variable with [[Luup_Lua_extensions#function:_variable_watch|luup.variable_watch]], and the variable changes, your callback is called with the information on the variable that changed.
 ==<startup>==

@@ Line 21: / Line 21: @@
 ==<job>==
-variables: <code>lul_device</code> is a number that is the device id. <code>lul_settings</code> is a table with all the arguments to the action. <code>lul_job</code> is the id number of the job.
+variables: <code>lul_device</code> is a number that is the device ID. <code>lul_settings</code> is a table with all the arguments to the action. <code>lul_job</code> is the id number of the job.
 return value: return 2 values with the syntax <code>return a,b</code>. The first is the job status and is a number from 0-5, and the second is the timeout in seconds.

@@ Line 6: / Line 6: @@
 ==<run>==
-variables: <code>lul_device</code> is a number that is the device id. <code>lul_settings</code> is a table with all the arguments to the action.
+variables: <code>lul_device</code> is a number that is the device ID. <code>lul_settings</code> is a table with all the arguments to the action.
 return value: ''true'' or ''false'' where ''true'' means the function ran ok, ''false'' means it failed.

@@ Line 21: / Line 21: @@
 ==<job>==
-variables: lul_device is a number that is the device id. lul_settings is a table with all the arguments to the action. lul_job is the id number of the job.
+variables: <code>lul_device</code> is a number that is the device id. <code>lul_settings</code> is a table with all the arguments to the action. <code>lul_job</cpde> is the id number of the job.
-return value: return 2 values with the syntax return a,b. The first is the job status and is a number from 0-5, and the second is the timeout in seconds.
+return value: return 2 values with the syntax <code>return a,b</code>. The first is the job status and is a number from 0-5, and the second is the timeout in seconds.
 For more detail see: