Skip to content

Commit d033757

Browse files
committed
updated info docstring; slight docstring formatting
1 parent bb69d5a commit d033757

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

adafruit_pca9685.py

+24-8
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,21 @@
3131
outputs for specific uses instead of generic duty_cycle adjustments.
3232
3333
* Author(s): Scott Shawcroft
34+
35+
Implementation Notes
36+
--------------------
37+
38+
**Hardware:**
39+
40+
* Adafruit `16-Channel 12-bit PWM/Servo Driver - I2C interface - PCA9685
41+
<https://www.adafruit.com/product/815>`_ (Product ID: 815)
42+
43+
**Software and Dependencies:**
44+
45+
* Adafruit CircuitPython firmware for the ESP8622 and M0-based boards:
46+
https://github.com/adafruit/circuitpython/releases
47+
* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
48+
* Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
3449
"""
3550

3651
__version__ = "0.0.0-auto.0"
@@ -89,16 +104,17 @@ def __getitem__(self, index):
89104
return self._channels[index]
90105

91106
class PCA9685:
92-
"""Initialise the PCA9685 chip at ``address`` on ``i2c_bus``.
107+
"""
108+
Initialise the PCA9685 chip at ``address`` on ``i2c_bus``.
93109
94-
The internal reference clock is 25mhz but may vary slightly with environmental conditions and
95-
manufacturing variances. Providing a more precise ``reference_clock_speed`` can improve the
96-
accuracy of the frequency and duty_cycle computations. See the ``calibration.py`` example for
97-
how to derive this value by measuring the resulting pulse widths.
110+
The internal reference clock is 25mhz but may vary slightly with environmental conditions and
111+
manufacturing variances. Providing a more precise ``reference_clock_speed`` can improve the
112+
accuracy of the frequency and duty_cycle computations. See the ``calibration.py`` example for
113+
how to derive this value by measuring the resulting pulse widths.
98114
99-
:param ~busio.I2C i2c_bus: The I2C bus which the PCA9685 is connected to.
100-
:param int address: The I2C address of the PCA9685.
101-
:param int reference_clock_speed: The frequency of the internal reference clock in Herz.
115+
:param ~busio.I2C i2c_bus: The I2C bus which the PCA9685 is connected to.
116+
:param int address: The I2C address of the PCA9685.
117+
:param int reference_clock_speed: The frequency of the internal reference clock in Herz.
102118
"""
103119
# Registers:
104120
mode1_reg = UnaryStruct(0x00, '<B')

0 commit comments

Comments
 (0)