diff options
| author |   José Bollo <jose.bollo@iot.bzh> | 2016-05-30 15:00:57 +0200 |
|---|---|---|
| committer | José Bollo <jose.bollo@iot.bzh> | 2016-05-30 15:51:50 +0200 |
| commit | ec667b3dfe10945dc6fa140ef5acaaf10a437db9 (patch) | |
| tree | 8eff27cc0b2811061819861cc797051bfd25bdce /doc/afb-tests-overview.html | |
| parent | 5b5a2534e5effa69c800c2384c90dff4bc887c09 (diff) | |
update documentation
Change-Id: I64a28ead6a82658dd9a95c7d54742dbe018ef574
Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'doc/afb-tests-overview.html')
| -rw-r--r-- | doc/afb-tests-overview.html | 106 |
1 files changed, 106 insertions, 0 deletions
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 @@ +<html> +<head> + <link rel="stylesheet" type="text/css" href="doc.css"> + <meta charset="UTF-8"> +</head> +<body> +<a name="Overview.of.tests.shipped.with.AFB-Daemon"></a> +<h1>Overview of tests shipped with AFB-Daemon</h1> + +<pre><code>Version: 1 +Date: 30 mai 2016 +Author: Manuel Bachmann +</code></pre> + +<a name="List.of.tests"></a> +<h2>List of tests</h2> + +<p>Here are the tests shipped in the source tree:</p> + +<ul> +<li><strong>afb-client-demo</strong> (command-line WebSockets)</li> +<li><strong>token-websock.qml</strong> (Qt/QML WebSockets)</li> +<li><strong>*.html</strong> (HTML5/JS HTTP-REST & WebSockets)</li> +</ul> + + +<a name="Detail.of.tests"></a> +<h2>Detail of tests</h2> + +<a name="afb-client-demo..command-line.WebSockets."></a> +<h3>afb-client-demo (command-line WebSockets)</h3> + +<p>This clients interactively calls plugins APIs from the command line, using the binder +<a href="https://en.wikipedia.org/wiki/WebSocket">WebSockets</a> facility.</p> + +<p>If <em>afb-daemon</em> has been launched with the following parameters:</p> + +<pre><code>$ afb-daemon --port=1234 --token=123456 [...] +</code></pre> + +<p>Then run the client with :</p> + +<pre><code>afb-client-demo ws://localhost:1234/api?token=123456 [<api> <verb> [<json-data>]] +</code></pre> + +<p>For instance, to initialize the Audio plugin from the command line :</p> + +<pre><code>afb-client-demo ws://localhost:1234/api?token=123456 +</code></pre> + +<p>The command doesn’t return. You should type requests of type <api> <verb> [<json-data>]. +So, try:</p> + +<pre><code>auth connect +audio init +</code></pre> + +<p><br /></p> + +<a name="token-websock.qml..Qt.QML.WebSockets."></a> +<h3>token-websock.qml (Qt/QML WebSockets)</h3> + +<p>If <em>afb-daemon</em> has been launched with the following parameters:</p> + +<pre><code>$ afb-daemon --port=1234 --token=123456 [...] +</code></pre> + +<p>and Qt5 is installed.</p> + +<p>For installing Qt5 on <strong>Ubuntu 16.04</strong>:</p> + +<pre><code>$ apt-get install qmlscene qml-module-qtwebsockets qml-module-qtquick-controls +</code></pre> + +<p>For installing Qt5 on <strong>Fedora 23</strong> :</p> + +<pre><code>$ dnf install qt5-qtdeclarative-devel qt5-qtwebsockets-devel qt5-qtquickcontrols +</code></pre> + +<p>Then run the client with :</p> + +<pre><code>qmlscene test/token-websock.qml +</code></pre> + +<p>and interactively press the buttons, “Connect”, “Refresh”, “Logout”.</p> + +<p><br /></p> + +<a name="L..html..HTML5.JS.HTTP-REST..amp..WebSockets."></a> +<h3>*.html (HTML5/JS HTTP-REST & WebSockets)</h3> + +<p>If <em>afb-daemon</em> has been launched with the following parameters:</p> + +<pre><code>$ afb-daemon --port=1234 --rootdir=$PWD/test [...] +</code></pre> + +<p><em>(“$PWD/test</em>” being the “test” subdirectory of the source tree)_</p> + +<p>Then open your preferred Web browser, connect to the following URL:</p> + +<pre><code>http://localhost:1234 +</code></pre> + +<p>and interactively run the various tests.</p> +</body> +</html> |