pinout-xyz / microbit.pinout.xyz

Everything you know and love about Pinout.xyz, now for the BBC micro:bit
7 stars 5 forks source link

micro:bit pinout

Creative Commons License

About this project

micro:bit pinout is a detailed, interactive guide to the GPIO pins on your BBC micro:bit, and the pins that various micro:bit add-ons use.

Find out if two add-ons will work together, or what pins you have available when using a particular add-on.

Contributing

Boards/Add-ons

If you've got a micro:bit add-on you want to see listed on microbit.pinout.xyz then please raise an issue with details of your board and a link to an appropriate photo.

You may also raise a pull request, contributing your board directly to overlay/manufacturer-boardname.md and image to resources/manufacturer-boardname.jpg. Use an existing board as a template and don't forget to test that it builds.

Translations

Based on what we learned with Pinout.xyz, I'll be handling translations as forks or branches and would appreciate some input from anyone fluent in English and the three most popular non-English lanauges from Pinout.xyz:

Building

Linux/OSX/Linux-On-Windows

microbit.pinout.xyz includes a Makefile to help you set up a build environment and generate the .html files. For most build processes you should prepare the Python virtual environment with:

Install required libraries

pip install virtualenv pyyaml markdown

Create and enter virtual environment

make venv
source venv/bin/activate

Build the HTML files

make pinout

Support this project

micro:bit pinout is a passion project put together in my free time, leverging my first-hand knowledge of designing, manufacturing and supporting micro:bit add-ons at Pimoroni.

If you'd like to keep me fed, fuelled and beered while I slog away and contribute to hosting and domain costs please head on over to my Patreon and throw a dollar my way - https://www.patreon.com/gadgetoid - thank you!

With thanks to

Micro:bit Educational Foundation for inspiration with the web design from their micro:bit classroom tool.