update documentation

This commit is contained in:
Justin Hammond 2020-01-06 14:48:18 +08:00
parent c64d765055
commit adcdfffedd
2 changed files with 6 additions and 3 deletions

View file

@ -16,12 +16,15 @@ Running:
-------------
Start a container with the following command line:
```docker run -it --device=/dev/ttyUSB0 -v /tmp/ozw:/opt/ozw/config -e MQTT_SERVER="10.100.200.102" -e USBPATH=/dev/ttyUSB0 openzwave/ozwdaemon:latest```
```docker run -it --security-opt seccomp=unconfined --device=/dev/ttyUSB0 -v /tmp/ozw:/opt/ozw/config -e MQTT_SERVER="10.100.200.102" -e USBPATH=/dev/ttyUSB0 openzwave/ozwdaemon:latest```
* replace MQTT_SERVER with the IP address of the MQTT Server
* replace all /dev/ttyUSB0 entries with the path to your USB Stick.
* OpenZWave Config Files are copied on startup to the host directory specified by /tmp/ozw - You should replace it with a directory that is persistent.
the `--security-opt seccomp=unconfined` is needed to generate meaningfull
backtraces, otherwise it will be difficult for us to debug.
Please see [docs/MQTT.md](docs/MQTT.md) for further information
## QT Wrapper Interface

View file

@ -1,13 +1,13 @@
MQTT Client for OpenZWave
=========================
Docker Repo: https://hub.docker.com/r/openzwave/ozw-mqtt
Docker Repo: https://hub.docker.com/r/openzwave/ozwdaemon
Copy the "config" folder from OZW to `/tmp/ozw/`.
Start a container with the following command line:
```
docker run -it --device=/dev/ttyUSB0 -v /tmp/ozw:/opt/ozw/config -e MQTT_SERVER="10.100.200.102" -e USBPATH=/dev/ttyUSB0 openzwave/ozw-mqtt:latest
docker run -it --security-opt seccomp=unconfined --device=/dev/ttyUSB0 -v /tmp/ozw:/opt/ozw/config -e MQTT_SERVER="10.100.200.102" -e USBPATH=/dev/ttyUSB0 openzwave/ozwdaemon:latest
```
(replace `MQTT_SERVER` with the IP address of the MQTT Server and all `/dev/ttyUSB0` entries with the path to your USB Stick.