diff options
Diffstat (limited to 'doc/documentation.tex')
| -rw-r--r-- | doc/documentation.tex | 35 |
1 files changed, 34 insertions, 1 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex index d1a7788..3d65a9e 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -22,7 +22,40 @@ \chapter{Introduction} \label{chap:introduction} -\texttt{soundbox} is a device to connect classic audio systems to the network. +\texttt{soundbox} is a small Raspberry Pi based device with a micro USB power +input and two cinch connectors as audio output. It can be used to connect +classic audio systems to a WLAN network. + +Music or other audio content can be streamed to the \texttt{soundbox} device. +Using multiple devices allows to build up a multi-room audio setup. + +\section{Current state} + +The following features are supported by the given \texttt{soundbox} version. + +\begin{itemize} + \item audio streaming with original sound quality + \item multi room audio without audible delay + \item 3D printed case to protect internals + \item discovery service to find the IP address of the device + \item safe shutdown by power cut +\end{itemize} + +Nevertheless the usage of \texttt{soundbox} is restricted by the limitations +below. + +\begin{itemize} + \item only the command line tool \texttt{ffmpeg} is currently supported to + stream content to \texttt{soundbox} devices + \item no user friendly way to set the WLAN name (SSID) and password + \item network discovery requires the \texttt{lldpd} service for the Linux + operating system or other client services for the Link Layer Discovery + Protocol + \item no user friendly update mechanism +\end{itemize} + +Improvements regarding these limitations are planned but future progress cannot +be guaranteed. \chapter{User guide} |