Skip to content

Commit eb7e904

Browse files
committed
Updated manual to be more clear
1 parent c2f09ba commit eb7e904

2 files changed

Lines changed: 3 additions & 9 deletions

File tree

tex/manual.pdf

-22.5 KB
Binary file not shown.

tex/manual.tex

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,6 @@
126126
\begin{itemize}
127127
\item Repository cloned/downloaded.
128128
\item Working Docker installation.
129-
\item A directory to store all data. In the example below, this is referred to as \textbf{data\_dir}.
130129
\end{itemize}
131130
The pre-built container image is available on Docker hub as several different architectures, the following architectures are available:
132131
\begin{itemize}
@@ -136,17 +135,12 @@
136135
\item i386
137136
\item amd64
138137
\end{itemize}
139-
In order to run one of these images, issue the docker run command with the appropriate image for your hardware. The following is an example on how to start the image on a x64 PC with timezone Europe/Stockholm:
138+
In order to run one of these images, issue the docker run command with the appropriate image for your hardware. The following is an example on how to start the image on a x64 PC with timezone Europe/Stockholm and store the data from the container in the "/nspmdata/"-directory:
140139
\begin{lstlisting}[language=bash]
141140
docker run --name nspanelmanager -e TZ=Europe/Stockholm -v \
142-
"data_dir/":"/data/" \
141+
"/nspmdata/":"/data/" \
143142
-d -p 8000:8000 -p 8001:8001 nspanelmanager/nspanelmanager-amd64:latest
144143
\end{lstlisting}
145-
\begin{itemize}
146-
\item Open a terminal and navigate to the downloaded repository.
147-
\item Execute \lstinline[language=bash]|cd docker| to navigate to the "docker"-directory.
148-
\item Run the script "docker-build\_and\_run.sh" to build the container \& start it up using the default values. This can be done by executing \lstinline[language=bash]|bash docker-build_and_run.sh|.
149-
\end{itemize}
150144
\important{All the data for the container will be stored in the directory mapped to /data/ in the container.}
151145
If you wish to manually build and run the container or change options or settings, see below for \hyperref[sec:advanced_setup]{advanced setup}.
152146
\bigbreak
@@ -479,7 +473,7 @@
479473
\subsubsection{Home Assistant and/or OpenHAB to/from NSPanel Manager container}
480474
There is two types of traffic flowing between these nodes:
481475
\begin{itemize}
482-
\item \textbf{Websocket:} A websocket connection is setup in order for the NSPanel Manager container to receive entity updates from Home Assistant and/or OpenHAB but also to sent entity commands (E.g. turn light X on to 20\%). A websocket is used to speed up the communication and also to not have to poll the home automation software for information.
476+
\item \textbf{Websocket:} A websocket connection is setup in order for the NSPanel Manager container to receive entity updates from Home Assistant and/or OpenHAB but also to sent entity commands (E.. turn light X on to 20\%). A websocket is used to speed up the communication and also to not have to poll the home automation software for information.
483477
\item \textbf{HTTP GET API:} The usual HTTP GET API is also used. This is used when adding entities to a room, as an example. When pressing the "Add new light" button, the NSPanel Manager container will make an HTTP GET request to gather all available entities and then send them back to the client (browser) so that the user may choose what entitiy to add to the room.
484478
\end{itemize}
485479
\subsubsection{NSPanel Manager container to/from MQTT}

0 commit comments

Comments
 (0)