Skip to main content

PicoFX: A RGB and Mono LED effects system for MicroPython

Project description

PicoFX

A RGB and Mono LED effects system for MicroPython

This repository is home to the PicoFX library, as well as MicroPython builds for supported boards like the Pimoroni Tiny FX and Tiny FX W.

Build Status GitHub release (latest by date)

Introduction

PicoFX is a MicroPython library for easily playing effects on mono and RGB leds.

Tiny FX is a programmable, RP2040-based controller board for adding smart light and sound effects to models and dioramas.

Get TinyFX

Programming TinyFX

All Tiny FX boards come pre-flashed with MicroPython and the libraries and examples needed to get you started.

To program Tiny FX you'll need to use an interpreter such as Thonny, which is available for Windows, Mac and Linux.

  • Connect Tiny FX to your computer with a USB-C cable.
  • Make sure you have 'MicroPython (Raspberry Pi Pico)' or 'MicroPython (RP2040)' selected as your interpreter in the bottom right of Thonny.
  • You'll probably also want the 'Files' window open (View > Files), so you can browse the files on the device.
  • Tiny FX runs a example by default so you'll need to press the stop button in Thonny to interrupt it before you can browse files or run code on the board.

If you're new to working with RP2040 boards, this Learn Guide goes into more detail about how to install and use Thonny.

Download MicroPython for Tiny FX

If you wish to update your board to the latest firmware or restore it back to a factory state, you can grab the latest release from https://github.com/pimoroni/picofx/releases/latest

There are two .uf2 files to pick from:

Firmware Only

  • tiny_fx-vX.X.X-pimoroni-micropython.uf2
  • tiny_fx_w-vX.X.X-pimoroni-micropython.uf2

This build includes only the firmware needed for Tiny FX to function. You will need to manually update the lib/picofx library afterwards to get the latest features and bug fixes.

With Libraries and Examples

:warning: This option will overwrite the entire contents of your Tiny FX! Be sure to back up files to your PC before installing!

  • tiny_fx-vX.X.X-pimoroni-micropython-with-libs-and-examples.uf2
  • tiny_fx_w-vX.X.X-pimoroni-micropython-with-libs-and-examples.uf2

This build contains both the firmware for Tiny FX, library files to easily create effects, and examples to get you going.

Flashing the Firmware

  1. Connect Tiny FX to your computer using a USB C cable.

  2. Put your board into bootloader mode by holding the BOOT button whilst tapping the RST button.

  3. Drag and drop one of the .uf2 files to the "RPI-RP2" drive that appears.

  4. After the copy completes your board should reset and, if you used the with-libs-and-examples variant, should start playing a wave sequence on the mono outputs, and a rainbow on the RGB output.

Examples

There are many examples to get you started with TinyFX (and other boards), located in the examples folder of this repository:

Documentation

To take TinyFX further, the full API documentation for the board can be found at:

Changelog

1.1.1

  • Include build files for release on PyPi

1.1.0

  • fixed error in docs
  • Readme: add programming info
  • Micropython 1.26 Update
  • Add the Pimoroni AyeArr library to TinyFX builds, and bump MP to v1.27
  • Clean up patches no longer needed for newest Micropython
  • Bump to v1.28 of Micropython
  • Add examples for using Aye Arr with Tiny FX by

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

picofx-1.1.1.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

picofx-1.1.1-py2.py3-none-any.whl (20.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file picofx-1.1.1.tar.gz.

File metadata

  • Download URL: picofx-1.1.1.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for picofx-1.1.1.tar.gz
Algorithm Hash digest
SHA256 3f9790a9366b73dd4c9e8e0bbe056152138686ff88ad8d444a082d1fc9fa75cf
MD5 b45ae0996aa544749e4bc561c0f1d758
BLAKE2b-256 2a21bab6289c9e7d6d0027a7ffcfb49c2587bafd09a4c7d98336f58177390171

See more details on using hashes here.

File details

Details for the file picofx-1.1.1-py2.py3-none-any.whl.

File metadata

  • Download URL: picofx-1.1.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 20.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for picofx-1.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 67921fc42cc3fb64b7eecde902d9db256afd204bed87c208e7755d5481866589
MD5 2ebeacab5edada122fbb539d675b009c
BLAKE2b-256 3d862aee9c20efea1faaac0e9a2b5acfa5a6726e0c5b2d08d8eb9f90bb907fda

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page