aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/millis.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
commit5e587be27a7c3bd854b686952a5c9637a2432ff0 (patch)
tree09d4ceeb46f19287ee874a24516c68be90c9ad8e /docs/source/lang/millis.rst
parentdb4ff6ba53e9b702c77411ae19cd53d914a675de (diff)
downloadlibrambutan-5e587be27a7c3bd854b686952a5c9637a2432ff0.tar.gz
librambutan-5e587be27a7c3bd854b686952a5c9637a2432ff0.zip
reorganized all the arduino/ docs into a lang/ subdirectory since
they're properly CC attributed now.
Diffstat (limited to 'docs/source/lang/millis.rst')
-rw-r--r--docs/source/lang/millis.rst70
1 files changed, 70 insertions, 0 deletions
diff --git a/docs/source/lang/millis.rst b/docs/source/lang/millis.rst
new file mode 100644
index 0000000..6ebfff5
--- /dev/null
+++ b/docs/source/lang/millis.rst
@@ -0,0 +1,70 @@
+.. _lang-millis:
+
+millis()
+========
+
+Description
+-----------
+
+Returns the number of milliseconds since the Arduino board began
+running the current program. This number will overflow (go back to
+zero), after approximately 50 days.
+
+
+
+Parameters
+----------
+
+None
+
+
+
+Returns
+-------
+
+Number of milliseconds since the program started (*unsigned long*)
+
+
+
+Example
+-------
+
+::
+
+ unsigned long time;
+
+ void setup(){
+ Serial.begin(9600);
+ }
+ void loop(){
+ Serial.print("Time: ");
+ time = millis();
+ //prints time since program started
+ Serial.println(time);
+ // wait a second so as not to send massive amounts of data
+ delay(1000);
+ }
+
+
+
+Tip:
+----
+
+Note that the parameter for millis is an unsigned long, errors may
+be generated if a programmer tries to do math with other datatypes
+such as ints.
+
+
+
+See also
+--------
+
+
+- `micros <http://arduino.cc/en/Reference/Micros>`_\ ()
+- `delay <http://arduino.cc/en/Reference/Delay>`_\ ()
+- `delayMicroseconds <http://arduino.cc/en/Reference/DelayMicroseconds>`_\ ()
+- `Tutorial: Blink Without Delay <http://arduino.cc/en/Tutorial/BlinkWithoutDelay>`_
+
+
+
+.. include:: cc-attribution.txt