summaryrefslogtreecommitdiffstats
path: root/Controler-afb/README.md
diff options
context:
space:
mode:
authorFulup Ar Foll <fulup@iot.bzh>2017-08-16 19:18:46 +0200
committerFulup Ar Foll <fulup@iot.bzh>2017-08-16 19:18:46 +0200
commita4899ab57f08aeb2741d08f74d7593c85a0ad3f4 (patch)
tree64ee18c96a149f67259ddc166814bf2d74eabe00 /Controler-afb/README.md
parent61f0f263c335ad403c6693a1b8b6f5428ac180a8 (diff)
Fix DoScript Lua Updated Documentation.
Diffstat (limited to 'Controler-afb/README.md')
-rw-r--r--Controler-afb/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/Controler-afb/README.md b/Controler-afb/README.md
index 3abe762..a81d4f7 100644
--- a/Controler-afb/README.md
+++ b/Controler-afb/README.md
@@ -95,6 +95,15 @@ Controler support tree categories of actions. Each action return a status status
Note: Lua added functions systematically prefix. AGL standard AppFw functions are prefixed with AGL: (eg: AGL:notice(), AGL_success(), ...).
User Lua functions added though the plugin and CTLP_Lua2C are prefix with plugin label (eg: MyPlug:HelloWorld1).
+### Debugging Facilities
+
+Controler Lua script are check for syntax from CMAKE template with Luac. When needed to go further an developer API allow to
+execute directly Lua command within controller context from Rest/Ws (api=control, verb=lua_doscript). DoScript API takes two
+other optional arguments func=xxxx where xxxx is the function to execute within Lua script and args a JSON object to provide
+input parameter. When funcname is not given by default the controller try to execute middle filename doscript-xxxx-????.lua.
+
+When executed from controller Lua script may use any AppFw Apis as well as any L2C user defined commands in plugin.
+
## Config Sample
Here after a simple configuration sample.