aboutsummaryrefslogtreecommitdiffstats
path: root/source/arduino/delay.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@mit.edu>2010-11-28 11:23:33 -0500
committerMarti Bolivar <mbolivar@mit.edu>2010-11-28 11:23:33 -0500
commitd9cbd78e29d42e70bb46641dd43ee0772c8c975f (patch)
tree80a67cba4468dbcd89b3cd23ad56695b1f146c66 /source/arduino/delay.rst
parent546b34076d230b617ba86defb6b90cd934b01878 (diff)
downloadlibrambutan-d9cbd78e29d42e70bb46641dd43ee0772c8c975f.tar.gz
librambutan-d9cbd78e29d42e70bb46641dd43ee0772c8c975f.zip
reorganized all the arduino/ docs into a lang/ subdirectory since
they're properly CC attributed now.
Diffstat (limited to 'source/arduino/delay.rst')
-rw-r--r--source/arduino/delay.rst70
1 files changed, 0 insertions, 70 deletions
diff --git a/source/arduino/delay.rst b/source/arduino/delay.rst
deleted file mode 100644
index 64d78aa..0000000
--- a/source/arduino/delay.rst
+++ /dev/null
@@ -1,70 +0,0 @@
-.. highlight:: cpp
-
-.. _arduino-delay:
-
-delay()
-=======
-
-Pauses the program for at least a given number of milliseconds. (There
-are 1000 milliseconds in a second.)
-
-Library Documentation
----------------------
-
-.. doxygenfunction:: delay
-
-
-Discussion
-----------
-
-While it is easy to create a blinking LED with the ``delay()``
-function, and many sketches use short delays for such tasks as switch
-debouncing, the use of ``delay()`` in a sketch has significant
-drawbacks. No other reading of sensors, mathematical calculations, or
-pin manipulation can go on during the delay function, so in effect, it
-brings most other activity to a halt. For alternative approaches to
-controlling timing see the :ref:`millis() <arduino-millis>` function
-and the "Blink Without Delay" sketch cited :ref:`below
-<arduino-delay-seealso>`\ . More knowledgeable programmers usually
-avoid the use of ``delay()`` for timing of events longer than tens of
-milliseconds, unless the sketch is very simple.
-
-Certain things *do* go on while the ``delay()`` function is
-controlling the STM32 chip, however, because the delay function does
-not disable interrupts. Serial communication that appears at the RX
-pin is recorded, PWM (see :ref:`pwmWrite() <wirish-pwmwrite>`\ )
-values and pin states are maintained, and :ref:`interrupts
-<arduino-attachinterrupt>` will work as they should.
-
-
-Example
--------
-
-::
-
- int ledPin = 13; // LED connected to pin 13
-
- void setup() {
- pinMode(ledPin, OUTPUT); // sets the digital pin as output
- }
-
- void loop() {
- digitalWrite(ledPin, HIGH); // sets the LED on
- delay(1000); // waits for a second
- digitalWrite(ledPin, LOW); // sets the LED off
- delay(1000); // waits for a second
- }
-
-.. _arduino-delay-seealso:
-
-See also
---------
-
-
-- :ref:`millis() <arduino-millis>`
-- :ref:`micros() <arduino-micros>`
-- :ref:`delayMicroseconds() <arduino-delayMicroseconds>`
-- (Arduino) `Blink Without Delay <http://arduino.cc/en/Tutorial/BlinkWithoutDelay>`_ example (works unmodified on Maple)
-
-
-.. include:: cc-attribution.txt \ No newline at end of file