src/adafruit_blinka/microcontroller/generic_linux/sysfs_pwmout.py

   1 # Much code from https://github.com/vsergeev/python-periphery/blob/master/periphery/pwm.py
   2 # Copyright (c) 2015-2016 vsergeev / Ivan (Vanya) A. Sergeev
   3 # License: MIT
   4
   5 import os
   6 import digitalio
   7
   8 try:
   9     from microcontroller.pin import pwmOuts
  10 except ImportError:
  11     raise RuntimeError("No PWM outputs defined for this board")
  12
  13 class PWMError(IOError):
  14     """Base class for PWM errors."""
  15     pass
  16
  17
  18 class PWMOut(object):
  19     # Sysfs paths
  20     _sysfs_path = "/sys/class/pwm/"
  21     _channel_path = "pwmchip{}"
  22
  23     # Channel paths
  24     _export_path = "export"
  25     _unexport_path = "unexport"
  26     _pin_path = "pwm{}"
  27
  28     # Pin attribute paths
  29     _pin_period_path = "period"
  30     _pin_duty_cycle_path = "duty_cycle"
  31     _pin_polarity_path = "polarity"
  32     _pin_enable_path = "enable"
  33
  34     def __init__(self, pin, *, frequency=500, duty_cycle=0, variable_frequency=False):
  35         """Instantiate a PWM object and open the sysfs PWM corresponding to the
  36         specified channel and pin.
  37
  38         Args:
  39             pin (Pin): CircuitPython Pin object to output to
  40             duty_cycle (int) : The fraction of each pulse which is high. 16-bit
  41             frequency (int) : target frequency in Hertz (32-bit)
  42             variable_frequency (bool) : True if the frequency will change over time
  43
  44         Returns:
  45             PWMOut: PWMOut object.
  46
  47         Raises:
  48             PWMError: if an I/O or OS error occurs.
  49             TypeError: if `channel` or `pin` types are invalid.
  50             ValueError: if PWM channel does not exist.
  51
  52         """
  53
  54         self._pwmpin = None
  55         self._open(pin, duty_cycle, frequency, variable_frequency)
  56
  57     def __del__(self):
  58         self.close()
  59
  60     def __enter__(self):
  61         return self
  62
  63     def __exit__(self, t, value, traceback):
  64         self.close()
  65
  66     def _open(self, pin, duty=0, freq=500, variable_frequency=False):
  67         self._channel = None
  68         for pwmpair in pwmOuts:
  69             if pwmpair[1] == pin:
  70                 self._channel = pwmpair[0][0]
  71                 self._pwmpin = pwmpair[0][1]
  72
  73         self._pin = pin
  74         if self._channel is None:
  75             raise RuntimeError("No PWM channel found for this Pin")
  76
  77         channel_path = os.path.join(self._sysfs_path, self._channel_path.format(self._channel))
  78         if not os.path.isdir(channel_path):
  79             raise ValueError("PWM channel does not exist, check that the required modules are loaded.")
  80
  81         pin_path = os.path.join(channel_path, self._pin_path.format(self._pwmpin))
  82         try:
  83             with open(os.path.join(channel_path, self._unexport_path), "w") as f_unexport:
  84                 f_unexport.write("%d\n" % self._pwmpin)
  85         except IOError as e:
  86             pass # not unusual, it doesnt already exist
  87         try:
  88             with open(os.path.join(channel_path, self._export_path), "w") as f_export:
  89                 f_export.write("%d\n" % self._pwmpin)
  90         except IOError as e:
  91             raise PWMError(e.errno, "Exporting PWM pin: " + e.strerror)
  92
  93         self._set_enabled(False)
  94
  95         # Look up the period, for fast duty cycle updates
  96         self._period = self._get_period()
  97
  98         self.duty_cycle = 0
  99
 100         # set frequency
 101         self.frequency = freq
 102         # set duty
 103         self.duty_cycle = duty
 104
 105         self._set_enabled(True)
 106
 107     def close(self):
 108         """Close the sysfs PWM."""
 109         if self._channel is not None:
 110             self.duty_cycle = 0
 111             try:
 112                 channel_path = os.path.join(self._sysfs_path, self._channel_path.format(self._channel))
 113                 with open(os.path.join(channel_path, self._unexport_path), "w") as f_unexport:
 114                     f_unexport.write("%d\n" % self._pwmpin)
 115             except IOError as e:
 116                 raise PWMError(e.errno, "Unexporting PWM pin: " + e.strerror)
 117
 118         self._channel = None
 119         self._pwmpin = None
 120
 121     def _write_pin_attr(self, attr, value):
 122         path = os.path.join(
 123             self._sysfs_path,
 124             self._channel_path.format(self._channel),
 125             self._pin_path.format(self._pwmpin),
 126             attr)
 127
 128         with open(path, 'w') as f_attr:
 129             #print(value, path)
 130             f_attr.write(value + "\n")
 131
 132     def _read_pin_attr(self, attr):
 133         path = os.path.join(
 134             self._sysfs_path,
 135             self._channel_path.format(self._channel),
 136             self._pin_path.format(self._pwmpin),
 137             attr)
 138
 139         with open(path, 'r') as f_attr:
 140             return f_attr.read().strip()
 141
 142     # Mutable properties
 143
 144     def _get_period(self):
 145         try:
 146             period_ns = int(self._read_pin_attr(self._pin_period_path))
 147         except ValueError:
 148             raise PWMError(None, "Unknown period value: \"%s\"" % period_ns)
 149
 150         # Convert period from nanoseconds to seconds
 151         period = period_ns / 1e9
 152
 153         # Update our cached period
 154         self._period = period
 155
 156         return period
 157
 158     def _set_period(self, period):
 159         if not isinstance(period, (int, float)):
 160             raise TypeError("Invalid period type, should be int or float.")
 161
 162         # Convert period from seconds to integer nanoseconds
 163         period_ns = int(period * 1e9)
 164
 165         self._write_pin_attr(self._pin_period_path, "{}".format(period_ns))
 166
 167         # Update our cached period
 168         self._period = float(period)
 169
 170     """Get or set the PWM's output period in seconds.
 171
 172     Raises:
 173         PWMError: if an I/O or OS error occurs.
 174         TypeError: if value type is not int or float.
 175
 176     :type: int, float
 177     """
 178
 179     def _get_duty_cycle(self):
 180         try:
 181             duty_cycle_ns = int(self._read_pin_attr(self._pin_duty_cycle_path))
 182         except ValueError:
 183             raise PWMError(None, "Unknown duty cycle value: \"%s\"" % duty_cycle_ns)
 184
 185         # Convert duty cycle from nanoseconds to seconds
 186         duty_cycle = duty_cycle_ns / 1e9
 187
 188         # Convert duty cycle to ratio from 0.0 to 1.0
 189         duty_cycle = duty_cycle / self._period
 190
 191         # convert to 16-bit
 192         duty_cycle = int(duty_cycle * 65535)
 193         return duty_cycle
 194
 195     def _set_duty_cycle(self, duty_cycle):
 196         if not isinstance(duty_cycle, (int, float)):
 197             raise TypeError("Invalid duty cycle type, should be int or float.")
 198
 199         # convert from 16-bit
 200         duty_cycle /= 65535.0
 201         if not 0.0 <= duty_cycle <= 1.0:
 202             raise ValueError("Invalid duty cycle value, should be between 0.0 and 1.0.")
 203
 204         # Convert duty cycle from ratio to seconds
 205         duty_cycle = duty_cycle * self._period
 206
 207         # Convert duty cycle from seconds to integer nanoseconds
 208         duty_cycle_ns = int(duty_cycle * 1e9)
 209
 210         self._write_pin_attr(self._pin_duty_cycle_path, "{}".format(duty_cycle_ns))
 211
 212     duty_cycle = property(_get_duty_cycle, _set_duty_cycle)
 213     """Get or set the PWM's output duty cycle as a ratio from 0.0 to 1.0.
 214
 215     Raises:
 216         PWMError: if an I/O or OS error occurs.
 217         TypeError: if value type is not int or float.
 218         ValueError: if value is out of bounds of 0.0 to 1.0.
 219
 220     :type: int, float
 221     """
 222
 223     def _get_frequency(self):
 224         return 1.0 / self._get_period()
 225
 226     def _set_frequency(self, frequency):
 227         if not isinstance(frequency, (int, float)):
 228             raise TypeError("Invalid frequency type, should be int or float.")
 229
 230         self._set_period(1.0 / frequency)
 231
 232     frequency = property(_get_frequency, _set_frequency)
 233     """Get or set the PWM's output frequency in Hertz.
 234
 235     Raises:
 236         PWMError: if an I/O or OS error occurs.
 237         TypeError: if value type is not int or float.
 238
 239     :type: int, float
 240     """
 241
 242     def _get_enabled(self):
 243         enabled = self._read_pin_attr(self._pin_enable_path)
 244
 245         if enabled == "1":
 246             return True
 247         elif enabled == "0":
 248             return False
 249
 250         raise PWMError(None, "Unknown enabled value: \"%s\"" % enabled)
 251
 252     def _set_enabled(self, value):
 253         if not isinstance(value, bool):
 254             raise TypeError("Invalid enabled type, should be string.")
 255
 256         self._write_pin_attr(self._pin_enable_path, "1" if value else "0")
 257
 258     """Get or set the PWM's output enabled state.
 259
 260     Raises:
 261         PWMError: if an I/O or OS error occurs.
 262         TypeError: if value type is not bool.
 263
 264     :type: bool
 265     """
 266
 267     # String representation
 268
 269     def __str__(self):
 270         return "PWM%d, pin %s (freq=%f Hz, duty_cycle=%f%%)" % \
 271             (self._channel, self._pin, self.frequency, self.duty_cycle * 100,)