From ec667b3dfe10945dc6fa140ef5acaaf10a437db9 Mon Sep 17 00:00:00 2001 From: José Bollo Date: Mon, 30 May 2016 15:00:57 +0200 Subject: update documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I64a28ead6a82658dd9a95c7d54742dbe018ef574 Signed-off-by: José Bollo --- doc/afb-tests-overview.html | 106 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 106 insertions(+) create mode 100644 doc/afb-tests-overview.html (limited to 'doc/afb-tests-overview.html') diff --git a/doc/afb-tests-overview.html b/doc/afb-tests-overview.html new file mode 100644 index 00000000..f5dcb646 --- /dev/null +++ b/doc/afb-tests-overview.html @@ -0,0 +1,106 @@ + + + + + + + +

Overview of tests shipped with AFB-Daemon

+ +
Version: 1
+Date:    30 mai 2016
+Author:  Manuel Bachmann
+
+ + +

List of tests

+ +

Here are the tests shipped in the source tree:

+ + + + + +

Detail of tests

+ + +

afb-client-demo (command-line WebSockets)

+ +

This clients interactively calls plugins APIs from the command line, using the binder +WebSockets facility.

+ +

If afb-daemon has been launched with the following parameters:

+ +
$ afb-daemon --port=1234 --token=123456 [...]
+
+ +

Then run the client with :

+ +
afb-client-demo ws://localhost:1234/api?token=123456 [<api> <verb> [<json-data>]]
+
+ +

For instance, to initialize the Audio plugin from the command line :

+ +
afb-client-demo ws://localhost:1234/api?token=123456
+
+ +

The command doesn’t return. You should type requests of type [<json-data>]. +So, try:

+ +
auth connect
+audio init
+
+ +


+ + +

token-websock.qml (Qt/QML WebSockets)

+ +

If afb-daemon has been launched with the following parameters:

+ +
$ afb-daemon --port=1234 --token=123456 [...]
+
+ +

and Qt5 is installed.

+ +

For installing Qt5 on Ubuntu 16.04:

+ +
$ apt-get install qmlscene qml-module-qtwebsockets qml-module-qtquick-controls
+
+ +

For installing Qt5 on Fedora 23 :

+ +
$ dnf install qt5-qtdeclarative-devel qt5-qtwebsockets-devel qt5-qtquickcontrols
+
+ +

Then run the client with :

+ +
qmlscene test/token-websock.qml
+
+ +

and interactively press the buttons, “Connect”, “Refresh”, “Logout”.

+ +


+ + +

*.html (HTML5/JS HTTP-REST & WebSockets)

+ +

If afb-daemon has been launched with the following parameters:

+ +
$ afb-daemon --port=1234 --rootdir=$PWD/test [...]
+
+ +

(“$PWD/test” being the “test” subdirectory of the source tree)_

+ +

Then open your preferred Web browser, connect to the following URL:

+ +
http://localhost:1234
+
+ +

and interactively run the various tests.

+ + -- cgit 1.2.3-korg