3 <link rel="stylesheet" type="text/css" href="doc.css">
7 <a name="Overview.of.plugins.shipped.with.AFB-Daemon"></a>
8 <h1>Overview of plugins shipped with AFB-Daemon</h1>
12 Author: Manuel Bachmann
15 <a name="List.of.plugins"></a>
16 <h2>List of plugins</h2>
18 <p>Here are the plugins shipped in the source tree:</p>
22 <li>Authentication</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>
30 <p>All plugins may not be built, depending on the development libraries present on the system at build time.</p>
32 <a name="Detail.of.plugins"></a>
33 <h2>Detail of plugins</h2>
35 <a name="Hello.World"></a>
38 <p>A sample Hello World plugin for demonstration and learning purposes.</p>
40 <p>This plugin provides a few unauthenticated requests, all beginning with “ping”, to demonstrate basic binder capabilities.</p>
42 <p><strong>Verbs</strong>:</p>
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>
56 <a name="Authentication"></a>
57 <h3>Authentication</h3>
59 <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>
63 <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>
65 <p><strong>Verbs</strong>:</p>
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>
78 <a name="Tic.Tac.Toe"></a>
81 <p>A sample Tic Tac Toe game plugin.</p>
83 <p>This plugin provides an interactive Tic Tac Toe game where the binder returns the grid as a JSON response.</p>
85 <p><strong>Verbs</strong>:</p>
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>
104 <p>A sample Audio plugin with 2 backends:</p>
107 <li>ALSA (mandatory)</li>
108 <li>PulseAudio (optional)</li>
112 <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>
114 <p><strong>Verbs</strong>:</p>
117 <li><em>ping:</em> returns a success response</li>
118 <li><em>init:</em> initializes backend, on the “default” 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>
126 <p><em>(if PulseAudio development libraries are not found at build time, only ALSA will be available)</em></p>
128 <p><em>(if a PulseAudio server is not found at runtime, the plugin will dynamically fall back to ALSA)</em></p>
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>
137 <p>A sample AM/FM Radio plugin with 1 backend:</p>
140 <li>RTLSDR - Realtek RTL2832U dongles (mandatory)</li>
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>
146 <p><strong>Verbs</strong>:</p>
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>
159 <p><em>(if rtlsdr development libraries are not found at build time, this plugin will not be built)</em></p>
166 <p>A sample Media Server plugin with 1 backend:</p>
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>
175 <p><strong>Verbs</strong>:</p>
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-…)</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>
190 <p><em>(if GUPnP/GSSDP development libraries are not fund at build time, this plugin will not be built)</em></p>
198 <p>Sample command-line applications: <em>afb-client-demo</em> (built by default)</p>
200 <p>Sample HTML5 applications:
201 <strong>test/*.html</strong>,
202 <strong><a href="https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/app-framework-demo.git;a=tree">afb-client</a></strong>,
203 <strong><a href="https://github.com/iotbzh/afb-radio">afb-radio</a></strong></p>
205 <p>Sample Qt/QML applications: <em>test/token-websock.qml</em></p>