<html> <head> <link rel="stylesheet" type="text/css" href="doc.css"> <meta charset="UTF-8"> </head> <body> <a name="Overview.of.plugins.shipped.with.AFB-Daemon"></a> <h1>Overview of plugins shipped with AFB-Daemon</h1> <pre><code>Version: 1 Date: 30 mai 2016 Author: Manuel Bachmann </code></pre> <a name="List.of.plugins"></a> <h2>List of plugins</h2> <p> Here are the plugins shipped in the source tree: * Hello World * Authentication * Tic Tac Toe * Audio <em>(2 backends: ALSA/PulseAudio)</em> * Radio <em>(1 backend: RTLSDR RTL2832U)</em> * Media <em>(1 backend: Rygel UPnP)</em></p> <p>All plugins may not be built, depending on the development libraries present on the system at build time.</p> <a name="Detail.of.plugins"></a> <h2>Detail of plugins</h2> <a name="Hello.World"></a> <h3>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>: * <em>ping:</em> returns a success response * <em>pingfail:</em> returns a failure response * <em>pingnull:</em> returns a success response, with an empty JSON response field * <em>pingbug:</em> does a memory violation (intercepted by the binder) * <em>pingJson:</em> returns a success response, with a complex JSON response field * <em>pingevent:</em> broadcasts a global event</p> <p><br /></p> <a name="Authentication"></a> <h3>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>: * <em>ping:</em> returns a success response * <em>connect:</em> creates a session and returns a new token * <em>refresh:</em> returns a new token * <em>check:</em> verifies the passed token is valid * <em>logout:</em> closes the session</p> <p><br /></p> <a name="Tic.Tac.Toe"></a> <h3>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>: * <em>new:</em> starts a new game * <em>play:</em> asks the server to play * <em>move:</em> gives a client move * <em>board:</em> gets the current board state, as a JSON structure * <em>level</em>: sets the server level * <em>join</em>: joins an existing board * <em>undo</em>: undo the last move * <em>wait</em>: wait for a move</p> <p><br /></p> <a name="Audio"></a> <h3>Audio</h3> <p>A sample Audio plugin with 2 backends: * ALSA (mandatory) * PulseAudio (optional)</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><strong>Verbs</strong>: * <em>ping:</em> returns a success response * <em>init:</em> initializes backend, on the “default” sound card * <em>volume:</em> gets or sets volume, in % (0-100) * <em>channels:</em> gets or sets channels count (1-8) * <em>mute:</em> gets or sets the mute status (on-off) * <em>play</em>: gets or sets the playing status (on-off)</p> <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_AUDIO_OUTPUT=Alsa</strong>)</em></p> <p><br /></p> <a name="Radio"></a> <h3>Radio</h3> <p>A sample AM/FM Radio plugin with 1 backend: * RTLSDR - Realtek RTL2832U dongles (mandatory)</p> <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>: * <em>ping:</em> returns a success response * <em>init:</em> initializes backend, looking for plugged-in devices * <em>power:</em> sets device power status (on-off) * <em>mode:</em> sets device reception mode (AM-FM) * <em>freq:</em> sets device frequency (in Hz) * <em>mute</em>: sets device mute status (on-off) * <em>play</em>: sets device playing status (on-off)</p> <p><em>(if rtlsdr development libraries are not found at build time, this plugin will not be built)</em></p> <p><br /></p> <a name="Media"></a> <h3>Media</h3> <p>A sample Media Server plugin with 1 backend: * Rygel</p> <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><strong>Verbs</strong>: * <em>ping:</em> returns a success response * <em>init:</em> initializes backend, looking for an active local UPnP server * <em>list:</em> returns list of audio files, as a JSON structure * <em>select:</em> select an audio files, by index number (001-…) * <em>play:</em> plays the currently selected audio file * <em>stop:</em> stops the currently selected audio file * <em>pause:</em> pauses the currently selected audio file * <em>seek:</em> seeks in the currently selected audio file, in seconds * <em>upload:</em> uploads an audio file, with a POST request</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> <hr /> <p><br /></p> <p>Sample command-line applications: <em>afb-client-demo</em> (built by default)</p> <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> <p>Sample Qt/QML applications: <em>test/token-websock.qml</em></p> </body> </html>