1
0
mirror of https://github.com/elua/elua.git synced 2025-01-08 20:56:17 +08:00

64 Commits

Author SHA1 Message Date
Bogdan Marinescu
5a26274a6e WOFS documentation, last part + another style change 2012-06-27 00:34:58 +03:00
Martin Guy
59f9a2616b Added documentation file for mizar32 rtc module
Forgot to git-add it in the previous commit. Oops.
2012-03-25 13:43:53 +02:00
Martin Guy
49ab7be03e Fix typo in docs 2012-03-15 09:20:57 +01:00
Martin Guy
27da495151 Document pio.decode() 2012-03-08 21:23:13 +01:00
Martin Guy
ff2ba18585 Fix typos in PIO refman 2012-03-08 20:47:26 +01:00
James Snyder
28d44765c3 Merge branch 'master' into newsite 2012-02-07 15:01:54 -06:00
Martin Guy
69eb5cc478 Put the order of timer parameters back to what it used to be
This patch undoes the change in the order of timer parameters for:
net.accept() net.recv() tmr.delay() tmr.setclock() tmr.set_match_int()
tmr.gettimediff()  and also changes the new tmr.getdiffnow() to have the
same parameter ordering as the others.
The default timer ID (the systimer), which previously was obtained with an
optional last parameter, is now obtained by supplying nil as the timer ID.
2012-01-21 17:30:38 +02:00
Martin Guy
3195763d16 Fix typo in tmr doc 2011-12-11 18:19:49 +01:00
Martin Guy
b07f2fd6c2 Implement and document mizar32.lcd.{getpos,buttons}() functions
The new LCD PIC firmware has the ability to return the cursor position
in the LCD character RAM and the state of the buttons. This commit
implements eLua module functions to make these available to users.
2011-12-10 12:50:31 +01:00
Martin Guy
d154d93523 Fix mizar32.lcd.*() documentation 2011-12-10 09:58:52 +01:00
James Snyder
bd116fae17 Merge branch 'master' into newsite
- resolve conflicts arising from merge
2011-12-02 16:33:31 -06:00
Bogdan Marinescu
c98474e357 added per platform information about system timer support 2011-10-21 21:17:55 +03:00
Bogdan Marinescu
93fdf7b4a6 updated information about default timer IDs 2011-10-21 15:18:10 +03:00
Bogdan Marinescu
c193777755 fixed documentation of the UART platform interface 2011-10-21 11:55:00 +03:00
Bogdan Marinescu
0e9a3c3043 fixed documentation for 'uart' and 'net' 2011-10-19 22:58:40 +03:00
Bogdan Marinescu
43724385b3 finished documenting the timer platform interface and the 'tmr' module 2011-10-19 15:09:59 +03:00
Bogdan Marinescu
6525e39960 start to document the changes 2011-10-19 00:57:33 +03:00
Martin Guy
a05c209ab2 Remove documentation for non-existent str9.rtc module 2011-09-27 15:09:11 +02:00
Martin Guy
22f08c454d Fix markup in PWM documentation 2011-09-13 19:34:27 +02:00
Martin Guy
1c1a59851d Split platform_pwm_op(id, op[, data]) into four distinct functions
platform_pwm_op( id, op, data ) did four unrelated tasks, switching on the
"op" parameter:
op==PLATFORM_PWM_OP_SET_CLOCK took a frequency and returned a frequency
op==PLATFORM_PWM_OP_GET_CLOCK took nothing returned a frequency
op==PLATFORM_PWM_OP_START and _STOP both took nothing and returned nothing

this patch replaces it with:
clock = platform_pwm_set_clock( id, clock)
clock = platform_pwm_get_clock( id )
platform_pwm_start( id ) and
platform_pwm_stop( id )

with resulting clarity in the documentation and smaller, faster code.

