Code Review / src / app-framework-binder.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
improves readability
[src/app-framework-binder.git] / doc / afb-plugins-overview.md
diff --git a/doc/afb-plugins-overview.md b/doc/afb-plugins-overview.md
index 544a030..dfbe601 100644 (file)
--- a/doc/afb-plugins-overview.md
+++ b/doc/afb-plugins-overview.md
@@ -1,30 +1,36 @@
-# Overview of plugins shipped with AFB-Daemon
+Overview of plugins shipped with AFB-Daemon
+===========================================
     Version: 1
     Version: 1
-    Date:    30 May 2016
+    Date:    09 juin 2016
     Author:  Manuel Bachmann
 
 
     Author:  Manuel Bachmann
 
 
-## List of plugins
-  Here are the plugins shipped in the source tree:
- * Hello World
- * Authentication
- * Tic Tac Toe
- * Audio _(2 backends: ALSA/PulseAudio)_
- * Radio _(1 backend: RTLSDR RTL2832U)_
- * Media _(1 backend: Rygel UPnP)_
+List of plugins
+---------------
+
+Here are the plugins shipped in the source tree:
+
+* Hello World
+* Authentication
+* Tic Tac Toe
+* Audio _(2 backends: ALSA/PulseAudio)_
+* Radio _(1 backend: RTLSDR RTL2832U)_
+* Media _(1 backend: Rygel UPnP)_
 
 All plugins may not be built, depending on the development libraries present on the system at build time.
 
 
 
 All plugins may not be built, depending on the development libraries present on the system at build time.
 
 
-## Detail of plugins
+Detail of plugins
+-----------------
 
 
- ### Hello World
+### Hello World
 
 A sample Hello World plugin for demonstration and learning purposes.
 
 This plugin provides a few unauthenticated requests, all beginning with "ping", to demonstrate basic binder capabilities.
 
 **Verbs**:
 
 A sample Hello World plugin for demonstration and learning purposes.
 
 This plugin provides a few unauthenticated requests, all beginning with "ping", to demonstrate basic binder capabilities.
 
 **Verbs**:
+
 * _ping:_ returns a success response
 * _pingfail:_ returns a failure response
 * _pingnull:_ returns a success response, with an empty JSON response field
 * _ping:_ returns a success response
 * _pingfail:_ returns a failure response
 * _pingnull:_ returns a success response, with an empty JSON response field
@@ -35,7 +41,7 @@ This plugin provides a few unauthenticated requests, all beginning with "ping",
 <br />
 
 
 <br />
 
 
- ### Authentication
+### Authentication
 
 An sample Authentication plugin for demonstration purposes.
 
 
 An sample Authentication plugin for demonstration purposes.
 
@@ -44,6 +50,7 @@ This plugin provides a few requests to demonstrate the binder's token-based secu
 Calling "_connect_" with a security token will initiate a session, calling "_refresh_" will issue a new token and invalidate the previous one, calling "_logout_" will invalidate all tokens and close the session.
 
 **Verbs**:
 Calling "_connect_" with a security token will initiate a session, calling "_refresh_" will issue a new token and invalidate the previous one, calling "_logout_" will invalidate all tokens and close the session.
 
 **Verbs**:
+
 * _ping:_ returns a success response
 * _connect:_ creates a session and returns a new token
 * _refresh:_ returns a new token
 * _ping:_ returns a success response
 * _connect:_ creates a session and returns a new token
 * _refresh:_ returns a new token
@@ -53,13 +60,14 @@ Calling "_connect_" with a security token will initiate a session, calling "_ref
 <br />
 
 
 <br />
 
 
- ### Tic Tac Toe
+### Tic Tac Toe
 
 A sample Tic Tac Toe game plugin.
 
 This plugin provides an interactive Tic Tac Toe game where the binder returns the grid as a JSON response. 
 
 **Verbs**:
 
 A sample Tic Tac Toe game plugin.
 
 This plugin provides an interactive Tic Tac Toe game where the binder returns the grid as a JSON response. 
 
 **Verbs**:
+
 * _new:_ starts a new game
 * _play:_ asks the server to play
 * _move:_ gives a client move
 * _new:_ starts a new game
 * _play:_ asks the server to play
 * _move:_ gives a client move
@@ -72,15 +80,17 @@ This plugin provides an interactive Tic Tac Toe game where the binder returns th
 <br />
 
 
 <br />
 
 
- ### Audio
+### Audio
 
 A sample Audio plugin with 2 backends:
 
 A sample Audio plugin with 2 backends:
- * ALSA (mandatory)
- * PulseAudio (optional)
+
+* ALSA (mandatory)
+* PulseAudio (optional)
 
 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.
 
 **Verbs**:
 
 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.
 
 **Verbs**:
+
 * _ping:_ returns a success response
 * _init:_ initializes backend, on the "default" sound card
 * _volume:_ gets or sets volume, in % (0-100)
 * _ping:_ returns a success response
 * _init:_ initializes backend, on the "default" sound card
 * _volume:_ gets or sets volume, in % (0-100)
@@ -97,14 +107,16 @@ _(a specifc backend can be forced by using this syntax before running afb-daemon
 <br />
 
 
 <br />
 
 
- ### Radio
+### Radio
 
 A sample AM/FM Radio plugin with 1 backend:
 
 A sample AM/FM Radio plugin with 1 backend:
- * RTLSDR - Realtek RTL2832U dongles (mandatory)
+
+* RTLSDR - Realtek RTL2832U dongles (mandatory)
 
 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 **audio** plugin).
 
 **Verbs**:
 
 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 **audio** plugin).
 
 **Verbs**:
+
 * _ping:_ returns a success response
 * _init:_ initializes backend, looking for plugged-in devices
 * _power:_ sets device power status (on-off)
 * _ping:_ returns a success response
 * _init:_ initializes backend, looking for plugged-in devices
 * _power:_ sets device power status (on-off)
@@ -118,14 +130,16 @@ _(if rtlsdr development libraries are not found at build time, this plugin will
 <br />
 
 
 <br />
 
 
- ### Media
+### Media
 
 A sample Media Server plugin with 1 backend:
 
 A sample Media Server plugin with 1 backend:
+
  * Rygel
 
 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.
 
 **Verbs**:
  * Rygel
 
 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.
 
 **Verbs**:
+
 * _ping:_ returns a success response
 * _init:_ initializes backend, looking for an active local UPnP server
 * _list:_ returns list of audio files, as a JSON structure
 * _ping:_ returns a success response
 * _init:_ initializes backend, looking for an active local UPnP server
 * _list:_ returns list of audio files, as a JSON structure
@@ -146,6 +160,9 @@ _(if GUPnP/GSSDP development libraries are not fund at build time, this plugin w
 
 Sample command-line applications: _afb-client-demo_ (built by default)
 
 
 Sample command-line applications: _afb-client-demo_ (built by default)
 
-Sample HTML5 applications: **test/*.html**, **[afb-client](https://github.com/iotbzh/afb-client)**, **[afb-radio](https://github.com/iotbzh/afb-radio)**
+Sample HTML5 applications: 
+**test/*.html**, 
+**[afb-client](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/app-framework-demo.git;a=tree)**, 
+**[afb-radio](https://github.com/iotbzh/afb-radio)**
 
 Sample Qt/QML applications: *test/token-websock.qml*
 
 Sample Qt/QML applications: *test/token-websock.qml*
Application Framework binder daemon, maintained by iot.bzh team