pymodaq_plugins_raspberry 5.0.1__py3-none-any.whl

pymodaq_plugins_raspberry/__init__.py

@@ -0,0 +1,11 @@
+from pathlib import Path
+from .utils import Config
+from pymodaq_utils.utils import get_version, PackageNotFoundError
+from pymodaq_utils.logger import set_logger, get_module_name
+
+config = Config()
+try:
+    __version__ = get_version(__package__)
+except PackageNotFoundError:
+    __version__ = '0.0.0dev'
+

pymodaq_plugins_raspberry/daq_move_plugins/__init__.py

@@ -0,0 +1,13 @@
+import importlib
+from pathlib import Path
+from .. import set_logger
+logger = set_logger('move_plugins', add_to_console=False)
+
+for path in Path(__file__).parent.iterdir():
+    try:
+        if '__init__' not in str(path):
+            importlib.import_module('.' + path.stem, __package__)
+    except Exception as e:
+        logger.warning("{:} plugin couldn't be loaded due to some missing packages or errors: {:}".format(path.stem, str(e)))
+        pass
+

pymodaq_plugins_raspberry/daq_viewer_plugins/__init__.py

@@ -0,0 +1,3 @@
+
+
+

pymodaq_plugins_raspberry/daq_viewer_plugins/plugins_0D/__init__.py

@@ -0,0 +1,13 @@
+import importlib
+from pathlib import Path
+from ... import set_logger
+logger = set_logger('viewer0D_plugins', add_to_console=False)
+
+for path in Path(__file__).parent.iterdir():
+    try:
+        if '__init__' not in str(path):
+            importlib.import_module('.' + path.stem, __package__)
+    except Exception as e:
+        logger.warning("{:} plugin couldn't be loaded due to some missing packages or errors: {:}".format(path.stem, str(e)))
+        pass
+

pymodaq_plugins_raspberry/daq_viewer_plugins/plugins_1D/__init__.py

@@ -0,0 +1,13 @@
+import importlib
+from pathlib import Path
+from ... import set_logger
+logger = set_logger('viewer1D_plugins', add_to_console=False)
+
+for path in Path(__file__).parent.iterdir():
+    try:
+        if '__init__' not in str(path):
+            importlib.import_module('.' + path.stem, __package__)
+    except Exception as e:
+        logger.warning("{:} plugin couldn't be loaded due to some missing packages or errors: {:}".format(path.stem, str(e)))
+        pass
+

pymodaq_plugins_raspberry/daq_viewer_plugins/plugins_2D/__init__.py

@@ -0,0 +1,14 @@
+import importlib
+from pathlib import Path
+from ... import set_logger
+logger = set_logger('viewer2D_plugins', add_to_console=False)
+
+for path in Path(__file__).parent.iterdir():
+    try:
+        if '__init__' not in str(path):
+            importlib.import_module('.' + path.stem, __package__)
+    except Exception as e:
+        logger.warning("{:} plugin couldn't be loaded due to some missing packages or errors: {:}".format(path.stem, str(e)))
+        pass
+
+

pymodaq_plugins_raspberry/daq_viewer_plugins/plugins_2D/daq_2Dviewer_PiCamera.py

