From 85c1c72db022bba891868afd3375e39dbe245701 Mon Sep 17 00:00:00 2001
From: Marti Bolivar <mbolivar@mit.edu>
Date: Wed, 20 Oct 2010 06:46:52 -0400
Subject: initial check-in of arduino docs in RST format (converted using
 wget+pandoc)

---
 source/arduino/micros.rst | 66 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 66 insertions(+)
 create mode 100644 source/arduino/micros.rst

(limited to 'source/arduino/micros.rst')

diff --git a/source/arduino/micros.rst b/source/arduino/micros.rst
new file mode 100644
index 0000000..cdee497
--- /dev/null
+++ b/source/arduino/micros.rst
@@ -0,0 +1,66 @@
+.. _arduino-micros:
+
+micros()
+========
+
+Description
+-----------
+
+Returns the number of microseconds since the Arduino board began
+running the current program. This number will overflow (go back to
+zero), after approximately 70 minutes. On 16 MHz Arduino boards
+(e.g. Duemilanove and Nano), this function has a resolution of four
+microseconds (i.e. the value returned is always a multiple of
+four). On 8 MHz Arduino boards (e.g. the LilyPad), this function
+has a resolution of eight microseconds.
+
+
+
+*Note*: there are 1,000 microseconds in a millisecond and 1,000,000
+microseconds in a second.
+
+
+
+Parameters
+----------
+
+None
+
+
+
+Returns
+-------
+
+Number of microseconds since the program started (*unsigned long*)
+
+
+
+Example
+-------
+
+::
+
+    unsigned long time;
+    
+    void setup(){
+      Serial.begin(9600);
+    }
+    void loop(){
+      Serial.print("Time: ");
+      time = micros();
+      //prints time since program started
+      Serial.println(time);
+      // wait a second so as not to send massive amounts of data
+      delay(1000);
+    }
+
+
+
+See also
+--------
+
+
+-  `millis <http://arduino.cc/en/Reference/Millis>`_\ ()
+-  `delay <http://arduino.cc/en/Reference/Delay>`_\ ()
+-  `delayMicroseconds <http://arduino.cc/en/Reference/DelayMicroseconds>`_\ ()
+
-- 
cgit v1.2.3