ADD Telemetrix ESP32 Features

README.rst

@@ -19,16 +19,17 @@ pymodaq_plugins_arduino
     :target: https://github.com/PyMoDAQ/pymodaq_plugins_arduino/actions/workflows/Test.yml
 
 
-This package regroups a list of instrument created around an arduino board. Some instruments use the
-Telemetrix library to use python together with the arduino board.
-
+This package regroups a list of instruments created around an Arduino or ESP32 board. Some
+instruments use the Telemetrix library to use Python together with the Arduino board. Others use the
+Telemetrix AIO ESP32 library to communicate with an ESP32 board over WiFi.
 
 Authors
 =======
 
 * Sebastien J. Weber  (sebastien.weber@cemes.fr)
 * Jérémie Margueritat
-
+* Mohamed El Mokhtari (mohamed.elmokhtari26@gmail.com)
+* Fabien Villedieu (fabien.villedieu.pro@gmail.com)
 
 Instruments
 ===========
@@ -40,24 +41,41 @@ Actuators
 
 * **LED**: control of a multicolor LED using three PWM digital outputs and the Telemetrix library.
   Allows the control of the three color channel independently
+
 * **LEDwithLCD**: same as **LED** actuator but displaying the red, green, blue values on a standard 16x2 liquid crystal
   display
-* **Analog**: data acquisition from analog inputs
 
+* **Servo**: control of a servo motor position (in degrees) on a digital pin using the Telemetrix
+  library
+
+* **Analog**: data acquisition from analog inputs
 
+* **FanHeater**: control of a heater and a fan using two PWM outputs and the Telemetrix AIO ESP32
+  library. Allows the control of the heater and fan independently over WiFi. The PWM duty cycle
+  ranges from 0 to 255 (8-bit resolution)
 
 Extensions
 ==========
 
-* **ColorSynthesizer**: DashBoard extension using RBG LED actuators. Allows to quicly select a RGB value and apply those
+* **ColorSynthesizer**: DashBoard extension using RBG LED actuators. Allows to quickly select a RGB value and apply those
   to the actuators
 
+Viewers
+=======
+
+* **Voltage_ADS1115**: reads up to four single-ended analog voltages (AIN0–AIN3) from an ADS1115
+  (16-bit) or ADS1015 (12-bit) I2C ADC. The PGA gain, data rate and number of active channels are
+  configurable. Communication is performed over I2C by an ESP32 running the Telemetrix AIO WiFi
+  firmware.
+
+* **Temperature MAX31865**: reads temperature from a PT100 resistance temperature detector (RTD) wired to a
+  MAX31865 amplifier/ADC board. Communication with the MAX31865 is performed over bit-banged SPI
+  by an ESP32 running the Telemetrix AIO WiFi firmware.
 
 Installation instructions
 =========================
 
-* PyMoDAQ version > 4.1.0
-
+* PyMoDAQ version > 5.0.0
 
 LED actuator
 ++++++++++++
