diff options
| author | Perry Hung <iperry@gmail.com> | 2011-01-24 23:23:29 -0500 | 
|---|---|---|
| committer | Perry Hung <iperry@gmail.com> | 2011-01-24 23:23:29 -0500 | 
| commit | c48689d34809943a5907884bd287cea9ae275352 (patch) | |
| tree | d49ff06b0d4b81f6ab0eac8060d178ce7542476c /docs/source/lang/api/micros.rst | |
| parent | 64431fd4b59cb8656365f1fad5f679cd4d756239 (diff) | |
| parent | a9b2d70bc7799ca96c1673b18fe3012b1a4dd329 (diff) | |
| download | librambutan-c48689d34809943a5907884bd287cea9ae275352.tar.gz librambutan-c48689d34809943a5907884bd287cea9ae275352.zip | |
Merge remote branch 'leaf/master'
Diffstat (limited to 'docs/source/lang/api/micros.rst')
| -rw-r--r-- | docs/source/lang/api/micros.rst | 46 | 
1 files changed, 46 insertions, 0 deletions
| diff --git a/docs/source/lang/api/micros.rst b/docs/source/lang/api/micros.rst new file mode 100644 index 0000000..f12976b --- /dev/null +++ b/docs/source/lang/api/micros.rst @@ -0,0 +1,46 @@ +.. highlight:: cpp + +.. _lang-micros: + +micros() +======== + +Returns the number of microseconds since the Maple board began running +the current program. This number will overflow (go back to zero), +after approximately 70 minutes. + +.. note:: There are 1,000 microseconds in a millisecond, and 1,000,000 +   microseconds in a second. + +Library Documentation +--------------------- + +.. doxygenfunction:: micros + +Example +------- + +:: + +    unsigned int time; + +    void setup() { +    } + +    void loop() { +      SerialUSB.print("Time: "); +      time = micros(); +      // prints time since program started +      SerialUSB.println(time); +      // wait a second so as not to send massive amounts of data +      delay(1000); +    } + +See Also +-------- + +-  :ref:`millis() <lang-millis>` +-  :ref:`delay() <lang-delay>` +-  :ref:`delayMicroseconds() <lang-delaymicroseconds>` + +.. include:: cc-attribution.txt | 
