You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|[](https://realtimeopencontrol.readthedocs.io/en/latest/)|[](https://github.com/Haschtl/RealTimeOpenControl/releases)|[](https://pypi.python.org/pypi/RTOC/)|[](https://pypi.python.org/pypi/RTOC/)|[](https://pypi.python.org/pypi/RTOC/)|[](https://github.com/Haschtl/RealTimeOpenControl/releases/)|[](https://github.com/Haschtl/RealTimeOpenControl/releases/)|
3
+
|[](https://realtimeopencontrol.readthedocs.io/en/latest/)|[](https://github.com/Haschtl/RealTimeOpenControl/releases)|[](https://pypi.python.org/pypi/RTOC/)|[](https://pypi.python.org/pypi/RTOC/)|[](https://pypi.python.org/pypi/RTOC/)|[](https://github.com/Haschtl/RealTimeOpenControl/releases/)|[](https://github.com/Haschtl/RealTimeOpenControl/releases/)|
4
4
5
5
6
6
### Version 2.0
@@ -37,35 +37,6 @@ Every plugin can send measurements and events to the RTOC-Server.
37
37
38
38
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.
39
39
40
-
41
-
42
-
### GUI
43
-
44
-
45
-
46
-
You can run the GUI with "python3 -m RTOC"
47
-
48
-
The GUI offers a lot of tools:
49
-
50
-
- Enable/disable devices
51
-
- Access to optional device-GUIs
52
-
- View and edit measurements in a lot of different ways
53
-
- View, filter and delete events
54
-
- Edit global events and actions
55
-
- Download devices from RTOC-repository
56
-
- Write and execute python-scripts, which can interact with the devices.
57
-
- Connect to a remote RTOC-Server and view/delete measurements and events and access devices of remote RTOC-Server
58
-
59
-
60
-
61
-
### No GUI
62
-
63
-
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.RTLogger -c`
64
-
65
-
If you just want to run the TCP-Server after configuration, you can do this with `python3 -m RTOC.RTLogger`. The best way, to run this code on embedded devices, is, to setup a systemd-service for automated startup. But you can also run/stop RTOC in background with 'python3 -m RTOC.RTLogger -s start/stop'.
66
-
67
-
If you want to start the HTML server on port 8050, you need to run it with 'python3 -m RTOC.RTLogger -w'.
68
-
69
40
## Getting Started
70
41
71
42
RTOC is written in Python 3. Tested on Windows and Linux.
@@ -79,6 +50,16 @@ RTOC can be installed and used in different ways:
79
50
80
51
[Click here for a complete setup-tutorial](https://realtimeopencontrol.readthedocs.io/en/latest/)
81
52
53
+
### Write simple Python-Plugin
54
+
55
+
Python plugins are integrated into RTOC and can be used to
56
+
57
+
- send data as stream(=append) or plot(=replace) to RTOC
58
+
- send events
59
+
60
+
Plugins can **not** access all measurements. This can be done with a TCP connection to RTOC.
[Read the Wiki for full documentation](https://realtimeopencontrol.readthedocs.io/en/latest/)
@@ -95,36 +76,22 @@ You can get more plugins from the [RTOC-plugin-repository](https://github.com/Ha
95
76
- ...
96
77
97
78
98
-
### First GUI-Run
79
+
### No GUI
99
80
100
-
The graphical user interface of RTOC offers a wealth of functions for data display and processing.
81
+
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.RTLogger -c`
101
82
102
-
- measuring tools
103
-
- Customize and save plot styles
104
-
- Save and load session
105
-
- Create multiple plots
106
-
- Run in the background
107
-
- Import and export data
108
-
- Scripts:
109
-
- Multi-Tab Script Editor
110
-
- The user can interact with the signals and plugins during runtime:
111
-
- Execute plugin functions or set plugin parameters
112
-
- Edit signals, create new signals, crop, overlay, ...
113
-
- Scaling, shifting of signals
114
-
- Run multiple scripts in parallel
83
+
If you just want to run the TCP-Server after configuration, you can do this with `python3 -m RTOC.RTLogger`. The best way, to run this code on embedded devices, is, to setup a systemd-service for automated startup. But you can also run/stop RTOC in background with 'python3 -m RTOC.RTLogger -s start/stop'.
<inputtype="image"src="https://www.paypalobjects.com/en_US/DK/i/btn/btn_donateCC_LG.gif"border="0"name="submit"title="PayPal - The safer, easier way to pay online!"alt="Donate with PayPal button" />
Description: 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.
9
+
Description: # RealTime OpenControl (RTOC)
10
10
11
-
In addition to data recording, events can also be recorded. These can, for example, trigger a telegram message.
RealTime OpenControl is a simple way for real-time data recording, visualization and editing.
19
+
20
+
RTOC is made for communication with different devices (IoT) in a network or local sensors or devices providing data. It collects Data from any source and provides easy and intuitive user interaction. The simplest way is, to run RTOC with the user-frontend. But it can also run a HTML-Server providing plots and events. This is the best way to view the data, if RTOC is running on screen-less devices, like a Raspberry Pi. And in any other case, you can get full access and control of RTOC with a simple Telegram-Bot all over the world, without many configurations. This bot is also capable of sending messages or warnings, if events are triggered. Read more about Events later on.
21
+
22
+
There are different ways to access data on an RTOC-Server:
23
+
24
+
- From GUI (PyQT5) (full access)
25
+
- From another RTOC-Server with TCP (partial access)
26
+
- From any device with a Telegram-Bot (full access)
27
+
- From any device with an HTML-website (only viewable)
28
+
- From any device with PostgreSQL-Database (only access to data, no controlling of RTOC)
29
+
30
+
### Possible applications
31
+
32
+
- General long time data recording and automation due to postgreSQL integration
15
33
- Central measurement data recording of laboratory instruments with PC connection (e.g. power supply unit, multimeter, sensors, microcontroller)
16
34
- Central recording of measurement data from Internet devices (e.g. mobile weather stations, drones, smartphones)
17
35
- Remote monitoring and control of processes and devices with PC and Smartphone (Telegram) (e.g. 3D printing, heating, Custom-SmartHome)
18
36
- Controlling between several devices (e.g.: power regulation of a power supply unit on the temperature sensor of a multimeter)
19
37
- Decentralized data recording (e.g. on Raspberry) and access via network connection (smart projects)
38
+
- Fun projects like controlling a LED with Telegram
39
+
40
+
### Recording data and events
41
+
42
+
Basis for a RTOC-Server are plugins, which collect data in any way and provide their functions and parameters. These plugins are represented by simple python-plugins, which can be downloaded from the [RTOC-plugin-repository](https://github.com/Haschtl/rtoc-plugins) for specific devices. You can also write your own plugins for it. If you want to publish your plugin in my repository, just send me a message.
43
+
44
+
Every plugin can send measurements and events to the RTOC-Server.
45
+
46
+
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.
47
+
48
+
## Getting Started
49
+
50
+
RTOC is written in Python 3. Tested on Windows and Linux.
51
+
52
+
Python3 (and pip3) need to be installed on the System. But you can also download the Stand-Alone-Builts for Windows and Linux below.
53
+
RTOC can be installed and used in different ways:
54
+
- Installation and use with PostgreSQL-Server (recommended for embedded)
55
+
- Installation without PostgreSQL-Database (recommended for simple-usage)
56
+
- Installation with builds (Linux/Windows)
57
+
- Installation from source
58
+
59
+
[Click here for a complete setup-tutorial](https://realtimeopencontrol.readthedocs.io/en/latest/)
60
+
61
+
### Write simple Python-Plugin
62
+
63
+
Python plugins are integrated into RTOC and can be used to
64
+
65
+
- send data as stream(=append) or plot(=replace) to RTOC
66
+
- send events
67
+
68
+
Plugins can **not** access all measurements. This can be done with a TCP connection to RTOC.
[Read the Wiki for full documentation](https://realtimeopencontrol.readthedocs.io/en/latest/)
74
+
75
+
### Default/Example Plugins:
76
+
77
+
- function generator: generates sine, square, sawtooth, random, AC, DC
78
+
79
+
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://realtimeopencontrol.readthedocs.io/en/latest/PLUGINS.html#plugin-repository):
80
+
- System: For recording many system variables (CPU, Memory, Network,...)
81
+
- Octoprint: Recording of 3D printers
82
+
- DPS5020: power supply unit recording and control (possibly also DPS5005, ...)
83
+
- HoldPeak VC820: Multimeter Measurement Recording (also other VC820)
84
+
- ...
85
+
86
+
87
+
### No GUI
88
+
89
+
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.RTLogger -c`
90
+
91
+
If you just want to run the TCP-Server after configuration, you can do this with `python3 -m RTOC.RTLogger`. The best way, to run this code on embedded devices, is, to setup a systemd-service for automated startup. But you can also run/stop RTOC in background with 'python3 -m RTOC.RTLogger -s start/stop'.
92
+
93
+
If you want to start the HTML server on port 8050, you need to run it with 'python3 -m RTOC.RTLogger -w'.
TCP clients can establish a connection to the RTOC server on the same computer or in the network (check firewall settings). With the necessary port shares on the router and dynamic DNS, the RTOC server can also be accessed from the Internet.
107
+
108
+
TCP communication takes place with JSONs, which allows communication in all programming languages and also, for example, with an ESP8266/ESP32 microcontroller. This connection can also be end-to-end-encrypted with AES.
109
+
110
+
The client can
111
+
112
+
- send data as stream(=append) or plot(=replace) to RTOC
113
+
- send events
114
+
- access all measurement data and events of the RTOC-server
115
+
- access all RTOC-server functions
116
+
- access all RTOC-server plugin functions and parameters
117
+
118
+
The connection between RTOC server and client can be encrypted end-to-end (DES) with a password.
119
+
120
+
[Example for TCP here.](https://realtimeopencontrol.readthedocs.io/en/latest/TCP.html)
121
+
122
+
### Include Telegram-messanger
123
+
124
+
[Tutorial for Telegram here.](https://realtimeopencontrol.readthedocs.io/en/latest/TELEGRAM.html)
All icons used in this software (including plugins) are kindly provided by [Icons8](www.icons8.com)
139
+
140
+
## Contributing
141
+
142
+
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on my code of conduct, and the process for submitting pull requests to me.
143
+
144
+
## License
145
+
146
+
This project is licensed under the **GNU General Public License v3.0** - see the [LICENSE](LICENSE) file for details
147
+
148
+
149
+
# Coffee
150
+
[Feel free to buy me some coffee with milk](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=V3JGL7BM8WGQY&source=url)
20
151
21
152
Platform: UNKNOWN
22
153
Classifier: Programming Language :: Python :: 3
@@ -27,7 +158,8 @@ Classifier: Operating System :: OS Independent
0 commit comments