time – time and timing related functions

The time module is a strict subset of the CPython time module. So, code written in MicroPython will work in CPython but not necessarily the other way around.

time.monotonic() → float

Returns an always increasing value of time with an unknown reference point. Only use it to compare against other values from monotonic.

Returns:the current monotonic time
Return type:float
time.sleep(seconds: float) → None

Sleep for a given number of seconds.

Parameters:seconds (float) – the time to sleep in fractional seconds
class time.struct_time(time_tuple: Tuple[int, int, int, int, int, int, int, int, int])

Structure used to capture a date and time. Note that it takes a tuple!

Parameters:time_tuple (tuple) –

Tuple of time info: (tm_year, tm_mon, tm_mday, tm_hour, tm_min, tm_sec, tm_wday, tm_yday, tm_isdst)

  • tm_year: the year, 2017 for example
  • tm_month: the month, range [1, 12]
  • tm_mday: the day of the month, range [1, 31]
  • tm_hour: the hour, range [0, 23]
  • tm_min: the minute, range [0, 59]
  • tm_sec: the second, range [0, 61]
  • tm_wday: the day of the week, range [0, 6], Monday is 0
  • tm_yday: the day of the year, range [1, 366], -1 indicates not known
  • tm_isdst: 1 when in daylight savings, 0 when not, -1 if unknown.
time.time() → int

Return the current time in seconds since since Jan 1, 1970.

Returns:the current time
Return type:int
time.monotonic_ns() → int

Return the time of the monotonic clock, cannot go backward, in nanoseconds.

Returns:the current time
Return type:int
time.localtime(secs: int) → struct_time

Convert a time expressed in seconds since Jan 1, 1970 to a struct_time in local time. If secs is not provided or None, the current time as returned by time() is used. The earliest date for which it can generate a time is Jan 1, 2000.

Returns:the current time
Return type:time.struct_time
time.mktime(t: struct_time) → int

This is the inverse function of localtime(). Its argument is the struct_time or full 9-tuple (since the dst flag is needed; use -1 as the dst flag if it is unknown) which expresses the time in local time, not UTC. The earliest date for which it can generate a time is Jan 1, 2000.

Return type:int