Integrated NetWoRTOC into RTOC

Cleaned Interface. 
Added settings
Added access from terminal
Cleaned package-dependencies
Added different pypi-Versions
A lot of small fixes

Author: Sebastian

MANIFEST.in

@@ -1,8 +1,8 @@
 include RTOC/*
 include RTOC/data/*
-include RTOC/data/ui/*
+include RTOC/RTOC_GUI/ui/*
 include RTOC/data/lib/*
-include RTOC/data/ui/icons/*
-include RTOC/data/ui/icons/dark/*
+include RTOC/RTOC_GUI/ui/icons/*
+include RTOC/RTOC_GUI/ui/icons/dark/*
 include RTOC/lang/*
 recursive-include RTOC *

README.md

@@ -1,30 +1,72 @@
 # RealTime OpenControl (RTOC)
 
-### Version 1.9.7.3
+### Version 1.9.9
 
 [**This README is available in GERMAN here.**](misc/README_german.md)
 
 [Documentation](https://github.com/Haschtl/RealTimeOpenControl/wiki)
 
-RealTime OpenControl enables simple real-time data recording, visualization and editing. The recording can be done with a local Python scripts or via TCP locally/from the network. Visualization and editing is available locally, in the network (TCP and HTML) and via Telegram on the smartphone. You have full control over your python-plugins via TCP and Telegram.
+RealTime OpenControl is a simple way for real-time data recording, visualization and editing.
 
-In addition to data recording, events can also be recorded. These can, for example, trigger a telegram message.
+RTOC is made for communication between different devices (IoT) in a network. You can also access it with a Telegram-Bot.
 
-Possible applications:
+There are different ways to access data on an RTOC-Server:
+
+- From another RTOC-Server with TCP
+- From any device with a Telegram-Bot (limited access)
+- From any device with an HTML-website (only viewable)
+
+### Possible applications
 
 - Central measurement data recording of laboratory instruments with PC connection (e.g. power supply unit, multimeter, sensors, microcontroller)
 - Central recording of measurement data from Internet devices (e.g. mobile weather stations, drones, smartphones)
 - Remote monitoring and control of processes and devices with PC and Smartphone (Telegram) (e.g. 3D printing, heating, Custom-SmartHome)
 - Controlling between several devices (e.g.: power regulation of a power supply unit on the temperature sensor of a multimeter)
 - Decentralized data recording (e.g. on Raspberry) and access via network connection (smart projects)
+- Fun projects like controlling a LED with Telegram
+
+### Recording data and events
+
+Basis for a RTOC-Server are "devices", which collect data in any way and provide their functions and parameters. "Devices" are simple python-scripts.
+
+These "devices" can send measurements and events to the RTOC-Server.
+
+A measurement represents the collected data. Events occur in certain conditions (for example if a measured value is higher than a limit value) and can trigger actions, which will be performed after the event. Also these events can be used to trigger PushNotifications in Telegram.
+
+
+
+### GUI
 
 ![Übersicht](screenshots/overview.png)
 
+You can run the GUI with "python3 -m RTOC"
+
+The GUI offers a lot of tools:
+
+- Enable/disable devices
+- Access to optional device-GUIs
+- View and edit measurements in a lot of different ways
+- View, filter and delete events
+- Edit global events and actions
+- Download devices from RTOC-repository
+- Write and execute python-scripts, which can interact with the devices.
+- Connect to a remote RTOC-Server and view/delete measurements and events and access devices of remote RTOC-Server
+
+
+
+### No GUI
+
+In some cases you don't want to run the GUI (e.g. raspberry). Then you can still configure RTOC in a terminal: `python3 -m RTOC.Console`
+
+If you just want to run the TCP-Server after configuration, you can do this with `python3 -m RTOC -s start/stop`
+
+
+
 ## Getting Started
 
 RTOC is written in Python 3.  Tested on Windows and Linux.
 
-Python 3 (and pip3) need to be installed on the System. But you can also download the Stand-Alone-Builts for Windows and Linux below.
+Python3 (and pip3) need to be installed on the System. But you can also download the Stand-Alone-Builts for Windows and Linux below.
 
 ### Installing with Python3 (recommended)
 
@@ -34,27 +76,48 @@ RTOC is available in the Python package manager PIP:
 pip3 install RTOC
 ```
 
+This will download the basic RTOC without the dependencies needed for the GUI, Telegram and the Webserver. The basic RTOC is enough for running RTOC on embedded devices.
+
+There are also different variations available to install:
+
+```
+pip3 install RTOC[Webserver]
+pip3 install RTOC[GUI]
+pip3 install RTOC[Telegram]
+pip3 install RTOC[ALL]
+```
+
+
+
 After installing you can run RTOC with
 
 ```
 // local RTOC-instance including GUI
 python3 -m RTOC
+
 // local RTOC-instance without GUI (only TCP-Server, [HTTP-Server, Telegram-Bot])
-python3 -m RTOC -s
+python3 -m RTOC -s start/stop
+
+// local RTOC-Configuration from Console
+python3 -m RTOC.Console
+
 // remote RTOC-instance with GUI
 python3 -m RTOC -r <ADRESS>
 ```
 
-After the first start RTOC creates a directory for user plugins, temporary user data and settings.
+After the first start RTOC creates a directory for user-devices, temporary user data and settings.
 
 ```
 user@rtoc-server:~$ ls .RTOC
 config.json  // Settings for RTOC
 devices/ 	 // Directory for user-plugins
 plotStyles.json // Custom plotstyles for signals are stored in this file
+autorun_devices // Contains devices, which will start with RTOC
+globalActions.json // Contains global definitions of actions
+globalEvents.json // Contains global definitions of events
 ```
 
-### Installing with Builds (not tested well)
+### Installing with Builds (not newest version!)
 
 Download the latest release builds for Windows (soon also Linux) here.
 
@@ -64,32 +127,29 @@ Extract the .zip file into a directory. RTOC is started by double-clicking on "R
 // local RTOC-instance including GUI
 ./RTOC
 // local RTOC-instance without GUI (only TCP-Server, [HTTP-Server, Telegram-Bot])
-./RTOC -s
+./RTOC -s start
 // remote RTOC-instance with GUI
 ./RTOC -r <ADRESS>
 ```
 
-After the first start RTOC creates a directory for user plugins, temporary user data and settings.
+### Install manually
 
-```
-user@rtoc-server:~$ ls .RTOC
-config.json  // Settings for RTOC
-devices/ 	 // Directory for user-plugins
-plotStyles.json // Custom plotstyles for signals are stored in this file
-```
+To use the basic RTOC, the following dependencies must be installed
 
-### Install manually
+```python
+pip3 install numpy pycryptdomex requests python-nmap whaaaaat
+```
 
-To use RTOC, the following dependencies must be installed
+If you want to use the GUI you must also install the following packages
 
 ```python
-pip3 install numpy pyqt5 pyqtgraph markdown2 xslxwriter scipy pandas ezodf
+pip3 install pyqt5 pyqtgraph markdown2 xslxwriter scipy pandas ezodf pyGithub
 ```
 
-The following packages should also be installed
+If you want full functionality, then you still need the following packages
 
 ```
-pip3 install python-telegram-bot matplotlib requests python-nmap bokeh pycryptdomex pyGithub
+pip3 install python-telegram-bot matplotlib bokeh
 ```
 
 You can use different stylesheets if you want. Just install one of these with pip:
@@ -102,29 +162,18 @@ The RTOC repository can then be cloned with
 git clone [email protected]:Haschtl/RealTimeOpenControl.git
 ```
 
-Now RTOC can be started:
+Now you can run RTOC. Important: To run RTOC, you need to call it as a module. So, do not enter the folder containing RTOC.py
 
 ```shell
-cd kellerlogger
+cd RealTimeOpenControl
 // local RTOC-instance including GUI
-python3 RTOC
+python3 -m RTOC
 // local RTOC-instance without GUI (only TCP-Server, [HTTP-Server, Telegram-Bot])
-python3 RTOC -s
+python3 -m RTOC -s
 // remote RTOC-instance with GUI
-python3 RTOC -r <ADRESS>
-```
-
-After the first start RTOC creates a directory for user plugins, temporary user data and settings.
-
-```
-user@rtoc-server:~$ ls .RTOC
-config.json  // Settings for RTOC
-devices/ 	 // Directory for user-plugins
-plotStyles.json // Custom plotstyles for signals are stored in this file
+python3 -m RTOC -r <ADRESS>
 ```
 
-
-
 ## First steps
 
 ![Beispielschematik](screenshots/RTOC-schematik.png)
@@ -135,7 +184,6 @@ plotStyles.json // Custom plotstyles for signals are stored in this file
 ### Default/Example Plugins:
 
 - function generator: generates sine, square, sawtooth, random, AC, DC
-- NetWoRTOC: Control and data exchange between several RTOC-servers
 
 You can get more plugins from the [RTOC-plugin-repository](https://github.com/Haschtl/rtoc-plugins). Simply follow the steps described in the [documentation](https://github.com/Haschtl/RealTimeOpenControl/wiki/RTOC-Repo):
 - System: For recording many system variables (CPU, Memory, Network,...)
@@ -245,8 +293,8 @@ The connection between RTOC server and client can be encrypted end-to-end (DES)
 - [Jsonsocket from mdebbar](https://github.com/mdebbar/jsonsocket)
 - [Taurus PyQtGraph](https://github.com/taurus-org/taurus_pyqtgraph.git)
 - [ImportCode script from avtivestate.com](http://code.activestate.com/recipes/82234-importing-a-dynamically-generated-module/)
+- [VC820Py from adnidor (for HoldPeak_VC820 plugin)](https://github.com/adnidor/vc820py)
 - [PyQt5 CSV-Editor](https://python-forum.io/Thread-Read-Write-CSV-Qt5)
-- [Python Daemon](https://web.archive.org/web/20160320091458/http://www.jejik.com/files/examples/daemon3x.py)
 
 All icons used in this software (including plugins) are kindly provided by [Icons8](www.icons8.com)
 

RTOC.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 1.2
+Metadata-Version: 2.1
 Name: RTOC
-Version: 1.9.7.3
+Version: 1.9.9
 Summary: RealTime OpenControl
 Home-page: https://github.com/Haschtl/RealTimeOpenControl
 Author: Sebastian Keller
@@ -28,3 +28,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Topic :: Scientific/Engineering :: Visualization
 Classifier: Topic :: Software Development :: User Interfaces
 Requires-Python: >=3
+Provides-Extra: ALL
+Provides-Extra: Webserver
+Provides-Extra: Telegram
+Provides-Extra: GUI