1
0
mirror of https://github.com/elua/elua.git synced 2025-01-08 20:56:17 +08:00
elua/doc/eluadoc/refman_ps_lm3s_disp.lua
James Snyder bd1465ca50 Merge 0.6 branch to trunk.
Conflicts:
	SConstruct
	doc/en/arch_platform.html
	doc/en/comunity.html
	doc/en/overview.html
	doc/en/refman.html
	doc/en/refman_gen.html
	doc/en/status.html
	doc/en/tut_bootstick.html
	doc/images/lng_pt.png
	doc/images/minusnode.png
	doc/images/next.png
	doc/images/node.png
	doc/images/nodelast.png
	doc/images/plusnode.png
	doc/images/plusnodelast.png
	doc/images/previous.png
	doc/images/showall.png
	doc/images/sync.png
	doc/images/vertline.png
	doc/pt/arch.html
	doc/pt/arch_coding.html
	doc/pt/arch_con_term.html
	doc/pt/arch_newport.html
	doc/pt/arch_overview.html
	doc/pt/arch_platform.html
	doc/pt/arch_tcpip.html
	doc/pt/building.html
	doc/pt/comunity.html
	doc/pt/dl_binaries.html
	doc/pt/dl_old.html
	doc/pt/dl_sources.html
	doc/pt/downloads.html
	doc/pt/examples.html
	doc/pt/faq.html
	doc/pt/installing_i386.html
	doc/pt/installing_lm3s.html
	doc/pt/news.html
	doc/pt/overview.html
	doc/pt/refman_dep.html
	doc/pt/refman_gen.html
	doc/pt/status.html
	doc/pt/tc_386.html
	doc/pt/toolchains.html
	doc/pt/tut_openocd.html
	doc/pt/using.html
	romfs/LM3S.lua
	romfs/led.lua
	romfs/morse.lua
	romfs/pong.lua
	src/lua/linit.c
	src/modules/auxmods.h
	src/platform/lm3s/platform.c
	src/platform/lm3s/platform_conf.h
	src/platform/sim/platform_conf.h
2009-10-13 02:14:27 +00:00

137 lines
4.1 KiB
Lua

-- eLua reference manual - platform data
data_en =
{
-- Title
title = "eLua reference manual - LM3S disp module",
-- Menu name
menu_name = "disp",
-- Overview
overview = [[This module contains functions for working with the RIT OLED display on the Luminary Micro EKx-LM3S8962 boards and others.]],
-- Functions
funcs =
{
{ sig = "#lm3s.disp.init#( frequency )",
desc = "Initialize the display.",
args = "$frequency$ - Number, the clock frequency (in Hertz) of the SSI interface used to control the display."
},
{ sig = "#lm3s.disp.enable#( frequency )",
desc = "Enable the display.",
args = "$frequency$ - Number, the clock frequency (in Hertz) of the SSI interface used to control the display."
},
{ sig = "#lm3s.disp.disable#()",
desc = "Disable the display.",
},
{ sig = "#lm3s.disp.on#()",
desc = "Turn the display on."
},
{ sig = "#lm3s.disp.off#()",
desc = "Turn the display off."
},
{ sig = "#lm3s.disp.clear#()",
desc = "Clear the display."
},
{ sig = "#lm3s.disp.print#( str, x, y, col )",
desc = "Write a string on the display. A 5x7 font (in a 6x8 cell) is used for drawing the text.",
args =
{
"$str$ - String, the text to be written on the display.",
"$x$ - Number [0-127], the horizonal position of the text (specified in columns).",
"$y$ - Number [0-95], the vertical position of the text (specified in lines).",
"$col$ - Number [0-15], the 4-bit gray scale value to be used for the text."
}
},
{ sig = "#lm3s.disp.draw#( img, x, y, width, height )",
desc = "Draw an image on the display.",
args =
{
"$img$ - String, the image to draw in string format.",
"$x$ - Number [0-127], the horizontal position of the image (specified in pixels).",
"$y$ - Number [0-95], the vertical position of the image (specified in pixels).",
"$width$ - Number [1-127], the width of the image.",
"$height$ - Number [1-95], the height of the image."
}
},
},
}
data_pt =
{
-- Title
title = "eLua reference manual - LM3S disp module",
-- Menu name
menu_name = "disp",
-- Overview
overview = [[This module contains functions for working with the RIT OLED display on the Luminary Micro EKx-LM3S8962 boards and others.]],
-- Functions
funcs =
{
{ sig = "#lm3s.disp.init#( frequency )",
desc = "Initialize the display.",
args = "$frequency$ - Number, the clock frequency (in Hertz) of the SSI interface used to control the display."
},
{ sig = "#lm3s.disp.enable#( frequency )",
desc = "Enable the display.",
args = "$frequency$ - Number, the clock frequency (in Hertz) of the SSI interface used to control the display."
},
{ sig = "#lm3s.disp.disable#()",
desc = "Disable the display.",
},
{ sig = "#lm3s.disp.on#()",
desc = "Turn the display on."
},
{ sig = "#lm3s.disp.off#()",
desc = "Turn the display off."
},
{ sig = "#lm3s.disp.clear#()",
desc = "Clear the display."
},
{ sig = "#lm3s.disp.print#( str, x, y, col )",
desc = "Write a string on the display. A 5x7 font (in a 6x8 cell) is used for drawing the text.",
args =
{
"$str$ - String, the text to be written on the display.",
"$x$ - Number [0-127], the horizonal position of the text (specified in columns).",
"$y$ - Number [0-95], the vertical position of the text (specified in lines).",
"$col$ - Number [0-15], the 4-bit gray scale value to be used for the text."
}
},
{ sig = "#lm3s.disp.draw#( img, x, y, width, height )",
desc = "Draw an image on the display.",
args =
{
"$img$ - String, the image to draw in string format.",
"$x$ - Number [0-127], the horizontal position of the image (specified in pixels).",
"$y$ - Number [0-95], the vertical position of the image (specified in pixels).",
"$width$ - Number [1-127], the width of the image.",
"$height$ - Number [1-95], the height of the image."
}
},
},
}