summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/pyb.LED.rst
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2016-01-29 23:06:13 +0000
committerDamien George <damien.p.george@gmail.com>2016-01-29 23:06:13 +0000
commit0f87a010e331c42fe020ad2803e5a1b67065b87a (patch)
tree65a3d3d0ade3350f6823284c9d43ace30f37dc9d /docs/library/pyb.LED.rst
parenta8a4b01af6501ff7ab61b251fc30fcf8a286f8d1 (diff)
downloadmicropython-0f87a010e331c42fe020ad2803e5a1b67065b87a.tar.gz
micropython-0f87a010e331c42fe020ad2803e5a1b67065b87a.zip
docs: Update to say that Timer(3) is free, and detail LED intensity.
Diffstat (limited to 'docs/library/pyb.LED.rst')
-rw-r--r--docs/library/pyb.LED.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/library/pyb.LED.rst b/docs/library/pyb.LED.rst
index 461ea57d31..aeeb75b8f1 100644
--- a/docs/library/pyb.LED.rst
+++ b/docs/library/pyb.LED.rst
@@ -25,6 +25,12 @@ Methods
If no argument is given, return the LED intensity.
If an argument is given, set the LED intensity and return ``None``.
+ *Note:* Only LED(3) and LED(4) can have a smoothly varying intensity, and
+ they use timer PWM to implement it. LED(3) uses Timer(2) and LED(4) uses
+ Timer(3). These timers are only configured for PWM if the intensity of the
+ relevant LED is set to a value between 1 and 254. Otherwise the timers are
+ free for general purpose use.
+
.. method:: led.off()
Turn the LED off.