@@ -0,0 +1,160 @@
+import numpy as np
+from qtpy import QtWidgets
+
+from pymodaq.utils.daq_utils import ThreadCommand
+from pymodaq.utils.data import DataFromPlugins, Axis, DataToExport
+from pymodaq.control_modules.viewer_utility_classes import DAQ_Viewer_base, comon_parameters, main
+from pymodaq.utils.parameter import Parameter
+from pymodaq_utils.logger import set_logger, get_module_name
+
+logger = set_logger(get_module_name(__file__))
+
+from picamera2 import Picamera2
+
+
+class DAQ_2DViewer_PiCamera(DAQ_Viewer_base):
+    """ Instrument plugin class for a 2D viewer.
+    
+    This object inherits all functionalities to communicate with PyMoDAQ’s DAQ_Viewer module through inheritance via
+    DAQ_Viewer_base. It makes a bridge between the DAQ_Viewer module and the Python wrapper of a particular instrument.
+
+    Attributes:
+    -----------
+    controller: object
+        The particular object that allow the communication with the hardware, in general a python wrapper around the
+         hardware library.
+
+             """
+
+    hardware_averaging = True
+    live_mode_available = False
+
+    params = comon_parameters + [
+        {'title': 'Resolution:', 'name': 'resolution', 'type': 'list', 'value': 'low', 'limits': ['low', 'high']},
+        #{'title': 'Zoom:', 'name': 'zoom', 'type': 'slide', 'value': 1.0, 'min': 0., 'max': 1., 'subtype': 'linear'},
+        #{'title': 'Brightness:', 'name': 'brightness', 'type': 'slide', 'value': 50, 'min': 0, 'max': 100,
+        # 'subtype': 'linear', 'int': True},
+        #{'title': 'Contrast:', 'name': 'contrast', 'type': 'slide', 'value': 0, 'min': -100, 'max': 100,
+        # 'subtype': 'linear', 'int': True},
+    ]
+
+    def ini_attributes(self):
+        #  TODO declare the type of the wrapper (and assign it to self.controller) you're going to use for easy
+        #  autocompletion
+        self.controller: PiCamera2 = None
+
+        # TODO declare here attributes you want/need to init with a default value
+        self.live = False
+
+        self.x_axis = None
+        self.y_axis = None
+        self.width = 640
+        self.height = 480
+
+    def commit_settings(self, param: Parameter):
+        """Apply the consequences of a change of value in the detector settings
+
+        Parameters
+        ----------
+        param: Parameter
+            A given parameter (within detector_settings) whose value has been changed by the user
+        """
+        # TODO for your custom plugin
+        if param.name() == "resolution":
+            if param.value() == 'low':
+                self.controller.switch_mode(self.low_res_config)
+            else:
+                self.controller.switch_mode(self.high_res_config)
+        #elif ...
+
+    def ini_detector(self, controller=None):
+        """Detector communication initialization
+
+        Parameters
+        ----------
+        controller: (object)
+            custom object of a PyMoDAQ plugin (Slave case). None if only one actuator/detector by controller
+            (Master case)
+
+        Returns
+        -------
+        info: str
+        initialized: bool
+            False if initialization failed otherwise True
+        """
+        if self.is_master:
+            self.controller = Picamera2()
+        else:
+            self.controller = controller
+        
+        self.low_res_config = self.controller.create_preview_configuration()
+        self.high_res_config = self.controller.create_still_configuration()
+
+        self.controller.configure(self.low_res_config)
+        
+
+        logger.info(self.controller.camera_controls)
+        logger.info(self.controller.camera_properties)
+        #print(self.controller.capture_metadata())
+        self.controller.start()
+
+        info = "Whatever info you want to log"
+        initialized = True
+        return info, initialized
+
+    def close(self):
+        """Terminate the communication protocol"""
+        if self.controller is not None and self.is_master:
+            self.controller.close()
+
+    def grab_data(self, Naverage=1, **kwargs):
+        """Start a grab from the detector
+
+        Parameters
+        ----------
+        Naverage: int
+            Number of hardware averaging (if hardware averaging is possible, self.hardware_averaging should be set to
+            True in class preamble and you should code this implementation)
+        kwargs: dict
+            others optionals arguments
+        """
+
+        self.camera_done = False
+        self.Naverage = Naverage
+        if 'live' in kwargs:
+            self.live = kwargs['live']
+        else:
+            self.live = False
+        logger.debug(f'live: {self.live}')
+        if 'wait_time' in kwargs:
+            self.wait_time = kwargs['wait_time']
+            logger.debug(self.wait_time)
+            
+        self.grab(Naverage)
+            
+    def grab(self, Naverage):
+        for ind in range(Naverage):
+            array = self.controller.capture_array("main")
+            logger.debug(f'array shape: {array.shape}')
+            if len(array.shape) == 2:
+                arrays = [array]
+            elif len(array.shape) == 3:
+                arrays = [array[..., ind] for ind in range(3)] #alpha is with the last index equal to 4, we may skip it!
+            else:
+                raise ValueError(f'The array shape is {array.shape} and is not handled')
+            if ind == 0:
+                dwa_camera = DataFromPlugins('PiCamera', data=arrays)
+            else:
+                dwa_camera = dwa_camera.average(DataFromPlugins('PiCamera', data=arrays),
+                                                weight= ind+1)
+        self.dte_signal.emit(DataToExport('myplugin', data=[dwa_camera]))
+        
+
+    def stop(self):
+        """Stop the current grab hardware wise if necessary"""
+        self.live = False
+        return ''
+
+
+if __name__ == '__main__':
+    main(__file__, init=False)

