Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pimoroni/yukon


https://github.com/pimoroni/yukon

Last synced: about 6 hours ago
JSON representation

Awesome Lists containing this project

README 

        
# Pimoroni Yukon 






This repository is home to the MicroPython build, library, and examples for Pimoroni Yukon.



[![Build Status](https://img.shields.io/github/actions/workflow/status/pimoroni/yukon/micropython.yml?branch=main&label=MicroPython)](https://github.com/pimoroni/yukon/actions/workflows/micropython.yml)

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/pimoroni/yukon)](https://github.com/pimoroni/picovision/releases/latest/)



- [Introduction](#introduction)

- [Download MicroPython](#download-micropython)

  - [Firmware Only](#firmware-only)

  - [With Filesystem](#with-filesystem)

- [Flashing the Firmware](#flashing-the-firmware)

- [Examples](#examples)

- [Documentation](#documentation)

- [Library Reference](#library-reference)

  - [Boards](#boards)

  - [Modules](#modules)

  - [Devices](#devices)



## Introduction



Yukon is a high-power modular robotics and engineering platform, designed to drive the most ambitious of robots, props and devices!



Powered by 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 drive unique combinations of motors, servos, steppers, speakers, LED strips, and more, all from a single Yukon board!



Powering Yukon is easy thanks to its XT30 connector, which enables you to attach 2 to 4 cell Lithium Polymer (LiPo) batteries (or any other source from 5V to 17V) to deliver up to 15A continuous for your high-power projects. An e-Fuse with switchable output is included to protect from accidental overvoltage and overcurrent events, along with internal sensors for monitoring voltage, current, and temperature whilst your programs run.



Yukon is supported by a comprehensive MicroPython library with a whopping 50 (!) examples to show you how to use the individual features of the board and all of its modules. There are even showcases of Yukon as a remote-controlled rover, spider tank, and pen plotter!



* :link: [Buy a Yukon here](https://shop.pimoroni.com/products/yukon)



## Download MicroPython



All Yukon boards come pre-flashed with MicroPython and the libraries needed to get you started. The instructions below are for if you wish to update your board to the latest firmware or restore it back back to a factory state.



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:



### Firmware Only



* `pimoroni-yukon-vX.X.X-micropython.uf2`



This build includes only the firmware needed for Yukon to function. 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 `



This build contains both the firmware for Yukon and the library files needed to take full advantage of the hardware.



## Flashing the Firmware



1. Connect Yukon to your computer using a USB A to C cable.



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.



4. Drag and drop one of the `pimoroni-yukon-vX.X.X...` .uf2 files to the "RPI-RP2" drive that appears.



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.



:information_source: **Overwriting Yukon's filesystem can take multiple minutes to complete.**



## Examples



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)



## Documentation



To find out more about how Yukon works, the following documentation is available:



* [Docs: Overview](/docs/overview.md)

* [Docs: Module Detection](/docs/module_detection.md)



## Library Reference



To take Yukon further, the full API for the library is described in the following documentation pages.



### Boards



* [Docs: Yukon](/docs/reference.md)



### Modules



* [Docs: Audio Amp Module](/docs/modules/audio_amp.md)

* [Docs: Bench Power Module](/docs/modules/bench_power.md)

* [Docs: Big Motor + Encoder Module](/docs/modules/big_motor.md)

* [Docs: Dual Motor / Bipolar Stepper Module](/docs/modules/dual_motor.md)

* [Docs: Dual Switched Output Module](/docs/modules/dual_output.md)

* [Docs: LED Strip Module](/docs/modules/led_strip.md)

* [Docs: Quad Servo Direct Module](/docs/modules/quad_servo_direct.md)

* [Docs: Quad Servo Regulated Module](/docs/modules/quad_servo_reg.md)

* [Docs: Serial Bus Servo Module](/docs/modules/serial_servo.md)

* [Docs: Yukon Module](/docs/modules/yukon_module.md)

* [Docs: Custom Module](/docs/modules/custom_module.md)



### Devices



* [Docs: LX Servo Class](/docs/devices/lxservo.md)

* [Docs: OkayStepper Class](/docs/devices/okaystepper.md)

* [Docs: WavPlayer Class](/docs/devices/wavplayer.md)