Embedded/elua
1
0
Fork 0
mirror of https://github.com/elua/elua.git synced 2025-01-25 01:02:54 +08:00
Code Issues Projects Releases Wiki Activity

Status, features and roadmap tables being updated for v0.8

Browse Source 
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
This commit is contained in:
Dado Sutter 2010-12-15 06:36:57 +00:00
parent a4ae2bf4fb
commit 26017e24ee
2 changed files with 45 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/eluadoc/refman_ps_str9_rtc.lua
View File

@ -17,37 +17,41 @@ data_en =
-- Functions
funcs =
{
{ sig = "#str9.pio.settime#( time )",
{ sig = "#str9.rtc.settime#( time )",
desc = "Sets the Real Time Clock time to a specific time of the day.",
args =
{
"$time$ - a string in the format 'hh:mm:ss' or a Lua table with 'hour', 'minute' and 'second' string fields.",
"$time$ - a string in the format 'hh:mm:ss' or a Lua table with 'hour', 'min' and 'sec' string fields.",
},
ret = "nothing."
ret = "nothing.",
ex = 'str9.settime("14:25:00") - Sets the RTC time to 14 hour 25 minutes, 2:25 PM',
},
{ sig = "#str9.pio.gettime#( format )",
{ sig = "#str9.rtc.gettime#( format )",
desc = "Gets the time kept by the Real Time Clock.",
args =
{
"$format$ - the string '*s' to return the time as a string 'hh:mm:ss' or '*t' to return as a Lua table with string fields 'hour', 'minute' and 'second'.",
"$format$ - the string '*s' to return the time as a string 'hh:mm:ss' or '*t' to return as a Lua table with string fields 'hour', 'min' and 'sec'.",
},
ret = "a string or a Lua table, according to the format argument."
ret = "a string or a Lua table, according to the format argument.",
ex = 'now = str9.rtc.gettime( "*s" ) - now receives a sting like "14:25:05", now = str9.rtc.gettime( "*t" ) - now receives the Lua table { hour = 14, min = 25, sec = 05 }',
},
{ sig = "#str9.pio.setdate#( date )",
{ sig = "#str9.rtc.setdate#( date )",
desc = "Sets the Real Time Clock date to a specific date.",
args =
{
"$date$ - a string in the format 'dd/mm/yyyy' or a Lua table with 'day', 'month' and 'year' string fields.",
},
ret = "nothing."
ret = "nothing.",
ex = 'str9.rtc.setdate( "31/08/1960" ) - set the RTC date to August 31st 1960',
},
{ sig = "#str9.pio.getdate#( format )",
{ sig = "#str9.rtc.getdate#( format )",
desc = "Gets the date kept by the Real Time Clock.",
args =
{
"$format$ - the string '*s' to return the date as a string 'dd/mm/yyyy' or '*t' to return as a Lua table with string fields 'day', 'month' and 'year'.",
},
ret = "a string or a Lua table, according to the format argument."
ret = "a string or a Lua table, according to the format argument.",
ex = 'today = str9.rtc.getdate( "*s" ) - today receives a string like "14/12/2010", meaning December 14th of 2010, today = str9.rtc.getdate( "*t" ) - today receives the Lua table { day = 14, month = 12, year = 2010 }',
},
},

56
doc/en/status.txt
View File

@ -27,8 +27,10 @@ The list of CPUs and boards currently supported by eLua is given below:
| _LM3S6918 | Cortex-M3 o| LM3S | _Eagle-100 | _sok
| _LM3S9B92 | Cortex-M3 o| LM3S | _EK-LM3S9B92 | _sok
| _AT32UC3A0512 | AVR32 o| AVR32 | _ATEVK1100 | _sok
| _AT32UC3B0256 | AVR32 o| AVR32 | _ATEVK1101 | _sok
| _AT91SAM7X256 | ARM7TDMI o| AT91SAM7X | _SAM7-EX256 | _sok
| _AT91SAM7X512 | ARM7TDMI o| AT91SAM7X | None | _snt
| _LPC1768 | Cortex-M3 o| LPC17xx | _mbed | _sok
| _LPC2468 | ARM7TDMI o| LPC24xx | _PUC-RioDemo | _sok
| _LPC2888 | ARM7TDMI o| LPC288x | _LPC-H2888 | _sok
| _STR711FR2 | ARM7TDMI o| STR7 | _MOD711 | _sok
@ -38,7 +40,6 @@ The list of CPUs and boards currently supported by eLua is given below:
| _STM32F103RE | Cortex-M3 o| STM32 | _ET-STM32Stamp | _sok
| _i386 | x86 o| i386 | PCs/emulators | _sok
|=====================================================================================
// | _LPC1768 | Cortex-M3 o| LPC17xx | _mbed | _sok
[[plat_modules]]
eLua modules x MCUs
@ -48,21 +49,23 @@ The relationship between a module and its implementation on a particular platfor
[width="70%", cols="<4, ^1, ^1, ^1, ^1, ^1, ^1, ^1, ^1, ^1, ^1, ^1, ^1, ^1, ^1, ^1", options="header"]
|===================================================================================================================================
^| MCU 15+| Module
| g| pio g| spi g| uart g| tmr g| pwm g| net g| cpu g| adc g| pd g| term g| bit g| pack g| can g| rpc g|mmc
| _LM3S8962 | _sok | _snt | _sok | _sok | _sok | _sok | _sok | _sok | _sok | _sok | _sok | _sok | _sni | _snt | _sok
| _LM3S6965 | _sok | _snt | _sok | _sok | _snt | _snt | _sok | _sok | _sok | _sok | _sok | _sok | _sna | _sok | _sok
| _LM3S6918 | _sok | _snt | _sok | _sok | _sna | _snt | _sok | _snt | _sok | _sok | _sok | _sok | _sna | _snt | _sni
| _LM3S9B92 | _sok | _snt | _sok | _sok | _sok | _sok | _sok | _snt | _sok | _sok | _sok | _sok | _sni | _snt | _sok
| _AT32UC3A0512 | _sok | _sni | _sok | _sok | _sni | _sni | _sok | _sni | _sok | _sok | _sok | _sok | _sna | _sni | _sni
| _AT91SAM7X256 | _sok | _sni | _sok | _sok | _sok | _sni | _sok | _sni | _sok | _sok | _sok | _sok | _sni | _sni | _sni
| _AT91SAM7X512 | _snt | _sni | _snt | _snt | _snt | _sni | _sok | _sni | _sok | _sok | _sok | _sok | _sni | _sni | _sni
| _LPC2468 | _sok | _sni | _sok | _sok | _sni | _sni | _sok | _sni | _sok | _sok | _sok | _sok | _sni | _sni | _sni
| _LPC2888 | _sok | _sni | _sok | _sok | _sna | _sni | _sok | _sni | _sok | _sok | _sok | _sok | _sna | _sni | _sni
| _STR711FR2 | _sok | _sni | _sok | _sok | _snt | _sna | _sok | _sni | _sok | _sok | _sok | _sok | _sna | _sni | _sni
| _STR912FAW44 | _sok | _sni | _sok | _sok | _sok | _sni | _sok | _sni | _sok | _sok | _sok | _sok | _sni | _sni | _sni
| _STM32F103ZE | _sok | _sni | _sok | _sok | _sni | _sni | _sok | _sni | _sok | _sok | _sok | _sok | _sni | _sni | _sni
| _STM32F103RE | _sok | _sni | _sok | _sok | _sni | _sni | _sok | _sni | _sok | _sok | _sok | _sok | _snt | _sni | _sni
| _i386 | _sna | _sna | _sni | _sni | _sna | _sni | _sni | _sna | _sok | _sni | _sni | _sni | _sna | _sni | _sni
| g| pio g| spi g| uart g| tmr g| pwm g| net g| cpu g| adc g| pd g| term g| bit g| pack g| can g| rpc g| mmc
| _LM3S8962 | _sok | _snt | _sok | _sok | _sok | _sok | _sok | _sok | _sok | _sok | _sok | _sok | _sni | _snt | _snt
| _LM3S6965 | _sok | _snt | _sok | _sok | _snt | _snt | _sok | _sok | _sok | _sok | _sok | _sok | _sna | _sok | _sok
| _LM3S6918 | _sok | _snt | _sok | _sok | _sna | _snt | _sok | _snt | _sok | _sok | _sok | _sok | _sna | _snt | _sni
| _LM3S9B92 | _sok | _snt | _sok | _sok | _sok | _sok | _sok | _snt | _sok | _sok | _sok | _sok | _sni | _snt | _sok
| _AT32UC3A0512 | _sok | _sni | _sok | _sok | _sni | _sni | _sok | _sni | _sok | _sok | _sok | _sok | _sna | _sni | _sni
| _AT32UC3B0256 | _sok | _sni | _sok | _sok | _sni | _sni | _sok | _sni | _sok | _sok | _sok | _sok | _sna | _sni | _sni
| _AT91SAM7X256 | _sok | _sni | _sok | _sok | _sok | _sni | _sok | _sni | _sok | _sok | _sok | _sok | _sni | _sni | _sni
| _AT91SAM7X512 | _snt | _sni | _snt | _snt | _snt | _sni | _sok | _sni | _sok | _sok | _sok | _sok | _sni | _sni | _sni
| _LPC1768 | _sok | _sni | _sok | _sok | _sni | _sni | _sok | _sni | _sok | _sok | _sok | _sok | _sni | _sni | _sni
| _LPC2468 | _sok | _sni | _sok | _sok | _sni | _sni | _sok | _sni | _sok | _sok | _sok | _sok | _sni | _sni | _sni
| _LPC2888 | _sok | _sni | _sok | _sok | _sna | _sni | _sok | _sni | _sok | _sok | _sok | _sok | _sna | _sni | _sni
| _STR711FR2 | _sok | _sni | _sok | _sok | _snt | _sna | _sok | _sni | _sok | _sok | _sok | _sok | _sna | _sni | _sni
| _STR912FAW44 | _sok | _sni | _sok | _sok | _sok | _sni | _sok | _sni | _sok | _sok | _sok | _sok | _sni | _sni | _sni
| _STM32F103ZE | _sok | _sni | _sok | _sok | _sni | _sni | _sok | _sni | _sok | _sok | _sok | _sok | _sni | _sni | _sni
| _STM32F103RE | _sok | _sni | _sok | _sok | _sni | _sni | _sok | _sni | _sok | _sok | _sok | _sok | _snt | _sni | _sni
| _i386 | _sna | _sna | _sni | _sni | _sna | _sni | _sni | _sna | _sok | _sni | _sni | _sni | _sna | _sni | _sni
|===================================================================================================================================
[[gen_modules]]
@ -74,15 +77,15 @@ The following table shows a list of the generic modules currently implemented (a
|=========================================================================
|Name ^|Description | Status
o|pio | programmable input/output | _sok
o|tmr | periodic timer / counters | _sok
o|pwm | pulse width modulation | _sok
o|uart | universal asynchronous receiver transmitter | _sok
o|tmr | periodic timer | _sok
o|pwm | pulse width modulation | _sok
o|uart | universal asynchronous receiver transmitter | _sok
o|spi | serial peripheral interface | _sok
o|net | TCP/IP networking | _sok
o|adc | analog to digital converter | _sok
o|dac | digital to analog converter | _sni
o|cpu | low level system access | _sok
o|pd | platform data | _sok
o|pd | platform data | _sok
o|term | ANSI terminal access | _sok
o|bit | bitwise operations | _sok
o|pack | pack/unpack binary data | _sok
@ -94,7 +97,6 @@ o|rpc | remote procedure call | _snt
o|i2s | inter-IC sound | _sni
o|mmc | SD/MMC card FAT file system | _sok
o|disp | LCD, OLED and other displays support | _sok
o|int | interrupt service routines | _sni
|=========================================================================
For some platforms, a number of platform dependent modules are implemented (or in the works) and are listed below. To understand the difference between generic
@ -104,7 +106,9 @@ modules and platform specific modules, check link:arch_overview.html[the eLua ar
|=======================================================================================
^| Name ^| Description ^| Boards ^| Status
o| disp | OLED display support | _EK-LM3S8962 _br _EK-LM3S6965 | _sok
o| pio | Platform specific PIO support | _STR-E912 _br _STR9-comStick | _sok
o| str9.pio | Extended PIO configuration | _STR-E912 _br _STR9-comStick | _sok
o| str9.rtc | Real time clock | _STR-E912 | _sok
o| str9.rtc | Real time clock | _STR9-comStick | _snt
|=======================================================================================
[[roadmap]]
@ -126,15 +130,17 @@ The following table shows the status of some existing and planned eLua features.
| link:using.html#rpc[LuaRPC - Remote Procedure Calls] | _snt
| link:using.html#uart[Terminal / Console over UART or Ethernet] | _sok
| link:using.html#shell[eLua command shell] | _sok
| eLua complete interrupt support | _sni
| Lua interrupt handlers | _snt
| C interrupt handlers | _snt
| link:arch_ltr.html[eLua LTR (Lua Tiny RAM) patch] | _sok
| link:elua_egc.html[eLua EGC (Emergency Garbage Collection) patch] | _sok
| Loadable binary modules | _sni
| Embedded text editor | _sni
| Embedded help/doc subsystem | _sni
| Lua debugging (remote/on target) | _sni
| Host (PC) File Sharing | _sni
| Remote (PC) File Sharing | _snt
| GUI/IDE interface for eLua | _sni
| eLua web build service | _snt
| eLua web build service | _sok
|=============================================================================
// $$FOOTER$$