doc/afb-plugins-overview.html

   1 <html>
   2 <head>
   3   <link rel="stylesheet" type="text/css" href="doc.css">
   4   <meta charset="UTF-8">
   5 </head>
   6 <body>
   7 <a name="Overview.of.plugins.shipped.with.AFB-Daemon"></a>
   8 <h1>Overview of plugins shipped with AFB-Daemon</h1>
   9
  10 <pre><code>Version: 1
  11 Date:    30 mai 2016
  12 Author:  Manuel Bachmann
  13 </code></pre>
  14
  15 <a name="List.of.plugins"></a>
  16 <h2>List of plugins</h2>
  17
  18 <p>Here are the plugins shipped in the source tree:</p>
  19
  20 <ul>
  21 <li>Hello World</li>
  22 <li>Authentication</li>
  23 <li>Tic Tac Toe</li>
  24 <li>Audio <em>(2 backends: ALSA/PulseAudio)</em></li>
  25 <li>Radio <em>(1 backend: RTLSDR RTL2832U)</em></li>
  26 <li>Media <em>(1 backend: Rygel UPnP)</em></li>
  27 </ul>
  28
  29
  30 <p>All plugins may not be built, depending on the development libraries present on the system at build time.</p>
  31
  32 <a name="Detail.of.plugins"></a>
  33 <h2>Detail of plugins</h2>
  34
  35 <a name="Hello.World"></a>
  36 <h3>Hello World</h3>
  37
  38 <p>A sample Hello World plugin for demonstration and learning purposes.</p>
  39
  40 <p>This plugin provides a few unauthenticated requests, all beginning with &ldquo;ping&rdquo;, to demonstrate basic binder capabilities.</p>
  41
  42 <p><strong>Verbs</strong>:</p>
  43
  44 <ul>
  45 <li><em>ping:</em> returns a success response</li>
  46 <li><em>pingfail:</em> returns a failure response</li>
  47 <li><em>pingnull:</em> returns a success response, with an empty JSON response field</li>
  48 <li><em>pingbug:</em> does a memory violation (intercepted by the binder)</li>
  49 <li><em>pingJson:</em> returns a success response, with a complex JSON response field</li>
  50 <li><em>pingevent:</em> broadcasts a global event</li>
  51 </ul>
  52
  53
  54 <p><br /></p>
  55
  56 <a name="Authentication"></a>
  57 <h3>Authentication</h3>
  58
  59 <p>An sample Authentication plugin for demonstration purposes.</p>
  60
  61 <p>This plugin provides a few requests to demonstrate the binder&rsquo;s token-based security mechanism.</p>
  62
  63 <p>Calling &ldquo;<em>connect</em>&rdquo; with a security token will initiate a session, calling &ldquo;<em>refresh</em>&rdquo; will issue a new token and invalidate the previous one, calling &ldquo;<em>logout</em>&rdquo; will invalidate all tokens and close the session.</p>
  64
  65 <p><strong>Verbs</strong>:</p>
  66
  67 <ul>
  68 <li><em>ping:</em> returns a success response</li>
  69 <li><em>connect:</em> creates a session and returns a new token</li>
  70 <li><em>refresh:</em> returns a new token</li>
  71 <li><em>check:</em> verifies the passed token is valid</li>
  72 <li><em>logout:</em> closes the session</li>
  73 </ul>
  74
  75
  76 <p><br /></p>
  77
  78 <a name="Tic.Tac.Toe"></a>
  79 <h3>Tic Tac Toe</h3>
  80
  81 <p>A sample Tic Tac Toe game plugin.</p>
  82
  83 <p>This plugin provides an interactive Tic Tac Toe game where the binder returns the grid as a JSON response.</p>
  84
  85 <p><strong>Verbs</strong>:</p>
  86
  87 <ul>
  88 <li><em>new:</em> starts a new game</li>
  89 <li><em>play:</em> asks the server to play</li>
  90 <li><em>move:</em> gives a client move</li>
  91 <li><em>board:</em> gets the current board state, as a JSON structure</li>
  92 <li><em>level</em>: sets the server level</li>
  93 <li><em>join</em>: joins an existing board</li>
  94 <li><em>undo</em>: undo the last move</li>
  95 <li><em>wait</em>: wait for a move</li>
  96 </ul>
  97
  98
  99 <p><br /></p>
 100
 101 <a name="Audio"></a>
 102 <h3>Audio</h3>
 103
 104 <p>A sample Audio plugin with 2 backends:</p>
 105
 106 <ul>
 107 <li>ALSA (mandatory)</li>
 108 <li>PulseAudio (optional)</li>
 109 </ul>
 110
 111
 112 <p>This plugin is able to initialize a specific soundcard, define volume levels, channels (mono/stereo&hellip;), mute sound, and play a 22,050 Hz PCM stream.</p>
 113
 114 <p><strong>Verbs</strong>:</p>
 115
 116 <ul>
 117 <li><em>ping:</em> returns a success response</li>
 118 <li><em>init:</em> initializes backend, on the &ldquo;default&rdquo; sound card</li>
 119 <li><em>volume:</em> gets or sets volume, in % (0-100)</li>
 120 <li><em>channels:</em> gets or sets channels count (1-8)</li>
 121 <li><em>mute:</em> gets or sets the mute status (on-off)</li>
 122 <li><em>play</em>: gets or sets the playing status (on-off)</li>
 123 </ul>
 124
 125
 126 <p><em>(if PulseAudio development libraries are not found at build time, only ALSA will be available)</em></p>
 127
 128 <p><em>(if a PulseAudio server is not found at runtime, the plugin will dynamically fall back to ALSA)</em></p>
 129
 130 <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>
 131
 132 <p><br /></p>
 133
 134 <a name="Radio"></a>
 135 <h3>Radio</h3>
 136
 137 <p>A sample AM/FM Radio plugin with 1 backend:</p>
 138
 139 <ul>
 140 <li>RTLSDR - Realtek RTL2832U dongles (mandatory)</li>
 141 </ul>
 142
 143
 144 <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>
 145
 146 <p><strong>Verbs</strong>:</p>
 147
 148 <ul>
 149 <li><em>ping:</em> returns a success response</li>
 150 <li><em>init:</em> initializes backend, looking for plugged-in devices</li>
 151 <li><em>power:</em> sets device power status (on-off)</li>
 152 <li><em>mode:</em> sets device reception mode (AM-FM)</li>
 153 <li><em>freq:</em> sets device frequency (in Hz)</li>
 154 <li><em>mute</em>: sets device mute status (on-off)</li>
 155 <li><em>play</em>: sets device playing status (on-off)</li>
 156 </ul>
 157
 158
 159 <p><em>(if rtlsdr development libraries are not found at build time, this plugin will not be built)</em></p>
 160
 161 <p><br /></p>
 162
 163 <a name="Media"></a>
 164 <h3>Media</h3>
 165
 166 <p>A sample Media Server plugin with 1 backend:</p>
 167
 168 <ul>
 169 <li>Rygel</li>
 170 </ul>
 171
 172
 173 <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>
 174
 175 <p><strong>Verbs</strong>:</p>
 176
 177 <ul>
 178 <li><em>ping:</em> returns a success response</li>
 179 <li><em>init:</em> initializes backend, looking for an active local UPnP server</li>
 180 <li><em>list:</em> returns list of audio files, as a JSON structure</li>
 181 <li><em>select:</em> select an audio files, by index number (001-&hellip;)</li>
 182 <li><em>play:</em> plays the currently selected audio file</li>
 183 <li><em>stop:</em> stops the currently selected audio file</li>
 184 <li><em>pause:</em> pauses the currently selected audio file</li>
 185 <li><em>seek:</em> seeks in the currently selected audio file, in seconds</li>
 186 <li><em>upload:</em> uploads an audio file, with a POST request</li>
 187 </ul>
 188
 189
 190 <p><em>(if GUPnP/GSSDP development libraries are not fund at build time, this plugin will not be built)</em></p>
 191
 192 <p><br /></p>
 193
 194 <hr />
 195
 196 <p><br /></p>
 197
 198 <p>Sample command-line applications: <em>afb-client-demo</em> (built by default)</p>
 199
 200 <p>Sample HTML5 applications: <strong>test/*.html</strong>, <strong><a href="https://github.com/iotbzh/afb-client">afb-client</a></strong>, <strong><a href="https://github.com/iotbzh/afb-radio">afb-radio</a></strong></p>
 201
 202 <p>Sample Qt/QML applications: <em>test/token-websock.qml</em></p>
 203 </body>
 204 </html>