summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/machine.rst
diff options
context:
space:
mode:
authorDamien George <damien@micropython.org>2021-04-30 16:42:51 +1000
committerDamien George <damien@micropython.org>2021-04-30 16:42:51 +1000
commit9e1b25a99e9107619c6ed607c730ea2869582799 (patch)
tree4906504f67265339789e57d17e16350b12a61d31 /docs/library/machine.rst
parent6b7c8d3e7283a6c94687ba7dcb8beb94c2dc9eef (diff)
downloadmicropython-9e1b25a99e9107619c6ed607c730ea2869582799.tar.gz
micropython-9e1b25a99e9107619c6ed607c730ea2869582799.zip
docs/library/machine: Specify initial machine.PWM class.
This adds an initial specification of the machine.PWM class, to provide a way to generate PWM output that is portable across the different ports. Such functionality may already be available in one way or another (eg through a Timer object), but because configuring PWM via a Timer is very port-specific, and because it's a common thing to do, it's beneficial to have a top-level construct for it. The specification in this commit aims to provide core functionality in a minimal way. It also somewhat matches most existing ad-hoc implementations of machine.PWM. See discussion in #2283 and #4237. Signed-off-by: Damien George <damien@micropython.org>
Diffstat (limited to 'docs/library/machine.rst')
-rw-r--r--docs/library/machine.rst1
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/library/machine.rst b/docs/library/machine.rst
index 18dc6f2afa..5076dc30e0 100644
--- a/docs/library/machine.rst
+++ b/docs/library/machine.rst
@@ -167,6 +167,7 @@ Classes
machine.Pin.rst
machine.Signal.rst
machine.ADC.rst
+ machine.PWM.rst
machine.UART.rst
machine.SPI.rst
machine.I2C.rst