aboutsummaryrefslogtreecommitdiffstats
path: root/source/lang/api/millis.rst
blob: b6fbf557e7feb35022ba409815b400eb436f82ea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
.. highlight:: cpp

.. _lang-millis:

millis()
========

Returns the number of milliseconds since the Maple board began running
the current program. This number will overflow (go back to zero) after
approximately 50 days.

Library Documentation
---------------------

.. doxygenfunction:: millis

Example
-------

The following time prints the value returned by ``millis()`` roughly
once per second::

    unsigned int time;

    void setup() {
    }

    void loop() {
      SerialUSB.print("Time: ");
      time = millis();
      // prints time since program started
      SerialUSB.println(time);

      // wait a second so as not to send massive amounts of data
      delay(1000);
    }

Tip
---

Since the return value for ``millis()`` is an :ref:`unsigned long
<lang-unsignedlong>`, overflow errors may occur if you try to do math
with other data types, such as :ref:`chars <lang-char>`.

See Also
--------

- :ref:`micros <lang-micros>`
- :ref:`delay <lang-delay>`
- :ref:`delayMicroseconds <lang-delaymicroseconds>`

.. include:: /arduino-cc-attribution.txt