src/adafruit_blinka/microcontroller/starfive/JH7110/pwmio/PWMOut.py

   1 # SPDX-FileCopyrightText: 2024 Vladimir Shtarev
   2 #
   3 # SPDX-License-Identifier: MIT
   4 """Custom PWMOut Wrapper for VisionFive.GPIO PWM Class"""
   5
   6 import VisionFive.gpio as GPIO
   7
   8 GPIO.setmode(GPIO.Board)
   9
  10
  11 # pylint: disable=unnecessary-pass
  12 class PWMError(IOError):
  13     """Base class for PWM errors."""
  14
  15     pass
  16
  17
  18 # pylint: enable=unnecessary-pass
  19
  20
  21 class PWMOut:
  22     """Pulse Width Modulation Output Class"""
  23
  24     def __init__(self, pin, *, frequency=500, duty_cycle=0, variable_frequency=False):
  25         self._pwmpin = None
  26         self._period = 0
  27         self._open(pin, duty_cycle, frequency, variable_frequency)
  28
  29     def __del__(self):
  30         self.deinit()
  31
  32     def __enter__(self):
  33         return self
  34
  35     def __exit__(self, t, value, traceback):
  36         self.deinit()
  37
  38     def _open(self, pin, duty=0, freq=500, variable_frequency=True):
  39         self._pin = pin
  40         GPIO.setup(pin.id, GPIO.OUT)
  41         self._pwmpin = GPIO.PWM(pin.id, freq)
  42
  43         if variable_frequency:
  44             print("Variable Frequency is not supported, continuing without it...")
  45
  46         # set frequency
  47         self.frequency = freq
  48         # set duty
  49         self.duty_cycle = duty
  50
  51         self.enabled = True
  52
  53     def deinit(self):
  54         """Deinit the PWM."""
  55         if self._pwmpin is not None:
  56             self._pwmpin.stop()
  57             GPIO.cleanup(self._pin.id)
  58             self._pwmpin = None
  59
  60     def _is_deinited(self):
  61         if self._pwmpin is None:
  62             raise ValueError(
  63                 "Object has been deinitialize and can no longer "
  64                 "be used. Create a new object."
  65             )
  66
  67     @property
  68     def period(self):
  69         """Get or set the PWM's output period in seconds.
  70
  71         Raises:
  72             PWMError: if an I/O or OS error occurs.
  73             TypeError: if value type is not int or float.
  74
  75         :type: int, float
  76         """
  77         return 1.0 / self.frequency
  78
  79     @period.setter
  80     def period(self, period):
  81         if not isinstance(period, (int, float)):
  82             raise TypeError("Invalid period type, should be int or float.")
  83
  84         self.frequency = 1.0 / period
  85
  86     @property
  87     def duty_cycle(self):
  88         """Get or set the PWM's output duty cycle which is the fraction of
  89         each pulse which is high.
  90
  91         Raises:
  92             PWMError: if an I/O or OS error occurs.
  93             TypeError: if value type is not int or float.
  94             ValueError: if value is out of bounds of 0.0 to 100.0.
  95
  96         :type: int, float
  97         """
  98         return int(self._duty_cycle)
  99
 100     @duty_cycle.setter
 101     def duty_cycle(self, duty_cycle):
 102         if not isinstance(duty_cycle, (int, float)):
 103             raise TypeError("Invalid duty cycle type, should be int or float.")
 104
 105         if not 0 <= duty_cycle <= 100:
 106             raise ValueError(
 107                 "Invalid duty cycle value, should be between 0.0 and 100.0"
 108             )
 109
 110         self._duty_cycle = duty_cycle
 111         self._pwmpin.ChangeDutyCycle(round(self._duty_cycle))
 112
 113     @property
 114     def frequency(self):
 115         """Get or set the PWM's output frequency in Hertz.
 116
 117         Raises:
 118             PWMError: if an I/O or OS error occurs.
 119             TypeError: if value type is not int or float.
 120
 121         :type: int, float
 122         """
 123
 124         return self._frequency
 125
 126     @frequency.setter
 127     def frequency(self, frequency):
 128         if not isinstance(frequency, (int, float)):
 129             raise TypeError("Invalid frequency type, should be int or float.")
 130
 131         self._pwmpin.ChangeFrequency(round(frequency))
 132         self._frequency = frequency
 133
 134     @property
 135     def enabled(self):
 136         """Get or set the PWM's output enabled state.
 137
 138         Raises:
 139             PWMError: if an I/O or OS error occurs.
 140             TypeError: if value type is not bool.
 141
 142         :type: bool
 143         """
 144         return self._enabled
 145
 146     @enabled.setter
 147     def enabled(self, value):
 148         if not isinstance(value, bool):
 149             raise TypeError("Invalid enabled type, should be string.")
 150
 151         if value:
 152             self._pwmpin.start(round(self._duty_cycle * 100))
 153         else:
 154             self._pwmpin.stop()
 155
 156         self._enabled = value
 157
 158     # String representation
 159     def __str__(self):
 160         return "pin %s (freq=%f Hz, duty_cycle=%f%%)" % (
 161             self._pin,
 162             self.frequency,
 163             self.duty_cycle,
 164         )