378 lines
16 KiB
HTML
378 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="icon" href="/assets/images/favicon.ico" type="image/x-icon" />
|
|
<meta name="msapplication-TileColor" content="#1a1919">
|
|
<meta name="msapplication-TileImage" content="https://cdn-shop.adafruit.com/static/mstile-144x144.png" />
|
|
<title>Libraries</title>
|
|
<meta name="description" content="The easiest way to program microcontrollers" />
|
|
|
|
<!-- Twitter and Open Graph cards -->
|
|
<meta name="twitter:site" content="@circuitpython" />
|
|
<meta property="og:url" content="https://circuitpython.org/libraries" />
|
|
|
|
<meta property="og:title" content="CircuitPython - Libraries" />
|
|
|
|
|
|
|
|
<meta property="og:description" content="The easiest way to program microcontrollers" />
|
|
|
|
|
|
|
|
<meta name="twitter:card" content="summary" />
|
|
<meta property="og:image" content="https://circuitpython.org/assets/images/CircuitPythonLogo_Black.png" />
|
|
|
|
<meta property="og:type" content="website" />
|
|
|
|
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.5.0/css/all.css" integrity="sha384-B4dIYHKNBt8Bc12p+WXckhzcICo0wtJAoU8YZTY5qE0Id1GSseTk6S+L3BlXeVIU" crossorigin="anonymous">
|
|
<link rel="stylesheet" href="/assets/css/main.css">
|
|
<link rel="canonical" href="https://circuitpython.org/libraries">
|
|
<!-- CircuitPython RSS Feed -->
|
|
<link rel="alternate"
|
|
type="application/rss+xml"
|
|
title="CircuitPython news!"
|
|
href="https://blog.adafruit.com/category/circuitpython/feed/"/>
|
|
<link rel="alternate" type="application/rss+xml" title="Latest Boards" href="/feed.rss"/>
|
|
<script src="/assets/javascript/header_mobile.js"></script>
|
|
</head>
|
|
|
|
|
|
<body>
|
|
<header id="site-header">
|
|
|
|
<nav class="top-navigation">
|
|
<div>
|
|
<div class="navigation">
|
|
<a class="skip-link" href="#main-content">Skip to main content</a>
|
|
<a href="/contributing">Contributing</a>
|
|
<a href="https://blog.adafruit.com/category/circuitpython">News</a>
|
|
<a href="/awesome">Awesome</a>
|
|
<a href="https://www.adafruitdaily.com/category/circuitpython">Newsletter</a>
|
|
<a href="https://docs.circuitpython.org/">Documentation</a>
|
|
<a href="https://forums.adafruit.com/viewforum.php?f=60">Forums</a>
|
|
<a href="https://adafru.it/discord" aria-label="Discord"><i class="fab fa-discord"></i> Discord</a>
|
|
<a href="/feed.rss" type="application/rss+xml" aria-label="RSS Feed"><i class="fas fa-rss-square"></i> RSS</a>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<div class="wrapper">
|
|
<div class="content">
|
|
<nav class="site-brand">
|
|
<div class="site-logo">
|
|
<a href="/">
|
|
<img src="/assets/images/logo.png"
|
|
srcset="/assets/images/logo.png 1x,
|
|
/assets/images/logo@2x.png 2x,
|
|
/assets/images/logo@3x.png 3x"
|
|
alt="CircuitPython Logo"
|
|
height="60" width="136">
|
|
</a>
|
|
</div>
|
|
<div class="site-navigation">
|
|
<a href="/downloads">Downloads</a>
|
|
<a class="active" aria-current="page" href="/libraries">Libraries</a>
|
|
<a href="/blinka">Blinka</a>
|
|
</div>
|
|
<div class="get-started">
|
|
<a href="https://learn.adafruit.com/welcome-to-circuitpython">Get Started</a>
|
|
</div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
<div class="bottom-bar"></div>
|
|
</header>
|
|
|
|
<header id="mobile-header">
|
|
<div class="header-contents">
|
|
<div class="site-logo">
|
|
<a href="/">
|
|
<img src="/assets/images/logo.png"
|
|
srcset="/assets/images/logo.png 1x,
|
|
/assets/images/logo@2x.png 2x,
|
|
/assets/images/logo@3x.png 3x"
|
|
alt="CircuitPython Logo"
|
|
height="60" width="136">
|
|
</a>
|
|
</div>
|
|
<div id="mobile-menu">
|
|
<div class="menu-toggle">
|
|
<a href="#" id="mobile-menu-button">
|
|
<span class="sr-only">Open Mobile Menu</span>
|
|
<i class="fa fa-bars" aria-hidden="true"></i>
|
|
</a>
|
|
</div>
|
|
</div>
|
|
<div class="clear"></div>
|
|
<nav id="mobile-menu-contents" role="navigation" class="hidden"
|
|
aria-expanded="false" aria-label="Mobile Menu">
|
|
<ul>
|
|
<li><a
|
|
href="/downloads">Downloads</a></li>
|
|
<li><a class='active'
|
|
href="/libraries">Libraries</a></li>
|
|
<li><a
|
|
href="/blinka">Blinka</a></li>
|
|
<li><a
|
|
href="/contributing">Contributing</a></li>
|
|
<li><a href="https://blog.adafruit.com/category/circuitpython">News</a></li>
|
|
<li><a
|
|
href="/awesome">Awesome</a></li>
|
|
<li><a href="https://www.adafruitdaily.com/category/circuitpython">Newsletter</a></li>
|
|
<li><a href="https://learn.adafruit.com/welcome-to-circuitpython">Get Started</a></li>
|
|
<li><a href="https://forums.adafruit.com/viewforum.php?f=60">Forums</a></li>
|
|
<li><a href="https://adafru.it/discord" aria-label="Discord"><i class="fab fa-discord"></i> Discord</a></li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
<div class="bottom-bar"></div>
|
|
</header>
|
|
|
|
<div id="main-content" class="wrapper">
|
|
<div id="common-page" class="common-layout">
|
|
<div class="content">
|
|
<div id="libraries-page">
|
|
<h1>CircuitPython Libraries</h1>
|
|
<p>
|
|
The CircuitPython Library Bundle contains all current libraries available for
|
|
CircuitPython. They are designed for use with CircuitPython and may or may not
|
|
work with MicroPython. The bundle options are explained below.
|
|
<p>
|
|
CircuitPython libraries are written in Python. They provide additional functionality
|
|
and support external devices, beyond what is in CircuitPython itself.
|
|
Libraries are stored on your <b>CIRCUITPY</b> drive in a folder called <b>lib</b>.
|
|
For more information on using and managing libraries, see the
|
|
<a href="https://learn.adafruit.com/welcome-to-circuitpython/circuitpython-libraries">Welcome To CircuitPython Guide</a>.
|
|
</p>
|
|
<section>
|
|
<h2>Documentation</h2>
|
|
<p>
|
|
The
|
|
<a href="https://circuitpython.readthedocs.io/projects/bundle/en/latest/drivers.html" title="">libraries documentation page</a>
|
|
contains a categorized list of all the CircuitPython libraries included in the following bundles,
|
|
with links to the documentation for every library.
|
|
<h2>Download and Installation Instructions</h2>
|
|
<p>
|
|
You can download all the available libraries in a zip-file bundle for all recent major
|
|
versions of CircuitPython. These bundles are updated daily, whenever any included library is updated.
|
|
</p>
|
|
<p>
|
|
The libraries in each release are supplied as <b>.mpy</b> files, which are compiled
|
|
versions of Python source code.
|
|
<strong>Make sure to download the bundle that matches the major version
|
|
of your CircuitPython</strong>, because the <b>.mpy</b> files can change between versions.
|
|
For example, if you are running 8.2.7 you should download the 8.x bundle.
|
|
</p>
|
|
<p>
|
|
The precompiled <b>.mpy</b> files take up less space on your CIRCUITPY drive than the <b>.py</b> files.
|
|
They also load faster, and for some low-RAM boards, are required because the <b>.py</b> files
|
|
are too large to compile on the board itself.
|
|
<strong>Unless you need the source version, choose the appropiate <b>.mpy</b> library bundle!</strong>
|
|
If you need to compile <b>.py</b> files to <b>.mpy</b>, you can
|
|
<a href="https://learn.adafruit.com/welcome-to-circuitpython/frequently-asked-questions#how-can-i-create-my-own-mpy-files-3020687-11">run the <b>mpy-cross</b>
|
|
cross-compiler yourself</a>.
|
|
</p>
|
|
<p>
|
|
<b>To install</b>, download the appropriate bundle for your version of CircuitPython.
|
|
Unzip the file, open the resulting folder and find the <b>lib</b> folder. Open the lib
|
|
folder and find the library files you need to load. Create a <b>lib</b> folder on your
|
|
CIRCUITPY drive. Copy the individual library files you need to the <b>lib</b> folder
|
|
on your CIRCUITPY drive. More details are available
|
|
<a href="https://learn.adafruit.com/welcome-to-circuitpython/circuitpython-libraries">here</a>.
|
|
</p>
|
|
<p>
|
|
You can always find the
|
|
<a href="https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/latest">latest releases of the libraries bundle</a>
|
|
on GitHub.
|
|
</p>
|
|
<p>
|
|
An alternative way to download and update libraries on your board is to use the
|
|
<a href="https://learn.adafruit.com/keep-your-circuitpython-libraries-on-devices-up-to-date-with-circup">CircUp tool</a>,
|
|
which is under development.
|
|
</p>
|
|
</section>
|
|
<section>
|
|
<h2>Bundles</h2>
|
|
<div class="release-section">
|
|
<div id="adafruit-circuitpython-bundle-8.x-mpy">
|
|
<h3>Bundle for Version 8.x</h3>
|
|
<p>
|
|
This bundle is built for use with CircuitPython 8.x.x. If you are using
|
|
CircuitPython 8, please download this bundle.
|
|
</p>
|
|
</div>
|
|
<div id="adafruit-circuitpython-bundle-9.x-mpy">
|
|
<h3>Bundle for Version 9.x</h3>
|
|
<p>
|
|
This bundle is built for use with CircuitPython 9.x.x. If you are using
|
|
CircuitPython 9, please download this bundle. The .mpy format has
|
|
changed as of CircuitPython 9, so 8.x libraries are <em>not</em> compatible.
|
|
</p>
|
|
</div>
|
|
<div>
|
|
<h3>Bundles for Older Versions</h3>
|
|
<p>
|
|
If you need a bundle for an older version of CircuitPython,
|
|
see <a href="https://learn.adafruit.com/welcome-to-circuitpython/frequently-asked-questions#faq-3105289">this list</a>.
|
|
</p>
|
|
</div>
|
|
<div id="adafruit-circuitpython-bundle-py">
|
|
<h3>Python Source Bundle</h3>
|
|
<p>
|
|
This bundle is the latest uncompiled Python source code for every library. It is not
|
|
intended for general use! It is only recommended if you need to edit
|
|
a library file. This bundle works with all supported versions of CircuitPython.
|
|
</p>
|
|
</div>
|
|
<div id="adafruit-circuitpython-bundle-examples">
|
|
<h3>Examples Bundle</h3>
|
|
<p>
|
|
Every CircuitPython library has examples to go along with it. This bundle
|
|
contains every library example. This bundle will have examples that
|
|
require the latest version of CircuitPython, and therefore contains files
|
|
that may not work with all versions.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section>
|
|
<h2>The Community Bundle</h2>
|
|
<p>
|
|
The libraries in the bundles above are officially supported by Adafruit.
|
|
Additional libraries written and supported by community members are available in the
|
|
<a href="https://github.com/adafruit/CircuitPython_Community_Bundle/">Community Bundle</a>.
|
|
</p>
|
|
<div class="release-section">
|
|
<div id="circuitpython-community-bundle-8.x-mpy">
|
|
<h3>Bundle for Version 8.x</h3>
|
|
<p>
|
|
This bundle is built for use with CircuitPython 8.x.x. If you are using
|
|
CircuitPython 8, please download this bundle.
|
|
</p>
|
|
</div>
|
|
<div id="circuitpython-community-bundle-9.x-mpy">
|
|
<h3>Bundle for Version 9.x</h3>
|
|
<p>
|
|
This bundle is built for use with CircuitPython 9.x.x. If you are using
|
|
CircuitPython 9, please download this bundle. The .mpy format has
|
|
changed as of CircuitPython 9, so 8.x libraries are <em>not</em> compatible.
|
|
</p>
|
|
</div>
|
|
<div>
|
|
<h3>Bundle for Older Versions</h3>
|
|
<p>
|
|
If you are looking for Community Bundles for older versions of CircuitPython, you can find them on
|
|
<a href="https://github.com/adafruit/CircuitPython_Community_Bundle/releases/">GitHub</a>.
|
|
</p>
|
|
</div>
|
|
<div id="circuitpython-community-bundle-py">
|
|
<h3>Python Source Bundle</h3>
|
|
<p>
|
|
This bundle is the uncompiled Python source code for every community library. It is not
|
|
intended for general use! It is only recommended if you need to edit
|
|
a library file. This bundle works with all supported versions of CircuitPython.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section>
|
|
<h2>Contributing</h2>
|
|
<p>
|
|
If you'd like to contribute to the CircuitPython project, the CircuitPython
|
|
libraries are a great way to begin. Everyone is welcome to contribute!
|
|
Regardless of your experience level, we have many resources to get you
|
|
started. Check out the Contributing page for detailed information!
|
|
</p>
|
|
<p>
|
|
Find out more about how you can
|
|
<a href="/contributing" title="Contributing Page">contribute to CircuitPython libraries</a>.
|
|
</p>
|
|
<h2>Library Activity for Week of Sat, Feb 10, 2024</h2>
|
|
<p>
|
|
Thank you to all of our contributors!
|
|
</p>
|
|
<p>
|
|
This week there were 9 pull requests merged:
|
|
<ul>
|
|
<li>
|
|
Authors:
|
|
|
|
<a href="https://github.com/dhalbert" title="Contributor Name">dhalbert</a>,
|
|
|
|
<a href="https://github.com/justmobilize" title="Contributor Name">justmobilize</a>,
|
|
|
|
<a href="https://github.com/ladyada" title="Contributor Name">ladyada</a>,
|
|
|
|
<a href="https://github.com/logandgsmith" title="Contributor Name">logandgsmith</a>,
|
|
|
|
<a href="https://github.com/michalpokusa" title="Contributor Name">michalpokusa</a>,
|
|
|
|
<a href="https://github.com/pythonmcpi" title="Contributor Name">pythonmcpi</a>,
|
|
|
|
<a href="https://github.com/vladak" title="Contributor Name">vladak</a>
|
|
|
|
</li>
|
|
<li>
|
|
Reviewers:
|
|
|
|
<a href="https://github.com/caternuson" title="Contributor Name">caternuson</a>,
|
|
|
|
<a href="https://github.com/dhalbert" title="Contributor Name">dhalbert</a>,
|
|
|
|
<a href="https://github.com/FoamyGuy" title="Contributor Name">FoamyGuy</a>,
|
|
|
|
<a href="https://github.com/jepler" title="Contributor Name">jepler</a>,
|
|
|
|
<a href="https://github.com/tannewt" title="Contributor Name">tannewt</a>
|
|
|
|
</li>
|
|
</ul>
|
|
</p>
|
|
<div class="libraries new">
|
|
<h3>New Libraries</h3>
|
|
<ul>
|
|
|
|
</ul>
|
|
</div>
|
|
<div class="libraries updated">
|
|
<h3>Updated Libraries</h3>
|
|
<ul>
|
|
|
|
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_Display_Button" title="Updated Library Location">Adafruit_CircuitPython_Display_Button</a></li>
|
|
|
|
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_Layout" title="Updated Library Location">Adafruit_CircuitPython_DisplayIO_Layout</a></li>
|
|
|
|
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_DS18X20" title="Updated Library Location">Adafruit_CircuitPython_DS18X20</a></li>
|
|
|
|
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_FocalTouch" title="Updated Library Location">Adafruit_CircuitPython_FocalTouch</a></li>
|
|
|
|
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_HTTPServer" title="Updated Library Location">Adafruit_CircuitPython_HTTPServer</a></li>
|
|
|
|
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation" title="Updated Library Location">Adafruit_CircuitPython_LED_Animation</a></li>
|
|
|
|
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_PyCamera" title="Updated Library Location">Adafruit_CircuitPython_PyCamera</a></li>
|
|
|
|
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_Requests" title="Updated Library Location">Adafruit_CircuitPython_Requests</a></li>
|
|
|
|
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_seesaw" title="Updated Library Location">Adafruit_CircuitPython_seesaw</a></li>
|
|
|
|
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_Typing" title="Updated Library Location">Adafruit_CircuitPython_Typing</a></li>
|
|
|
|
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_US100" title="Updated Library Location">Adafruit_CircuitPython_US100</a></li>
|
|
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
|
|
<script src="/assets/javascript/libraries.js"></script>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|