This does not affect the Lau interface.
2011-08-02 16:15:59 +02:00
Martin Guy
8f520abd16 Fix typo in I2C refman 2011-07-28 17:53:10 +02:00
Martin Guy
a6b5f865d5 Document the units of net timeouts (microseconds).
Also remove superfluous text (you can't specify a timeout without giving a
timer ID parameter because it comes after it).
2011-07-24 17:12:38 +02:00
Martin Guy
fe95291cdd First full version of Mizar32 LCD module driver. 2011-07-24 01:21:59 +02:00
Martin Guy
158ce167ca Split platform_adc_op() into six separate functions
Previously, you called platform_adc_op(id, OPERATION, u32 arg) to achieve
six unrelated functions with different arg types and return values:

GET_MAXVAL takes nothing and returns an ADC conversion value
SET_SMOOTHING takes a power-of-two filter length and returns nothing
SET_BLOCKING takes a boolean and returns nothing
IS_DONE takes nothing and returns a boolean
SET_TIMER takes a timer ID and returns nothing
SET_CLOCK takes a frequency in Hz and returns a frequency in Hz.

This changes these to six independent functions, each with the right
parameters and return values.

This also makes the documentation more comprehensible, saves 26 bytes of
executable code and should be very slightly faster.
2011-07-23 20:04:32 +02:00
Martin Guy
2e2bcba26e Fix typos 2011-07-19 18:05:33 +02:00
Martin Guy
1730329faf Fix typos 2011-07-18 17:14:03 +02:00
Martin Guy
0585f8ec96 Initial framework for Mizar32 character LCD display driver 2011-07-16 00:12:19 +02:00
Martin Guy
e3982f6682 Document the fact that other I2C bus speeds can be specified as an integer. 2011-07-15 15:23:18 +02:00
Martin Guy
db9d054711 Fix typos 2011-07-15 08:32:02 +02:00
Martin Guy
51a3ed5f0c Document more precisely the arguments to i2c.write() 2011-07-08 21:44:51 +02:00
Martin Guy
cd0b194fe3 Fix repeated spelling error "reffer" 2011-07-05 17:26:39 +02:00
Martin Guy
d72145688a Document the default for ADC's blocking or non-blocking mode (i.e. blocking) 2011-07-05 17:23:14 +02:00
Martin Guy
d1daa53541 Refactor "Portuguese" translations which are an old copy of the English. 2011-06-25 22:15:31 +02:00
Dado Sutter
17487f9ebe - doc folder replaced by some work done on Led Lab for the new doc and site
- This should actually be a merge but we made a mistake on the initial repo creation
  and a merge was not possible.
- Below there is a resumed log of the commit messages for the few steps, just for
  the record.

- The merged commit messages for this work are:

 - Removing Portuguese doc content
 - Ignore folder names fixed on .gitignore
 - Removed doc files which content migrated to the CMS
 - docdata.lua updated accordingly
 - Doc build checked ok
 - Overall doc structure and contents still being refined
 - Removing folder cache from git versioning
 - Removing folder dist from git versioning. The folders above are generated by the buildall.lua script and are not part of the sources
 - Adding .gitignore file with objects info to inform git what to ignore
 - Removed file
 - Merge branch 'master' of git@repos.giga.puc-rio.br:elua-doc.git
 - Moving all files and folders to a working doc folder
 - Css updated
 - Index page added and CSS adjusts
 - Merge branch 'master' of git@repos.giga.puc-rio.br:elua-doc.git
 - Signed-off-by: Guilherme Sanchez <guilhermesanchezpacheco@gmail.com>
 - Merge branch 'master' of git@repos.giga.puc-rio.br:elua-doc.git
 - files deleted
 - Changed function that creates functions submenus.
 - Menu inserted with árvore, CSS adjusts, google search
 - Changed past design to new design
 - CSS updated
 - initial import

- The commit ids were also preserved but they are related to this "other"
  work done on Led Lab. We'll keep the repo just in case.

