djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
circuitpython/docs/library/pyb.LED.rst

47 lines
1.2 KiB
ReStructuredText
Raw Normal View History

docs/pyb.*: Add "currentmodule:: pyb" directive. Makes sure that classes described in these separate files are properly designated as belonging to "pyb" module in indexes.
2016-06-07 17:57:41 -04:00
.. currentmodule:: pyb
docs: Add links from quickref to pyb classes.
2014-11-04 13:25:20 -05:00
.. _pyb.LED:
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
class LED -- LED object
=======================
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-30 21:37:19 -04:00
The LED object controls an individual LED (Light Emitting Diode).
Constructors
------------
.. class:: pyb.LED(id)
Create an LED object associated with the given LED:
- ``id`` is the LED number, 1-4.
Methods
-------
docs/pyb.*: Use proper class case in method headers. Class designator will be used as is in indexes, so must match actual class name.
2016-06-08 09:21:28 -04:00
.. method:: LED.intensity([value])
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-30 21:37:19 -04:00
Get or set the LED intensity. Intensity ranges between 0 (off) and 255 (full on).
If no argument is given, return the LED intensity.
If an argument is given, set the LED intensity and return ``None``.
docs: Update to say that Timer(3) is free, and detail LED intensity.
2016-01-29 18:06:13 -05:00
*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.
docs/pyb.*: Use proper class case in method headers. Class designator will be used as is in indexes, so must match actual class name.
2016-06-08 09:21:28 -04:00
.. method:: LED.off()
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-30 21:37:19 -04:00
Turn the LED off.
docs/pyb.*: Use proper class case in method headers. Class designator will be used as is in indexes, so must match actual class name.
2016-06-08 09:21:28 -04:00
.. method:: LED.on()
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-30 21:37:19 -04:00
docs: Define more clearly the behaviour of LED methods. Addresses issue #1006.
2014-12-16 06:55:46 -05:00
Turn the LED on, to maximum intensity.
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-30 21:37:19 -04:00
docs/pyb.*: Use proper class case in method headers. Class designator will be used as is in indexes, so must match actual class name.
2016-06-08 09:21:28 -04:00
.. method:: LED.toggle()
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-30 21:37:19 -04:00
docs: Define more clearly the behaviour of LED methods. Addresses issue #1006.
2014-12-16 06:55:46 -05:00
Toggle the LED between on (maximum intensity) and off. If the LED is at
non-zero intensity then it is considered "on" and toggle will turn it off.