aboutsummaryrefslogtreecommitdiffstats
path: root/source/lang/delaymicroseconds.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@mit.edu>2010-12-03 20:18:00 -0500
committerMarti Bolivar <mbolivar@mit.edu>2010-12-03 20:18:00 -0500
commit210f3d2b1555bae87c9de27ea145e16d3bddb0f8 (patch)
tree5e409fff948c9a1847d08e5ec34f905ea2212956 /source/lang/delaymicroseconds.rst
parent11573d0fca18ef2ccd965ab67d419afd48b7cef2 (diff)
downloadlibrambutan-210f3d2b1555bae87c9de27ea145e16d3bddb0f8.tar.gz
librambutan-210f3d2b1555bae87c9de27ea145e16d3bddb0f8.zip
cleaning up previous commits.
note that addition of new files under docs/source/lang/api and docs/source/lang/cpp which were just copies of files in docs/source/lang/ imply that change history is lost to git.
Diffstat (limited to 'source/lang/delaymicroseconds.rst')
-rw-r--r--source/lang/delaymicroseconds.rst65
1 files changed, 0 insertions, 65 deletions
diff --git a/source/lang/delaymicroseconds.rst b/source/lang/delaymicroseconds.rst
deleted file mode 100644
index 24a8286..0000000
--- a/source/lang/delaymicroseconds.rst
+++ /dev/null
@@ -1,65 +0,0 @@
-.. highlight:: cpp
-
-.. _lang-delaymicroseconds:
-
-delayMicroseconds()
-===================
-
-Pauses the program for the amount of time (in microseconds)
-specified as parameter. There are a thousand microseconds in a
-millisecond, and a million microseconds in a second.
-
-Library Documentation
----------------------
-
-.. doxygenfunction:: delayMicroseconds
-
-
-Example
--------
-
-The following example configures pin number 8 to work as an output
-pin, and sends a train of pulses with a period of roughly 100
-microseconds::
-
- int outPin = 8;
-
- void setup() {
- pinMode(outPin, OUTPUT); // sets the digital pin as output
- }
-
- void loop() {
- digitalWrite(outPin, HIGH); // sets the pin on
- delayMicroseconds(50); // pauses for 50 microseconds
- digitalWrite(outPin, LOW); // sets the pin off
- delayMicroseconds(50); // pauses for 50 microseconds
- }
-
-
-Caveats and Known Issues
-------------------------
-
-The longest time ``delayMicroseconds()`` can delay is bounded by its
-argument type and the STM32 clock rate to be (2^32 - 1) / 12
-microseconds, or less than 6 minutes. For longer pauses, use of
-:ref:`lang-delay` is possible.
-
-Arduino Compatibility
----------------------
-
-While we have made every effort we could to ensure that the timing of
-delayMicroseconds is as accurate as possible, we cannot guarantee it
-will behave as the Arduino implementation down to the microsecond,
-especially for smaller values of ``us``.
-
-See Also
---------
-
-- :ref:`millis <lang-millis>`
-- :ref:`micros <lang-micros>`
-- :ref:`delay <lang-delay>`
-
-
-
-
-.. include:: cc-attribution.txt