RealTime OpenControl’s documentation¶
Welcome to RealTime OpenControl’s documentation¶
RealTime OpenControl (RTOC) is a free software for recording measurement data of various measuring instruments. It offers the following components
RTLogger backend¶
The core element of RTOC. More information here: Backend Source-code
Expandable with plugins¶
You can write plugins by your own or use a plugin from the repository. More information here: Collecting data
Telegram-Bot¶
The Telegram-Bot offers access to RTOC from any device with Telegram installed. More information here: Telegram Communication
TCP-Server¶
Communication with RTLogger from other processes or devices. Suitable for embedded devices with graphical user interface. More information here: TCP Communication
Webserver¶
View plots and events from any network device. More information here: Run webserver
Graphical user interface (RTOC-GUI)¶
Used, when running RTOC on computers/laptops to view and edit data. More information here Graphical user interface.
Scripting/Automation¶
You can write scripts and run/edit and stop them during runtime. You have full access to all data stored in RTOC and access to all plugins. A event/action system gives a simple solution for very custom automisations. More information here: Controlling and automation
Getting started¶
Follow one of the installation-instructions (pip, builds, source): Installation
Have a look at the plugin-documentation: Collecting data
RTOC will create a directory in the home-directory, where all user-data is stored. More information here: Userdata
FAQ¶
- How can I get plugins from the community? Plugin repository
- How do I import new data from CSV, Wave, Excel, ODF, Matlab? Import/Export signals/sessions
- How do I connect a new plugin? Collecting data
- How do I create a sub-GUI for a device? Writing Plugins
- How do I create my first script? Controlling and automation
- What does the trigger mean? Trigger-System
- RTOC library and default functions for scripts:
RTLogger.scriptLibrary
- Can I access the data from any device? Telegram Communication or TCP Communication
- How do I use the graphical user interface? Graphical user interface
- How do I create a telegram bot? Telegram-Bot setup
- How do I control an RTOC server via TCP in the network? Remote-control via TCP
- Where can I find examples for plugins? RTOC repository
Feel free to buy me some coffee with milk
Indices and tables¶
Table of contents¶
- Backend Source-code
- LoggerPlugin.py
- jsonsocket.py
- RTOC.RTLogger Submodules
- RTOC.RTLogger.Daemon module
- RTOC.RTLogger.DeviceFunctions module
- RTOC.RTLogger.EventActionFunctions module
- RTOC.RTLogger.NetworkFunctions module
- RTOC.RTLogger.RTLogger module
- RTOC.RTLogger.RTOC_Web module
- RTOC.RTLogger.RTOC_Web_standalone module
- RTOC.RTLogger.RTRemote module
- RTOC.RTLogger.RT_data module
- RTOC.RTLogger.ScriptFunctions module
- RTOC.RTLogger.importCode module
- RTOC.RTLogger.loggerlib module
- RTOC.RTLogger.scriptLibrary module
- RTOC.RTLogger.telegramBot module
- GUI - Source-code
- RTOC.RTOC module
- RTOC.RTOC_GUI subpackage
- RTOC.RTOC_GUI.Actions module
- RTOC.RTOC_GUI.RTPlotActions module
- RTOC.RTOC_GUI.RTPlotWidget module
- RTOC.RTOC_GUI.csvSignalWidget module
- RTOC.RTOC_GUI.define module
- RTOC.RTOC_GUI.eventWidget module
- RTOC.RTOC_GUI.globalActionWidget module
- RTOC.RTOC_GUI.globalEventWidget module
- RTOC.RTOC_GUI.remoteWidget module
- RTOC.RTOC_GUI.scriptHelpWidget module
- RTOC.RTOC_GUI.scriptSubWidget module
- RTOC.RTOC_GUI.scriptWidget module
- RTOC.RTOC_GUI.settingsWidget module
- RTOC.RTOC_GUI.signalEditWidget module
- RTOC.RTOC_GUI.signalWidget module
- RTOC.RTOC_GUI.styleMultiPlotGUI module
- RTOC.RTOC_GUI.stylePlotGUI module
- RTOC.RTOC.PluginDownloader module
- RTOC.RTOC.RTOC_Import module
- RTOC.lib package
- View source on Github