summaryrefslogtreecommitdiffstats
path: root/conf.d/project/lua.d/README.md
diff options
context:
space:
mode:
authorFulup Ar Foll <fulup@iot.bzh>2017-08-27 13:32:56 +0200
committerFulup Ar Foll <fulup@iot.bzh>2017-08-27 13:32:56 +0200
commite9b532488dff41b1215a8c92820a55fe6847e2f1 (patch)
treeb2e5950c3172e6b85ff89fe2b92bb55c8daa6314 /conf.d/project/lua.d/README.md
parent1951815533e516f4bfeb0749aa6056090371704d (diff)
Readme update for controller
Diffstat (limited to 'conf.d/project/lua.d/README.md')
-rw-r--r--conf.d/project/lua.d/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/conf.d/project/lua.d/README.md b/conf.d/project/lua.d/README.md
new file mode 100644
index 0000000..86b60dd
--- /dev/null
+++ b/conf.d/project/lua.d/README.md
@@ -0,0 +1,33 @@
+WARNING: controller is now independent from AAAA and thus should be imported by your binder before requesting it.
+
+For this your only have to provide the path where to find your controller you are in your development tree probably with something
+like --binding=../../afb-controller/build/ctl-binding/afb-controller.so on the other hand if you controller was installed you
+should import it from where ever you install it.
+
+To run this controller sample from your developpement environement use
+```
+
+export BUILD_DIR=build
+
+# with an internal MPDC (Pusic Player Daemon Client) API
+afb-daemon --port=1234 --workdir=. --roothttp=../htdocs --token= --verbose \
+--alias=/monitoring:$HOME/opt/afb-monitoring \
+--ldpaths=. \
+--alias=/monitoring:/home/fulup/opt/afb-monitoring \
+--binding=../../afb-controller/$BUILD_DIR/package/lib/afb-controller.so \
+--binding=../../afb-mpdc/$BUILD_DIR/package/lib/afb-mpdc-api.so
+
+# with an exernal MPDC API
+afb-daemon --port=1234 --workdir=. --roothttp=../htdocs --token= --verbose \
+--alias=/monitoring:$HOME/opt/afb-monitoring \
+--ldpaths=. \
+--alias=/monitoring:/home/fulup/opt/afb-monitoring \
+--binding=../../afb-controller/$BUILD_DIR/ctl-binding/afb-controller.so \
+--ws-client=unix:/var/tmp/afb-ws/mpdc
+
+# Note:
+ - Both sample make the assumption the monitoring HTML5 app is avaliable at $HOME/opt/afb-monitoring
+ - With second sample you should obviously have your MPDC service exposing its API with --ws-server=unix:/var/tmp/afb-ws/mpdc
+ - Running AAAA from Netbeans ![Sample config](netbeans-aaaa-run-config.png)
+
+```