MaixPy Documentation

1. What is MaixPy

MaixPy ported Micropython to K210 (a 64-bit dual-core RISC-V CPU with hardware FPU 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 get the hardware (the 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. Let's get started

To get started, we need one dev board, there are three kind of boards:

  • Dan dock with Sipeed M1(Dan) module

Dan dock

  • Sipeed Maix BiT


  • Sipeed Go


To get any of those boards, visit Sipeed Official Website

More hardware infomation here

We can now start writing software, refer to get started

4. MaixPy Getting Started Tutorial video

5. Getting Started Tutorial video

The video briefly introduces the basics of getting started. In fact, the documentation will be more detailed, and the video just provides a more intuitive introduction.

The language used for the video is Chinese, please select English subtitles.

6. Source code

MaixPy source code on GitHub

Maintained by ©Sipeed Co.,Ltd. More contributors here

7. 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

8. Feedback

results matching ""

    No results matching ""