BEDGE-2726 pip installable version of modbus simulator

Author: krish_trip

.gitignore

@@ -62,4 +62,4 @@ target/
 .idea
 
 #IniFiles
-*.ini
+*.ini

MANIFEST.in

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

modbus_simulator/__init__.py

@@ -12,23 +12,28 @@
 from kivy.uix.settings import SettingsWithSidebar
 from kivy.uix.listview import ListView, ListItemButton
 from kivy.adapters.listadapter import ListAdapter
-from utils.modbus import ModbusSimu, BLOCK_TYPES, configure_modbus_logger
-from ui.settings import SettingIntegerWithRange
-from utils.backgroundJob import BackgroundJob
+from modbus_simulator.utils.modbus import ModbusSimu, BLOCK_TYPES, \
+    configure_modbus_logger
+from modbus_simulator.ui.settings import SettingIntegerWithRange
+from modbus_simulator.utils.backgroundJob import BackgroundJob
 import re
 import os
 from kivy.config import Config
 from kivy.lang import Builder
-import ui.datamodel
+import modbus_simulator.ui.datamodel
+from pkg_resources import resource_filename
+
 
 MAP = {
     "coils": "coils",
     'discrete inputs': 'discrete_inputs',
     'input registers': 'input_registers',
     'holding registers': 'holding_registers'
 }
-
-Builder.load_file("templates/modbussimu.kv")
+settings_icon = resource_filename(__name__, "assets/Control-Panel.png")
+app_icon = resource_filename(__name__, "assets/riptideLogo.png")
+modbus_template = resource_filename(__name__, "templates/modbussimu.kv")
+Builder.load_file(modbus_template)
 
 
 class FloatInput(TextInput):
@@ -85,6 +90,9 @@ class Gui(BoxLayout):
     data_model_input_registers = ObjectProperty()
     data_model_holding_registers = ObjectProperty()
 
+    settings = ObjectProperty()
+    riptide_logo = ObjectProperty()
+
     # Helpers
     # slaves = ["%s" %i for i in xrange(1, 248)]
     _data_map = {"tcp": {}, "rtu": {}}
@@ -106,6 +114,8 @@ class Gui(BoxLayout):
     def __init__(self, **kwargs):
         super(Gui, self).__init__(**kwargs)
         time_interval = kwargs.get("time_interval", 1)
+        self.settings.icon = settings_icon
+        self.riptide_logo.app_icon = app_icon
         self.config = Config.get_configparser('app')
         self.slave_list.adapter.bind(on_selection_change=self.select_slave)
         self.data_model_loc.disabled = True
@@ -831,7 +841,6 @@ class ModbusSimuApp(App):
     settings_cls = SettingsWithSidebar
 
     def build(self):
-
         self.gui = Gui(
             modbus_log=os.path.join(self.user_data_dir, 'modbus.log')
         )
@@ -910,5 +919,9 @@ def close_settings(self, *args):
         super(ModbusSimuApp, self).close_settings()
 
 
-if __name__ == "__main__":
+def run():
     ModbusSimuApp().run()
+
+
+if __name__ == "__main__":
+    run()

assets/Control-Panel.png renamed to modbus_simulator/assets/Control-Panel.png

@@ -0,0 +1,33 @@
+[Modbus Tcp]
+ip = 127.0.0.3
+
+[Modbus Protocol]
+block start = 0
+block size = 100
+bin min = 0
+bin max = 1
+reg min = 0
+reg max = 65535
+
+[Modbus Serial]
+baudrate = 9600
+bytesize = 8
+parity = N
+stopbits = 1
+xonxoff = 0
+rtscts = 0
+dsrdtr = 0
+writetimeout = 2
+timeout = 2
+
+[Logging]
+log file = /home/mahakal/.config/modbussimu/modbus.log
+logging = 1
+console logging = 1
+console log level = DEBUG
+file log level = DEBUG
+file logging = 1
+
+[Simulation]
+time interval = 1
+

assets/favicon.ico renamed to modbus_simulator/assets/favicon.ico

@@ -2,6 +2,7 @@
 #:import KivyLexer kivy.extras.highlight.KivyLexer
 #:import ListItemButton kivy.uix.listview.ListItemButton
 #:import sla kivy.adapters.listadapter
+
 <Separator@Widget>
     size_hint_y: None
     thickness: 2
@@ -38,7 +39,8 @@
     slave_pane: slave_pane
     slave_start_add: slave_start_add
     slave_end_add: slave_end_add
-    action_bar: action_bar
+    settings: settings
+    riptide_logo: riptide_logo
     BoxLayout:
         padding: '2sp'
         canvas:
@@ -288,16 +290,16 @@
         ActionView:
             use_separator: True
             ActionPrevious:
+                id: riptide_logo
                 with_previous: False
-                app_icon: 'assets/riptideLogo.png'
                 disabled: True
             ActionOverflow:
             ActionToggleButton:
                 text: 'Simulate'
                 on_release: root.start_stop_simulation(*args)
             ActionButton:
+                id: settings
                 text: 'settings'
-                icon: 'assets/Control-Panel.png'
                 on_release: app.show_settings(*args)
 
 

assets/riptideLogo.png renamed to modbus_simulator/assets/riptideLogo.png

@@ -0,0 +1,11 @@
+# #!/bin/bash
+#
+# root_dir="$(cd $(dirname $0)/..; pwd)"
+# launch_cmd="$root_dir/main.py"
+# python $launch_cmd
+
+# import modbus_simulator
+# from os.path import dirname, join
+# from os import execlp
+
+# execlp("python", join(dirname(modbus_simulator.__file__), 'main.py'))

main.py renamed to modbus_simulator/main.py

@@ -13,9 +13,11 @@
 from kivy.uix.popup import Popup
 from kivy.uix.textinput import TextInput
 
-from utils.backgroundJob import BackgroundJob
+from modbus_simulator.utils.backgroundJob import BackgroundJob
+from pkg_resources import resource_filename
 
-Builder.load_file("templates/datamodel.kv")
+datamodel_template = resource_filename(__name__, "../templates/datamodel.kv")
+Builder.load_file(datamodel_template)
 
 integers_dict = {}
 

modbus_simulator/modbussimu.ini

@@ -9,7 +9,7 @@
 from modbus_tk.modbus_rtu import RtuServer, RtuMaster
 from modbus_tk.modbus_tcp import TcpServer, TcpMaster
 
-from utils.common import path, make_dir, remove_file
+from modbus_simulator.utils.common import path, make_dir, remove_file
 
 ADDRESS_RANGE = {
     COILS: 0,

templates/datamodel.kv renamed to modbus_simulator/templates/datamodel.kv

@@ -20,14 +20,15 @@ def readme():
     version="0.1",
     description="Modbus Simulator using modbus_tk and kivy",
     long_description=readme(),
-    classifiers=[
-        "Programming Language : Python : 2.7",
-        "Simulator : Modbus Simulator",
-    ],
     keywords="Modbus Simulator",
     author="riptideio",
     packages=find_packages(),
-    install_requires=install_requires,
-    scripts=['tools/launcher'],
+    install_requires=install_requires(),
+    scripts=['modbus_simulator/tools/modbus_simu.py'],
+    entry_points={
+        'console_scripts': [
+            'modbus_simu = modbus_simulator.main:run',
+        ],
+    },
     include_package_data=True
 )