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 | 5606a05e2992043387a9cf995365db7e1dc83cff (patch) | |
tree | 163705188111e89e18f2325e7cb987672381bcb7 /source/lang/unimplemented | |
parent | 1b12488ce8b7c69968709b0c1c17975e519b0f5e (diff) | |
download | librambutan-5606a05e2992043387a9cf995365db7e1dc83cff.tar.gz librambutan-5606a05e2992043387a9cf995365db7e1dc83cff.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 'source/lang/unimplemented')
-rw-r--r-- | source/lang/unimplemented/notone.rst | 17 | ||||
-rw-r--r-- | source/lang/unimplemented/tone.rst | 27 |
2 files changed, 4 insertions, 40 deletions
diff --git a/source/lang/unimplemented/notone.rst b/source/lang/unimplemented/notone.rst index 485c9c5..8af878b 100644 --- a/source/lang/unimplemented/notone.rst +++ b/source/lang/unimplemented/notone.rst @@ -10,41 +10,28 @@ Stops the generation of a square wave triggered by `tone <http://arduino.cc/en/Reference/Tone>`_\ (). Has no effect if no tone is being generated. - - **NOTE:** if you want to play different pitches on multiple pins, you need to call noTone() on one pin before calling tone() on the next pin. - - Syntax ------ noTone(pin) - - Parameters ---------- pin: the pin on which to stop generating the tone - - Returns ------- -nothing - - +Nothing. -See also +See Also -------- - - `tone <http://arduino.cc/en/Reference/Tone>`_ () - - .. include:: /lang/cc-attribution.txt diff --git a/source/lang/unimplemented/tone.rst b/source/lang/unimplemented/tone.rst index f83bf6b..13d581e 100644 --- a/source/lang/unimplemented/tone.rst +++ b/source/lang/unimplemented/tone.rst @@ -12,70 +12,47 @@ continues until a call to `noTone <http://arduino.cc/en/Reference/NoTone>`_\ (). The pin can be connected to a piezo buzzer or other speaker to play tones. - - Only one tone can be generated at a time. If a tone is already playing on a different pin, the call to tone() will have no effect. If the tone is playing on the same pin, the call will set its frequency. - - Use of the tone() function will interfere with PWM output on pins 3 and 11 (on boards other than the Mega). - - **NOTE:** if you want to play different pitches on multiple pins, you need to call noTone() on one pin before calling tone() on the next pin. - - Syntax ------ tone(pin, frequency) tone(pin, frequency, duration) - - Parameters ---------- pin: the pin on which to generate the tone - - frequency: the frequency of the tone in hertz - - duration: the duration of the tone in milliseconds (optional) - - Returns ------- nothing - - -See also +See Also -------- - - `noTone <http://arduino.cc/en/Reference/NoTone>`_\ () - `analogWrite <http://arduino.cc/en/Reference/AnalogWrite>`_\ () - `Tutorial:Tone <http://arduino.cc/en/Tutorial/Tone>`_ - `Tutorial:Pitch follower <http://arduino.cc/en/Tutorial/Tone2>`_ - `Tutorial:Simple Keyboard <http://arduino.cc/en/Tutorial/Tone3>`_ - `Tutorial: multiple tones <http://arduino.cc/en/Tutorial/Tone4>`_ - - - `Tutorial: PWM <http://arduino.cc/en/Tutorial/PWM>`_ - - -.. include:: /lang/cc-attribution.txt +.. include:: /arduino-cc-attribution.txt |