summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2024-09-28 21:45:07 +0200
committerxengineering <me@xengineering.eu>2024-09-28 21:49:08 +0200
commit5c5d5c3f938bc19e75d81a4b1279d9a356bde36e (patch)
tree1dcbf27ff5af1c01b991d480844a77940c11abb3
parent844588c7b98db65fc4c8050bae3184a747822092 (diff)
downloadsoundbox-5c5d5c3f938bc19e75d81a4b1279d9a356bde36e.tar
soundbox-5c5d5c3f938bc19e75d81a4b1279d9a356bde36e.tar.zst
soundbox-5c5d5c3f938bc19e75d81a4b1279d9a356bde36e.zip
doc: Add device label
It is required for the user to know the MAC address since it is used to calculate the IPv6 address required for streaming audio to the device without additional network configuration. Thus a label containing the MAC address has to be added to the device.
-rw-r--r--doc/documentation.tex13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex
index a912235..935c450 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -378,6 +378,19 @@ reboot
After this reboot the soundbox device should be able to play audio like
described in section~\ref{playing-audio}.
+\section{Device label}
+
+A device label has to be added to the \texttt{soundbox} device after assembly
+to let the user reference and access the device by the MAC address.
+
+\begin{verbatim}
+soundbox <version>
+MAC: <mac-address>
+\end{verbatim}
+
+The current version \texttt{\input{../version.txt}} and the MAC address noted down in
+\autoref{retrieve-mac} should be used.
+
\chapter{Developer documentation}
\section{Versioning}