BlinkenArea - GitList
Repositories
Blog
Wiki
Blinker
Code
Commits
Branches
Tags
Search
Tree:
39777a9
Branches
Tags
master
Blinker
doc
index.html
start page of documentation
Stefan Schuermans
commited
39777a9
at 2011-11-19 17:19:15
index.html
Blame
History
Raw
<html> <head> <title>Blinker</title> </head> <body> <h1>Blinker</h1> <p> Blinker is a server for LED projects and Blinken-houses that are driven by Blinkenlights network streams. </p> <h2>Overview</h2> <p> Blinker is based on different modules, which can be connected via streams. Several types of modules are available, for example a movie player, a network stream sender, modules to mix and separate streams. </p> <h2>Getting Started</h2> <p> As Blinker uses BlinkenLib to perform the low-level operations on Blinken movies and Blinken streams, BlinkenLib has to be installed first. </p> <p> Go to the <code>src</code> directory and type <code>make</code>. This should compile Blinker and produce a binary <code>Blinker</code> in this directory. </p> <p> Start Blinker using the example configuration directory using <code>./Blinker ../example_cfg</code>. You should see a small test movie appearing on standard output (printed there by a printer module). Other movies are sent as MCUF streams over UDPv4, one stream is sent to <code>127.0.0.1:2323</code>. </p> <h2>Streams</h2> <p> Every stream is identified by a name and works like a TV program. A source creates the content and uses the stream to distribute it to its receivers. A single stream can have any number of receivers, they all receive the same content. Usually, there should be only one provider of content for a single stream. If multiple parties send video frames to the stream, the frames are mixed, which is most likely not what you want. </p> <h2>Configuration Directory</h2> <p> The configuration of blinker is not stored in a single file, but in a directory structure, reflecting the inner structure of Blinker's modules. This way, every module has got its own configuration directory containing single files each containing one simple setting. It the module has some internel structure, those config setting files are organized in a directory structure underneath the module's configuration directory. </p> <p> The main config directory contains a directory for each module class, e.g. <code>players</code> for movie player modules. Inside, there is an arbitrary number of subdirectories, one for each instantance of the player module. E.g. the <code>players/stereoscope</code> directory in the example configuration (<code>example_cfg</code> directory in the top level) contains the configuration of the movie player for Blinkenlights stereoscope movies. </p> <p> Reconfiguration can happen at runtime by just changing the configuration directory. Blinker will detect those changes and adapt its operation to the new configuration without restart. <br> Sometimes, especially after an invalid configuration has been seen by Blinker, changes are not automatically detected by Blinker. In this case, it is neccessary to <code>touch</code> the parent directory containing the setting file to make Blinker aware of the reconfiguration. (Solving this issue is planned.) </p> <h2>Modules</h2> <p> The following module types are available for instantiation: <ul> <li>TODO</li> </ul> </p> <h2>Copyright / Copyleft</h2> <p> Blinker<br> Copyright 2011 Stefan Schuermans <stefan@blinkenarea.org><br> Copyleft GNU public license - http://www.gnu.org/copyleft/gpl.html<br> a blinkenarea.org project </p> <h2>Links</h2> <ul> <li> <a href=https://git.blinkenarea.org/?p=Blinker"> Blinker GIT repository </a> </li> <li> <a href=https://git.blinkenarea.org/?p=BlinkenLib"> BlinkenLib GIT repository </a> </li> <li> <a href=https://wiki.blinkenarea.org/index.php/Protocols"> Information about Blinken protocols </a> </li> <li> <a href=https://wiki.blinkenarea.org/index.php/DateiformateEnglish"> Information about Blinken movie file formats </a> </li> <li> <a href=https://www.blinkenarea.org/"> BlinkenArea is a group of people building and operating Blinken stuff </a> </li> <li> <a href=http://www.blinkenlights.de/"> Project BlinkenLights kicked off the whole Blinken story </a> </li> </ul> </body> </html>
