mirror of
https://github.com/elua/elua.git
synced 2025-01-25 01:02:54 +08:00
English and Portuguese test content for the new doc structure still under development.
To be enhanced very soon. This is just an initial commit to allow colaborative dev.
This commit is contained in:
parent
6137c01714
commit
a75755fdcc
14
doc/en/api_doc.html
Normal file
14
doc/en/api_doc.html
Normal file
@ -0,0 +1,14 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Strict//EN">
|
||||
<html><head>
|
||||
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
|
||||
|
||||
|
||||
|
||||
<meta http-equiv="Content-Language" content="en-us">
|
||||
|
||||
<title>Product</title><link rel="stylesheet" type="text/css" href="./style.css"></head>
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<h3><a name="over"></a>eLua API Reference</h3>Welcome to the eLua Manual<br><br><br>
|
||||
|
||||
</body></html>
|
110
doc/en/bit_doc.html
Normal file
110
doc/en/bit_doc.html
Normal file
@ -0,0 +1,110 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Strict//EN">
|
||||
<html><head>
|
||||
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
|
||||
|
||||
|
||||
|
||||
<meta http-equiv="Content-Language" content="en-us">
|
||||
|
||||
<title>Product</title><link rel="stylesheet" type="text/css" href="./style.css"></head>
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<h3><a name="over"></a>bit</h3>This is ugly but acording to Roberto, this is what Lua 5.2+ will have.
|
||||
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
The problem is that <b>not </b>and <b>and</b> are Lua reserved words and cannot be used as table indexes.<br>
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
We could add .rot and .rotc to these :)
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
<br>
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
Res = bit.bnot( value ): unary negation
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
Res = bit.band( v1, v2, ... ): <b>bitwise </b>"and"
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
Res = bit.bor( v1, v2, ... ): <b>bitwise</b><b> </b>"or"
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
Res = bit.bxor( v1, v2, ... ): <b>bitwise</b><b> </b>"exclusive or"
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
Res = bit.lshift( value, pos ): shift "value" left "pos" positions.
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
Res = bit.rshift( value, pos ): shift "value" right "pos" positions. The sign is
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
not propagated.
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
Res = bit.arshift( value, pos ): shift "value" right "pos" positions. The sign
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
is propagated ("arithmetic shift").
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
Res = bit.bit( bitno ): a shortcut for bit.lshift( 1, bitno )
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
Res1, Res2, ... = bit.set( bitno, v1, v2, ... ): set the bit at position "bitno"
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
in v1, v2, ... to 1.
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
Res1, Res2, ... = bit.clear( bitno, v1, v2, ... ): set the bit at position
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
"bitno"in v1, v2, ... to 0.
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
Res = bit.isset( value, bitno ): returns true if bit at position "bitno" in
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
"value" is 1, false otherwise.
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
Res = bit.isclear( value, bitno ): returns true if bit at position "bitno" in
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
"value" is 0, false otherwise.
|
||||
</p>
|
||||
<br style="font-family: Verdana;"></body></html>
|
145
doc/en/gpio_doc.html
Normal file
145
doc/en/gpio_doc.html
Normal file
@ -0,0 +1,145 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Strict//EN">
|
||||
<html><head>
|
||||
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
|
||||
|
||||
|
||||
|
||||
<meta http-equiv="Content-Language" content="en-us">
|
||||
|
||||
<title>Product</title><link rel="stylesheet" type="text/css" href="./style.css"></head>
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<h3><a name="over">gpio</a></h3><p class="MsoNormal" style="font-family: Verdana;">
|
||||
<b>[gpio] pio</b><br>
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
[gpio.setpinvalue] pio.setpin( value, Pin1, Pin2 ... ): set the value to all the pins in the list
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
to "value" (0 or 1).
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
[gpio.setpinhigh] pio.set( Pin1, Pin2, ... ): set the value of all the pins in the list to 1.
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
[gpio.getpinvalue] Val1, Val2, ... = pio.get( Pin1, Pin2, ... ): reads one or more pins and returns
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
their values (0 or 1).
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
[gpio.setpinlow] pio.clear( Pin1, Pin2, ... ): set the value of all the pins in the list to 0.
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
[gpio.configpin(gpio.DIR, gpio.DIR_INPUT)] pio.input( Pin1, Pin2, ... ): set the specified pin(s) as input(s).
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
[gpio.configpin(gpio.DIR, gpio.DIR_OUTPUT)] pio.output( Pin1, Pin2, ... ): set the specified pin(s) as output(s).
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
[gpio.setportvalue] pio.setport( value, Port1, Port2, ... ): set the value of all the ports in the
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
list to "value".
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
[gpio.getportvalue] Val1, Val2, ... = pio.getport( Port1, Port2, ... ): reads one or more ports and
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
returns their values.
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;"> [gpio.getportname]
|
||||
Port = pio.port( code ): return the physical port number associated
|
||||
with the given code. For example, "pio.port( pio.P0_20 )" will return
|
||||
0.
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
[gpio.getpinnumber] Pin = pio.pin( code ): return the physical pin number associated with the
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
given code. For example, "pio.pin( pio.P0_20 )" will return 20.
|
||||
</p>
|
||||
<br>
|
||||
[gpio.togglepin([Pin1], [Pin2], ...)]<br>
|
||||
[gpio.toggleport([Port1], [Port2], ...)]<br style="font-family: Verdana;">
|
||||
<br>
|
||||
Another idea (can be added to the above ?)<br>
|
||||
[gpio.configport(gpio.[FUNCTION], gpio.MASK, [MASK])]<br>
|
||||
Ex:<br>
|
||||
gpio.configpin(gpio.DIR, gpio.DIR_INPUT) (.DIR_OUTPUT)<br>
|
||||
gpio.configpin(gpio.PULL, gpio.PULL_UP) (.PULL_DOWN, PULL_NO)<br style="font-family: Verdana;">
|
||||
<br>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
[gpio.configport(gpio.DIR, gpio.DIR_INPUT, [Port1], [Port2], ...)]
|
||||
pio.port_input( Port1, Port2, ... ): set the specified port(s) as
|
||||
input(s).
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
[gpio.configport(gpio.DIR, gpio.DIR_OUTPUT, [Port1], [Port2], ...)]
|
||||
pio.port_output( Port1, Port2, ... ): set the specified port(s) as
|
||||
output(s).
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
[gpio.configpin(gpio.PULL, gpio.PULL_UP, [Pin1], [Pin2], ...)]
|
||||
pio.pullup( Pin1, Pin2, ... ): enable internal pullups on the specified
|
||||
pins.Note that some CPUs might not provide this feature.
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
[gpio.configpin(gpio.PULL, gpio.PULL_DOWN, [Pin1], [Pin2], ...)]
|
||||
pio.pulldown( Pin1, Pin2, ... ): enable internal pulldowns on the
|
||||
specified pins. Note that some CPUs might not provide this feature.
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
|
||||
</p>
|
||||
<p class="MsoNormal" style="font-family: Verdana;">
|
||||
[gpio.configpin(gpio.PULL, gpio.PULL_NO, [Pin1], [Pin2], ...)]
|
||||
pio.nopull( Pin1, Pin2, ... ): disable the pullups/pulldowns on the
|
||||
specifiedpins. Note that some CPUs might not provide this feature.
|
||||
</p>
|
||||
<br>
|
||||
<br>What is the real advantage/reason of having a pin "list" on some of
|
||||
these functions ? If we cannot build a table with them, there's really
|
||||
no great use of this, as we cannot create the list in run time and some
|
||||
other proposed functions solve the problem of avoiding more than one
|
||||
call for several pins.<br>A: It IS usefull and sometimes necessary so it will stay.....<br>
|
||||
<br></body></html>
|
16
doc/en/modules_doc.html
Normal file
16
doc/en/modules_doc.html
Normal file
@ -0,0 +1,16 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Strict//EN">
|
||||
<html><head>
|
||||
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
|
||||
|
||||
|
||||
|
||||
<meta http-equiv="Content-Language" content="en-us">
|
||||
|
||||
<title>Product</title><link rel="stylesheet" type="text/css" href="./style.css"></head>
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<h3><a name="over"></a>eLua Modules</h3><br>This section describes eLua Modules ............<br> <br>Modules are listed in alphabetical order .........<br><br>eLua Modules rocks .............<br><br><br><br><br>
|
||||
|
||||
|
||||
|
||||
</body></html>
|
70
doc/en/spi_doc.html
Normal file
70
doc/en/spi_doc.html
Normal file
@ -0,0 +1,70 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Strict//EN">
|
||||
<html><head>
|
||||
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
|
||||
|
||||
|
||||
|
||||
<meta http-equiv="Content-Language" content="en-us">
|
||||
|
||||
<title>Product</title><link rel="stylesheet" type="text/css" href="./style.css"></head>
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<h3><a name="over"></a>spi</h3><span style="font-weight: bold;"></span><br>
|
||||
<big><span style="font-family: Helvetica,Arial,sans-serif;"></span><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big>Actual_clock = spi.setup( id, spi.MASTER | spi.SLAVE, clock, cpol, cpha,</big></font><span style="font-family: Helvetica,Arial,sans-serif;">
|
||||
</span><br style="font-family: Helvetica,Arial,sans-serif;"><span style="font-family: Helvetica,Arial,sans-serif;">
|
||||
</span><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big>databits): set the SPI interface with the given parameters, returns the clock</big></font><span style="font-family: Helvetica,Arial,sans-serif;">
|
||||
</span><br style="font-family: Helvetica,Arial,sans-serif;"><span style="font-family: Helvetica,Arial,sans-serif;">
|
||||
</span><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big>that was set for the interface.</big></font><span style="font-family: Helvetica,Arial,sans-serif;">
|
||||
</span><br style="font-family: Helvetica,Arial,sans-serif;"><span style="font-family: Helvetica,Arial,sans-serif;">
|
||||
|
||||
</span><br style="font-family: Helvetica,Arial,sans-serif;"><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big>spi.select( </big></font><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big>id</big></font><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big> ): sets the selected spi as active (sets the SS line of the given interface).</big></font><span style="font-family: Helvetica,Arial,sans-serif;">
|
||||
</span><br style="font-family: Helvetica,Arial,sans-serif;"><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big> </big></font><span style="font-family: Helvetica,Arial,sans-serif;">
|
||||
</span><br style="font-family: Helvetica,Arial,sans-serif;"><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big>spi.unselect( id ): clears the SS line of the given interface.</big></font><span style="font-family: Helvetica,Arial,sans-serif;">
|
||||
</span><br style="font-family: Helvetica,Arial,sans-serif;"><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big> </big></font><span style="font-family: Helvetica,Arial,sans-serif;">
|
||||
</span><br style="font-family: Helvetica,Arial,sans-serif;"><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big>spi.send( id, Data1, Data2, ... ): sends all the data to the specified SPI</big></font><span style="font-family: Helvetica,Arial,sans-serif;">
|
||||
</span><br style="font-family: Helvetica,Arial,sans-serif;"><span style="font-family: Helvetica,Arial,sans-serif;">
|
||||
</span><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big>interface.</big></font><span style="font-family: Helvetica,Arial,sans-serif;">
|
||||
</span><br style="font-family: Helvetica,Arial,sans-serif;"><span style="font-family: Helvetica,Arial,sans-serif;">
|
||||
|
||||
</span><br style="font-family: Helvetica,Arial,sans-serif;"><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big>[</big></font><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big>spi.sendrecv(</big></font><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big>id, Out1, Out2, ...</big></font><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big>)] </big></font><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big>In1, In2, ... = spi.send_recv( id, Out1, Out2, ... ): sends all the "out" bytes</big></font><span style="font-family: Helvetica,Arial,sans-serif;"> </span><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big>to the specified SPI interface and returts the data read after each sent byte.</big></font><span style="font-family: Helvetica,Arial,sans-serif;">
|
||||
</span><br style="font-family: Helvetica,Arial,sans-serif;"><br style="font-family: Helvetica,Arial,sans-serif;"><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big>Returning
|
||||
several values in this blocking way would not complicate some queued
|
||||
send implementations ? (ok, this could be another function :)</big></font><span style="font-family: Helvetica,Arial,sans-serif;">
|
||||
</span><br style="font-family: Helvetica,Arial,sans-serif;"><br style="font-family: Helvetica,Arial,sans-serif;"><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big>Sending multiple data/chars in a single call and not in
|
||||
a table argument does not allow the data to be built in run time
|
||||
(without some string massage, of course :)</big></font><br style="font-family: Helvetica,Arial,sans-serif;"><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big>
|
||||
</big></font><br style="font-family: Helvetica,Arial,sans-serif;"><font style="font-family: Helvetica,Arial,sans-serif;" size="2"><big>
|
||||
</big></font><br style="font-family: Helvetica,Arial,sans-serif;"><span style="font-family: Helvetica,Arial,sans-serif;">
|
||||
|
||||
</span></big>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<br>
|
||||
<br style="font-family: Verdana;"></body></html>
|
94
doc/en/style.css
Normal file
94
doc/en/style.css
Normal file
@ -0,0 +1,94 @@
|
||||
/* Generated by KompoZer */
|
||||
body {
|
||||
margin-left: 1em;
|
||||
margin-right: 1em;
|
||||
font-family: tahoma,verdana,arial,helvetica,geneva,sans-serif;
|
||||
background-color: #ffffff;
|
||||
}
|
||||
p {
|
||||
margin-left: 1em;
|
||||
line-height: 130%;
|
||||
}
|
||||
h2 {
|
||||
color: #3366cc;
|
||||
}
|
||||
h3 {
|
||||
border: 1px solid #808080;
|
||||
padding: 4px;
|
||||
background-color: blue;
|
||||
color: white;
|
||||
}
|
||||
pre {
|
||||
border: 1px solid #62a0ff;
|
||||
padding: 10px;
|
||||
background-color: #cee7ff;
|
||||
font-family: 'Monotype.com',"Courier New",Courier,monospace;
|
||||
font-size: 90%;
|
||||
line-height: 125%;
|
||||
margin-left: 3em;
|
||||
margin-right: 3em;
|
||||
}
|
||||
p.info {
|
||||
margin-left: 3em;
|
||||
}
|
||||
ul {
|
||||
margin-left: 2em;
|
||||
}
|
||||
h4 {
|
||||
padding: 3px;
|
||||
background-color: #e1e1e1;
|
||||
margin-right: 2em;
|
||||
margin-left: 2em;
|
||||
}
|
||||
h1 {
|
||||
text-align: center;
|
||||
}
|
||||
.homeTitle {
|
||||
font-family: Arial,Helvetica,sans-serif;
|
||||
font-size: 36pt;
|
||||
font-weight: bold;
|
||||
color: #003399;
|
||||
text-align: center;
|
||||
}
|
||||
.homeDescription {
|
||||
font-family: Arial,Helvetica,sans-serif;
|
||||
font-size: 20pt;
|
||||
color: #003399;
|
||||
text-align: center;
|
||||
}
|
||||
.homeVersion {
|
||||
margin: 10px;
|
||||
font-family: Arial,Helvetica,sans-serif;
|
||||
font-size: 16pt;
|
||||
color: #003399;
|
||||
text-align: center;
|
||||
}
|
||||
#navigation {
|
||||
position: fixed;
|
||||
top: 0;
|
||||
right: 0;
|
||||
background-color: #e1e1e1;
|
||||
}
|
||||
#navigation ul {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
list-style-type: none;
|
||||
}
|
||||
#navigation li {
|
||||
float: left;
|
||||
}
|
||||
#navigation a {
|
||||
border: 1px solid #808080;
|
||||
padding: 3px;
|
||||
color: #5c5c5c;
|
||||
text-decoration: none;
|
||||
display: block;
|
||||
background-color: #e1e1e1;
|
||||
font-size: small;
|
||||
}
|
||||
#navigation a:hover {
|
||||
border: 1px solid #808080;
|
||||
color: #e1e1e1;
|
||||
text-decoration: none;
|
||||
background-color: #5c5c5c;
|
||||
}
|
97
doc/en/term_doc.html
Normal file
97
doc/en/term_doc.html
Normal file
@ -0,0 +1,97 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Strict//EN">
|
||||
<html><head>
|
||||
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
|
||||
|
||||
|
||||
|
||||
<meta http-equiv="Content-Language" content="en-us">
|
||||
|
||||
<title>Product</title><link rel="stylesheet" type="text/css" href="./style.css"></head>
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<h3><a name="over"></a>term</h3>
|
||||
<p>
|
||||
<br>
|
||||
</p>
|
||||
<p>
|
||||
[term.clear] term.clrscr(): clear the screen
|
||||
</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<p>
|
||||
[term.cleareol] term.clreol(): clear from the current cursor position to the end of the line
|
||||
</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<p>
|
||||
[term.moveto] term.gotoxy( x, y ): position the cursor at the given coordinates
|
||||
</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<p>
|
||||
[term.moveup] term.up( delta ): move the cursor up "delta" lines
|
||||
</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<p>
|
||||
[term.movedown] term.down( delta ): move the cursor down "delta" lines
|
||||
</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<p>
|
||||
[term.moveleft] term.left( delta ): move the cursor left "delta" lines
|
||||
</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<p>
|
||||
[term.moveright] term.right( delta ): move the cursor right "delta" lines
|
||||
</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<p>
|
||||
[term.getlinecount] Lines = term.lines(): returns the number of lines
|
||||
</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<p>
|
||||
[term.getcolcount] Cols = term.cols(): returns the number of columns
|
||||
</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<p>
|
||||
[term.printchar] term.put( c1, c2, ... ): writes the specified character(s) to the terminal
|
||||
</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<p>
|
||||
[term.printstr] term.putstr( s1, s2, ... ): writes the specified string(s) to the terminal
|
||||
</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<p>
|
||||
[term.getx] Cx = term.cursorx(): return the cursor X position
|
||||
</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<p>
|
||||
[term.gety] Cy = term.cursory(): return the cursor Y position
|
||||
</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<p>
|
||||
<font size="2">[term.inputchar] c = term.getch( term.WAIT | term.NOWAIT ): returns a char read from the </font>
|
||||
</p>
|
||||
<font size="2"> terminal.</font></body></html>
|
59
doc/en/uart_doc.html
Normal file
59
doc/en/uart_doc.html
Normal file
@ -0,0 +1,59 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Strict//EN">
|
||||
<html><head>
|
||||
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
|
||||
|
||||
|
||||
|
||||
<meta http-equiv="Content-Language" content="en-us">
|
||||
|
||||
<title>Product</title><link rel="stylesheet" type="text/css" href="./style.css"></head>
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<h3><a name="over"></a>uart</h3><br><p style="margin-bottom: 0in;">
|
||||
<font face="Bitstream Vera Sans Mono, sans-serif">[uart.setup(</font><font face="Bitstream Vera Sans Mono, sans-serif"> id, baud, databits, </font>
|
||||
</p>
|
||||
<p style="margin-bottom: 0in;">
|
||||
<font face="Bitstream Vera Sans Mono, sans-serif">uart.PARITY_EVEN |uart.</font><font face="Bitstream Vera Sans Mono, sans-serif">PARITY</font><font face="Bitstream Vera Sans Mono, sans-serif">_ODD | uart.</font><font face="Bitstream Vera Sans Mono, sans-serif">PARITY</font><font face="Bitstream Vera Sans Mono, sans-serif">_NONE, </font>
|
||||
</p>
|
||||
<p style="margin-bottom: 0in;">
|
||||
<font face="Bitstream Vera Sans Mono, sans-serif">uart.STOPBITS_1 | uart.STOPBITS_1_5 | uart.STOPBITS_2 )] Actual_baud = uart.setup( id, baud, databits, </font>
|
||||
</p>
|
||||
<p style="margin-bottom: 0in;">
|
||||
<font face="Bitstream Vera Sans Mono, sans-serif">uart.PAR_EVEN |uart.PAR_ODD | uart.PAR_NONE, </font>
|
||||
</p>
|
||||
<p style="margin-bottom: 0in;">
|
||||
<font face="Bitstream Vera Sans Mono, sans-serif">uart.STOP_1 | uart.STOP_1_5 | uart.STOP_2 ): set the UART interface with the</font>
|
||||
</p>
|
||||
<p style="margin-bottom: 0in;">
|
||||
<font face="Bitstream Vera Sans Mono, sans-serif">given parameters, returns the baud rate that was set for the UART.</font>
|
||||
</p>
|
||||
<p style="margin-bottom: 0in;">
|
||||
</p>
|
||||
<p style="margin-bottom: 0in;">
|
||||
<font face="Bitstream Vera Sans Mono, sans-serif"><br>
|
||||
</font>
|
||||
</p>
|
||||
<p style="margin-bottom: 0in;">
|
||||
<font face="Bitstream Vera Sans Mono, sans-serif">[</font><font face="Bitstream Vera Sans Mono, sans-serif">uart.send] </font><font face="Bitstream Vera Sans Mono, sans-serif">uart.send( id, Data1, Data2, ... ): send all the data to the specified UART interface.</font>
|
||||
</p>
|
||||
<p style="margin-bottom: 0in;">
|
||||
<font face="Bitstream Vera Sans Mono, sans-serif">#### Data 1 only !?!!<br>
|
||||
</font>
|
||||
</p>
|
||||
<p style="margin-bottom: 0in;">
|
||||
</p>
|
||||
<p style="margin-bottom: 0in;">
|
||||
<font face="Bitstream Vera Sans Mono, sans-serif"><br>
|
||||
</font>
|
||||
</p>
|
||||
<p style="margin-bottom: 0in;">
|
||||
<font face="Bitstream Vera Sans Mono, sans-serif">[</font><font face="Bitstream Vera Sans Mono, sans-serif">uart.recv(</font><font face="Bitstream Vera Sans Mono, sans-serif"> id, uart.TIMEOUT_NO | <strike>uart.TIMEOUT_INFINITE</strike> | timeout )</font><font face="Bitstream Vera Sans Mono, sans-serif"> </font><font face="Bitstream Vera Sans Mono, sans-serif">Data = uart.recv( id, uart.NO_TIMEOUT | uart.INF_TIMEOUT | timeout ): reads a </font>
|
||||
</p>
|
||||
<p style="margin-bottom: 0in;">
|
||||
<font face="Bitstream Vera Sans Mono, sans-serif">byte from the specified UART interface.</font>
|
||||
</p>
|
||||
<br>
|
||||
|
||||
|
||||
|
||||
</body></html>
|
94
doc/pt/style.css
Normal file
94
doc/pt/style.css
Normal file
@ -0,0 +1,94 @@
|
||||
/* Generated by KompoZer */
|
||||
body {
|
||||
margin-left: 1em;
|
||||
margin-right: 1em;
|
||||
font-family: tahoma,verdana,arial,helvetica,geneva,sans-serif;
|
||||
background-color: #ffffff;
|
||||
}
|
||||
p {
|
||||
margin-left: 1em;
|
||||
line-height: 130%;
|
||||
}
|
||||
h2 {
|
||||
color: #3366cc;
|
||||
}
|
||||
h3 {
|
||||
border: 1px solid #808080;
|
||||
padding: 4px;
|
||||
background-color: blue;
|
||||
color: white;
|
||||
}
|
||||
pre {
|
||||
border: 1px solid #62a0ff;
|
||||
padding: 10px;
|
||||
background-color: #cee7ff;
|
||||
font-family: 'Monotype.com',"Courier New",Courier,monospace;
|
||||
font-size: 90%;
|
||||
line-height: 125%;
|
||||
margin-left: 3em;
|
||||
margin-right: 3em;
|
||||
}
|
||||
p.info {
|
||||
margin-left: 3em;
|
||||
}
|
||||
ul {
|
||||
margin-left: 2em;
|
||||
}
|
||||
h4 {
|
||||
padding: 3px;
|
||||
background-color: #e1e1e1;
|
||||
margin-right: 2em;
|
||||
margin-left: 2em;
|
||||
}
|
||||
h1 {
|
||||
text-align: center;
|
||||
}
|
||||
.homeTitle {
|
||||
font-family: Arial,Helvetica,sans-serif;
|
||||
font-size: 36pt;
|
||||
font-weight: bold;
|
||||
color: #003399;
|
||||
text-align: center;
|
||||
}
|
||||
.homeDescription {
|
||||
font-family: Arial,Helvetica,sans-serif;
|
||||
font-size: 20pt;
|
||||
color: #003399;
|
||||
text-align: center;
|
||||
}
|
||||
.homeVersion {
|
||||
margin: 10px;
|
||||
font-family: Arial,Helvetica,sans-serif;
|
||||
font-size: 16pt;
|
||||
color: #003399;
|
||||
text-align: center;
|
||||
}
|
||||
#navigation {
|
||||
position: fixed;
|
||||
top: 0;
|
||||
right: 0;
|
||||
background-color: #e1e1e1;
|
||||
}
|
||||
#navigation ul {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
list-style-type: none;
|
||||
}
|
||||
#navigation li {
|
||||
float: left;
|
||||
}
|
||||
#navigation a {
|
||||
border: 1px solid #808080;
|
||||
padding: 3px;
|
||||
color: #5c5c5c;
|
||||
text-decoration: none;
|
||||
display: block;
|
||||
background-color: #e1e1e1;
|
||||
font-size: small;
|
||||
}
|
||||
#navigation a:hover {
|
||||
border: 1px solid #808080;
|
||||
color: #e1e1e1;
|
||||
text-decoration: none;
|
||||
background-color: #5c5c5c;
|
||||
}
|
Loading…
x
Reference in New Issue
Block a user