doc/afb-plugins-overview.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4   <meta charset="utf-8">
   5   <meta name="generator" content="pandoc">
   6   <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
   7   <title></title>
   8   <style type="text/css">code{white-space: pre;}</style>
   9   <!--[if lt IE 9]>
  10     <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
  11   <![endif]-->
  12   <link rel="stylesheet" href="doc.css">
  13 </head>
  14 <body>
  15 <nav id="TOC">
  16 <ul>
  17 <li><a href="#overview-of-plugins-shipped-with-afb-daemon">Overview of plugins shipped with AFB-Daemon</a><ul>
  18 <li><a href="#list-of-plugins">List of plugins</a></li>
  19 <li><a href="#detail-of-plugins">Detail of plugins</a><ul>
  20 <li><a href="#hello-world">Hello World</a></li>
  21 <li><a href="#authentication">Authentication</a></li>
  22 <li><a href="#tic-tac-toe">Tic Tac Toe</a></li>
  23 <li><a href="#audio">Audio</a></li>
  24 <li><a href="#radio">Radio</a></li>
  25 <li><a href="#media">Media</a></li>
  26 </ul></li>
  27 </ul></li>
  28 </ul>
  29 </nav>
  30 <h1 id="overview-of-plugins-shipped-with-afb-daemon">Overview of plugins shipped with AFB-Daemon</h1>
  31 <pre><code>Version: 1
  32 Date:    09 juin 2016
  33 Author:  Manuel Bachmann</code></pre>
  34 <h2 id="list-of-plugins">List of plugins</h2>
  35 <p>Here are the plugins shipped in the source tree:</p>
  36 <ul>
  37 <li>Hello World</li>
  38 <li>Authentication</li>
  39 <li>Tic Tac Toe</li>
  40 <li>Audio <em>(2 backends: ALSA/PulseAudio)</em></li>
  41 <li>Radio <em>(1 backend: RTLSDR RTL2832U)</em></li>
  42 <li>Media <em>(1 backend: Rygel UPnP)</em></li>
  43 </ul>
  44 <p>All plugins may not be built, depending on the development libraries present on the system at build time.</p>
  45 <h2 id="detail-of-plugins">Detail of plugins</h2>
  46 <h3 id="hello-world">Hello World</h3>
  47 <p>A sample Hello World plugin for demonstration and learning purposes.</p>
  48 <p>This plugin provides a few unauthenticated requests, all beginning with &quot;ping&quot;, to demonstrate basic binder capabilities.</p>
  49 <p><strong>Verbs</strong>:</p>
  50 <ul>
  51 <li><em>ping:</em> returns a success response</li>
  52 <li><em>pingfail:</em> returns a failure response</li>
  53 <li><em>pingnull:</em> returns a success response, with an empty JSON response field</li>
  54 <li><em>pingbug:</em> does a memory violation (intercepted by the binder)</li>
  55 <li><em>pingJson:</em> returns a success response, with a complex JSON response field</li>
  56 <li><em>pingevent:</em> broadcasts a global event</li>
  57 </ul>
  58 <p><br /></p>
  59 <h3 id="authentication">Authentication</h3>
  60 <p>An sample Authentication plugin for demonstration purposes.</p>
  61 <p>This plugin provides a few requests to demonstrate the binder's token-based security mechanism.</p>
  62 <p>Calling &quot;<em>connect</em>&quot; with a security token will initiate a session, calling &quot;<em>refresh</em>&quot; will issue a new token and invalidate the previous one, calling &quot;<em>logout</em>&quot; will invalidate all tokens and close the session.</p>
  63 <p><strong>Verbs</strong>:</p>
  64 <ul>
  65 <li><em>ping:</em> returns a success response</li>
  66 <li><em>connect:</em> creates a session and returns a new token</li>
  67 <li><em>refresh:</em> returns a new token</li>
  68 <li><em>check:</em> verifies the passed token is valid</li>
  69 <li><em>logout:</em> closes the session</li>
  70 </ul>
  71 <p><br /></p>
  72 <h3 id="tic-tac-toe">Tic Tac Toe</h3>
  73 <p>A sample Tic Tac Toe game plugin.</p>
  74 <p>This plugin provides an interactive Tic Tac Toe game where the binder returns the grid as a JSON response.</p>
  75 <p><strong>Verbs</strong>:</p>
  76 <ul>
  77 <li><em>new:</em> starts a new game</li>
  78 <li><em>play:</em> asks the server to play</li>
  79 <li><em>move:</em> gives a client move</li>
  80 <li><em>board:</em> gets the current board state, as a JSON structure</li>
  81 <li><em>level</em>: sets the server level</li>
  82 <li><em>join</em>: joins an existing board</li>
  83 <li><em>undo</em>: undo the last move</li>
  84 <li><em>wait</em>: wait for a move</li>
  85 </ul>
  86 <p><br /></p>
  87 <h3 id="audio">Audio</h3>
  88 <p>A sample Audio plugin with 2 backends:</p>
  89 <ul>
  90 <li>ALSA (mandatory)</li>
  91 <li>PulseAudio (optional)</li>
  92 </ul>
  93 <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>
  94 <p><strong>Verbs</strong>:</p>
  95 <ul>
  96 <li><em>ping:</em> returns a success response</li>
  97 <li><em>init:</em> initializes backend, on the &quot;default&quot; sound card</li>
  98 <li><em>volume:</em> gets or sets volume, in % (0-100)</li>
  99 <li><em>channels:</em> gets or sets channels count (1-8)</li>
 100 <li><em>mute:</em> gets or sets the mute status (on-off)</li>
 101 <li><em>play</em>: gets or sets the playing status (on-off)</li>
 102 </ul>
 103 <p><em>(if PulseAudio development libraries are not found at build time, only ALSA will be available)</em></p>
 104 <p><em>(if a PulseAudio server is not found at runtime, the plugin will dynamically fall back to ALSA)</em></p>
 105 <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>
 106 <p><br /></p>
 107 <h3 id="radio">Radio</h3>
 108 <p>A sample AM/FM Radio plugin with 1 backend:</p>
 109 <ul>
 110 <li>RTLSDR - Realtek RTL2832U dongles (mandatory)</li>
 111 </ul>
 112 <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>
 113 <p><strong>Verbs</strong>:</p>
 114 <ul>
 115 <li><em>ping:</em> returns a success response</li>
 116 <li><em>init:</em> initializes backend, looking for plugged-in devices</li>
 117 <li><em>power:</em> sets device power status (on-off)</li>
 118 <li><em>mode:</em> sets device reception mode (AM-FM)</li>
 119 <li><em>freq:</em> sets device frequency (in Hz)</li>
 120 <li><em>mute</em>: sets device mute status (on-off)</li>
 121 <li><em>play</em>: sets device playing status (on-off)</li>
 122 </ul>
 123 <p><em>(if rtlsdr development libraries are not found at build time, this plugin will not be built)</em></p>
 124 <p><br /></p>
 125 <h3 id="media">Media</h3>
 126 <p>A sample Media Server plugin with 1 backend:</p>
 127 <ul>
 128 <li>Rygel</li>
 129 </ul>
 130 <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>
 131 <p><strong>Verbs</strong>:</p>
 132 <ul>
 133 <li><em>ping:</em> returns a success response</li>
 134 <li><em>init:</em> initializes backend, looking for an active local UPnP server</li>
 135 <li><em>list:</em> returns list of audio files, as a JSON structure</li>
 136 <li><em>select:</em> select an audio files, by index number (001-...)</li>
 137 <li><em>play:</em> plays the currently selected audio file</li>
 138 <li><em>stop:</em> stops the currently selected audio file</li>
 139 <li><em>pause:</em> pauses the currently selected audio file</li>
 140 <li><em>seek:</em> seeks in the currently selected audio file, in seconds</li>
 141 <li><em>upload:</em> uploads an audio file, with a POST request</li>
 142 </ul>
 143 <p><em>(if GUPnP/GSSDP development libraries are not fund at build time, this plugin will not be built)</em></p>
 144 <p><br /></p>
 145 <hr />
 146 <p><br /></p>
 147 <p>Sample command-line applications: <em>afb-client-demo</em> (built by default)</p>
 148 <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>
 149 <p>Sample Qt/QML applications: <em>test/token-websock.qml</em></p>
 150 </body>
 151 </html>