updated documentation and implemented bpodgui plugin

docs/source/getting-started.rst

@@ -137,3 +137,22 @@ Configure the using the GUI
 
 .. image:: /_static/rotary-encoder-module.png
    :scale: 100 %
+
+
+Add the Rotary Plugin to the PyBpod-GUI
+================================================
+
+
+In the GUI settings add the next configuration to the list of plugins
+
+.. code:: python
+
+	GENERIC_EDITOR_PLUGINS_LIST = [
+		...
+		'pybpod_rotaryencoder_module',
+	]
+
+After open the PyBpod-GUI a access the plugin in the Tools menu.
+
+.. image:: /_static/pybpod-gui-menu.png
+   :scale: 100 %

pybpod_rotaryencoder_module/__init__.py

@@ -6,4 +6,10 @@
 __email__ 		= ['ricardojvr@gmail.com']
 __status__ 		= "Development"
 
+__version__ = "0"
+
+from pysettings import conf
+
+conf += 'pybpod_rotaryencoder_module.settings'
+
 from pybpod_rotaryencoder_module.module import RotaryEncoder as BpodModule

pybpod_rotaryencoder_module/models/projects/__init__.py

@@ -0,0 +1 @@
+from pybpod_rotaryencoder_module.models.projects.projects_rotaryencoder import ProjectsRotaryEncoder as Projects

pybpod_rotaryencoder_module/models/projects/projects_rotaryencoder.py

@@ -0,0 +1,34 @@
+# !/usr/bin/python3
+# -*- coding: utf-8 -*-
+from pysettings import conf
+if conf.PYFORMS_USE_QT5:
+	from PyQt5.QtGui import QIcon
+else:
+	from PyQt4.QtGui import QIcon
+
+from pybpod_rotaryencoder_module.module_gui import RotaryEncoderModuleGUI
+
+class ProjectsRotaryEncoder(object):
+
+	def register_on_main_menu(self, mainmenu):
+		super(ProjectsRotaryEncoder, self).register_on_main_menu(mainmenu)
+
+		if len([m for m in mainmenu if 'Tools' in m.keys()]) == 0:
+			 mainmenu.append({'Tools': []})
+
+		menu_index = 0
+		for i, m in enumerate(mainmenu):
+			if 'Tools' in m.keys(): menu_index=i; break
+
+		mainmenu[menu_index]['Tools'].append( '-' )	
+		mainmenu[menu_index]['Tools'].append( {'Rotary encoder': self.open_rotaryencoder_plugin, 'icon': QIcon(conf.ROTARYENCODER_PLUGIN_ICON)} )
+
+	def open_rotaryencoder_plugin(self):
+		if not hasattr(self, 'rotaryencoder_plugin'):
+			self.rotaryencoder_plugin = RotaryEncoderModuleGUI(self)
+			self.rotaryencoder_plugin.show()
+			self.rotaryencoder_plugin.subwindow.resize(*conf.ROTARYENCODER_PLUGIN_WINDOW_SIZE)			
+		else:
+			self.rotaryencoder_plugin.show()
+
+		return self.rotaryencoder_plugin

pybpod_rotaryencoder_module/module_gui.py

@@ -7,15 +7,18 @@
 from pysettings import conf
 if conf.PYFORMS_USE_QT5:
 	from PyQt5.QtCore import QTimer, QEventLoop
+	from PyQt5.QtWidgets import  QMessageBox
 else:
 	from PyQt4.QtCore import QTimer, QEventLoop
+	from PyQt4.QtGui import  QMessageBox
+
 
 class RotaryEncoderModuleGUI(RotaryEncoderModule, BaseWidget):
 
 	TITLE = 'Rotary encoder module'
 
-	def __init__(self):
-		BaseWidget.__init__(self, self.TITLE)
+	def __init__(self, parent_win=None):
+		BaseWidget.__init__(self, self.TITLE, parent_win=parent_win)
 		RotaryEncoderModule.__init__(self)
 
 		self._port 			= ControlText('Serial port', '/dev/ttyACM1')
@@ -129,14 +132,20 @@ def __toggle_connection_evt(self):
 			self._thresh_lower.enabled = False
 			self._thresh_upper.enabled = False
 		else:
-			self.open(self._port.value)
-			self._connect_btn.label = 'Connected'
-			self._stream.enabled = True
-			self._events.enabled = True
-			self._zero_btn.enabled = True
-			self._reset_threshs.enabled = True
-			self._thresh_lower.enabled = True
-			self._thresh_upper.enabled = True
+			try:
+				self.open(self._port.value)
+
+				self._connect_btn.label = 'Connected'
+				self._stream.enabled = True
+				self._events.enabled = True
+				self._zero_btn.enabled = True
+				self._reset_threshs.enabled = True
+				self._thresh_lower.enabled = True
+				self._thresh_upper.enabled = True
+			except  Exception as err:
+				QMessageBox.critical(self, "Error", str(err))
+				self._connect_btn.checked = False
+
 
 
 

pybpod_rotaryencoder_module/settings.py

@@ -0,0 +1,11 @@
+#!/usr/bin/python3
+# -*- coding: utf-8 -*-
+
+import os
+
+
+ROTARYENCODER_PLUGIN_ICON = os.path.join( os.path.dirname(__file__), 'resources', 'rotary.png' )
+
+
+ROTARYENCODER_PLUGIN_WINDOW_SIZE = 300, 500
+

setup.py

@@ -15,4 +15,6 @@
 
 	include_package_data=True,
 	packages=find_packages(),
+
+	package_data={'pybpod_rotaryencoder_module': ['resources/*.*',]}
 )