From 090e063a539f6ee6e62e65ada619787930c31eac Mon Sep 17 00:00:00 2001 From: xengineering Date: Sat, 20 Jan 2024 21:55:22 +0100 Subject: doc: Add user guide for device discovery --- doc/documentation.tex | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) 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} -- cgit v1.2.3-70-g09d2