Template for MicroPython development

This repo is a Template Repository you can use to initialize a MicroPython project. It has everything you need to get started immediately, including a Hello World example.

Setup

To use this as a base for your own project click "Use this template" and follow the prompts to create your own repository. From there you can clone that repo and begin to modify for your purposes.

If you do not have a GitHub account, or do not wish to create a GitHub repository, you can clone this repo to your local filesystem:

git clone https://github.com/skullydazed/micropython_template.git my_cool_project

Dependencies

Run make install_deps to install the dependencies.

Prepare the Raspberry Pi Pico

You will need to install the MicroPython firmware on your Raspberry Pi Pico.

Code

A basic main.py has been included so that you can test your setup immediately. It will blink the onboard LED 5 times and then exit to the REPL.

Usage

Run make when you are ready to upload and run your code. This will upload every *.py file to the Pico and connect to the serial console. From here you can press ^D to soft reboot and run your code.

make help

Use make help to see the available commands:

Usage: make [command]

Commands for the Raspberry Pi Pico:

    make              - Runs make upload followed by make console
    make console      - Opens the serial console for the RPi Pico
    make ls           - List all files on the RPi Pico
    make reset        - Soft reboot the RPi Pico and run main.py
    make rm-rf        - Removes all files from the Raspberry Pi Pico
    make upload       - Upload user code from the current directory
    make upload_mods  - Upload 3rd party modules installed with make upip

Commands for the Local Machine:

    make install_deps - Install dependencies needed for development
    make upip         - Install a 3rd party micropython library
    make help         - This output

Detailed help for upip:

    This command will install a 3rd party package and upload it to your RPi Pico.
    You must pass PACKAGE=<package_name> to the command. If you don't want to
    install it to your RPi Pico just yet you can also pass NOUPLOAD=true.

    make upip PACKAGE=<package_name> [NOUPLOAD=true]

skullydazed / micropython_template