MaixPy Documentation

undefined undefinedundefined

Currently the only official document website:</br> Development board information:,

1. What is MaixPy

MaixPy ported Micropython to K210 (a 64-bit dual-core RISC-V CPU with hardware FPU、FFT、sha256 and convolution accelerator). A project that supports MCU routine operations and integrates machine vision and microphone arrays to quickly develop intelligent applications in the AIOT field that are extremely cost effective and practical.

MicroPython is a lean and efficient implementation of the Python 3 programming language that includes a small subset of the Python standard library and is optimised to run on microcontrollers and in constrained environments.

K210 created for AIOT(AI+IOT) use, It's powerful performance and low cost are very competitive.

Micropython makes programming on K210 hardware easier, the code is open source and can be found on GitHub)

For example if we want to find an I2C device, we just need this code:

from machine import I2C

i2c = I2C(I2C.I2C0, freq=100000, scl=28, sda=29)
devices = i2c.scan()

Again, if we want to make a breathing light using PWM, we just need this code:

from machine import Timer,PWM
import time

tim = Timer(Timer.TIMER0, Timer.CHANNEL0, mode=Timer.MODE_PWM)
ch = PWM(tim, freq=500000, duty=50, pin=board_info.LED_G)
dir = True
while True:
    if dir:
        duty += 10
        duty -= 10
    if duty>100:
        duty = 100
        dir = False
    elif duty<0:
        duty = 0
        dir = True

To take a picture

import sensor
import image
import lcd

while True:

2. About this documentation

Everything related to MaixPy, mainly about

  • How to choose and get a suitable module/development board
  • How to get started with MaixPy, even if you are not an expert in hardware programming.
  • Learn MicroPython language basics
  • Libraries (API) reference

3. Boards supported MaixPy

First of all, we need to choose a development board that suits your needs. The following ones are currently available:

  • Dan dock with Sipeed M1(Dan) module


  • Sipeed Maix BiT


  • Sipeed Maix Go


  • Sipeed Maixduino


To get any of those boards or more boards, visit Sipeed Wiki

4. MaixPy source code

If you want to participate in the development of MaixPy's built in features, you can download the source code and do a pull request.

MaixPy source is hosted on GitHub

Branch Status
master Build Status

This project was started by ©Sipeed Co.,Ltd. and accepts contributions from the open source community. You can see who contributed by checking the list of contributors

5. Source code of MaixPy documentation

Doumentation will be edited if the API code is changed.

The source of the documentation can be found on GitHub

You MUST read the documentation convention before editing it!

Branch Status
master Build Status
dev Build Status

6. Feedback

powered by GitbookFile Modify: 2020-11-30 13:31:44

results matching ""

    No results matching ""