diff options
| author | Marti Bolivar <mbolivar@leaflabs.com> | 2011-04-26 03:27:10 -0400 |
|---|---|---|
| committer | Marti Bolivar <mbolivar@leaflabs.com> | 2011-04-26 03:27:10 -0400 |
| commit | 1f98566c939c84a986ee8b60fde6aa601c3521da (patch) | |
| tree | 8a0069ca9758bf6f3952bd71bf1a7c149d161bc1 /docs/source/lang/api/pwmwrite.rst | |
| parent | 621706150fc55b8266229131cc7fb6db6b2f7cd9 (diff) | |
| download | librambutan-1f98566c939c84a986ee8b60fde6aa601c3521da.tar.gz librambutan-1f98566c939c84a986ee8b60fde6aa601c3521da.zip | |
0.0.10 Documentation checkpoint.
The vast majority of the Maple-specific values have been pulled out of
the higher-level overview pages and replaced with refs into documents
under /docs/source/hardware/.
Much of the work that's left to be done in this regard is labeled with
versioned TODO and FIXME comments.
Suggestions from StephenFromNYC and gbulmer were incorporated from
this forum thread:
http://forums.leaflabs.com/topic.php?id=703
Diffstat (limited to 'docs/source/lang/api/pwmwrite.rst')
| -rw-r--r-- | docs/source/lang/api/pwmwrite.rst | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/docs/source/lang/api/pwmwrite.rst b/docs/source/lang/api/pwmwrite.rst index cea602b..5cc112e 100644 --- a/docs/source/lang/api/pwmwrite.rst +++ b/docs/source/lang/api/pwmwrite.rst @@ -11,10 +11,13 @@ pwmWrite(), the pin will output a steady square wave with the given duty cycle. You can change the duty cycle later by calling pwmWrite() again with the same pin and a different duty. -.. FIXME board-specific information - -On the Maple, the pins which support PWM are: 0, 1, 2, 3, 5, 6, 7, 8, -9, 11, 12, 14, 24, 27, and 28. +The pins which support PWM have ``PWM`` listed underneath their number +on your board's silkscreen. These pin numbers are available to your +program in the :ref:`boardPWMPins <lang-board-values-pwm-pins>` +board-specific array. The number of pins which are capable of PWM on +your board is given by the ``BOARD_NR_PWM_PINS`` constant. These +values are documented for each board in the :ref:`Board Hardware +Documentation <index-boards>` pages. The Arduino function :ref:`analogWrite() <lang-analogwrite>` is an alias for ``pwmWrite()``, but it is badly named, and its use is @@ -54,4 +57,5 @@ potentiometer:: See Also -------- -- :ref:`Maple PWM tutorial <pwm>` +- :ref:`Maple PWM tutorial <pwm>` +- :ref:`boardPWMPins <lang-board-values-pwm-pins>` |