summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2024-01-20 21:55:22 +0100
committerxengineering <me@xengineering.eu>2024-01-20 21:55:22 +0100
commit090e063a539f6ee6e62e65ada619787930c31eac (patch)
tree7833891fb7c70fdb69b892948f3c242fcd85a5be
parentce3aad39474789faa7e3c8fd49a6f401c8fa3c01 (diff)
downloadsoundbox-090e063a539f6ee6e62e65ada619787930c31eac.tar
soundbox-090e063a539f6ee6e62e65ada619787930c31eac.tar.zst
soundbox-090e063a539f6ee6e62e65ada619787930c31eac.zip
doc: Add user guide for device discovery
-rw-r--r--doc/documentation.tex17
1 files changed, 16 insertions, 1 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex
index 1162727..65d0dc8 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -52,7 +52,22 @@ In addition to \autoref{chap:introduction} `\nameref{chap:introduction}` the
following sections document everything required to use \texttt{soundbox}
devices.
-%\section{Device setup}
+\section{Discover soundbox IP address}
+
+If the IP address of the soundbox device is not known it can be discovered via
+the Link Layer Discovery Protocol (LLDP). This can be done with a software like
+lldpd\footnote{\href{https://lldpd.github.io/}{https://lldpd.github.io/}}. If
+the corresponding service is running the currently discovered devices can be
+looked up with \texttt{lldpcli}. Root privileges are required to use this
+command.
+
+\begin{verbatim}
+lldpcli show neighbors
+\end{verbatim}
+
+A device with the system name \texttt{soundbox.local} should show up. Every 30
+seconds a new discovery packet is emitted by soundbox. Thus it can take up to
+30 seconds until it shows up.
\section{Playing audio} \label{playing-audio}