4dce3f77c47b0c3001a2075a946e80ee52759b49 - Removing Portuguese doc content
78d8847525cacf045fe7e672cff6bd1e058a6a4b Ignore folder names fixed on .gitignore
48dee6b7962168ab1098bf709ead6f3cfe6b7964 - Removed doc files which content migrated to the CMS - docdata.lua updated accordingly - Doc build checked ok - Overall doc structure and contents still being refined
2aa2fe0c554db03dbc7029c34d0f4500fe625b37 - Removing folder cache from git versioning - Removing folder dist from git versioning   The folders above are generated by the buildall.lua script and are not part of the sources - Adding .gitignore file with objects info to inform git what to ignore
af6cc2890edf1855af319dc999a03feee5f9bee0 Removed file
6a180e72eb4f4860620cafc0685000e9f2174cfe Merge branch 'master' of git@repos.giga.puc-rio.br:elua-doc.git
eb430112e78ae537459ab315e228ebca84bdf2d4 Moving all files and folders to a working doc folder
d28a7c99489915630bd2625f3756fecf0d08ce37 Css updated
32836ffe382f04ab07c3e6f018c7b449a20d7a8d Index page added and CSS adjusts
1461d9957d9d25a1467cb57ab8717aa213a37e8d Merge branch 'master' of git@repos.giga.puc-rio.br:elua-doc.git
ae1934c04f35a29e25bb4495ae8a31cd9c000b5b Signed-off-by: Guilherme Sanchez <guilhermesanchezpacheco@gmail.com>
b5f31d70f1fac8d3fba325c9867a03f976775698 Merge branch 'master' of git@repos.giga.puc-rio.br:elua-doc.git
ec9ad8446b7ea38b252c6a416e70774349835e45 files deleted
bd7a80151b2030720ba8d8a303467d8c25a4b4b2 Changed function that creates functions submenus.
6a7494acaec694fadbb13520bcbccc51a6b95dfe Inserido menu com árvore, ajustes no CSS, busca do google
e979f1c259d425c9a3be83f9cda20eddffe073bb Changed past design to new design.
381459e95286886b052103a0253e60b29e064d7a CSS updated
4f81d2f1195efe733fe5f97517be325d75937bc3 initial import
2011-05-06 06:49:21 -03:00
Dado Sutter
573694b121 Removing the doc folder, preparing to merge with the inital work done for the new doc and site 2011-05-06 06:46:07 -03:00
Martin Guy
7154ad7717 Fix typo 2011-04-27 14:28:27 +02:00
Martin Guy
ead2bf6b27 Turn KC_UP into term.KC_UP for clarity 2011-04-27 01:10:34 +02:00
Martin Guy
a0c387efb7 Fix typo 2011-04-27 00:52:33 +02:00
Martin Guy
c0faaa1305 Fix markup 2011-04-26 23:36:33 +02:00
Martin Guy
f49b44eae6 Fix typos in en_refman_gen_tmr doc 2011-04-23 18:56:41 +02:00
Martin Guy
a0cda92c75 Fix typos in pio refman doc 2011-04-13 11:38:26 +02:00
Martin Guy
d6042df51f Fix two typos in refman_gen_cpu doc 2011-04-13 11:34:31 +02:00
Martin Guy
873c731568 Fix typo in i2c doc: u23 -> u32 2011-04-13 09:32:05 +02:00
Martin Guy
28c2c86847 Fix typos in I2C documentation 2011-04-12 16:23:25 +02:00
Martin Guy
c99a357f91 Fix typo in PWM refman 2011-04-05 18:11:31 +02:00
Bogdan Marinescu
f9fbead54c merged pre0.8 branch back to trunk 2011-02-02 17:52:12 +00:00
Bogdan Marinescu
81e7f040fc merged remotefs_int branch on trunk, not fully tested yet 2011-01-16 00:23:19 +00:00
Dado Sutter
26017e24ee Status, features and roadmap tables being updated for v0.8
Needs more work and revision

SRT9 RTC Doc fixes
Introduced the field "ex" for examples on the doc, not yet treated by the doc builder
Examples added for STR9 RTC
2010-12-15 06:36:57 +00:00
Dado Sutter
91eddd9e81 Added doc for STR9 platform-specific Real Time Clock support.
Doc build structure changed to include it on the platform-dependent modules menu.
2010-12-11 00:17:03 +00:00
Dado Sutter
b583073b98 Minor typos and doc enhancements 2010-11-22 23:31:40 +00:00