MicroPython Wiki
Welcome to the MicroPython Wiki!
These pages host community generated documentation and examples of the features of MicroPython and the pyboard. We welcome your contributions.
Are You a New User?
If so, here's the basic stuff you need to read and know:
- The Official Pyboard Quick-Start guide and some community added details
- MicroPython (uPy) implements Python 3+ ... learn it from the official tutorial
- A growing set of tutorials is available on the 'fountain of all knowledge' i.e. (MicroPython site) ...
- You don't even need any additional hardware to start making magic:
- And it has many ways to interact with the outside world:
- Before you move on beyond the basics, it is best to update your board to the latest firmware. You could skip this step, but may run into some issues if your board is not up to date.
- Tips & Tricks for working with your pyboard
Dive Deeper
Community Contributed Projects to wet your appetite and spark ideas:
- Add a battery, so that it remembers the time
- Pins are your pyboards interface to the world
- Accessing the SD card
- Importing Modules
- SD Data Logger
- Repository of example code to get you started
- More code examples
- Minimising power consumption - how to run from batteries Includes code for accessing features of the pyboard such as battery backed RAM and RTC registers and alarms.
- USB HID Keyboard mode example : a password manager dongle
Libraries for External Devices
Usually you will want to connect different devices to your microcontroller, like sensors, displays, actuators and much more. Here you can find modules for different devices.
Official Accessories
Drivers in the MicroPython source tree. These may be found under drivers:
NRF24L01 Provides two way checksummed radio communications with auto-retry in the 2.4GHz ISM band.
OneWire: generic driver for devices using the OneWire bus
CC3000 and CC3100: WiFi drivers
Display drivers: The official LCD touch display uses the LCD160CR controller. SSD1306 OLED devices are also supported.
DHT11 and DHT22 temperature and humidity sensors
SD card: supports SD cards connected by SPI bus.
Other Devices
-
This site has drivers for several Inertial Measurement Units: MPU9150, MPU9250 and LSM9DS0. It also has other code for drones and robots including Madgwick sensor fusion and a driver for the BMP180 pressure (altitude) sensor.
LCD touch screens with SSD1963 Driver for medium sized (4.3 and 7 inch) colour LCD displays.
Touch GUI A touch interface library for the above displays.
Touch GUI for official Pyboard LCD display For displays using the LCD160CR controller.
A simple radio link between two Pyboards This uses the officially supported nRF24L01+ and provides a means to exchange arbitrary Python objects between the boards. Designed for ease of use.
e-paper display Supports Embedded Artists (EA) and Adafruit displays. EA support includes drivers for the onboard flash memory and LM75 temperature sensor.
Adafruit Ferroelectric RAM modules Allows these to be mounted as part of the pyboard filesystem or addressed as an array of bytes.
DS3231 Precision Real Time Clock. In addition to general use code is provided for using a DS3231 to calibrate the pyboard's RTC.
Another HD44780-compatible LCD driver module
-
A module for reading encoders using gray code error-checking
Network Protocol: SNMP, tested WiPy only
IR Remote Control The file aremote.py supports IR remotes using the NEC protocol.
General Code Examples
Cooperative scheduling using uasyncio Resources include a tutorial, drivers for debounced switches and pushbuttons with optional push, release, double-click and long press events, and a set of synchronisation primitives.
Threaded code library This offers an alternative to the official asyncio module for writing event driven code. It includes libraries to support HD44780 LCD's, debounced switches and pushbuttons with optional push, release, double-click and long press events.
Fast filter routines FIR (finite impulse response) filters for realtime data written in ARM assembler. Docs detail how to create a filter with custom characteristics.
Fourier Transform FFT in ARM assembler. Includes maths routines such as Cartesian to polar conversion.
Convert fonts to Python source A PC utility to convert ttf and otf files to MicroPython source which may optionally be frozen as bytecode. The file format is offered as a proposed standard.
Utilities
- rshell Enables access to a MicroPython target via USB or a network connection. Enables maintenance of the filesystem using Unix-like commands. Also provides a REPL prompt.
- data_to_py Converts an arbitrary binary data file to Python source which may be frozen as bytecode. This conserves RAM.
Structured Detail
MicroPython (uPy)
- uPy vs CPython (aka 'Official Python')
- The home of Offical Python
Modules
uPy will never support all of CPython's builtin modules, only a subset:
- Inline Assembler
- Platforms
- Boards
- pyboard
- Versions;
- pyboard v0.4 (Kickstarter preview)
- pyboard v1.0 (Kickstarter reward)
- pyboard 1.1
- pyboard lite 1.0
- pyboard lite 1.0 with accelerometer
- Versions;
- MCU:stm32f4xx
- WiPy
- ESP2866
- Other hardware ports:
- STM32F429DISCOVERY
- Nucleo STM32F4401RE
- Teensy 3.1
- pyboard
- *nix (Unix & Linux)
- Port-specific Modules:
- Onboard Peripherals:
- Accelerometer
- Offboard peripherals:
- Officially supported:
- Community supported:
- Boards