Skip to content

Commit f6296fb

Browse files
denpamusicdenpamusic
committed
Add example and rockspec files
1 parent 2c3971b commit f6296fb

13 files changed

Lines changed: 243 additions & 51 deletions

File tree

‎config.ld‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,6 @@ readme = "README.md"
88
description = [[
99
lua-lcdproc is a humble LCDproc client written in Lua language.
1010
]]
11+
examples = {
12+
"examples/simple.lua"
13+
}

‎docs/examples/simple.lua.html‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3+
<html>
4+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
5+
<head>
6+
<title>lua-lcdproc documentation</title>
7+
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
8+
</head>
9+
<body>
10+
11+
<div id="container">
12+
13+
<div id="product">
14+
<div id="product_logo"></div>
15+
<div id="product_name"><big><b></b></big></div>
16+
<div id="product_description"></div>
17+
</div> <!-- id="product" -->
18+
19+
20+
<div id="main">
21+
22+
23+
<!-- Menu -->
24+
25+
<div id="navigation">
26+
<br/>
27+
<h1>lua-lcdproc</h1>
28+
29+
<ul>
30+
<li><a href="../index.html">Index</a></li>
31+
</ul>
32+
33+
34+
35+
<h2>Examples</h2>
36+
<ul class="nowrap">
37+
<li><strong>simple.lua</strong></li>
38+
</ul>
39+
<h2>Modules</h2>
40+
<ul class="nowrap">
41+
<li><a href="../modules/lcdproc.html">lcdproc</a></li>
42+
<li><a href="../modules/lcdproc.menu.html">lcdproc.menu</a></li>
43+
<li><a href="../modules/lcdproc.screen.html">lcdproc.screen</a></li>
44+
<li><a href="../modules/lcdproc.widgets.html">lcdproc.widgets</a></li>
45+
</ul>
46+
<h2>Topics</h2>
47+
<ul class="">
48+
<li><a href="../topics/README.md.html">README</a></li>
49+
</ul>
50+
51+
</div>
52+
53+
<div id="content">
54+
55+
<h2>simple.lua</h2>
56+
<pre>
57+
<span class="global">package</span>.path = <span class="global">package</span>.path .. <span class="string">";../src/?.lua"</span>
58+
59+
<span class="keyword">local</span> LCDproc = <span class="global">require</span> <span class="string">"lcdproc"</span>
60+
61+
<span class="keyword">local</span> lcd = LCDproc.new(<span class="string">"172.30.5.252"</span>, <span class="number">13666</span>)
62+
lcd:set_name(<span class="string">"Simple Clock"</span>)
63+
64+
<span class="comment">-- create clock screen
65+
</span><span class="keyword">local</span> screen = lcd:add_screen(<span class="string">"clock_screen"</span>)
66+
screen:add_title(<span class="string">"one"</span>, <span class="string">"Simple Clock"</span>)
67+
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>))
68+
69+
<span class="keyword">local</span> active = <span class="keyword">false</span>
70+
71+
<span class="comment">-- toggle active variable if screen is currenly being shown or ignored
72+
</span>lcd:on_listen(<span class="keyword">function</span> () active = <span class="keyword">true</span> <span class="keyword">end</span>)
73+
lcd:on_ignore(<span class="keyword">function</span> () active = <span class="keyword">false</span> <span class="keyword">end</span>)
74+
75+
<span class="keyword">while</span> <span class="keyword">true</span> <span class="keyword">do</span>
76+
<span class="keyword">if</span> active <span class="keyword">then</span>
77+
<span class="comment">-- update time only when screen is active
78+
</span> screen.widgets.time:set_text(<span class="global">os</span>.date(<span class="string">"%H:%M:%S"</span>))
79+
<span class="keyword">end</span>
80+
81+
<span class="comment">-- poll LCDproc server once per second
82+
</span> lcd:poll()
83+
<span class="keyword">end</span>
84+
85+
<span class="comment">-- close connection to LCDproc server
86+
</span>lcd:close()</pre>
87+
88+
89+
</div> <!-- id="content" -->
90+
</div> <!-- id="main" -->
91+
<div id="about">
92+
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
93+
<i style="float:right;">Last updated 2020-02-27 14:53:59 </i>
94+
</div> <!-- id="about" -->
95+
</div> <!-- id="container" -->
96+
</body>
97+
</html>

‎docs/index.html‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ <h2>Topics</h2>
4040
<ul class="">
4141
<li><a href="topics/README.md.html">README</a></li>
4242
</ul>
43+
<h2>Examples</h2>
44+
<ul class="nowrap">
45+
<li><a href="examples/simple.lua.html">simple.lua</a></li>
46+
</ul>
4347

4448
</div>
4549

@@ -76,12 +80,19 @@ <h2>Topics</h2>
7680
<td class="summary"></td>
7781
</tr>
7882
</table>
83+
<h2>Examples</h2>
84+
<table class="module_list">
85+
<tr>
86+
<td class="name" nowrap><a href="examples/simple.lua.html">simple.lua</a></td>
87+
<td class="summary"></td>
88+
</tr>
89+
</table>
7990

