Add example and rockspec files

denpamusic · Feb 27, 2020 · f6296fb · f6296fb
1 parent 2c3971b
commit f6296fb
Show file tree

Hide file tree

Showing 13 changed files with 243 additions and 51 deletions.
diff --git a/config.ld b/config.ld
@@ -8,3 +8,6 @@ readme = "README.md"
 description = [[
     lua-lcdproc is a humble LCDproc client written in Lua language.
 ]]
+examples = {
+    "examples/simple.lua"
+}
diff --git a/docs/examples/simple.lua.html b/docs/examples/simple.lua.html
@@ -0,0 +1,97 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+<head>
+    <title>lua-lcdproc documentation</title>
+    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
+</head>
+<body>
+
+<div id="container">
+
+<div id="product">
+	<div id="product_logo"></div>
+	<div id="product_name"><big><b></b></big></div>
+	<div id="product_description"></div>
+</div> <!-- id="product" -->
+
+
+<div id="main">
+
+
+<!-- Menu -->
+
+<div id="navigation">
+<br/>
+<h1>lua-lcdproc</h1>
+
+<ul>
+  <li><a href="../index.html">Index</a></li>
+</ul>
+
+
+
+<h2>Examples</h2>
+<ul class="nowrap">
+  <li><strong>simple.lua</strong></li>
+</ul>
+<h2>Modules</h2>
+<ul class="nowrap">
+  <li><a href="../modules/lcdproc.html">lcdproc</a></li>
+  <li><a href="../modules/lcdproc.menu.html">lcdproc.menu</a></li>
+  <li><a href="../modules/lcdproc.screen.html">lcdproc.screen</a></li>
+  <li><a href="../modules/lcdproc.widgets.html">lcdproc.widgets</a></li>
+</ul>
+<h2>Topics</h2>
+<ul class="">
+  <li><a href="../topics/README.md.html">README</a></li>
+</ul>
+
+</div>
+
+<div id="content">
+
+    <h2>simple.lua</h2>
+<pre>
+<span class="global">package</span>.path = <span class="global">package</span>.path .. <span class="string">";../src/?.lua"</span>
+
+<span class="keyword">local</span> LCDproc = <span class="global">require</span> <span class="string">"lcdproc"</span>
+
+<span class="keyword">local</span> lcd = LCDproc.new(<span class="string">"172.30.5.252"</span>, <span class="number">13666</span>)
+lcd:set_name(<span class="string">"Simple Clock"</span>)
+
+<span class="comment">-- create clock screen
+</span><span class="keyword">local</span> screen = lcd:add_screen(<span class="string">"clock_screen"</span>)
+screen:add_title(<span class="string">"one"</span>, <span class="string">"Simple Clock"</span>)
+screen:add_string(<span class="string">"time"</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="global">os</span>.date(<span class="string">"%H:%M:%S"</span>))
+
+<span class="keyword">local</span> active = <span class="keyword">false</span>
+
+<span class="comment">-- toggle active variable if screen is currenly being shown or ignored
+</span>lcd:on_listen(<span class="keyword">function</span> () active = <span class="keyword">true</span> <span class="keyword">end</span>)
+lcd:on_ignore(<span class="keyword">function</span> () active = <span class="keyword">false</span> <span class="keyword">end</span>)
+
+<span class="keyword">while</span> <span class="keyword">true</span> <span class="keyword">do</span>
+  <span class="keyword">if</span> active <span class="keyword">then</span>
+    <span class="comment">-- update time only when screen is active
+</span>    screen.widgets.time:set_text(<span class="global">os</span>.date(<span class="string">"%H:%M:%S"</span>))
+  <span class="keyword">end</span>
+
+  <span class="comment">-- poll LCDproc server once per second
+</span>  lcd:poll()
+<span class="keyword">end</span>
+
+<span class="comment">-- close connection to LCDproc server
+</span>lcd:close()</pre>
+
+
+</div> <!-- id="content" -->
+</div> <!-- id="main" -->
+<div id="about">
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
+<i style="float:right;">Last updated 2020-02-27 14:53:59 </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+</body>
+</html>
diff --git a/docs/index.html b/docs/index.html
@@ -40,6 +40,10 @@ <h2>Topics</h2>
 <ul class="">
   <li><a href="topics/README.md.html">README</a></li>
 </ul>
