CINXE.COM
Overview — MicroPython latest documentation
<!DOCTYPE html> <html class="writer-html5" lang="en" data-content_root="./"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Overview — MicroPython latest documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" /> <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> <link rel="stylesheet" type="text/css" href="_static/custom.css?v=d5a28fe3" /> <link rel="stylesheet" href="_static/customstyle.css" type="text/css" /> <link rel="shortcut icon" href="_static/favicon.ico"/> <script src="_static/jquery.js?v=5d32c60e"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="_static/documentation_options.js?v=c6e86fd7"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="#" class="icon icon-home"> MicroPython </a> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul> <li class="toctree-l1"><a class="reference internal" href="library/index.html">MicroPython libraries</a></li> <li class="toctree-l1"><a class="reference internal" href="reference/index.html">MicroPython language and implementation</a></li> <li class="toctree-l1"><a class="reference internal" href="genrst/index.html">MicroPython differences from CPython</a></li> <li class="toctree-l1"><a class="reference internal" href="develop/index.html">MicroPython Internals</a></li> <li class="toctree-l1"><a class="reference internal" href="license.html">MicroPython license information</a></li> <li class="toctree-l1"><a class="reference internal" href="pyboard/quickref.html">Quick reference for the pyboard</a></li> <li class="toctree-l1"><a class="reference internal" href="esp8266/quickref.html">Quick reference for the ESP8266</a></li> <li class="toctree-l1"><a class="reference internal" href="esp32/quickref.html">Quick reference for the ESP32</a></li> <li class="toctree-l1"><a class="reference internal" href="rp2/quickref.html">Quick reference for the RP2</a></li> <li class="toctree-l1"><a class="reference internal" href="mimxrt/quickref.html">Quick reference for the i.MXRT family</a></li> <li class="toctree-l1"><a class="reference internal" href="wipy/quickref.html">Quick reference for the WiPy</a></li> <li class="toctree-l1"><a class="reference internal" href="unix/quickref.html">Quick reference for the UNIX and Windows ports</a></li> <li class="toctree-l1"><a class="reference internal" href="zephyr/quickref.html">Quick reference for the Zephyr port</a></li> <li class="toctree-l1"><a class="reference internal" href="renesas-ra/quickref.html">Quick reference for the Renesas RA</a></li> <li class="toctree-l1"><a class="reference internal" href="samd/quickref.html">Quick reference for the SAMD21/SAMD51 family</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="#">MicroPython</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="#" class="icon icon-home" aria-label="Home"></a></li> <li class="breadcrumb-item active">Overview</li> <li class="wy-breadcrumbs-aside"> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div class="wy-alert wy-alert-danger"> <p> This is the documentation for the latest development branch of MicroPython and may refer to features that are not available in released versions. </p> <p> If you are looking for the documentation for a specific release, use the drop-down menu on the left and select the desired version. </p> </div> <div itemprop="articleBody"> <h1>MicroPython documentation</h1> <p> Welcome! This is the documentation for MicroPython, last updated 17 Mar 2025. </p> <p> MicroPython runs on a variety of systems and hardware platforms. Here you can read the general documentation which applies to all systems, as well as specific information about the various platforms - also known as <a href="reference/glossary.html#term-micropython-port">ports</a> - that MicroPython runs on. </p> <p><strong>General documentation for MicroPython:</strong></p> <table class="contentstable"><tr> <td width="40%" style="padding-left:2em;"> <p class="biglink"> <a class="biglink" href="library/index.html">Library Reference</a><br/> <span class="linkdescr">MicroPython libraries and modules</span> </p> <p class="biglink"> <a class="biglink" href="genrst/index.html">MicroPython Differences</a><br/> <span class="linkdescr">MicroPython operations which differ from CPython</span> </p> </td> <td width="40%" style="padding-left:2em;"> <p class="biglink"> <a class="biglink" href="reference/index.html">Language Reference</a><br/> <span class="linkdescr">information about MicroPython specific language features</span> </p> <p class="biglink"> <a class="biglink" href="license.html">License</a><br/> <span class="linkdescr">MicroPython license information</span> </p> </td> </tr></table> <p><strong>References and tutorials for specific platforms:</strong></p> <table class="contentstable"><tr> <td width="40%" style="padding-left:2em;"> <p class="biglink"> <a class="biglink" href="pyboard/quickref.html">Quick reference for the pyboard</a><br/> <span class="linkdescr">pinout for the pyboard, snippets of useful code, and a tutorial</span> </p> <p class="biglink"> <a class="biglink" href="esp8266/quickref.html">Quick reference for the ESP8266</a><br/> <span class="linkdescr">pinout for ESP8266-based boards, snippets of useful code, and a tutorial</span> </p> <p class="biglink"> <a class="biglink" href="esp32/quickref.html">Quick reference for the ESP32</a><br/> <span class="linkdescr">pinout for ESP32-based boards, snippets of useful code, and a tutorial</span> </p> <p class="biglink"> <a class="biglink" href="rp2/quickref.html">Quick reference for the Raspberry Pi RP2xxx</a><br/> <span class="linkdescr">pinout for rp2xxx-based boards, snippets of useful code, and a tutorial</span> </p> <p class="biglink"> <a class="biglink" href="mimxrt/quickref.html">Quick reference for the NXP i.MXRT 10xx</a><br/> <span class="linkdescr">general introduction, snippets of useful code, and a tutorial</span> </p> <p class="biglink"> <a class="biglink" href="wipy/quickref.html">Quick reference for the WiPy/CC3200</a><br/> <span class="linkdescr">pinout for the WiPy/CC3200, snippets of useful code, and a tutorial</span> </p> <p class="biglink"> <a class="biglink" href="unix/quickref.html">Quick reference for UNIX and Windows</a><br/> <span class="linkdescr">command-line reference</span> </p> <p class="biglink"> <a class="biglink" href="zephyr/quickref.html">Quick reference for the Zephyr port</a><br/> <span class="linkdescr">snippets of useful code and a tutorial</span> </p> <p class="biglink"> <a class="biglink" href="renesas-ra/quickref.html">Quick reference for the Renesas RA</a><br/> <span class="linkdescr">general information for Renesas RA based boards, snippets of useful code, and a tutorial</span> </p> <p class="biglink"> <a class="biglink" href="samd/quickref.html">Quick reference for the SAMD21/SAMD51</a><br/> <span class="linkdescr">general information for SAMD21/SAMD51 based boards, snippets of useful code, and a tutorial</span> </p> </td> </tr></table> <p><strong>Indices and tables:</strong></p> <table class="contentstable"><tr> <td width="40%" style="padding-left:2em;"> <p class="biglink"> <a class="biglink" href="py-modindex.html">Module index</a><br/> <span class="linkdescr">quick access to all modules</span> </p> <p class="biglink"> <a class="biglink" href="genindex.html">Full index</a><br/> <span class="linkdescr">all functions, classes, constants</span> </p> </td> <td width="40%" style="padding-left:2em;"> <p class="biglink"> <a class="biglink" href="reference/glossary.html">Glossary</a><br/> <span class="linkdescr">MicroPython terms explained</span> </p> <p class="biglink"> <a class="biglink" href="#">Table of contents</a><br/> <span class="linkdescr">a list of all sections and subsections</span> </p> </td></tr> </table> <p><strong>External links:</strong></p> <table class="contentstable"><tr> <td width="40%" style="padding-left:2em;"> <p class="biglink"> <a class="biglink" href="http://micropython.org">MicroPython homepage</a><br/> <span class="linkdescr">the official MicroPython site</span> </p> <p class="biglink"> <a class="biglink" href="https://github.com/orgs/micropython/discussions">GitHub Discussions</a><br/> <span class="linkdescr">community discussion for all things related to MicroPython</span> </p> </td> <td width="40%" style="padding-left:2em;"> <p class="biglink"> <a class="biglink" href="https://github.com/micropython">MicroPython on GitHub</a><br/> <span class="linkdescr">contribute to the source code on GitHub</span> </p> </td> </tr></table> </div> </div> <footer> <hr/> <div role="contentinfo"> <p>© Copyright - The MicroPython Documentation is Copyright 漏 2014-2025, MicroPython authors and contributors. <span class="lastupdated">Last updated on 17 Mar 2025. </span></p> </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> <span class="rst-current-version" data-toggle="rst-current-version"> <span class="fa fa-book"> Versions and Downloads</span> latest <span class="fa fa-caret-down"></span> </span> <div class="rst-other-versions"> <dl> <dt>Versions</dt> <dd><a href="http://docs.micropython.org/en/v1.4.4">v1.4.4</a></dd> <dd><a href="http://docs.micropython.org/en/v1.4.5">v1.4.5</a></dd> <dd><a href="http://docs.micropython.org/en/v1.4.6">v1.4.6</a></dd> <dd><a href="http://docs.micropython.org/en/v1.5">v1.5</a></dd> <dd><a href="http://docs.micropython.org/en/v1.5.1">v1.5.1</a></dd> <dd><a href="http://docs.micropython.org/en/v1.5.2">v1.5.2</a></dd> <dd><a href="http://docs.micropython.org/en/v1.6">v1.6</a></dd> <dd><a href="http://docs.micropython.org/en/v1.7">v1.7</a></dd> <dd><a href="http://docs.micropython.org/en/v1.8">v1.8</a></dd> <dd><a href="http://docs.micropython.org/en/v1.8.1">v1.8.1</a></dd> <dd><a href="http://docs.micropython.org/en/v1.8.2">v1.8.2</a></dd> <dd><a href="http://docs.micropython.org/en/v1.8.3">v1.8.3</a></dd> <dd><a href="http://docs.micropython.org/en/v1.8.4">v1.8.4</a></dd> <dd><a href="http://docs.micropython.org/en/v1.8.5">v1.8.5</a></dd> <dd><a href="http://docs.micropython.org/en/v1.8.6">v1.8.6</a></dd> <dd><a href="http://docs.micropython.org/en/v1.8.7">v1.8.7</a></dd> <dd><a href="http://docs.micropython.org/en/v1.9">v1.9</a></dd> <dd><a href="http://docs.micropython.org/en/v1.9.1">v1.9.1</a></dd> <dd><a href="http://docs.micropython.org/en/v1.9.2">v1.9.2</a></dd> <dd><a href="http://docs.micropython.org/en/v1.9.3">v1.9.3</a></dd> <dd><a href="http://docs.micropython.org/en/v1.9.4">v1.9.4</a></dd> <dd><a href="http://docs.micropython.org/en/v1.10">v1.10</a></dd> <dd><a href="http://docs.micropython.org/en/v1.11">v1.11</a></dd> <dd><a href="http://docs.micropython.org/en/v1.12">v1.12</a></dd> <dd><a href="http://docs.micropython.org/en/v1.13">v1.13</a></dd> <dd><a href="http://docs.micropython.org/en/v1.14">v1.14</a></dd> <dd><a href="http://docs.micropython.org/en/v1.15">v1.15</a></dd> <dd><a href="http://docs.micropython.org/en/v1.16">v1.16</a></dd> <dd><a href="http://docs.micropython.org/en/v1.17">v1.17</a></dd> <dd><a href="http://docs.micropython.org/en/v1.18">v1.18</a></dd> <dd><a href="http://docs.micropython.org/en/v1.19.1">v1.19.1</a></dd> <dd><a href="http://docs.micropython.org/en/v1.20.0">v1.20.0</a></dd> <dd><a href="http://docs.micropython.org/en/v1.21.0">v1.21.0</a></dd> <dd><a href="http://docs.micropython.org/en/v1.22.0">v1.22.0</a></dd> <dd><a href="http://docs.micropython.org/en/v1.23.0">v1.23.0</a></dd> <dd><a href="http://docs.micropython.org/en/v1.24.0">v1.24.0</a></dd> <dd><a href="http://docs.micropython.org/en/latest">latest</a></dd> </dl> <dl> <dt>Downloads</dt> <dd><a href="http://docs.micropython.org/en/latest/micropython-docs.pdf">PDF</a></dd> </dl> <hr/> <dl> <dt>External links</dt> <dd> <a href="https://www.micropython.org">micropython.org</a> </dd> <dd> <a href="https://github.com/micropython/micropython">GitHub</a> </dd> </dl> </div> </div><script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>