mirror of
https://github.com/licsber/micropython.git
synced 2024-09-20 17:10:24 +08:00
d8e0320485
The WiPy machine.Timer class is very different to the esp8266 and esp32 implementations which are better candidates for a general Timer class. By moving the WiPy Timer docs to a completely separate file, under a new name machine.TimerWiPy, it gives a clean slate to define and write the docs for a better, general machine.Timer class. This is with the aim of eventually providing documentation that does not have conditional parts to it, conditional on the port. While the new docs are being defined it makes sense to keep the WiPy docs, since they describe its behaviour. Once the new Timer behaviour is defined the WiPy code can be changed to match it, and then the TimerWiPy docs would be removed.
151 lines
4.8 KiB
ReStructuredText
151 lines
4.8 KiB
ReStructuredText
.. _micropython_lib:
|
|
|
|
MicroPython libraries
|
|
=====================
|
|
|
|
.. warning::
|
|
|
|
Important summary of this section
|
|
|
|
* MicroPython implements a subset of Python functionality for each module.
|
|
* To ease extensibility, MicroPython versions of standard Python modules
|
|
usually have ``u`` ("micro") prefix.
|
|
* Any particular MicroPython variant or port may miss any feature/function
|
|
described in this general documentation (due to resource constraints or
|
|
other limitations).
|
|
|
|
|
|
This chapter describes modules (function and class libraries) which are built
|
|
into MicroPython. There are a few categories of such modules:
|
|
|
|
* Modules which implement a subset of standard Python functionality and are not
|
|
intended to be extended by the user.
|
|
* Modules which implement a subset of Python functionality, with a provision
|
|
for extension by the user (via Python code).
|
|
* Modules which implement MicroPython extensions to the Python standard libraries.
|
|
* Modules specific to a particular `MicroPython port` and thus not portable.
|
|
|
|
Note about the availability of the modules and their contents: This documentation
|
|
in general aspires to describe all modules and functions/classes which are
|
|
implemented in MicroPython project. However, MicroPython is highly configurable, and
|
|
each port to a particular board/embedded system makes available only a subset
|
|
of MicroPython libraries. For officially supported ports, there is an effort
|
|
to either filter out non-applicable items, or mark individual descriptions
|
|
with "Availability:" clauses describing which ports provide a given feature.
|
|
|
|
With that in mind, please still be warned that some functions/classes
|
|
in a module (or even the entire module) described in this documentation **may be
|
|
unavailable** in a particular build of MicroPython on a particular system. The
|
|
best place to find general information of the availability/non-availability
|
|
of a particular feature is the "General Information" section which contains
|
|
information pertaining to a specific `MicroPython port`.
|
|
|
|
On some ports you are able to discover the available, built-in libraries that
|
|
can be imported by entering the following at the REPL::
|
|
|
|
help('modules')
|
|
|
|
Beyond the built-in libraries described in this documentation, many more
|
|
modules from the Python standard library, as well as further MicroPython
|
|
extensions to it, can be found in `micropython-lib`.
|
|
|
|
Python standard libraries and micro-libraries
|
|
---------------------------------------------
|
|
|
|
The following standard Python libraries have been "micro-ified" to fit in with
|
|
the philosophy of MicroPython. They provide the core functionality of that
|
|
module and are intended to be a drop-in replacement for the standard Python
|
|
library. Some modules below use a standard Python name, but prefixed with "u",
|
|
e.g. ``ujson`` instead of ``json``. This is to signify that such a module is
|
|
micro-library, i.e. implements only a subset of CPython module functionality.
|
|
By naming them differently, a user has a choice to write a Python-level module
|
|
to extend functionality for better compatibility with CPython (indeed, this is
|
|
what done by the `micropython-lib` project mentioned above).
|
|
|
|
On some embedded platforms, where it may be cumbersome to add Python-level
|
|
wrapper modules to achieve naming compatibility with CPython, micro-modules
|
|
are available both by their u-name, and also by their non-u-name. The
|
|
non-u-name can be overridden by a file of that name in your library path (``sys.path``).
|
|
For example, ``import json`` will first search for a file ``json.py`` (or package
|
|
directory ``json``) and load that module if it is found. If nothing is found,
|
|
it will fallback to loading the built-in ``ujson`` module.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
builtins.rst
|
|
array.rst
|
|
cmath.rst
|
|
gc.rst
|
|
math.rst
|
|
sys.rst
|
|
ubinascii.rst
|
|
ucollections.rst
|
|
uerrno.rst
|
|
uhashlib.rst
|
|
uheapq.rst
|
|
uio.rst
|
|
ujson.rst
|
|
uos.rst
|
|
ure.rst
|
|
uselect.rst
|
|
usocket.rst
|
|
ussl.rst
|
|
ustruct.rst
|
|
utime.rst
|
|
uzlib.rst
|
|
_thread.rst
|
|
|
|
|
|
MicroPython-specific libraries
|
|
------------------------------
|
|
|
|
Functionality specific to the MicroPython implementation is available in
|
|
the following libraries.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
btree.rst
|
|
framebuf.rst
|
|
machine.rst
|
|
micropython.rst
|
|
network.rst
|
|
ucryptolib.rst
|
|
uctypes.rst
|
|
|
|
|
|
Libraries specific to the pyboard
|
|
---------------------------------
|
|
|
|
The following libraries are specific to the pyboard.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
pyb.rst
|
|
lcd160cr.rst
|
|
|
|
|
|
Libraries specific to the WiPy
|
|
------------------------------
|
|
|
|
The following libraries and classes are specific to the WiPy.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
wipy.rst
|
|
machine.TimerWiPy.rst
|
|
|
|
|
|
Libraries specific to the ESP8266
|
|
---------------------------------
|
|
|
|
The following libraries are specific to the ESP8266.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
esp.rst
|