11![ OpenADMS] ( https://www.dabamos.de/github/openadms.png )
22
33OpenADMS is an open source automatic deformation monitoring system for
4- geodetical and geotechnical measurements . The software is written in Python 3
4+ geodetical and geotechnical observations . The software is written in Python 3
55and should run on Python 3.5 upwards. So far, it has been tested with CPython on
6- FreeBSD 10 (x86-64), NetBSD 7 (ARMv7), and Windows 7 (x86). For more
7- information, please see https://www.dabamos.de/ .
6+ FreeBSD 10 (x86-64, ARMv7 ), NetBSD 7 (ARMv7), and Windows 7 (x86, x86-64 ). For
7+ more information, please see https://www.dabamos.de/ .
88
9- The current development version of OpenADMS is 0.4 (code name “Dar es Salaam”).
9+ The current development version of OpenADMS is 0.4 (code name “Dar es Salaam”).
1010
1111## Installation
1212To run OpenADMS, clone the branch and execute ` openadms.py ` :
1313
1414```
1515$ git clone https://github.com/dabamos/openadms.git
1616$ cd openadms
17+ $ pip install -U -r requirements.txt
1718$ python3 openadms.py --config ./config/myconfig.json --debug
1819```
1920
20- ### Libraries
21- Some additional modules have to be installed in order to use OpenADMS:
21+ Some additional modules are used by OpenADMS:
2222
2323* [ coloredlogs] ( https://pypi.python.org/pypi/coloredlogs ) (MIT Licence)
2424* [ paho-mqtt] ( https://pypi.python.org/pypi/paho-mqtt ) (Eclipse Public Licence)
2525* [ pyserial] ( https://pypi.python.org/pypi/pyserial ) (Python Software Foundation Licence)
2626
27- The installation can be done with ` pip ` :
2827
29- ```
30- $ pip install -U -r requirements.txt
31- ```
3228## Message Broker
33- The MQTT protocol is used for the internal message exchange in OpenADMS. An MQTT
34- message broker, like [ Eclipse Mosquitto] ( https://mosquitto.org/ ) , must be
35- installed and running before starting OpenADMS. On Unix-like operating systems
36- an installed Mosquitto MQTT message broker can be launched with:
37-
38- ```
39- # service mosquitto onestart
40- ```
29+ The MQTT protocol is used for the internal and external message exchange in
30+ OpenADMS. An MQTT message broker, like [ Eclipse Mosquitto] ( https://mosquitto.org/ )
31+ or [ HBMQTT] ( https://github.com/beerfactory/hbmqtt ) , must be installed and
32+ running before starting OpenADMS.
4133
4234For testing only, the public sandbox broker of
4335[ Eclipse IoT] ( https://iot.eclipse.org/getting-started ) can be used. The server
@@ -56,8 +48,8 @@ $ python3 openadms.py --config ./config/myconfig.json --debug
5648```
5749
5850## Virtual Environment
59- For the set-up of an independent Python environment the tool ` pyvenv ` can be
60- used, which is part of Python 3 :
51+ The Python tool ` pyvenv ` can be used to set-up a virtual environment for
52+ development :
6153
6254```
6355$ pyvenv-3.5 ~/virtual-environment
0 commit comments