W55MH32 Supported Libraries

Warning

Important summary of this section

• MicroPython provides built-in modules that mirror the functionality of the Python standard library (e.g. os, time), as well as MicroPython-specific modules (e.g. bluetooth, machine).

• Most Python standard library modules implement a subset of the functionality of the equivalent Python module, and in a few cases provide some MicroPython-specific extensions (e.g. array, os)

• Due to resource constraints or other limitations, some ports or firmware versions may not include all the functionality documented here.

• To allow for extensibility, some built-in modules can be extended from Python code loaded onto the device filesystem.

This chapter describes modules (function and class libraries) which are built into MicroPython. This documentation in general aspires to describe all modules and functions/classes which are implemented in the MicroPython project. However, MicroPython is highly configurable, and each port to a particular board/embedded system may include only a subset of the available MicroPython libraries.

With that in mind, please 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.

• array – arrays of numeric data
• asyncio — asynchronous I/O scheduler
• binascii – binary/ASCII conversions
• builtins – builtin functions and exceptions
• cmath – mathematical functions for complex numbers
• collections – collection and container types
• errno – system error codes
• gc – control the garbage collector
• hashlib – hashing algorithms
• heapq – heap queue algorithm
• io – input/output streams
• json – JSON encoding and decoding
• math – mathematical functions
• os – basic “operating system” services
• platform – access to underlying platform’s identifying data
• random – generate random numbers
• re – simple regular expressions
• select – wait for events on a set of streams
• socket – socket module
• struct – pack and unpack primitive data types
• sys – system specific functions
• time – time related functions

MicroPython-specific libraries

Functionality specific to the MicroPython implementation is available in the following libraries.

• deflate – deflate compression & decompression
• framebuf — frame buffer manipulation
• machine — functions related to the hardware
• micropython – access and control MicroPython internals
• network — network configuration