8091
</div> <!-- id="content" -->
8192
</div> <!-- id="main" -->
8293
<div id="about">
8394
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
84-
<i style="float:right;">Last updated 2020-02-27 14:06:08 </i>
95+
<i style="float:right;">Last updated 2020-02-27 14:53:59 </i>
8596
</div> <!-- id="about" -->
8697
</div> <!-- id="container" -->
8798
</body>

‎docs/modules/lcdproc.html‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ <h2>Topics</h2>
4747
<ul class="">
4848
<li><a href="../topics/README.md.html">README</a></li>
4949
</ul>
50+
<h2>Examples</h2>
51+
<ul class="nowrap">
52+
<li><a href="../examples/simple.lua.html">simple.lua</a></li>
53+
</ul>
5054

5155
</div>
5256

@@ -255,17 +259,17 @@ <h3>Parameters:</h3>
255259
<ul>
256260
<li><span class="parameter">host</span>
257261
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
258-
(localhost)
262+
LCDproc server host (localhost)
259263
(<em>optional</em>)
260264
</li>
261265
<li><span class="parameter">port</span>
262266
<span class="types"><span class="type">int</span></span>
263-
(13666)
267+
LCDproc server port (13666)
264268
(<em>optional</em>)
265269
</li>
266270
<li><span class="parameter">debug</span>
267271
<span class="types"><span class="type">bool</span></span>
268-
(false)
272+
enable debug mode debug (false)
269273
(<em>optional</em>)
270274
</li>
271275
</ul>
@@ -739,7 +743,7 @@ <h3>Parameters:</h3>
739743
</div> <!-- id="main" -->
740744
<div id="about">
741745
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
742-
<i style="float:right;">Last updated 2020-02-27 14:06:08 </i>
746+
<i style="float:right;">Last updated 2020-02-27 14:53:59 </i>
743747
</div> <!-- id="about" -->
744748
</div> <!-- id="container" -->
745749
</body>

‎docs/modules/lcdproc.menu.html‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,10 @@ <h2>Topics</h2>
5555
<ul class="">
5656
<li><a href="../topics/README.md.html">README</a></li>
5757
</ul>
58+
<h2>Examples</h2>
59+
<ul class="nowrap">
60+
<li><a href="../examples/simple.lua.html">simple.lua</a></li>
61+
</ul>
5862

5963
</div>
6064

@@ -507,7 +511,7 @@ <h3>Parameters:</h3>
507511
<ul>
508512
<li><span class="parameter">menu</span>
509513
<span class="types"><a class="type" href="../modules/lcdproc.menu.html#Menu">Menu</a></span>
510-
Menu object
514+
Menu instance
511515
</li>
512516
<li><span class="parameter">id</span>
513517
<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>
614618
<ul>
615619
<li><span class="parameter">menu</span>
616620
<span class="types"><a class="type" href="../modules/lcdproc.menu.html#Menu">Menu</a></span>
617-
Menu object
621+
Menu instance
618622
</li>
619623
<li><span class="parameter">id</span>
620624
<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>
755759
<ul>
756760
<li><span class="parameter">menu</span>
757761
<span class="types"><a class="type" href="../modules/lcdproc.menu.html#Menu">Menu</a></span>
758-
Menu object
762+
Menu instance
759763
</li>
760764
<li><span class="parameter">id</span>
761765
<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>
896900
<ul>
897901
<li><span class="parameter">menu</span>
898902
<span class="types"><a class="type" href="../modules/lcdproc.menu.html#Menu">Menu</a></span>
899-
Menu object
903+
Menu instance
900904
</li>
901905
<li><span class="parameter">id</span>
902906
<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>
10491053
<ul>
10501054
<li><span class="parameter">menu</span>
10511055
<span class="types"><a class="type" href="../modules/lcdproc.menu.html#Menu">Menu</a></span>
1052-
Menu object
1056+
Menu instance
10531057
</li>
10541058
<li><span class="parameter">id</span>
10551059
<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>
11941198
<ul>
11951199
<li><span class="parameter">menu</span>
11961200
<span class="types"><a class="type" href="../modules/lcdproc.menu.html#Menu">Menu</a></span>
1197-
Menu object
1201+
Menu instance
11981202
</li>
11991203
<li><span class="parameter">id</span>
12001204
<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>
14111415
<ul>
14121416
<li><span class="parameter">menu</span>
14131417
<span class="types"><a class="type" href="../modules/lcdproc.menu.html#Menu">Menu</a></span>
1414-
Menu object
1418+
Menu instance
14151419
</li>
14161420
<li><span class="parameter">id</span>
14171421
<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>
20212025
</div> <!-- id="main" -->
20222026
<div id="about">
20232027
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
2024-
<i style="float:right;">Last updated 2020-02-27 14:06:08 </i>
2028+
<i style="float:right;">Last updated 2020-02-27 14:53:59 </i>
20252029
</div> <!-- id="about" -->
20262030
</div> <!-- id="container" -->
20272031
</body>

