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>Media <em>(1 backend: Rygel UPnP)</em></li>
  26 </ul>
  27
  28
  29 <p>All plugins may not be built, depending on the development libraries present on the system at build time.</p>
  30
  31 <a name="Detail.of.plugins"></a>
  32 <h2>Detail of plugins</h2>
  33
  34 <a name="Hello.World"></a>
  35 <h3>Hello World</h3>
  36
  37 <p>A sample Hello World plugin for demonstration and learning purposes.</p>
  38
  39 <p>This plugin provides a few unauthenticated requests, all beginning with &ldquo;ping&rdquo;, to demonstrate basic binder capabilities.</p>
  40
  41 <p><strong>Verbs</strong>:</p>
  42
  43 <ul>
  44 <li><em>ping:</em> returns a success response</li>
  45 <li><em>pingfail:</em> returns a failure response</li>
  46 <li><em>pingnull:</em> returns a success response, with an empty JSON response field</li>
  47 <li><em>pingbug:</em> does a memory violation (intercepted by the binder)</li>
  48 <li><em>pingJson:</em> returns a success response, with a complex JSON response field</li>
  49 <li><em>pingevent:</em> broadcasts a global event</li>
  50 </ul>
  51
  52
  53 <p><br /></p>
  54
  55 <a name="Authentication"></a>
  56 <h3>Authentication</h3>
  57
  58 <p>An sample Authentication plugin for demonstration purposes.</p>
  59
  60 <p>This plugin provides a few requests to demonstrate the binder&rsquo;s token-based security mechanism.</p>
  61
  62 <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>
  63
  64 <p><strong>Verbs</strong>:</p>
  65
  66 <ul>
  67 <li><em>ping:</em> returns a success response</li>
  68 <li><em>connect:</em> creates a session and returns a new token</li>
  69 <li><em>refresh:</em> returns a new token</li>
  70 <li><em>check:</em> verifies the passed token is valid</li>
  71 <li><em>logout:</em> closes the session</li>
  72 </ul>
  73
  74
  75 <p><br /></p>
  76
  77 <a name="Tic.Tac.Toe"></a>
  78 <h3>Tic Tac Toe</h3>
  79
  80 <p>A sample Tic Tac Toe game plugin.</p>
  81
  82 <p>This plugin provides an interactive Tic Tac Toe game where the binder returns the grid as a JSON response.</p>
  83
  84 <p><strong>Verbs</strong>:</p>
  85
  86 <ul>
  87 <li><em>new:</em> starts a new game</li>
  88 <li><em>play:</em> asks the server to play</li>
  89 <li><em>move:</em> gives a client move</li>
  90 <li><em>board:</em> gets the current board state, as a JSON structure</li>
  91 <li><em>level</em>: sets the server level</li>
  92 <li><em>join</em>: joins an existing board</li>
  93 <li><em>undo</em>: undo the last move</li>
  94 <li><em>wait</em>: wait for a move</li>
  95 </ul>
  96
  97
  98 <p><br /></p>
  99
 100 <a name="Audio"></a>
 101 <h3>Audio</h3>
 102
 103 <p>A sample Audio plugin with 2 backends:</p>
 104
 105 <ul>
 106 <li>ALSA (mandatory)</li>
 107 <li>PulseAudio (optional)</li>
 108 </ul>
 109
 110
 111 <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>
 112
 113 <p><strong>Verbs</strong>:</p>
 114
 115 <ul>
 116 <li><em>ping:</em> returns a success response</li>
 117 <li><em>init:</em> initializes backend, on the &ldquo;default&rdquo; sound card</li>
 118 <li><em>volume:</em> gets or sets volume, in % (0-100)</li>
 119 <li><em>channels:</em> gets or sets channels count (1-8)</li>
 120 <li><em>mute:</em> gets or sets the mute status (on-off)</li>
 121 <li><em>play</em>: gets or sets the playing status (on-off)</li>
 122 </ul>
 123
 124
 125 <p><em>(if PulseAudio development libraries are not found at build time, only ALSA will be available)</em></p>
 126
 127 <p><em>(if a PulseAudio server is not found at runtime, the plugin will dynamically fall back to ALSA)</em></p>
 128
 129 <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>
 130
 131 <p><br /></p>
 132
 133 <a name="Media"></a>
 134 <h3>Media</h3>
 135
 136 <p>A sample Media Server plugin with 1 backend:</p>
 137
 138 <ul>
 139 <li>Rygel</li>
 140 </ul>
 141
 142
 143 <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>
 144
 145 <p><strong>Verbs</strong>:</p>
 146
 147 <ul>
 148 <li><em>ping:</em> returns a success response</li>
 149 <li><em>init:</em> initializes backend, looking for an active local UPnP server</li>
 150 <li><em>list:</em> returns list of audio files, as a JSON structure</li>
 151 <li><em>select:</em> select an audio files, by index number (001-&hellip;)</li>
 152 <li><em>play:</em> plays the currently selected audio file</li>
 153 <li><em>stop:</em> stops the currently selected audio file</li>
 154 <li><em>pause:</em> pauses the currently selected audio file</li>
 155 <li><em>seek:</em> seeks in the currently selected audio file, in seconds</li>
 156 <li><em>upload:</em> uploads an audio file, with a POST request</li>
 157 </ul>
 158
 159
 160 <p><em>(if GUPnP/GSSDP development libraries are not fund at build time, this plugin will not be built)</em></p>
 161
 162 <p><br /></p>
 163
 164 <hr />
 165
 166 <p><br /></p>
 167
 168 <p>Sample command-line applications: <em>afb-client-demo</em> (built by default)</p>
 169
 170 <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>
 171
 172 <p>Sample Qt/QML applications: <em>test/token-websock.qml</em></p>
 173 </body>
 174 </html>