src/adafruit_blinka/microcontroller/nova/pwmout.py

   1 """PWMOut Class for Binho Nova"""
   2
   3 try:
   4     from microcontroller.pin import pwmOuts
   5 except ImportError:
   6     raise RuntimeError("No PWM outputs defined for this board")
   7
   8 from microcontroller.pin import Pin
   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     # Nova instance
  25     _nova = None
  26     MAX_CYCLE_LEVEL = 1024
  27
  28     def __init__(self, pin, *, frequency=750, duty_cycle=0, variable_frequency=False):
  29         """Instantiate a PWM object and open the sysfs PWM corresponding to the
  30         specified channel and pin.
  31
  32         Args:
  33             pin (Pin): CircuitPython Pin object to output to
  34             duty_cycle (int) : The fraction of each pulse which is high. 16-bit
  35             frequency (int) : target frequency in Hertz (32-bit)
  36             variable_frequency (bool) : True if the frequency will change over time
  37
  38         Returns:
  39             PWMOut: PWMOut object.
  40
  41         Raises:
  42             PWMError: if an I/O or OS error occurs.
  43             TypeError: if `channel` or `pin` types are invalid.
  44             ValueError: if PWM channel does not exist.
  45
  46         """
  47         if PWMOut._nova is None:
  48             # pylint: disable=import-outside-toplevel
  49             from adafruit_blinka.microcontroller.nova import Connection
  50
  51             # pylint: enable=import-outside-toplevel
  52
  53             PWMOut._nova = Connection.getInstance()
  54
  55         PWMOut._nova.setOperationMode(0, "IO")
  56         self._pwmpin = None
  57         self._channel = None
  58         self._enable = False
  59         self._open(pin, duty_cycle, frequency, variable_frequency)
  60
  61     def __del__(self):
  62         self.deinit()
  63
  64     def __enter__(self):
  65         return self
  66
  67     def __exit__(self, t, value, traceback):
  68         self.deinit()
  69
  70     def _open(self, pin, duty=0, freq=750, variable_frequency=False):
  71         self._channel = None
  72         for pwmpair in pwmOuts:
  73             if pwmpair[1] == pin:
  74                 self._channel = pwmpair[0][0]
  75                 self._pwmpin = pwmpair[0][1]
  76
  77         self._pin = pin
  78         if self._channel is None:
  79             raise RuntimeError("No PWM channel found for this Pin")
  80
  81         PWMOut._nova.setIOpinMode(self._pwmpin, Pin.PWM)
  82
  83         # set frequency
  84         self.frequency = freq
  85         # set period
  86         self._period = self._get_period()
  87
  88         # set duty
  89         self.duty_cycle = duty
  90
  91         self._set_enabled(True)
  92
  93     def deinit(self):
  94         """Deinit the Nova PWM."""
  95         # pylint: disable=broad-except
  96         try:
  97             if self._channel is not None:
  98                 # self.duty_cycle = 0
  99                 self._set_enabled(False)  # make to disable before unexport
 100
 101         except Exception as e:
 102             # due to a race condition for which I have not yet been
 103             # able to find the root cause, deinit() often fails
 104             # but it does not effect future usage of the pwm pin
 105             print(
 106                 "warning: failed to deinitialize pwm pin {0}:{1} due to: {2}\n".format(
 107                     self._channel, self._pwmpin, type(e).__name__
 108                 )
 109             )
 110         finally:
 111             self._channel = None
 112             self._pwmpin = None
 113         # pylint: enable=broad-except
 114
 115     def _is_deinited(self):
 116         if self._pwmpin is None:
 117             raise ValueError(
 118                 "Object has been deinitialize and can no longer "
 119                 "be used. Create a new object."
 120             )
 121
 122     # Mutable properties
 123
 124     def _get_period(self):
 125         return 1.0 / self._get_frequency()
 126
 127     def _set_period(self, period):
 128         if not isinstance(period, (int, float)):
 129             raise TypeError("Invalid period type, should be int or float.")
 130
 131         self._set_frequency(1.0 / period)
 132
 133     period = property(_get_period, _set_period)
 134
 135     """Get or set the PWM's output period in seconds.
 136
 137     Raises:
 138         PWMError: if an I/O or OS error occurs.
 139         TypeError: if value type is not int or float.
 140
 141     :type: int, float
 142     """
 143
 144     def _get_duty_cycle(self):
 145         duty_cycle = Pin._nova.getIOpinValue(self._pwmpin)
 146
 147         # Convert duty cycle to ratio from 0.0 to 1.0
 148         duty_cycle = duty_cycle / PWMOut.MAX_CYCLE_LEVEL
 149
 150         # convert to 16-bit
 151         duty_cycle = int(duty_cycle * 65535)
 152         return duty_cycle
 153
 154     def _set_duty_cycle(self, duty_cycle):
 155         if not isinstance(duty_cycle, (int, float)):
 156             raise TypeError("Invalid duty cycle type, should be int or float.")
 157
 158         # convert from 16-bit
 159         duty_cycle /= 65535.0
 160         if not 0.0 <= duty_cycle <= 1.0:
 161             raise ValueError("Invalid duty cycle value, should be between 0.0 and 1.0.")
 162
 163         # Convert duty cycle from ratio to 1024 levels
 164         duty_cycle = duty_cycle * PWMOut.MAX_CYCLE_LEVEL
 165
 166         # Set duty cycle
 167         # pylint: disable=protected-access
 168         Pin._nova.setIOpinValue(self._pwmpin, duty_cycle)
 169         # pylint: enable=protected-access
 170
 171     duty_cycle = property(_get_duty_cycle, _set_duty_cycle)
 172     """Get or set the PWM's output duty cycle as a ratio from 0.0 to 1.0.
 173
 174     Raises:
 175         PWMError: if an I/O or OS error occurs.
 176         TypeError: if value type is not int or float.
 177         ValueError: if value is out of bounds of 0.0 to 1.0.
 178
 179     :type: int, float
 180     """
 181
 182     def _get_frequency(self):
 183         return int(PWMOut._nova.getIOpinPWMFreq(self._pwmpin).split("PWMFREQ ")[1])
 184
 185     def _set_frequency(self, frequency):
 186         if not isinstance(frequency, (int, float)):
 187             raise TypeError("Invalid frequency type, should be int or float.")
 188
 189         PWMOut._nova.setIOpinPWMFreq(self._pwmpin, frequency)
 190
 191     frequency = property(_get_frequency, _set_frequency)
 192     """Get or set the PWM's output frequency in Hertz.
 193
 194     Raises:
 195         PWMError: if an I/O or OS error occurs.
 196         TypeError: if value type is not int or float.
 197
 198     :type: int, float
 199     """
 200
 201     def _get_enabled(self):
 202         enabled = self._enable
 203
 204         if enabled == "1":
 205             return True
 206         if enabled == "0":
 207             return False
 208
 209         raise PWMError(None, 'Unknown enabled value: "%s"' % enabled)
 210
 211     def _set_enabled(self, value):
 212         """Get or set the PWM's output enabled state.
 213
 214         Raises:
 215             PWMError: if an I/O or OS error occurs.
 216             TypeError: if value type is not bool.
 217
 218         :type: bool
 219         """
 220         if not isinstance(value, bool):
 221             raise TypeError("Invalid enabled type, should be string.")
 222         self._enable = value
 223         if not self._enable:
 224             self._set_duty_cycle(0.0)
 225
 226     # String representation
 227
 228     def __str__(self):
 229         return "PWM%d, pin %s (freq=%f Hz, duty_cycle=%f%%)" % (
 230             self._pin,
 231             self._pin,
 232             self.frequency,
 233             self.duty_cycle * 100,
 234         )