-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
32e1f6b
commit 7ec9841
Showing
11 changed files
with
481 additions
and
424 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,74 @@ | ||
| # Pimoroni Yukon <!-- omit in toc --> | ||
| ## Firmware, Examples & Documentation <!-- omit in toc --> | ||
|
|
||
| Yukon is a high power modular robotics / engineering platform, powered by the Raspberry Pi RP2040. Learn more - https://shop.pimoroni.com/products/yukon | ||
| This repository is home to the MicroPython build, library, and examples for Pimoroni Yukon. | ||
|
|
||
| - [Install](#install) | ||
| - [Flashing the Firmware](#flashing-the-firmware) | ||
| - [Examples and Usage](#examples-and-usage) | ||
| [](https://github.com/pimoroni/yukon/actions/workflows/micropython.yml) | ||
| [](https://github.com/pimoroni/picovision/releases/latest/) | ||
|
|
||
| - [Introduction](#introduction) | ||
| - [Download MicroPython](#download-micropython) | ||
| - [Regular](#regular) | ||
| - [With Filesystem](#with-filesystem) | ||
| - [Flashing the Firmware](#flashing-the-firmware) | ||
| - [Examples](#examples) | ||
| - [Documentation](#documentation) | ||
|
|
||
| ## Install | ||
|
|
||
| ## Introduction | ||
|
|
||
| Yukon is a high-power modular robotics and engineering platform, able to drive your most ambitious of robots, props or contraptions! | ||
|
|
||
| Powered by the RP2040, Yukon leverages the chip's unique pin capabilities to offer six slots for attaching a range of interchangeable hardware modules for driving high-powered devices. This lets you control motors, servos, steppers, speakers, LED strips, and more, all from a single board! | ||
|
|
||
| Customise Yukon to suit almost any project, or started with a few modules and expand as a project grows. There is also a proto module for adding more features! Each module is screwed down to ensure a solid mechanical and electrical connection. | ||
|
|
||
| * :link: [Buy a Yukon here](https://shop.pimoroni.com/products/yukon) | ||
|
|
||
| ## Download MicroPython | ||
|
|
||
| Grab the latest release from [https://github.com/pimoroni/yukon/releases/latest](https://github.com/pimoroni/yukon/releases/latest) | ||
|
|
||
| There are two .uf2 files to pick from. | ||
| There are two .uf2 files to pick from: | ||
|
|
||
| ### Regular | ||
|
|
||
| * `pimoroni-yukon-vX.X.X-micropython.uf2` | ||
|
|
||
| This build includes only the firmware needed for Yukon to function, and leaves your files alone. You will need to manually update the `lib/pimoroni_yukon` library afterwards to get the latest features and bug fixes. | ||
|
|
||
|
|
||
| ### With Filesystem | ||
|
|
||
| :warning: **This option will overwrite the entire contents of your Yukon! Be sure to back up files to your PC before installing!** | ||
|
|
||
| * `pimoroni-yukon-vX.X.X-micropython-with-filesystem.uf2 ` | ||
|
|
||
| :warning: Those marked `with-filesystem` contain a full filesystem image that will overwrite both the firmware *and* filesystem of your Yukon: | ||
| This build contains both the firmware for Yukon and the library files needed to take full advantage of the hardware. | ||
|
|
||
| * pimoroni-yukon-vX.X.X-micropython-with-filesystem.uf2 | ||
| ## Flashing the Firmware | ||
|
|
||
| The regular builds just include the firmware, and leave your files alone: | ||
| 1. Connect Yukon to your computer using a USB A to C cable. | ||
|
|
||
| * pimoroni-yukon-vX.X.X-micropython.uf2 | ||
| 2. Turn off your board by pressing the PWR button. The green light should turn off. | ||
|
|
||
| 3. Put your board into bootloader mode by holding the BOOT/USER button whilst pressing the PWR button to turn the board on. The green light should turn on, and the lights next to the A and B buttons should have a dim glow. | ||
|
|
||
| ### Flashing the Firmware | ||
| 4. Drag and drop one of the `pimoroni-yukon-vX.X.X...` .uf2 files to the "RPI-RP2" drive that appears. | ||
|
|
||
| 1. Connect your Yukon to your computer using a USB A to C cable. | ||
| 5. After the copy completes your board should reset and, if you used the `with-filesystem` variant, should start playing a flashing pattern on the A and B LEDs. | ||
|
|
||
| 2. Turn off your board by pressing the PWM button. The green light should turn off. | ||
| :information_source: **Overwriting Yukon's filesystem can take multiple minutes to complete.** | ||
|
|
||
| 3. Put your device into bootloader mode by holding the BOOT/USER button whilst pressing the PWR button to turn the board on. The green light should turn on, and the lights next to the A and B buttons should have a dim glow. | ||
|
|
||
| 4. Drag and drop one of the `yukon` .uf2 files to the "RPI-RP2" drive that appears. | ||
| ## Examples | ||
|
|
||
| 5. Your device should reset and, if you used the `with-filesystem` variant, should see the A and B lights flash in a repeated pattern. | ||
| There are many examples to get you started with Yukon, located in the examples folder of this repository. Details about what each one does can be found in their respective sections: | ||
|
|
||
| * [Examples: Board](/examples/board/README.md) | ||
| * [Examples: Modules](/examples/modules/README.md) | ||
| * [Examples: Showcase](/examples/showcase/README.md) | ||
|
|
||
| ## Examples and Usage | ||
|
|
||
| There are many examples to get you started with Yukon, located in the examples folder of this repository. Details about what each one does can be found in the [examples readme](/examples/README.md). | ||
| ## Documentation | ||
|
|
||
| To take Yukon further, the full API is described in the [documentation readme](/docs/README.md) |
Oops, something went wrong.