Add basic documentation for plugins

[src/app-framework-binder.git] / doc / afb-plugins-overview.html
diff --git a/doc/afb-plugins-overview.html b/doc/afb-plugins-overview.html

new file mode 100644 (file)

index 0000000..e156bd3
--- /dev/null
+++ b/doc/afb-plugins-overview.html
@@ -0,0 +1,63 @@
+<html>
+<head>
+  <link rel="stylesheet" type="text/css" href="doc.css">
+  <meta charset="UTF-8">
+</head>
+<body>
+<h1>Overview of plugins shipped with AFB-Daemon</h1>
+
+<pre><code>Version: 1
+Date:    30 May 2016
+Author:  Manuel Bachmann
+</code></pre>
+
+<h2>List of plugins</h2>
+
+<p>Here are the plugins shipped in the source tree:
+ * 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>
+
+<h2>Detail of plugins</h2>
+
+<p>### Audio</p>
+
+<p>A sample Audio plugin with 2 backends:
+ * ALSA (mandatory)
+ * PulseAudio (optional)</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</em>AUDIO<em>OUTPUT=Alsa</strong>)</em></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>Sample applications: <strong><a href="https://github.com/iotbzh/afb-radio">afb-radio</a></strong></p>
+
+<p>### Radio</p>
+
+<p>A sample AM/FM Radio plugin with 1 backend:
+ * RTLSDR - Realtek RTL2832U dongles (mandatory)</p>
+
+<p><em>(if rtlsdr development libraries are not found at build time, this plugin will not be built)</em></p>
+
+<p>This plugin is able to initialize specific RTL2832U dongles, switch between AM/FM modes, define frequency, mute sound, and play sound (by using the <strong>audio</strong> plugin).</p>
+
+<p>Sample applications: <strong><a href="https://github.com/iotbzh/afb-radio">afb-radio</a></strong></p>
+
+<p>### Media</p>
+
+<p>A sample Media Server plugin with 1 backend:
+ * Rygel</p>
+
+<p><em>(if GUPnP/GSSDP development libraries are not fund at build time, this plugin will not be built)</em></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>Sample applications: <strong><a href="https://github.com/iotbzh/afb-radio">afb-radio</a></strong></p>
+</body>
+</html>