+<h2>Examples</h2>
+<ul class="nowrap">
+  <li><a href="examples/simple.lua.html">simple.lua</a></li>
+</ul>
 
 </div>
 
@@ -76,12 +80,19 @@ <h2>Topics</h2>
 		<td class="summary"></td>
 	</tr>
 </table>
+<h2>Examples</h2>
+<table class="module_list">
+	<tr>
+		<td class="name"  nowrap><a href="examples/simple.lua.html">simple.lua</a></td>
+		<td class="summary"></td>
+	</tr>
+</table>
 
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2020-02-27 14:06:08 </i>
+<i style="float:right;">Last updated 2020-02-27 14:53:59 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/lcdproc.html b/docs/modules/lcdproc.html
@@ -47,6 +47,10 @@ <h2>Topics</h2>
 <ul class="">
   <li><a href="../topics/README.md.html">README</a></li>
 </ul>
+<h2>Examples</h2>
+<ul class="nowrap">
+  <li><a href="../examples/simple.lua.html">simple.lua</a></li>
+</ul>
 
 </div>
 
@@ -255,17 +259,17 @@ <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">host</span>
             <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
-         (localhost)
+         LCDproc server host (localhost)
          (<em>optional</em>)
         </li>
         <li><span class="parameter">port</span>
             <span class="types"><span class="type">int</span></span>
-         (13666)
+         LCDproc server port (13666)
          (<em>optional</em>)
         </li>
         <li><span class="parameter">debug</span>
             <span class="types"><span class="type">bool</span></span>
-         (false)
+         enable debug mode debug (false)
          (<em>optional</em>)
         </li>
     </ul>
@@ -739,7 +743,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2020-02-27 14:06:08 </i>
+<i style="float:right;">Last updated 2020-02-27 14:53:59 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/lcdproc.menu.html b/docs/modules/lcdproc.menu.html
@@ -55,6 +55,10 @@ <h2>Topics</h2>
 <ul class="">
   <li><a href="../topics/README.md.html">README</a></li>
 </ul>
+<h2>Examples</h2>
+<ul class="nowrap">
+  <li><a href="../examples/simple.lua.html">simple.lua</a></li>
+</ul>
 
 </div>
 
@@ -507,7 +511,7 @@ <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">menu</span>
             <span class="types"><a class="type" href="../modules/lcdproc.menu.html#Menu">Menu</a></span>
-         Menu object
+         Menu instance
         </li>
         <li><span class="parameter">id</span>
             <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
@@ -614,7 +618,7 @@ <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">menu</span>
             <span class="types"><a class="type" href="../modules/lcdproc.menu.html#Menu">Menu</a></span>
-         Menu object
+         Menu instance
         </li>
         <li><span class="parameter">id</span>
             <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
@@ -755,7 +759,7 @@ <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">menu</span>
             <span class="types"><a class="type" href="../modules/lcdproc.menu.html#Menu">Menu</a></span>
-         Menu object
+         Menu instance
         </li>
         <li><span class="parameter">id</span>
             <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
@@ -896,7 +900,7 @@ <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">menu</span>
             <span class="types"><a class="type" href="../modules/lcdproc.menu.html#Menu">Menu</a></span>
-         Menu object
+         Menu instance
         </li>
         <li><span class="parameter">id</span>
             <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
@@ -1049,7 +1053,7 @@ <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">menu</span>
             <span class="types"><a class="type" href="../modules/lcdproc.menu.html#Menu">Menu</a></span>
-         Menu object
+         Menu instance
         </li>
         <li><span class="parameter">id</span>
             <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
@@ -1194,7 +1198,7 @@ <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">menu</span>
             <span class="types"><a class="type" href="../modules/lcdproc.menu.html#Menu">Menu</a></span>
-         Menu object
+         Menu instance
         </li>
         <li><span class="parameter">id</span>
             <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