pymodaq_plugins_raspberry/daq_viewer_plugins/plugins_ND/__init__.py

@@ -0,0 +1,13 @@
+import importlib
+from pathlib import Path
+from ... import set_logger
+logger = set_logger('viewerND_plugins', add_to_console=False)
+
+for path in Path(__file__).parent.iterdir():
+    try:
+        if '__init__' not in str(path):
+            importlib.import_module('.' + path.stem, __package__)
+    except Exception as e:
+        logger.warning("{:} plugin couldn't be loaded due to some missing packages or errors: {:}".format(path.stem, str(e)))
+        pass
+

pymodaq_plugins_raspberry/exporters/__init__.py

@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+"""
+Created the 01/06/2023
+
+@author: Sebastien Weber
+"""

pymodaq_plugins_raspberry/extensions/__init__.py

@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+"""
+Created the 01/06/2023
+
+@author: Sebastien Weber
+"""

pymodaq_plugins_raspberry/models/__init__.py

@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+"""
+Created the 01/06/2023
+
+@author: Sebastien Weber
+"""

pymodaq_plugins_raspberry/resources/config_template.toml

@@ -0,0 +1,2 @@
+#this is the configuration file of the plugin
+

pymodaq_plugins_raspberry/scanners/__init__.py

@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+"""
+Created the 01/06/2023
+
+@author: Sebastien Weber
+"""

pymodaq_plugins_raspberry/utils.py

@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+"""
+Created the 31/08/2023
+
+@author: Sebastien Weber
+"""
+from pathlib import Path
+
+from pymodaq_utils.config import BaseConfig, USER
+
+
+class Config(BaseConfig):
+    """Main class to deal with configuration values for this plugin"""
+    config_template_path = Path(__file__).parent.joinpath('resources/config_template.toml')
+    config_name = f"config_{__package__.split('pymodaq_plugins_')[1]}"

pymodaq_plugins_raspberry-5.0.1.dist-info/METADATA

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: pymodaq_plugins_raspberry
+Version: 5.0.1
+Summary: Set of instrument plugins to use with a raspberry
+Project-URL: Homepage, https://pymodaq.cnrs.fr
+Project-URL: Documentation , https://pymodaq.cnrs.fr
+Project-URL: Repository , https://github.com/PyMoDAQ/pymodaq_plugins_raspberry
+Author-email: Weber Sébastien <sebastien.weber@cnrs.fr>
+Maintainer-email: Weber Sébastien <sebastien.weber@cnrs.fr>
+License: The MIT License (MIT)
+        
+        Copyright (c) 2021 Sebastien Weber <sebastien.weber@cemes.fr>
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in
+        all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+        THE SOFTWARE.
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Python: >=3.8
+Requires-Dist: picamera2
+Requires-Dist: pymodaq>=5.0.0
+Description-Content-Type: text/x-rst
+
+Raspberry plugin
+################
+
+.. the following must be adapted to your developed package, links to pypi, github  description...
+
+.. image:: https://img.shields.io/pypi/v/pymodaq_plugins_raspberry.svg
+   :target: https://pypi.org/project/pymodaq_plugins_raspberry/
+   :alt: Latest Version
+
+.. image:: https://readthedocs.org/projects/pymodaq/badge/?version=latest
+   :target: https://pymodaq.readthedocs.io/en/stable/?badge=latest
+   :alt: Documentation Status
+
+.. image:: https://github.com/PyMoDAQ/pymodaq_plugins_raspberry/workflows/Upload%20Python%20Package/badge.svg
+   :target: https://github.com/PyMoDAQ/pymodaq_plugins_raspberry
+   :alt: Publication Status
+
+.. image:: https://github.com/PyMoDAQ/pymodaq_plugins_raspberry/actions/workflows/Test.yml/badge.svg
+    :target: https://github.com/PyMoDAQ/pymodaq_plugins_raspberry/actions/workflows/Test.yml
+
+
+Set of instrument plugins to be used from or on your Raspberry Pi
+
+Authors
+=======
+
+* Sebastien J. Weber  (sebastien.weber@cnrs.fr)
+
+
+Instruments
+===========
+
+Below is the list of instruments included in this plugin
+
+
+Viewer2D
+++++++++
+
+* **picamera**: control of the integrated pi camera using the Picamera2 library
+
+.. if needed use this field
+
+    PID Models
+    ==========
+
+
+    Extensions
+    ==========
+
+
+Installation instructions
+=========================
+
+* PyMoDAQ’s version >= 4
+* Tested on/with a raspberry pi 4
+

