Skip to content

Commit 3a3af42

Browse files
Merge pull request #18 from pimoroni/docs/readme
Readme: add programming info
2 parents 82ee19d + b42f82b commit 3a3af42

File tree

1 file changed

+39
-15
lines changed

1 file changed

+39
-15
lines changed

README.md

Lines changed: 39 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1-
# PicoFX - A RGB and Mono LED effects system for MicroPython <!-- omit in toc -->
1+
# PicoFX<!-- omit in toc -->
22

3-
This repository is home to the PicoFX library, as well as MicroPython builds for supported boards like the Pimoroni Tiny FX.
3+
## A RGB and Mono LED effects system for MicroPython <!-- omit in toc -->
4+
5+
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.
46

57
[![Build Status](https://img.shields.io/github/actions/workflow/status/pimoroni/picofx/micropython.yml?branch=main&label=MicroPython)](https://github.com/pimoroni/picofx/actions/workflows/micropython.yml)
68
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/pimoroni/picofx)](https://github.com/pimoroni/picofx/releases/latest/)
79

810
- [Introduction](#introduction)
9-
- [Download MicroPython for TinyFX](#download-micropython-for-tinyfx)
11+
- [Get TinyFX](#get-tinyfx)
12+
- [Programming TinyFX](#programming-tinyfx)
13+
- [Download MicroPython for Tiny FX](#download-micropython-for-tiny-fx)
1014
- [Firmware Only](#firmware-only)
1115
- [With Libraries and Examples](#with-libraries-and-examples)
1216
- [Flashing the Firmware](#flashing-the-firmware)
@@ -18,39 +22,59 @@ This repository is home to the PicoFX library, as well as MicroPython builds for
1822

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

21-
## Download MicroPython for TinyFX
25+
Tiny FX is a programmable, RP2040-based controller board for adding smart light and sound effects to models and dioramas.
26+
27+
## Get TinyFX
28+
29+
* [Tiny FX](https://shop.pimoroni.com/products/tinyfx)
30+
* [Tiny FX W](https://shop.pimoroni.com/products/tiny-fx-w) (with wireless connectivity)
31+
32+
## Programming TinyFX
33+
34+
All Tiny FX boards come pre-flashed with MicroPython and the libraries and examples needed to get you started.
35+
36+
To program Tiny FX you'll need to use an interpreter such as [Thonny](https://thonny.org/), which is available for Windows, Mac and Linux.
2237

23-
All Tiny FX boards come pre-flashed with MicroPython and the libraries and examples 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 to a factory state.
38+
* Connect Tiny FX to your computer with a USB-C cable.
39+
* Make sure you have 'MicroPython (Raspberry Pi Pico)' or 'MicroPython (RP2040)' selected as your interpreter in the bottom right of Thonny.
40+
* You'll probably also want the 'Files' window open (View > Files), so you can browse the files on the device.
41+
* 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.
2442

25-
Grab the latest release from [https://github.com/pimoroni/picofx/releases/latest](https://github.com/pimoroni/picofx/releases/latest)
43+
If you're new to working with RP2040 boards, this Learn Guide goes into more detail about how to install and use Thonny.
44+
45+
* [Getting Started with Pico](https://learn.pimoroni.com/article/getting-started-with-pico)
46+
47+
## Download MicroPython for Tiny FX
48+
49+
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](https://github.com/pimoroni/picofx/releases/latest)
2650

2751
There are two .uf2 files to pick from:
2852

2953
### Firmware Only
3054

31-
* `tinyfx-vX.X.X-pimoroni-micropython.uf2`
55+
* `tiny_fx-vX.X.X-pimoroni-micropython.uf2`
56+
* `tiny_fx_w-vX.X.X-pimoroni-micropython.uf2`
3257

3358
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.
3459

35-
3660
### With Libraries and Examples
3761

38-
:warning: **This option will overwrite the entire contents of your TinyFX! Be sure to back up files to your PC before installing!**
62+
:warning: **This option will overwrite the entire contents of your Tiny FX! Be sure to back up files to your PC before installing!**
3963

40-
* `tinyfx-vX.X.X-pimoroni-micropython-with-libs-and-examples.uf2 `
64+
* `tiny_fx-vX.X.X-pimoroni-micropython-with-libs-and-examples.uf2`
65+
* `tiny_fx_w-vX.X.X-pimoroni-micropython-with-libs-and-examples.uf2`
4166

42-
This build contains both the firmware for TinyFX, library files to easily create effects, and examples to get you going.
67+
This build contains both the firmware for Tiny FX, library files to easily create effects, and examples to get you going.
4368

4469
## Flashing the Firmware
4570

46-
1. Connect Tiny FX to your computer using a USB A to C cable.
71+
1. Connect Tiny FX to your computer using a USB C cable.
4772

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

50-
3. Drag and drop one of the `tinyfx-vX.X.X...` .uf2 files to the "RPI-RP2" drive that appears.
51-
52-
5. 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.
75+
3. Drag and drop one of the .uf2 files to the "RPI-RP2" drive that appears.
5376

77+
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.
5478

5579
## Examples
5680

0 commit comments

Comments
 (0)