Skip to content

Latest commit

 

History

History
152 lines (104 loc) · 6.02 KB

README.md

File metadata and controls

152 lines (104 loc) · 6.02 KB
Raw

Pybricks

Pybricks brings Python-like coding to programmable LEGO bricks, and transforms remote-controlled smart hubs into truly autonomous robots.

Pybricks builds on MicroPython, which is an efficient Python implementation that runs on microcontrollers. Pybricks expands MicroPython with new powerful drivers for LEGO devices including motors and sensors. It also adds the pybricks package, which makes it easy for end-users to access those devices and all the features of the smart hubs.

Are you a beginning user?

Start by visiting our website and the documentation.

Are you a developer or just super curious?

Read on!

Questions and Support

We have a single issue tracker for all your questions and bug reports. If you try Pybricks, please let us know what you think.

Supported Programmable Bricks & Hubs

Released

  • LEGO MINDSTORMS EV3: The community-supported version comes preinstalled with the latest ev3dev image. LEGO Education has also tested and approved the 2.0 release, which is available through their website.

In beta

You can try these hubs using Pybricks Code, our online IDE. Just follow the instructions shown on the right hand side.

  • LEGO Technic Hub (TechnicHub)
  • LEGO BOOST Move Hub (MoveHub)
  • LEGO City Hub (CityHub)

In alpha

This is still in progress. An early alpha version is ready for advanced users:

  • LEGO SPIKE Prime Hub (PrimeHub)
  • LEGO MINDSTORMS Robot Inventor Hub (InventorHub)

What's next?

Check out our roadmap!

Development

Most Pybricks users will not need to do anything with this source code. Pybricks Code always gives you the latest stable firmware.

But since you're reading this, you might be interested to build the code yourself, or start tweaking and hacking. Check out the contributor's guide to get started.

Pybricks and Upstream MicroPython

The Pybricks authors are actively contributing to upstream MicroPython instead of forking it into a whole new project. In essence, Pybricks just adds a family of ports.

To streamline development and releases, we do maintain a fork of micropython here. This adds a few minor patches that haven't made it upstream yet. Every once in a while, that repository gets rebased with all the latest and greatest that upstream micropython has to offer.

Summing up:

Cloning

This project uses submodules. However we don't recommend using the --recursive option of git since it will clone unnecessary dependencies. Instead, the required submodules will be automatically cloned the first time you run make.

git clone https://github.com/pybricks/pybricks-micropython

What about all the other repositories?

Pybricks includes not just firmware for each LEGO hub, but also various tools, documentation, and fun projects. Here's an overview of the other repositories:

  • pybricks-api: This is the Pybricks user API. It documents the pybricks package that comes preinstalled in our firmware. This repository doesn't contain any real code. The real package is written in C and baked into the firmware. This repo just helps us design and document the user Python API without getting into too much implementation details. Don't want to build it? View the web version here.
  • pybricks-projects: This is a broad collection of end-user MicroPython scripts that you can run! This includes example snippets and projects for official LEGO models and custom made ones.

What about the other stuff in /bricks?

Like MicroPython, Pybricks can run on just about every device that lets you update the firmware. And we could not resist doing just that, so there's more than just the bricks above. But getting to a point where it is easy to use for everyday users takes quite a bit more work, so not all bricks in /bricks will be supported officially for now. Be sure to join the discussion on our issue tracker to share your thoughts on these new ports.

Differences with other LEGO MicroPython Implementations

We recommend that beginning users start with the official LEGO Python apps. Read more about the differences on the Pybricks about page.

How can I help?

If you've got any of the hubs listed above, the best way to help right now is to try out the beta release of Pybricks Code. You may run into issues or bugs. Please let us know by opening an issue. Thanks!

If you enjoy using Pybricks, please consider sponsoring the project.