pymodaq_plugins_raspberry-5.0.1.dist-info/RECORD

@@ -0,0 +1,21 @@
+pymodaq_plugins_raspberry/__init__.py,sha256=u-fOvR0JC9f2mTbw9qWM5TjXEC7XbwQDgq7yrL1z-9w,304
+pymodaq_plugins_raspberry/utils.py,sha256=saBKehqiq5myeh7GCW1vYf5wq4QVYhSVLTxFK6KkdP4,419
+pymodaq_plugins_raspberry/daq_move_plugins/__init__.py,sha256=H-DnuGG6lezGyUjuhavlXRbzoQqzMbZaT3mfMNnAhHk,454
+pymodaq_plugins_raspberry/daq_viewer_plugins/__init__.py,sha256=ajz1GSNU9xYVrFEDSz6Xwg7amWQ_yvW75tQa1ZvRIWc,3
+pymodaq_plugins_raspberry/daq_viewer_plugins/plugins_0D/__init__.py,sha256=ooWW3pJyqQ8lk_bgXe8RXvCZLzl41Cm5gJxwSc-vaCc,459
+pymodaq_plugins_raspberry/daq_viewer_plugins/plugins_1D/__init__.py,sha256=R2Z_g54zfMJ16Kj3dA7MRj3TF8rjK8lWVAqwJ_yPYTA,459
+pymodaq_plugins_raspberry/daq_viewer_plugins/plugins_2D/__init__.py,sha256=U43pcyA6aNdltDFbW0TbxpQ2MWYJy3BW-dNucGTjoBc,460
+pymodaq_plugins_raspberry/daq_viewer_plugins/plugins_2D/daq_2Dviewer_PiCamera.py,sha256=DUGRDNo3V-cf_te29b5F824Mnl206t79UJOJX_l_msY,5804
+pymodaq_plugins_raspberry/daq_viewer_plugins/plugins_ND/__init__.py,sha256=AkMkmRCEIkEN8Jxnd0xFhmaTfLm-Sg95TozVstPsHLI,459
+pymodaq_plugins_raspberry/exporters/__init__.py,sha256=vqgY3SHF6EhPcfeS8lzb7QvAiTIXWmyObIaCYeJNb6Y,81
+pymodaq_plugins_raspberry/extensions/__init__.py,sha256=vqgY3SHF6EhPcfeS8lzb7QvAiTIXWmyObIaCYeJNb6Y,81
+pymodaq_plugins_raspberry/hardware/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pymodaq_plugins_raspberry/models/__init__.py,sha256=vqgY3SHF6EhPcfeS8lzb7QvAiTIXWmyObIaCYeJNb6Y,81
+pymodaq_plugins_raspberry/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pymodaq_plugins_raspberry/resources/config_template.toml,sha256=wJnPtBbfpOs5-AwGV4C4W3y9p4ZiyuARnJoUXUW97f4,47
+pymodaq_plugins_raspberry/scanners/__init__.py,sha256=vqgY3SHF6EhPcfeS8lzb7QvAiTIXWmyObIaCYeJNb6Y,81
+pymodaq_plugins_raspberry-5.0.1.dist-info/METADATA,sha256=fE1iByVgWIRJsVUVFoDZzC4G_cDd5pZ6oWoroUkG5fE,3946
+pymodaq_plugins_raspberry-5.0.1.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+pymodaq_plugins_raspberry-5.0.1.dist-info/entry_points.txt,sha256=kRsnQEzwHVJJIds1x4wpzYG-7rFXkOb13FxpgvIw4m4,117
+pymodaq_plugins_raspberry-5.0.1.dist-info/licenses/LICENSE,sha256=VKOejxexXAe3XwfhAhcFGqeXQ12irxVHdeAojZwFEI8,1108
+pymodaq_plugins_raspberry-5.0.1.dist-info/RECORD,,

pymodaq_plugins_raspberry-5.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pymodaq_plugins_raspberry-5.0.1.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[pymodaq.instruments]
+raspberry = pymodaq_plugins_raspberry
+
+[pymodaq.plugins]
+raspberry = pymodaq_plugins_raspberry

pymodaq_plugins_raspberry-5.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Sebastien Weber <sebastien.weber@cemes.fr>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.