doc/afb-plugins-overview.md

   1 # Overview of plugins shipped with AFB-Daemon
   2     Version: 1
   3     Date:    30 May 2016
   4     Author:  Manuel Bachmann
   5
   6
   7 ## List of plugins
   8   Here are the plugins shipped in the source tree:
   9  * Hello World
  10  * Authentication
  11  * Tic Tac Toe
  12  * Audio _(2 backends: ALSA/PulseAudio)_
  13  * Radio _(1 backend: RTLSDR RTL2832U)_
  14  * Media _(1 backend: Rygel UPnP)_
  15
  16 All plugins may not be built, depending on the development libraries present on the system at build time.
  17
  18
  19 ## Detail of plugins
  20
  21  ### Hello World
  22
  23 A sample Hello World plugin for demonstration and learning purposes.
  24
  25 This plugin provides a few unauthenticated requests, all beginning with "ping", to demonstrate basic binder capabilities.
  26
  27 **Verbs**:
  28 * _ping:_ returns a success response
  29 * _pingfail:_ returns a failure response
  30 * _pingnull:_ returns a success response, with an empty JSON response field
  31 * _pingbug:_ does a memory violation (intercepted by the binder)
  32 * _pingJson:_ returns a success response, with a complex JSON response field
  33 * _pingevent:_ broadcasts a global event
  34
  35 <br />
  36
  37
  38  ### Authentication
  39
  40 An sample Authentication plugin for demonstration purposes.
  41
  42 This plugin provides a few requests to demonstrate the binder's token-based security mechanism.
  43
  44 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.
  45
  46 **Verbs**:
  47 * _ping:_ returns a success response
  48 * _connect:_ creates a session and returns a new token
  49 * _refresh:_ returns a new token
  50 * _check:_ verifies the passed token is valid
  51 * _logout:_ closes the session
  52
  53 <br />
  54
  55
  56  ### Tic Tac Toe
  57
  58 A sample Tic Tac Toe game plugin.
  59
  60 This plugin provides an interactive Tic Tac Toe game where the binder returns the grid as a JSON response.
  61
  62 **Verbs**:
  63 * _new:_ starts a new game
  64 * _play:_ asks the server to play
  65 * _move:_ gives a client move
  66 * _board:_ gets the current board state, as a JSON structure
  67 * _level_: sets the server level
  68 * _join_: joins an existing board
  69 * _undo_: undo the last move
  70 * _wait_: wait for a move
  71
  72 <br />
  73
  74
  75  ### Audio
  76
  77 A sample Audio plugin with 2 backends:
  78  * ALSA (mandatory)
  79  * PulseAudio (optional)
  80
  81 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.
  82
  83 **Verbs**:
  84 * _ping:_ returns a success response
  85 * _init:_ initializes backend, on the "default" sound card
  86 * _volume:_ gets or sets volume, in % (0-100)
  87 * _channels:_ gets or sets channels count (1-8)
  88 * _mute:_ gets or sets the mute status (on-off)
  89 * _play_: gets or sets the playing status (on-off)
  90
  91 _(if PulseAudio development libraries are not found at build time, only ALSA will be available)_
  92
  93 _(if a PulseAudio server is not found at runtime, the plugin will dynamically fall back to ALSA)_
  94
  95 _(a specifc backend can be forced by using this syntax before running afb-daemon : **$ export AFB_AUDIO_OUTPUT=Alsa**)_
  96
  97 <br />
  98
  99
 100  ### Radio
 101
 102 A sample AM/FM Radio plugin with 1 backend:
 103  * RTLSDR - Realtek RTL2832U dongles (mandatory)
 104
 105 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).
 106
 107 **Verbs**:
 108 * _ping:_ returns a success response
 109 * _init:_ initializes backend, looking for plugged-in devices
 110 * _power:_ sets device power status (on-off)
 111 * _mode:_ sets device reception mode (AM-FM)
 112 * _freq:_ sets device frequency (in Hz)
 113 * _mute_: sets device mute status (on-off)
 114 * _play_: sets device playing status (on-off)
 115
 116 _(if rtlsdr development libraries are not found at build time, this plugin will not be built)_
 117
 118 <br />
 119
 120
 121  ### Media
 122
 123 A sample Media Server plugin with 1 backend:
 124  * Rygel
 125
 126 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.
 127
 128 **Verbs**:
 129 * _ping:_ returns a success response
 130 * _init:_ initializes backend, looking for an active local UPnP server
 131 * _list:_ returns list of audio files, as a JSON structure
 132 * _select:_ select an audio files, by index number (001-...)
 133 * _play:_ plays the currently selected audio file
 134 * _stop:_ stops the currently selected audio file
 135 * _pause:_ pauses the currently selected audio file
 136 * _seek:_ seeks in the currently selected audio file, in seconds
 137 * _upload:_ uploads an audio file, with a POST request
 138
 139 _(if GUPnP/GSSDP development libraries are not fund at build time, this plugin will not be built)_
 140
 141 <br />
 142
 143
 144 ---
 145 <br />
 146
 147 Sample command-line applications: _afb-client-demo_ (built by default)
 148
 149 Sample HTML5 applications: **test/*.html**, **[afb-client](https://github.com/iotbzh/afb-client)**, **[afb-radio](https://github.com/iotbzh/afb-radio)**
 150
 151 Sample Qt/QML applications: *test/token-websock.qml*