@@ -75,12 +93,49 @@ I2C backpack. The functionalities used to drive the LCD are adapted from a micro
 (https://github.com/brainelectronics/micropython-i2c-lcd) itself adapted from
 https://github.com/fdebrabander/Arduino-LiquidCrystal-I2C-library
 
+Servo actuator
+++++++++++++++
+
+The **Servo** actuator uses the telemetrix library. The corresponding sketch should therefore be
+uploaded on the arduino board. This allows to drive a servo motor connected to a digital pin of the
+Arduino board, the position being commanded in degrees. See https://mryslab.github.io/telemetrix/
+
 Analog 0D viewer
 ++++++++++++++++
 
 The **Analog** 0D viewer uses the telemetrix library. The corresponding sketch should therefore be uploaded
 on the arduino board. This allows to acquire data from the analog inputs on an Arduino board from python objects on
 the connected computer. See https://mryslab.github.io/telemetrix/
 
+FanHeater actuator
+++++++++++++++++++
+
+The **FanHeater** actuator uses the telemetrix-aio-esp32 library. The corresponding firmware should
+therefore be uploaded on the ESP32 board. This allows to control a heater and a fan connected to
+the ESP32 over WiFi from python objects on the connected computer.
+See https://mryslab.github.io/telemetrix-esp32/
+
+Voltage_ADS1115 0D viewer
++++++++++++++++++++++++++
+
+The **Voltage_ADS1115** 0D viewer uses the telemetrix-aio-esp32 library. The corresponding firmware
+should therefore be uploaded on the ESP32 board. This allows to acquire analog voltages from an
+ADS1115/ADS1015 I2C ADC connected to the ESP32 over WiFi.
+See https://mryslab.github.io/telemetrix-esp32/
+
+Temperature MAX31865 0D viewer
++++++++++++++++
+
+The **Temperature MAX31865** 0D viewer uses the telemetrix-aio-esp32 library. The corresponding firmware should
+therefore be uploaded on the ESP32 board. This allows to acquire temperature data from a PT100
+sensor wired to a MAX31865 board connected to the ESP32 over WiFi.
+
 Here are `detailed installation instructions <https://pymodaq.cnrs.fr/en/latest/lab_story_folder/arduino_ubuntu.html#>`_.
 
+Wiki
+====
+
+Additional documentation for this fork is available on the dedicated Wiki:
+https://wiki-plugins-dap-pymodaq.github.io/
+
+

pyproject.toml

@@ -14,6 +14,7 @@ description = 'Set of instrument plugins implemented using an Arduino Board'
 dependencies = [
     "pymodaq>=5.0.0",
     'telemetrix',
+    'telemetrix-esp32>=2.1.1',
     'pyvisa',
     'pyvisa-py',
 

src/pymodaq_plugins_arduino/daq_move_plugins/daq_move_FanHeater.py

@@ -0,0 +1,149 @@
+from typing import Optional
+
+from pymodaq.control_modules.move_utility_classes import (DAQ_Move_base, comon_parameters_fun, main,
+                                                          DataActuatorType, DataActuator)
+from pymodaq_utils.utils import ThreadCommand
+from pymodaq_gui.parameter import Parameter
+
+from pymodaq_plugins_arduino.hardware.esp32_telemetrix import ArduinoWifi
+from pymodaq_plugins_arduino.utils import Config
+
+config = Config()
+
+
+class DAQ_Move_FanHeater(DAQ_Move_base):
+    """Instrument plugin class for the heater and fan actuators.
+
+    This object inherits all functionalities to communicate with PyMoDAQ's DAQ_Move module through
+    inheritance via DAQ_Move_base.  It makes a bridge between the DAQ_Move module and the Python
+    wrapper of a particular instrument.
+
+    Both actuators are driven by a XY-MOS PWM board connected to an ESP32 over WiFi using the
+    Telemetrix AIO protocol.  The PWM duty cycle ranges from 0 to 255 (8-bit resolution).
+
+        Heater
+        Fan    
+
+    Attributes:
+    -----------
+    controller: object
+        The particular object that allows communication with the hardware, in general a Python
+        wrapper around the hardware library.
+    """
+
+    _controller_units = '' # raw PWM level (0-255) unit depends on wired device
+    is_multiaxes = True
+    _axis_names = {
+        'Heater': config('esp32', 'pins', 'heater_pin'),
+        'Fan':    config('esp32', 'pins', 'fan_pin'),
+    }
+    _epsilon = 0.1
+    data_actuator_type = DataActuatorType['DataActuator']
+
+    params = [
+        {'title': 'IP Address:', 'name': 'ip_address', 'type': 'str',
+         'value': config('esp32', 'ip_address')},
+    ] + comon_parameters_fun(is_multiaxes, axis_names=_axis_names, epsilon=_epsilon)
+
+    def ini_attributes(self):
+        self.controller: Optional[ArduinoWifi] = None
+
+    def get_actuator_value(self):
+        """Get the current value from the hardware with scaling conversion.
+
+        Returns
+        -------
+        float: The position obtained after scaling conversion.
+        """
+        pos = DataActuator(data=self.controller.get_output_pin_value(self.axis_value), units=self.axis_unit)
+        pos = self.get_position_with_scaling(pos)
+        return pos
+
+    def close(self):
+        """Terminate the communication protocol"""
+        if self.is_master:
+            self.controller.set_pins_output_to(0)
+            self.controller.shutdown()
+
+    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
+        """
+        pass
+
+    def ini_stage(self, controller=None):
+        """Actuator communication initialization
+
+        Parameters
+        ----------
+        controller: (object)
+            custom object of a PyMoDAQ plugin (Slave case). None if only one actuator by controller
+            (Master case)
+
+        Returns
+        -------
+        info: str
+        initialized: bool
+            False if initialization failed otherwise True
+        """
+
+        if self.is_master:
+            self.controller = ArduinoWifi(
+                ip_address=self.settings['ip_address']
+            )
+            self.set_pins()
+        else:
+            self.controller = controller
+
+        info = "Heater and Fan ready"
+        initialized = True
+        return info, initialized
+
+    def set_pins(self):
+        """Configure every axis pin as a PWM output and reset it to 0."""
+        for pin in self._axis_names.values():
+            self.controller.set_pin_mode_analog_output(pin)
+            self.controller.analog_write_and_memorize(pin, 0)
+
+    def move_abs(self, value: DataActuator):
+        """Move the actuator to the absolute target defined by value
+
+        Parameters
+        ----------
+        value: (float) value of the absolute target positioning
+        """
+        value = self.check_bound(value)                  # apply user-defined bounds
+        self.target_value = value
+        value = self.set_position_with_scaling(value)    # apply scaling if the user specified one
+
+        self.controller.analog_write_and_memorize(self.axis_value, int(value.value(self.axis_unit)))
+
+    def move_rel(self, value: DataActuator):
+        """Move the actuator to the relative target actuator value defined by value
+
+        Parameters
+        ----------
+        value: (float) value of the relative target positioning
+        """
+        value = self.check_bound(self.current_position + value) - self.current_position
+        self.target_value = value + self.current_position
+        value = self.set_position_relative_with_scaling(value)
+
+        # PWM value is set in duty-cycle counts (0–255)
+        self.controller.analog_write_and_memorize(self.axis_value, int(self.target_value.value(self.axis_unit)))
+
+    def move_home(self):
+        """Call the reference method of the controller"""
+        self.controller.analog_write_and_memorize(self.axis_value, 0)
+
+    def stop_motion(self):
+        """Stop the actuator and emits move_done signal"""
+        pass
+
+
+if __name__ == '__main__':
+    main(__file__)