+<!DOCTYPE html>
<html>
<head>
- <link rel="stylesheet" type="text/css" href="doc.css">
- <meta charset="UTF-8">
+ <meta charset="utf-8">
+ <meta name="generator" content="pandoc">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
+ <meta name="author" content="Manuel Bachmann">
+ <meta name="author" content="José Bollo">
+ <title>Overview of plugins shipped with AFB-Daemon</title>
+ <style type="text/css">code{white-space: pre;}</style>
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+ <link rel="stylesheet" href="doc.css">
</head>
<body>
-<h1>Overview of plugins shipped with AFB-Daemon</h1>
-
+<header>
+<h1 class="title">Overview of plugins shipped with AFB-Daemon</h1>
+<h2 class="author">Manuel Bachmann</h2>
+<h2 class="author">José Bollo</h2>
+<h3 class="date">09 juin 2016</h3>
+</header>
+<nav id="TOC">
+<ul>
+<li><a href="#overview-of-plugins-shipped-with-afb-daemon">Overview of plugins shipped with AFB-Daemon</a><ul>
+<li><a href="#list-of-plugins">List of plugins</a></li>
+<li><a href="#detail-of-plugins">Detail of plugins</a><ul>
+<li><a href="#hello-world">Hello World</a></li>
+<li><a href="#authentication">Authentication</a></li>
+<li><a href="#tic-tac-toe">Tic Tac Toe</a></li>
+<li><a href="#audio">Audio</a></li>
+<li><a href="#radio">Radio</a></li>
+<li><a href="#media">Media</a></li>
+</ul></li>
+</ul></li>
+</ul>
+</nav>
+<h1 id="overview-of-plugins-shipped-with-afb-daemon">Overview of plugins shipped with AFB-Daemon</h1>
<pre><code>Version: 1
-Date: 30 May 2016
-Author: Manuel Bachmann
-</code></pre>
-
-<h2>List of plugins</h2>
-
-<p>Here are the plugins shipped in the source tree:
- * Audio <em>(2 backends: ALSA/PulseAudio)</em>
- * Radio <em>(1 backend: RTLSDR RTL2832U)</em>
- * Media <em>(1 backend: Rygel UPnP)</em></p>
-
+Date: 09 juin 2016
+Author: Manuel Bachmann</code></pre>
+<h2 id="list-of-plugins">List of plugins</h2>
+<p>Here are the plugins shipped in the source tree:</p>
+<ul>
+<li>Hello World</li>
+<li>Authentication</li>
+<li>Tic Tac Toe</li>
+<li>Audio <em>(2 backends: ALSA/PulseAudio)</em></li>
+<li>Radio <em>(1 backend: RTLSDR RTL2832U)</em></li>
+<li>Media <em>(1 backend: Rygel UPnP)</em></li>
+</ul>
<p>All plugins may not be built, depending on the development libraries present on the system at build time.</p>
-
-<h2>Detail of plugins</h2>
-
-<p>### Audio</p>
-
-<p>A sample Audio plugin with 2 backends:
- * ALSA (mandatory)
- * PulseAudio (optional)</p>
-
+<h2 id="detail-of-plugins">Detail of plugins</h2>
+<h3 id="hello-world">Hello World</h3>
+<p>A sample Hello World plugin for demonstration and learning purposes.</p>
+<p>This plugin provides a few unauthenticated requests, all beginning with "ping", to demonstrate basic binder capabilities.</p>
+<p><strong>Verbs</strong>:</p>
+<ul>
+<li><em>ping:</em> returns a success response</li>
+<li><em>pingfail:</em> returns a failure response</li>
+<li><em>pingnull:</em> returns a success response, with an empty JSON response field</li>
+<li><em>pingbug:</em> does a memory violation (intercepted by the binder)</li>
+<li><em>pingJson:</em> returns a success response, with a complex JSON response field</li>
+<li><em>pingevent:</em> broadcasts a global event</li>
+</ul>
+<p><br /></p>
+<h3 id="authentication">Authentication</h3>
+<p>An sample Authentication plugin for demonstration purposes.</p>
+<p>This plugin provides a few requests to demonstrate the binder's token-based security mechanism.</p>
+<p>Calling "<em>connect</em>" with a security token will initiate a session, calling "<em>refresh</em>" will issue a new token and invalidate the previous one, calling "<em>logout</em>" will invalidate all tokens and close the session.</p>
+<p><strong>Verbs</strong>:</p>
+<ul>
+<li><em>ping:</em> returns a success response</li>
+<li><em>connect:</em> creates a session and returns a new token</li>
+<li><em>refresh:</em> returns a new token</li>
+<li><em>check:</em> verifies the passed token is valid</li>
+<li><em>logout:</em> closes the session</li>
+</ul>
+<p><br /></p>
+<h3 id="tic-tac-toe">Tic Tac Toe</h3>
+<p>A sample Tic Tac Toe game plugin.</p>
+<p>This plugin provides an interactive Tic Tac Toe game where the binder returns the grid as a JSON response.</p>
+<p><strong>Verbs</strong>:</p>
+<ul>
+<li><em>new:</em> starts a new game</li>
+<li><em>play:</em> asks the server to play</li>
+<li><em>move:</em> gives a client move</li>
+<li><em>board:</em> gets the current board state, as a JSON structure</li>
+<li><em>level</em>: sets the server level</li>
+<li><em>join</em>: joins an existing board</li>
+<li><em>undo</em>: undo the last move</li>
+<li><em>wait</em>: wait for a move</li>
+</ul>
+<p><br /></p>
+<h3 id="audio">Audio</h3>
+<p>A sample Audio plugin with 2 backends:</p>
+<ul>
+<li>ALSA (mandatory)</li>
+<li>PulseAudio (optional)</li>
+</ul>
+<p>This plugin is able to initialize a specific soundcard, define volume levels, channels (mono/stereo...), mute sound, and play a 22,050 Hz PCM stream.</p>
+<p><strong>Verbs</strong>:</p>
+<ul>
+<li><em>ping:</em> returns a success response</li>
+<li><em>init:</em> initializes backend, on the "default" sound card</li>
+<li><em>volume:</em> gets or sets volume, in % (0-100)</li>
+<li><em>channels:</em> gets or sets channels count (1-8)</li>
+<li><em>mute:</em> gets or sets the mute status (on-off)</li>
+<li><em>play</em>: gets or sets the playing status (on-off)</li>
+</ul>
<p><em>(if PulseAudio development libraries are not found at build time, only ALSA will be available)</em></p>
-
<p><em>(if a PulseAudio server is not found at runtime, the plugin will dynamically fall back to ALSA)</em></p>
-
-<p><em>(a specifc backend can be forced by using this syntax before running afb-daemon : <strong>$ export AFB</em>AUDIO<em>OUTPUT=Alsa</strong>)</em></p>
-
-<p>This plugin is able to initialize a specific soundcard, define volume levels, channels (mono/stereo...), mute sound, and play a 22,050 Hz PCM stream.</p>
-
-<p>Sample applications: <strong><a href="https://github.com/iotbzh/afb-radio">afb-radio</a></strong></p>
-
-<p>### Radio</p>
-
-<p>A sample AM/FM Radio plugin with 1 backend:
- * RTLSDR - Realtek RTL2832U dongles (mandatory)</p>
-
+<p><em>(a specifc backend can be forced by using this syntax before running afb-daemon : <strong>$ export AFB_AUDIO_OUTPUT=Alsa</strong>)</em></p>
+<p><br /></p>
+<h3 id="radio">Radio</h3>
+<p>A sample AM/FM Radio plugin with 1 backend:</p>
+<ul>
+<li>RTLSDR - Realtek RTL2832U dongles (mandatory)</li>
+</ul>
+<p>This plugin is able to initialize specific RTL2832U dongles, switch between AM/FM modes, define frequency, mute sound, and play sound (if combining with the <strong>audio</strong> plugin).</p>
+<p><strong>Verbs</strong>:</p>
+<ul>
+<li><em>ping:</em> returns a success response</li>
+<li><em>init:</em> initializes backend, looking for plugged-in devices</li>
+<li><em>power:</em> sets device power status (on-off)</li>
+<li><em>mode:</em> sets device reception mode (AM-FM)</li>
+<li><em>freq:</em> sets device frequency (in Hz)</li>
+<li><em>mute</em>: sets device mute status (on-off)</li>
+<li><em>play</em>: sets device playing status (on-off)</li>
+</ul>
<p><em>(if rtlsdr development libraries are not found at build time, this plugin will not be built)</em></p>
-
-<p>This plugin is able to initialize specific RTL2832U dongles, switch between AM/FM modes, define frequency, mute sound, and play sound (by using the <strong>audio</strong> plugin).</p>
-
-<p>Sample applications: <strong><a href="https://github.com/iotbzh/afb-radio">afb-radio</a></strong></p>
-
-<p>### Media</p>
-
-<p>A sample Media Server plugin with 1 backend:
- * Rygel</p>
-
-<p><em>(if GUPnP/GSSDP development libraries are not fund at build time, this plugin will not be built)</em></p>
-
+<p><br /></p>
+<h3 id="media">Media</h3>
+<p>A sample Media Server plugin with 1 backend:</p>
+<ul>
+<li>Rygel</li>
+</ul>
<p>This plugin is able to detect a local Rygel UPnP media server, list audio files, select an audio file for playback, play/pause/seek in this file, upload an audio file to the server.</p>
-
-<p>Sample applications: <strong><a href="https://github.com/iotbzh/afb-radio">afb-radio</a></strong></p>
+<p><strong>Verbs</strong>:</p>
+<ul>
+<li><em>ping:</em> returns a success response</li>
+<li><em>init:</em> initializes backend, looking for an active local UPnP server</li>
+<li><em>list:</em> returns list of audio files, as a JSON structure</li>
+<li><em>select:</em> select an audio files, by index number (001-...)</li>
+<li><em>play:</em> plays the currently selected audio file</li>
+<li><em>stop:</em> stops the currently selected audio file</li>
+<li><em>pause:</em> pauses the currently selected audio file</li>
+<li><em>seek:</em> seeks in the currently selected audio file, in seconds</li>
+<li><em>upload:</em> uploads an audio file, with a POST request</li>
+</ul>
+<p><em>(if GUPnP/GSSDP development libraries are not fund at build time, this plugin will not be built)</em></p>
+<p><br /></p>
+<hr />
+<p><br /></p>
+<p>Sample command-line applications: <em>afb-client-demo</em> (built by default)</p>
+<p>Sample HTML5 applications: **test/*.html<strong>, </strong><a href="https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/app-framework-demo.git;a=tree">afb-client</a><strong>, </strong><a href="https://github.com/iotbzh/afb-radio">afb-radio</a>**</p>
+<p>Sample Qt/QML applications: <em>test/token-websock.qml</em></p>
</body>
</html>
Code Review / src / app-framework-binder.git / blobdiff