From 741d4e0505c588f38a64350c1d3c53c74f7ac22c Mon Sep 17 00:00:00 2001 From: José Bollo Date: Thu, 9 Jun 2016 14:22:22 +0200 Subject: documentation: switch to pandoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I60fcea9d370f5b98efa1e08632f5f9682741b8c1 Signed-off-by: José Bollo --- doc/afb-tests-overview.html | 129 +++++++++++++++++--------------------------- 1 file changed, 50 insertions(+), 79 deletions(-) (limited to 'doc/afb-tests-overview.html') diff --git a/doc/afb-tests-overview.html b/doc/afb-tests-overview.html index ce1cba44..f663a75f 100644 --- a/doc/afb-tests-overview.html +++ b/doc/afb-tests-overview.html @@ -1,106 +1,77 @@ + - - + + + + + Overview of tests shipped with AFB-Daemon + + + - -

Overview of tests shipped with AFB-Daemon

- +
+

Overview of tests shipped with AFB-Daemon

+

Manuel Bachmann

+

30 mai 2016

+
+ +

Overview of tests shipped with AFB-Daemon

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

List of tests

- +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.

- +

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 [...]
-
- +
$ afb-daemon --port=1234 --token=123456 [...]

Then run the client with :

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

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

The command doesn't return. You should type requests of type []. So, try:

auth connect
-hello pingjson true
-
- +hello pingjson true


- - -

token-websock.qml (Qt/QML WebSockets)

- +

token-websock.qml (Qt/QML WebSockets)

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

- -
$ afb-daemon --port=1234 --token=123456 [...]
-
- +
$ 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
-
- +
$ 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
-
- +
$ 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”.

- +
qmlscene test/token-websock.qml
+

and interactively press the buttons, "Connect", "Refresh", "Logout".


- - -

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

- +

*.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)_

- +
$ 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
-
- +
http://localhost:1234

and interactively run the various tests.

-- cgit 1.2.3-korg