Quick Start


For an introduction to MaixPy, please see the MaixPy official website homepage
Please give the MaixPy project a Star ⭐️ to encourage us to develop more features if you like MaixPy.

Choose Your Device First

Confirm your device model, then open only the matching quick-start guide below. The three device types use different startup and connection steps. You can find the model name on the package, order page, or device enclosure.

Your Device Product Image Open This Guide Now
MaixCAM2 MaixCAM2 👉 Open MaixCAM2 Quick Start
MaixCAM / MaixCAM-Pro MaixCAM / MaixCAM-Pro 👉 Open MaixCAM Quick Start
MaixCAM Lite / another screenless version MaixCAM Lite / screenless version 👉 Open Screenless Quick Start

Before You Start

  • This is the MaixPy v4 documentation for the MaixCAM series. For K210 devices, use the MaixPy v1 documentation.
  • Boards from other product lines cannot use the same system and programs just because they use a similar chip.
  • Videos are useful for seeing the general process, but follow the latest documentation for current buttons and settings.
  • If something does not work, check the relevant step and the FAQ first.

What to Learn After Quick Start

After following the guide for your device and successfully running an example, choose the next topic that matches your goal:

  • Write your first MaixPy program: start with Using MaixVision and Python Fundamentals in the Basic section.
  • Use the camera, display, or common algorithms: choose a topic from Basic Image Processing and Algorithms.
  • Run or train an AI model: start with AI Vision or Train, Convert and Deploy.
  • Put your program in the device menu: see App Development and App Store.

Use the API documentation to look up function parameters and return values. Learning is easier with a small goal, such as reading a QR code or detecting an apple.

Frequently Asked Questions (FAQ)

If you encounter any problems, please check the FAQ first. If you cannot find a solution there, you can ask in the forums or groups below, or submit a source code issue on MaixPy issue.

Share and Discuss

  • MaixHub Project and Experience Sharing: Share your projects and practical experience for a chance to receive an official cash reward. MaixHub especially welcomes these types of posts:
    • Step-by-step tutorial: Provide enough instructions for other people to build the project themselves.
    • Project showcase: Full build instructions are not required; focus on the project's creative idea and real-world result.
    • Problem-solving experience: Describe the problem, how you investigated it, and the solution that worked.
  • MaixPy Official Forum (for asking questions and discussion)
  • Telegram: MaixPy
  • MaixPy Source Code Issues: MaixPy issue
  • For business cooperation or bulk purchases, please contact support@sipeed.com.