Skip to content

Commit bbed38b

Browse files
committed
Update README
1 parent c995a14 commit bbed38b

File tree

1 file changed

+32
-24
lines changed

1 file changed

+32
-24
lines changed

README.md

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
## A RGB and Mono LED effects system for MicroPython <!-- omit in toc -->
44

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.
5+
This repository is home to the PicoFX library, as well as MicroPython builds for supported boards like the Pimoroni Mighty FX and Tiny FX (W).
66

77
[![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)
88
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/pimoroni/picofx)](https://github.com/pimoroni/picofx/releases/latest/)
99

1010
- [Introduction](#introduction)
11-
- [Get TinyFX](#get-tinyfx)
12-
- [Programming TinyFX](#programming-tinyfx)
13-
- [Download MicroPython for Tiny FX](#download-micropython-for-tiny-fx)
11+
- [Get Mighty and Tiny FX](#get-mighty-and-tiny-fx)
12+
- [Programming Mighty and Tiny FX](#programming-mighty-and-tiny-fx)
13+
- [Download MicroPython for Mighty and Tiny FX](#download-micropython-for-mighty-and-tiny-fx)
1414
- [Firmware Only](#firmware-only)
1515
- [With Libraries and Examples](#with-libraries-and-examples)
1616
- [Flashing the Firmware](#flashing-the-firmware)
@@ -24,68 +24,76 @@ PicoFX is a MicroPython library for easily playing effects on mono and RGB leds.
2424

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

27-
## Get TinyFX
27+
Mighty FX is a programmable, RP2350-based controller board that goes further with effects by adding motion and screens.
28+
29+
## Get Mighty and Tiny FX
30+
31+
* [Mighty FX](https://shop.pimoroni.com/products/mightyfx)
2832

2933
* [Tiny FX](https://shop.pimoroni.com/products/tinyfx)
3034
* [Tiny FX W](https://shop.pimoroni.com/products/tiny-fx-w) (with wireless connectivity)
3135

32-
## Programming TinyFX
36+
## Programming Mighty and Tiny FX
3337

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

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.
40+
To program Mighty and Tiny FX you'll need to use an interpreter such as [Thonny](https://thonny.org/), which is available for Windows, Mac and Linux.
3741

38-
* Connect Tiny FX to your computer with a USB-C cable.
42+
* Connect Mighty or Tiny FX to your computer with a USB-C cable.
3943
* Make sure you have 'MicroPython (Raspberry Pi Pico)' or 'MicroPython (RP2040)' selected as your interpreter in the bottom right of Thonny.
4044
* 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.
45+
* Mighty and Tiny FX run an 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.
4246

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

4549
* [Getting Started with Pico](https://learn.pimoroni.com/article/getting-started-with-pico)
4650

47-
## Download MicroPython for Tiny FX
51+
## Download MicroPython for Mighty and Tiny FX
4852

4953
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)
5054

51-
There are two .uf2 files to pick from:
55+
There are two types of .uf2 file to pick from:
5256

5357
### Firmware Only
5458

55-
* `tiny_fx-vX.X.X-pimoroni-micropython.uf2`
56-
* `tiny_fx_w-vX.X.X-pimoroni-micropython.uf2`
59+
* `mighty_fx-vX.X.X-micropython.uf2`
60+
* `tiny_fx-vX.X.X-micropython.uf2`
61+
* `tiny_fx_w-vX.X.X-micropython.uf2`
5762

58-
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.
63+
This build type includes only the firmware needed for Mighty and Tiny FX to function. You will need to manually update the `lib/picofx` library afterwards to get the latest features and bug fixes.
5964

6065
### With Libraries and Examples
6166

62-
:warning: **This option will overwrite the entire contents of your Tiny FX! Be sure to back up files to your PC before installing!**
67+
:warning: **This option will overwrite the entire contents of your Mighty and Tiny FX! Be sure to back up files to your PC before installing!**
6368

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`
69+
* `mighty_fx-vX.X.X-micropython-with-libs-and-examples.uf2`
70+
* `tiny_fx-vX.X.X-micropython-with-libs-and-examples.uf2`
71+
* `tiny_fx_w-vX.X.X-micropython-with-libs-and-examples.uf2`
6672

67-
This build contains both the firmware for Tiny FX, library files to easily create effects, and examples to get you going.
73+
This build type contains both the firmware for Mighty and Tiny FX, library files to easily create effects, and examples to get you going.
6874

6975
## Flashing the Firmware
7076

71-
1. Connect Tiny FX to your computer using a USB C cable.
77+
1. Connect Mighty or Tiny FX to your computer using a USB C cable.
7278

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

75-
3. Drag and drop one of the .uf2 files to the "RPI-RP2" drive that appears.
81+
3. Drag and drop one of the .uf2 files to the "RP2350" or "RPI-RP2" drive that appears.
7682

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.
83+
4. After the copy completes your board should reset and, if you used the `with-libs-and-examples` variant, should start playing a light sequence on the board's RGB and mono outputs.
7884

7985
## Examples
8086

81-
There are many examples to get you started with TinyFX (and other boards), located in the examples folder of this repository:
87+
There are many examples to get you started with Mighty and Tiny FX (and other boards), located in the examples folder of this repository:
8288

89+
* [Examples: Mighty FX](/examples/mighty_fx/README.md)
8390
* [Examples: Tiny FX](/examples/tiny_fx/README.md)
91+
* [Examples: Tiny FX W](/examples/tiny_fx_w/README.md)
8492
* [Examples: Plasma](/examples/plasma/README.md)
8593

8694

8795
## Documentation
8896

89-
To take TinyFX further, the full API documentation for the board can be found at:
97+
To take Mighty and Tiny FX further, the full API documentation for the boards can be found at:
9098

9199
* [Library Reference](/docs/reference.md)

0 commit comments

Comments
 (0)