mirrors
/
micropython
mirror of https://github.com/micropython/micropython.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
micropython/docs/library/time.rst

50 lines
1.3 KiB
ReStructuredText
Raw Normal View History

docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
:mod:`time` -- time related functions
=====================================
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
.. module:: time
:synopsis: time related functions
The ``time`` module provides functions for getting the current time and date,
and for sleeping.
Functions
---------
.. function:: localtime([secs])
Convert a time expressed in seconds since Jan 1, 2000 into an 8-tuple which
contains: (year, month, mday, hour, minute, second, weekday, yearday)
If secs is not provided or None, then the current time from the RTC is used.
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
year includes the century (for example 2014).
* month is 1-12
* mday is 1-31
* hour is 0-23
* minute is 0-59
* second is 0-59
* weekday is 0-6 for Mon-Sun
* yearday is 1-366
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
.. function:: mktime()
This is inverse function of localtime. It's argument is a full 8-tuple
which expresses a time as per localtime. It returns an integer which is
the number of seconds since Jan 1, 2000.
docs: Add initial draft documentation for the WiPy. This makes all common files "port-aware" using the .. only directive.
2015-06-10 22:29:56 +01:00
.. only:: port_pyboard
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
docs: Add initial draft documentation for the WiPy. This makes all common files "port-aware" using the .. only directive.
2015-06-10 22:29:56 +01:00
.. function:: sleep(seconds)
Sleep for the given number of seconds. Seconds can be a floating-point number to
sleep for a fractional number of seconds.
cc3200: time.sleep() now receives seconds, like CPython.
2015-07-02 16:23:22 +01:00
.. only:: port_esp8266 or port_wipy
docs: Add initial draft documentation for the WiPy. This makes all common files "port-aware" using the .. only directive.
2015-06-10 22:29:56 +01:00
.. function:: sleep(seconds)
Sleep for the given number of seconds.
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
.. function:: time()
Returns the number of seconds, as an integer, since 1/1/2000.