update examples readme

pull/559/head
Hel Gibbons 2022-11-03 15:20:28 +00:00
rodzic 0f5e96495c
commit c599ae4941
1 zmienionych plików z 24 dodań i 16 usunięć

Wyświetl plik

@ -2,7 +2,7 @@
Galactic Unicorn offers 53x11 bright RGB LEDs driven by Pico W's PIO in addition to a 1W amplifier + speaker, a collection of system and user buttons, and two Qw/ST connectors for adding external sensors and devices. Woha!
- link:[Galactic Unicorn store page](https://shop.pimoroni.com/products/galactic-unicorn)
- :link: [Galactic Unicorn store page](https://shop.pimoroni.com/products/galactic-unicorn)
Galactic Unicorn ships with MicroPython firmware pre-loaded, but you can download the most recent version at the link below (you'll want the `galactic-unicorn` image).
@ -21,12 +21,13 @@ Galactic Unicorn ships with MicroPython firmware pre-loaded, but you can downloa
- [Rainbow](#rainbow)
- [Scrolling Text](#scrolling-text)
- [Wireless Examples](#wireless-examples)
- [Cheerlights Over Time](#cheerlights-over-time)
- [Cheerlights History](#cheerlights-history)
- [Galactic Paint](#galactic-paint)
- [Factory reset](#factory-reset)
## Galactic Unicorn and PicoGraphics
The easiest way to start displaying stuff on Galactic Unicorn is using our Galactic Unicorn module (which contains a bunch of helpful functions for interacting with the buttons, adjusting brightness and suchlike) and our PicoGraphics library, which is chock full of useful functions for drawing on the LED matrix.
The easiest way to start displaying cool stuff on Galactic Unicorn is using our Galactic Unicorn module (which contains a bunch of helpful functions for interacting with the buttons, adjusting brightness and suchlike) and our PicoGraphics library, which is chock full of useful functions for drawing on the LED matrix.
- [Galactic Unicorn function reference](../../modules/picographics/README.md)
- [PicoGraphics function reference](../../modules/galactic_unicorn/README.md)
@ -43,59 +44,59 @@ Clock example with (optional) NTP synchronization.
[eighties_super_computer.py](eighties_super_computer.py)
todo
Random LEDs blink on and off mimicing the look of a movie super computer doing its work in the eighties.
### Feature Test
[feature_test.py](feature_test.py)
todo
Displays some text, gradients and colours and demonstrates button use.
### Feature Test With Audio
[feature_test_with_audio.py](feature_test_with_audio.py)
todo
Displays some text, gradients and colours and demonstrates button use. Also demonstrates some of the audio / synth features.
### Fire Effect
[fire_effect.py](fire_effect.py)
todo
A pretty, procedural fire effect. Switch `landscape = False` for vertical fire!
### Lava Lamp
[lava_lamp.py](lava_lamp.py)
todo
A 70s-tastic, procedural rainbow lava lamp.
### Nostalgia Prompt
[nostalgia_prompt.py](nostalgia_prompt.py)
todo
A collection of copies of classic terminal styles including C64, MS-DOS, Spectrum, and more. Images and text are drawn pixel by pixel from a pattern of Os and Xs.
### Rainbow
[rainbow.py](rainbow.py)
Some good old fashioned rainbows!
Some good old fashioned rainbows! You can adjust the cycling speed with VOL + and - and the brightness with LUX + and -.
### Scrolling Text
[scrolling_text.py](scrolling_text.py)
todo
Display scrolling wisdom, quotes or greetz.
## Wireless Examples
### Cheerlights Over Time
### Cheerlights History
[cheerlights_over_time.py](cheerlights_over_time.py)
[cheerlights_history.py](cheerlights_history.py)
todo
Updates one pixel every five minutes to display the most recent #Cheerlights colour. Discover the most popular colours over time, or use it as an avant garde (but colourful) 53 hour clock! Find out more about the Cheerlights API at https://cheerlights.com/
This wireless example needs `network_manager.py` and `WIFI_CONFIG.py` from the `common` directory to be saved to your Pico W. Open up `WIFI_CONFIG.py` in Thonny to add your wifi details (and save it when you're done).
This example needs `network_manager.py` and `WIFI_CONFIG.py` (from the `common` directory) to be saved to your Pico W. Open up `WIFI_CONFIG.py` in Thonny to add your wifi details (and save it when you're done).
- [micropython/examples/common](../../examples/common)
@ -103,6 +104,13 @@ This wireless example needs `network_manager.py` and `WIFI_CONFIG.py` from the `
[galactic_paint](galactic_paint)
todo
Draw on your Galactic Unicorn from another device in real time!
- [Galactic Paint readme](galactic_paint/README.md)
## Factory reset
[launch](launch)
If you want to get the demo reel back, copy the contents of this `launch` folder to your Pico W.