‎docs/modules/lcdproc.screen.html‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ <h2>Topics</h2>
4747
<ul class="">
4848
<li><a href="../topics/README.md.html">README</a></li>
4949
</ul>
50+
<h2>Examples</h2>
51+
<ul class="nowrap">
52+
<li><a href="../examples/simple.lua.html">simple.lua</a></li>
53+
</ul>
5054

5155
</div>
5256

@@ -796,7 +800,7 @@ <h3>Parameters:</h3>
796800
</div> <!-- id="main" -->
797801
<div id="about">
798802
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
799-
<i style="float:right;">Last updated 2020-02-27 14:06:08 </i>
803+
<i style="float:right;">Last updated 2020-02-27 14:53:59 </i>
800804
</div> <!-- id="about" -->
801805
</div> <!-- id="container" -->
802806
</body>

‎docs/modules/lcdproc.widgets.html‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,10 @@ <h2>Topics</h2>
5555
<ul class="">
5656
<li><a href="../topics/README.md.html">README</a></li>
5757
</ul>
58+
<h2>Examples</h2>
59+
<ul class="nowrap">
60+
<li><a href="../examples/simple.lua.html">simple.lua</a></li>
61+
</ul>
5862

5963
</div>
6064

@@ -262,7 +266,7 @@ <h3>Parameters:</h3>
262266
<ul>
263267
<li><span class="parameter">screen</span>
264268
<span class="types"><span class="type">Screen</span></span>
265-
screen object
269+
screen instance
266270
</li>
267271
<li><span class="parameter">id</span>
268272
<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>
495499
<ul>
496500
<li><span class="parameter">screen</span>
497501
<span class="types"><span class="type">Screen</span></span>
498-
Screen object
502+
Screen instance
499503
</li>
500504
<li><span class="parameter">id</span>
501505
<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>
636640
<ul>
637641
<li><span class="parameter">screen</span>
638642
<span class="types"><span class="type">Screen</span></span>
639-
object
643+
instance
640644
</li>
641645
<li><span class="parameter">id</span>
642646
<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>
687691
<ul>
688692
<li><span class="parameter">screen</span>
689693
<span class="types"><span class="type">Screen</span></span>
690-
object
694+
instance
691695
</li>
692696
<li><span class="parameter">id</span>
693697
<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>
845849
<ul>
846850
<li><span class="parameter">screen</span>
847851
<span class="types"><span class="type">Screen</span></span>
848-
object
852+
instance
849853
</li>
850854
<li><span class="parameter">id</span>
851855
<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>
981985
<ul>
982986
<li><span class="parameter">screen</span>
983987
<span class="types"><span class="type">Screen</span></span>
984-
screen object
988+
screen instance
985989
</li>
986990
<li><span class="parameter">id</span>
987991
<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>
12021206
<ul>
12031207
<li><span class="parameter">screen</span>
12041208
<span class="types"><span class="type">Screen</span></span>
1205-
object
1209+
instance
12061210
</li>
12071211
<li><span class="parameter">id</span>
12081212
<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>
14311435
<ul>
14321436
<li><span class="parameter">screen</span>
14331437
<span class="types"><span class="type">Screen</span></span>
1434-
screen object
1438+
screen instance
14351439
</li>
14361440
<li><span class="parameter">id</span>
14371441
<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>
15891593
</div> <!-- id="main" -->
15901594
<div id="about">
15911595
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
1592-
<i style="float:right;">Last updated 2020-02-27 14:06:08 </i>
1596+
<i style="float:right;">Last updated 2020-02-27 14:53:59 </i>
15931597
</div> <!-- id="about" -->
15941598
</div> <!-- id="container" -->
15951599
</body>

‎docs/topics/README.md.html‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ <h2>Modules</h2>
4949
<li><a href="../modules/lcdproc.screen.html">lcdproc.screen</a></li>
5050
<li><a href="../modules/lcdproc.widgets.html">lcdproc.widgets</a></li>
5151
</ul>
52+
<h2>Examples</h2>
53+
<ul class="nowrap">
54+
<li><a href="../examples/simple.lua.html">simple.lua</a></li>
55+
</ul>
5256

5357
</div>
5458

@@ -111,7 +115,7 @@ <h2>Documentation</h2>
111115
</div> <!-- id="main" -->
112116
<div id="about">
113117
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
114-
<i style="float:right;">Last updated 2020-02-27 14:06:08 </i>
118+
<i style="float:right;">Last updated 2020-02-27 14:53:59 </i>
115119
</div> <!-- id="about" -->
116120
</div> <!-- id="container" -->
117121
</body>

0 commit comments

Comments
 (0)