Skip to content

Commit e6d6cfd

Browse files
committed
Updated manual with new options available in the web ui
1 parent 83daa92 commit e6d6cfd

2 files changed

Lines changed: 8 additions & 6 deletions

File tree

tex/manual.pdf

1.77 KB
Binary file not shown.

tex/manual.tex

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -426,19 +426,20 @@
426426
\end{figure}
427427

428428
The "Global settings" section of the web interface is where you can settings that apply to all NSPanels or settings that simply are not directly related the the panels themsevles. The following options are available:
429-
\textbf{Connection settings}
429+
\subsubsection{Connection settings}
430430
\begin{itemize}
431431
\item \textbf{Manager address} - The is the IP address that will be sent to each NSPanel when it boots. This address is used in the NSPanel to communicate with the manager and has to be reachable from each and every NSPanel.
432432
\item \textbf{Manager port} - Port to use when connecting to the above mentioned IP address.
433433
\end{itemize}
434434

435-
\textbf{Logging options}
435+
\subsubsection{Logging options}
436436
\begin{itemize}
437+
\item \textbf{MQTTManager log level} - Log level for the MQTTManager background component. For more information about MQTTManager see \hyperref[sec:software_components]{Software components}. There is also a "Download"-button available in this section to download the MQTTManager log file as a .txt-file.
437438
\item \textbf{Number of messages to display on live log} - The number of log messages to display in the live log for each NSPanel in the NSPanel settings page.
438439
\item \textbf{Number of messages in buffer} - The number of log messages to keep in buffer in the MQTTManager.
439440
\end{itemize}
440441

441-
\textbf{Global NSPanel settings}
442+
\subsubsection{Global NSPanel settings}
442443
\begin{itemize}
443444
\item \textbf{Minimum color temperature} - The minimum kelvin to send to Home Assistant/OpenHAB.
444445
\item \textbf{Maximum color temperature} - The maximum kelvin to send to Home Assistant/OpenHAB.
@@ -463,21 +464,21 @@
463464
\item \textbf{MQTT ignore time (ms)} - Time to wait (in milliseconds) after sending a command over MQTT before allowing new values to update the screen. This can be raised or lowered to minimize flickering of sliders on the NSPanel.
464465
\end{itemize}
465466

466-
\textbf{MQTT}
467+
\subsubsection{MQTT}
467468
\begin{itemize}
468469
\item \textbf{MQTT address} - The address used to connect to the MQTT server.
469470
\item \textbf{MQTT port} - The port used to connect to the MQTT server.
470471
\item \textbf{MQTT username} - Username used to authenticate to the MQTT server. Leave empty if not used.
471472
\item \textbf{MQTT password} - Password used to authenticate to the MQTT server. Leave empty if not used.
472473
\end{itemize}
473474

474-
\textbf{Home Assistant API}
475+
\subsubsection{Home Assistant API}
475476
\begin{itemize}
476477
\item \textbf{Home Assistant address} - The address used to connect to Home Assistant. This should include "http://" or "https://" in the beginning and port are the end.
477478
\item \textbf{Access token} - The long lived access token used to authenticate to Home Assistant.
478479
\end{itemize}
479480

480-
\textbf{OpenHAB API}
481+
\subsubsection{OpenHAB API}
481482
\begin{itemize}
482483
\item \textbf{OpenHAB address} - The address used to connect to OpenHAB. This should include "http://" or "https://" in the beginning and port are the end.
483484
\item \textbf{Access token} - The access token used to authenticate to OpenHAB.
@@ -597,6 +598,7 @@
597598

598599
\clearpage
599600
\section{Functional information}
601+
\label{sec:software_components}
600602
\subsection{Software components}
601603
There are really three software components written for the NSPanel Manager project. These are described as below:
602604
\begin{itemize}

0 commit comments

Comments
 (0)