Merge remote-tracking branch 'riptide/master' into riptide

Author: dhoomakethu

.gitignore

@@ -1,6 +1,7 @@
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
+*$py.class
 
 # C extensions
 *.so
@@ -42,6 +43,7 @@ htmlcov/
 nosetests.xml
 coverage.xml
 *,cover
+.hypothesis/
 
 # Translations
 *.mo
@@ -54,6 +56,16 @@ coverage.xml
 docs/_build/
 
 # PyBuilder
-
 target/
 
+#PyCharms
+.idea
+
+#IniFiles
+*.ini
+
+#JSONFiles
+*.json
+**/*.ini
+instructions
+read

MANIFEST.in

@@ -0,0 +1,5 @@
+include requirements
+include README.md
+include modbus_simulator/assets/*.png
+include modbus_simulator/assets/*.ico
+include modbus_simulator/templates/*.kv

README.md

@@ -1,64 +1,54 @@
-# NOTE:
-## 1
-This project is moved to [gitlab] (https://gitlab.com/dhoomakethu/kivy-modbus-simu) .
-A newer version with support to serial mode is available there.
-
-## 2
-A cli version supporting both Modbus_RTU and Modbus_TCP is available here [modbus_simu_cli](https://github.com/dhoomakethu/modbus_sim_cli)
-
 # Modbus Simulator
 
 Modbus Simulator with GUI based on modbus-tk
 
-## Requirements
-* [modbus-tk](https://pypi.python.org/pypi/modbus_tk)
-* [kivy 1.9.0 >](http://kivy.org/#download)
-
 ## Checking Out the Source
-    $ git clone https://bitbucket.org/sanjaykv/modbus-simulator
-    $ cd modbus_simulator
+    $ git clone https://github.com/riptideio/modbus-simulator.git
+    $ cd modbus-simulator
+
 
 ## Development Instructions
-1. install kivy
-    - [OSx](http://kivy.org/docs/installation/installation-macosx.html)
-    - [Linux](http://kivy.org/docs/installation/installation-linux.html#ubuntu-11-10-or-newer)
-    - [Windows](http://kivy.org/docs/installation/installation-windows.html)
-
-2. install modbus-tk
-    * On Mac kivy uses its own virtual env ,hence all required modules needs to be installed seperatly [installing modules](http://kivy.org/docs/installation/installation-macosx.html#installing-modules)
-        - kivy -m pip install modbus-tk
+1. create virtualenv and install requirements
+   
+    ```
+    $ # Kivy depends on Cython, Install Cython before running the requirements
+    $ pip install Cython==0.25.2
+    $ pip install -r requirements
+    $ # Choose Modbus Backend modbus_tk or pymodbus (default)
+    $ # To install pymodbus
+    $ pip install pymodbus==1.3.2
+    $ # To install modbus tk
+    $ Pip install modbus-tk
+
+    ```
+
+
 3. [Setup development environment](https://github.com/kivy/kivy/wiki/Setting-Up-Kivy-with-various-popular-IDE's)
 
 ## Running/Testing application
-    $ cd modbus_simulator
-    $ kivy main.py
+
+1. To run simulation with pymodbus backend, run `./tools/launcher`
+2. To run sumulation with modbus-tk as backend run `./tools/launcher mtk`
+
+
+
 A GUi should show up if all the requirements are met !!
 
 ![main_screen.png](/img/main_screen.png)
 
-## Usage instructions
-1. Select the interface (only TCP supported as of now)
-2. Enter the desired PORT 
-3. Start Simulation
-4. Add Slave
-    * to add a single slave just click on 'add' 
-    * one can play around with values in 'from'/'to'/'count' text fields to add multiple slaves 
-    * to delete a selected slave use "delete' button
-    * 'enable all' button is not implemented yet
-5. Add Data blocks
-    * select a slave to enable Datablock tab pane
-    * use button 'add' in Datablock pane to add data (0 based offset)
-    * to delete a datablock ,select an item and use 'delete' button in Datablock pane
-6. To simulate data , press 'Simulate' button
-7. All the settings for various modbus related settings (block size/minimum/maximun values/logging) could be set and accessed from settings panel (use F1 or click on Settings icon at the bottom)
+All the settings for various modbus related settings (block size/minimum/maximun values/logging) could be set and accessed from settings panel (use F1 or click on Settings icon at the bottom)
 ![settings_screen.png](img/settings_screen.png)
 
+## Usage instructions
+[![Demo Modbus Simulator](img/simu.dif)](https://youtu.be/nlu3S5jdEn4)
+
 ## Packaging for different OS (Standalone applications)
 A standalone application specific to target OS can be created with Kivy package manager
 
-1. [OSX](http://kivy.org/docs/guide/packaging-macosx.html)
+1. [OSX](https://kivy.org/docs/guide/packaging-osx.html)
 2. [Linux](http://bitstream.io/packaging-and-distributing-a-kivy-application-on-linux.html)
 3. [Windows](http://kivy.org/docs/guide/packaging-windows.html)
 
-## OSx Standalone application
-[Modbus-Simulator v0.0.3](/binaries/osx/modbus_simulator.app.zip)
+
+# NOTE:
+A cli version supporting both Modbus_RTU and Modbus_TCP is available here [modbus_simu_cli](https://github.com/dhoomakethu/modbus_sim_cli)