starting a new instrument plugin for my monochromator

copied from template

Author: seb5g

setup.py

@@ -6,7 +6,17 @@
 from pymodaq_utils.utils import ThreadCommand  # object used to send info back to the main thread
 from pymodaq_gui.parameter import Parameter
 
-from pymodaq_plugins_teaching.hardware.spectrometer import Spectrometer
+#  TODO:
+#  Replace the following fake import with the import of the real Python wrapper of your instrument. Here we suppose that
+#  the wrapper is in the hardware directory, but it could come from an external librairy like pylablib or pymeasure.
+from pymodaq_plugins_template.hardware.python_wrapper_file_of_your_instrument import PythonWrapperObjectOfYourInstrument
+
+# TODO:
+# (1) change the name of the following class to DAQ_Move_TheNameOfYourChoice
+# (2) change the name of this file to daq_move_TheNameOfYourChoice ("TheNameOfYourChoice" should be the SAME
+#     for the class name and the file name.)
+# (3) this file should then be put into the right folder, namely IN THE FOLDER OF THE PLUGIN YOU ARE DEVELOPING:
+#     pymodaq_plugins_my_plugin/daq_move_plugins
 
 
 class DAQ_Move_Monochromator(DAQ_Move_base):
@@ -33,7 +43,7 @@ class DAQ_Move_Monochromator(DAQ_Move_base):
     """
     is_multiaxes = False  # TODO for your plugin set to True if this plugin is controlled for a multiaxis controller
     _axis_names: Union[List[str], Dict[str, int]] = ['Axis1', 'Axis2']  # TODO for your plugin: complete the list
-    _controller_units: Union[str, List[str]] = 'nm'  # TODO for your plugin: put the correct unit here, it could be
+    _controller_units: Union[str, List[str]] = 'mm'  # TODO for your plugin: put the correct unit here, it could be
     # TODO  a single str (the same one is applied to all axes) or a list of str (as much as the number of axes)
     _epsilon: Union[float, List[float]] = 0.1  # TODO replace this by a value that is correct depending on your controller
     # TODO it could be a single float of a list of float (as much as the number of axes)
@@ -46,7 +56,12 @@ class DAQ_Move_Monochromator(DAQ_Move_base):
     # the target value. It is the developer responsibility to put here a meaningful value
 
     def ini_attributes(self):
-        self.controller: Spectrometer = None
+        #  TODO declare the type of the wrapper (and assign it to self.controller) you're going to use for easy
+        #  autocompletion
+        self.controller: PythonWrapperObjectOfYourInstrument = None
+
+        #TODO declare here attributes you want/need to init with a default value
+        pass
 
     def get_actuator_value(self):
         """Get the current value from the hardware with scaling conversion.
@@ -55,7 +70,9 @@ def get_actuator_value(self):
         -------
         float: The position obtained after scaling conversion.
         """
-        pos = DataActuator(data=self.controller.get_wavelength(),  # when writing your own plugin replace this line
+        ## TODO for your custom plugin
+        raise NotImplementedError  # when writing your own plugin remove this line
+        pos = DataActuator(data=self.controller.your_method_to_get_the_actuator_value(),  # when writing your own plugin replace this line
                            units=self.axis_unit)
         pos = self.get_position_with_scaling(pos)
         return pos
@@ -76,9 +93,11 @@ def user_condition_to_reach_target(self) -> bool:
 
     def close(self):
         """Terminate the communication protocol"""
-
+        ## TODO for your custom plugin
+        raise NotImplementedError  # when writing your own plugin remove this line
         if self.is_master:
-            self.controller.close_communication()
+            #  self.controller.your_method_to_terminate_the_communication()  # when writing your own plugin replace this line
+            ...
 
     def commit_settings(self, param: Parameter):
         """Apply the consequences of a change of value in the detector settings
@@ -114,9 +133,12 @@ def ini_stage(self, controller=None):
         initialized: bool
             False if initialization failed otherwise True
         """
+        raise NotImplementedError  # TODO when writing your own plugin remove this line and modify the ones below
         if self.is_master:  # is needed when controller is master
-            self.controller = Spectrometer()
-            initialized = self.controller.open_communication()
+            self.controller = PythonWrapperObjectOfYourInstrument(arg1, arg2, ...) #  arguments for instantiation!)
+            initialized = self.controller.a_method_or_atttribute_to_check_if_init()  # todo
+            # todo: enter here whatever is needed for your controller initialization and eventual
+            #  opening of the communication channel
         else:
             self.controller = controller
             initialized = True
@@ -135,7 +157,9 @@ def move_abs(self, value: DataActuator):
         value = self.check_bound(value)  #if user checked bounds, the defined bounds are applied here
         self.target_value = value
         value = self.set_position_with_scaling(value)  # apply scaling if the user specified one
-        self.controller.set_wavelength(value.value(self.axis_unit))  # when writing your own plugin replace this line
+        ## TODO for your custom plugin
+        raise NotImplementedError  # when writing your own plugin remove this line
+        self.controller.your_method_to_set_an_absolute_value(value.value(self.axis_unit))  # when writing your own plugin replace this line
         self.emit_status(ThreadCommand('Update_Status', ['Some info you want to log']))
 
     def move_rel(self, value: DataActuator):
@@ -149,20 +173,25 @@ def move_rel(self, value: DataActuator):
         self.target_value = value + self.current_position
         value = self.set_position_relative_with_scaling(value)
 
-        self.controller.set_wavelength(value.value(self.axis_unit),
-                                       set_type='rel')  # when writing your own plugin replace this line
+        ## TODO for your custom plugin
+        raise NotImplementedError  # when writing your own plugin remove this line
+        self.controller.your_method_to_set_a_relative_value(value.value(self.axis_unit))  # when writing your own plugin replace this line
         self.emit_status(ThreadCommand('Update_Status', ['Some info you want to log']))
 
     def move_home(self):
         """Call the reference method of the controller"""
 
-        self.controller.find_reference()  # when writing your own plugin replace this line
+        ## TODO for your custom plugin
+        raise NotImplementedError  # when writing your own plugin remove this line
+        self.controller.your_method_to_get_to_a_known_reference()  # when writing your own plugin replace this line
         self.emit_status(ThreadCommand('Update_Status', ['Some info you want to log']))
 
     def stop_motion(self):
         """Stop the actuator and emits move_done signal"""
 
-        self.controller.stop()  # when writing your own plugin replace this line
+        ## TODO for your custom plugin
+        raise NotImplementedError  # when writing your own plugin remove this line
+        self.controller.your_method_to_stop_positioning()  # when writing your own plugin replace this line
         self.emit_status(ThreadCommand('Update_Status', ['Some info you want to log']))