@@ -1411,7 +1415,7 @@ <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">menu</span>
             <span class="types"><a class="type" href="../modules/lcdproc.menu.html#Menu">Menu</a></span>
-         Menu object
+         Menu instance
         </li>
         <li><span class="parameter">id</span>
             <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
@@ -2021,7 +2025,7 @@ <h3>Returns:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2020-02-27 14:06:08 </i>
+<i style="float:right;">Last updated 2020-02-27 14:53:59 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/lcdproc.screen.html b/docs/modules/lcdproc.screen.html
@@ -47,6 +47,10 @@ <h2>Topics</h2>
 <ul class="">
   <li><a href="../topics/README.md.html">README</a></li>
 </ul>
+<h2>Examples</h2>
+<ul class="nowrap">
+  <li><a href="../examples/simple.lua.html">simple.lua</a></li>
+</ul>
 
 </div>
 
@@ -796,7 +800,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2020-02-27 14:06:08 </i>
+<i style="float:right;">Last updated 2020-02-27 14:53:59 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/lcdproc.widgets.html b/docs/modules/lcdproc.widgets.html
@@ -55,6 +55,10 @@ <h2>Topics</h2>
 <ul class="">
   <li><a href="../topics/README.md.html">README</a></li>
 </ul>
+<h2>Examples</h2>
+<ul class="nowrap">
+  <li><a href="../examples/simple.lua.html">simple.lua</a></li>
+</ul>
 
 </div>
 
@@ -262,7 +266,7 @@ <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">screen</span>
             <span class="types"><span class="type">Screen</span></span>
-         screen object
+         screen instance
         </li>
         <li><span class="parameter">id</span>
             <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
@@ -495,7 +499,7 @@ <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">screen</span>
             <span class="types"><span class="type">Screen</span></span>
-         Screen object
+         Screen instance
         </li>
         <li><span class="parameter">id</span>
             <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
@@ -636,7 +640,7 @@ <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">screen</span>
             <span class="types"><span class="type">Screen</span></span>
-         object
+         instance
         </li>
         <li><span class="parameter">id</span>
             <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
@@ -687,7 +691,7 @@ <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">screen</span>
             <span class="types"><span class="type">Screen</span></span>
-         object
+         instance
         </li>
         <li><span class="parameter">id</span>
             <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
@@ -845,7 +849,7 @@ <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">screen</span>
             <span class="types"><span class="type">Screen</span></span>
-         object
+         instance
         </li>
         <li><span class="parameter">id</span>
             <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
@@ -981,7 +985,7 @@ <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">screen</span>
             <span class="types"><span class="type">Screen</span></span>
-         screen object
+         screen instance
         </li>
         <li><span class="parameter">id</span>
             <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
@@ -1202,7 +1206,7 @@ <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">screen</span>
             <span class="types"><span class="type">Screen</span></span>
-         object
+         instance
         </li>
         <li><span class="parameter">id</span>
             <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
@@ -1431,7 +1435,7 @@ <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">screen</span>
             <span class="types"><span class="type">Screen</span></span>
-         screen object
+         screen instance
         </li>
         <li><span class="parameter">id</span>
             <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
@@ -1589,7 +1593,7 @@ <h3>Fields:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2020-02-27 14:06:08 </i>
+<i style="float:right;">Last updated 2020-02-27 14:53:59 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/topics/README.md.html b/docs/topics/README.md.html
@@ -49,6 +49,10 @@ <h2>Modules</h2>
   <li><a href="../modules/lcdproc.screen.html">lcdproc.screen</a></li>
   <li><a href="../modules/lcdproc.widgets.html">lcdproc.widgets</a></li>
 </ul>
+<h2>Examples</h2>
+<ul class="nowrap">
+  <li><a href="../examples/simple.lua.html">simple.lua</a></li>
+</ul>
 
 </div>
 
@@ -111,7 +115,7 @@ <h2>Documentation</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2020-02-27 14:06:08 </i>
+<i style="float:right;">Last updated 2020-02-27 14:53:59 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>