Merge pull request #76 from TUB-Control/development

Development

CHANGELOG.rst

@@ -1,6 +1,18 @@
 Changelog
 ---------
 
+v.1.4:
+----------
+- **feature**: Plot now supports different line width styles.
+- **feature**: PaPI Main GUI now supports a fullscreen mode including toolbar toggling and run mode.
+- **improvement**: Cmd line arguments and switches can control full screen mode and run mode of PaPI.
+- **improvement**: Run mode now prevents close and move of tabs.
+- **improvement**: It is not more mandatory to start PaPI inside of the PaPI installation folder.
+- **improvement**: The PaPI start.sh script can be used with simlinks everywhere
+- **improvement**: Subscriptions for blocks which does not exist yet are delayed and done later. Better Supports run-time block creation using e.g. Simulink
+- **simulink**: The configuration can now be changed without re-compiling the simulink model by setting a file in the PaPIBlock mask.
+- **plugin**: Added new plugin function: pl_get_plugin_path()
+
 v.1.3:
 ------
 - **feature**: Added possibility to copy a plugin, i.e to create a plugin with the same start-up cfg automatically

Makefile

@@ -35,6 +35,8 @@ MKDIR_P = mkdir -p
 
 AUTHOR = $(shell whoami)
 
+ROOT_DIR :=$(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
+
 .PHONY: rst_files create_rst create_ui clean
 
 create_ui: $(PY_FILES)
@@ -103,3 +105,9 @@ clean:
  @rm $(RST_DES_DIR)/$(CHANGELOG_RST)
  @rm -R $(RST_STATIC_FOLDER_DES)
  make -C docs clean
+
+install:
+ @rm -rf /usr/local/bin/PaPI 
+ @ln -s $(ROOT_DIR)/start.sh /usr/local/bin/PaPI
+
+

README.rst

@@ -1,5 +1,5 @@
-PaPI v. 1.3
-===========
+PaPI v. 1.4
+===============
 
 Plugin based Process Interaction
 
@@ -37,10 +37,7 @@ HTMLViewer plugin) [optional]
 ``sudo apt-get install python3-pyqt5.qtsvg`` (just needed for the
 export feature of the Plot plugin) [optional]
 
-``sudo pip3 install socketio_client`` (required for ORTD_UDP) [optional]
-
-``sudo pip3 install tornado`` (just needed for the Human plugin)
-[optional]
+``sudo pip3 install socketio_client==0.6.5`` (required for ORTD_UDP) [optional]
 
 ``git clone https://github.com/TUB-Control/PaPI.git PaPI``
 
@@ -52,6 +49,29 @@ Tip: If python3.4 interpreter cannot find or locate the installed
 packages (PyQt5 or numpy), please make sure that the right python
 interpreter is called (in case there are multiple installed).
 
+Start PaPI
+--------------------------------------------
+You can either start PaPI by calling the main.py with a python interpreter or you can start PaPI by using the bash script.
+In addition, PaPI can be installed as a symlink to your device.
+
+``cd PaPI``
+
+``sudo make install``
+
+For both start methods, command line switches and arguments are available.
+
+``-f``: Starts PaPI in full screen mode.
+
+``-r``: Starts PaPI with activated run mode.
+
+``-v``: Displays the version of PaPI.
+
+``-h``: Displays a help message.
+
+``-c``: Start PaPI with the given configuration(PaPI loads arg-cfg after start).
+
+``-u``: Specify another user config.
+
 Real-time target systems currently supported
 --------------------------------------------
 
@@ -73,7 +93,11 @@ Documentation
 
 Sphinx doc on GitHub: https://tub-control.github.io/PaPI/
 
-PaPI wiki on GitHub: https://github.com/TUB-Control/PaPI/wiki
+The provide makefile is used to build the documentation by using this simple command
+
+``make html``
+
+The documentation can be found in `docs/_build/html/`.
 
 Embedded Packages
 -----------------