From c247770f481995393f4d106db20f9d8bb9ebbb98 Mon Sep 17 00:00:00 2001 From: ZodiusInfuser Date: Fri, 4 Nov 2022 10:57:53 +0000 Subject: [PATCH] Updated example descriptions --- .../examples/galactic_unicorn/README.md | 23 ++++++++++++------- .../eighties_super_computer.py | 7 ++++++ .../examples/galactic_unicorn/feature_test.py | 6 +++++ .../feature_test_with_audio.py | 11 +++++++++ .../examples/galactic_unicorn/fire_effect.py | 7 ++++++ .../examples/galactic_unicorn/lava_lamp.py | 6 +++++ .../galactic_unicorn/nostalgia_prompt.py | 8 +++++++ .../examples/galactic_unicorn/rainbow.py | 9 ++++++++ .../galactic_unicorn/scrolling_text.py | 6 +++++ 9 files changed, 75 insertions(+), 8 deletions(-) diff --git a/micropython/examples/galactic_unicorn/README.md b/micropython/examples/galactic_unicorn/README.md index 3af29f1f..677e6bc0 100644 --- a/micropython/examples/galactic_unicorn/README.md +++ b/micropython/examples/galactic_unicorn/README.md @@ -42,55 +42,60 @@ The easiest way to start displaying cool stuff on Galactic Unicorn is using our [clock.py](clock.py) -Clock example with (optional) NTP synchronization. +Clock example with (optional) NTP synchronization. You can adjust the brightness with LUX + and -, and resync the time by pressing A. ### Eighties Super Computer [eighties_super_computer.py](eighties_super_computer.py) -Random LEDs blink on and off mimicing the look of a movie super computer doing its work in the eighties. +Random LEDs blink on and off mimicing the look of a movie super computer doing its work in the eighties. You can adjust the brightness with LUX + and -. ### Feature Test [feature_test.py](feature_test.py) -Displays some text, gradients and colours and demonstrates button use. +Displays some text, gradients and colours and demonstrates button use. You can adjust the brightness with LUX + and -. ### Feature Test With Audio [feature_test_with_audio.py](feature_test_with_audio.py) Displays some text, gradients and colours and demonstrates button use. Also demonstrates some of the audio / synth features. +- Button A plays a synth tune +- Button B plays a solo channel of the synth tune +- Button C plays a sinewave (it's frequency can be adjusted with VOL + and -) +- Button D plays a second sinewave (it's frequency can be adjusted with LUX + and -) +- Sleep button stops the sounds ### Fire Effect [fire_effect.py](fire_effect.py) -A pretty, procedural fire effect. Switch `landscape = False` for vertical fire! +A pretty, procedural fire effect. Switch between landscape fire and vertical fire using the A and B buttons! You can adjust the brightness with LUX + and -. ### Lava Lamp [lava_lamp.py](lava_lamp.py) -A 70s-tastic, procedural rainbow lava lamp. +A 70s-tastic, procedural rainbow lava lamp. You can adjust the brightness with LUX + and -. ### Nostalgia Prompt [nostalgia_prompt.py](nostalgia_prompt.py) -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. +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. You can adjust the brightness with LUX + and -. ### Rainbow [rainbow.py](rainbow.py) -Some good old fashioned rainbows! You can adjust the cycling speed with VOL + and - and the brightness with LUX + and -. +Some good old fashioned rainbows! You can adjust the cycling speed with A and B, stripe width with C and D, hue with VOL + and -, and the brightness with LUX + and -. The sleep button stops the animation (can be started again with A or B). ### Scrolling Text [scrolling_text.py](scrolling_text.py) -Display scrolling wisdom, quotes or greetz. +Display scrolling wisdom, quotes or greetz. You can adjust the brightness with LUX + and -. ## Wireless Examples @@ -106,6 +111,8 @@ Updates one pixel every five minutes to display the most recent #Cheerlights col Requires `WIFI_CONFIG.py` and `network_manager.py` from the `common` directory. +You can adjust the brightness with LUX + and -. + ### Galactic Paint [galactic_paint](galactic_paint) diff --git a/micropython/examples/galactic_unicorn/eighties_super_computer.py b/micropython/examples/galactic_unicorn/eighties_super_computer.py index 168ac9c5..501e5eb4 100644 --- a/micropython/examples/galactic_unicorn/eighties_super_computer.py +++ b/micropython/examples/galactic_unicorn/eighties_super_computer.py @@ -3,6 +3,13 @@ import random from galactic import GalacticUnicorn from picographics import PicoGraphics, DISPLAY_GALACTIC_UNICORN as DISPLAY +''' +Random LEDs blink on and off mimicing the look of a movie +super computer doing its work in the eighties. + +You can adjust the brightness with LUX + and -. +''' + gu = GalacticUnicorn() graphics = PicoGraphics(DISPLAY) diff --git a/micropython/examples/galactic_unicorn/feature_test.py b/micropython/examples/galactic_unicorn/feature_test.py index 462a94a4..891076e6 100644 --- a/micropython/examples/galactic_unicorn/feature_test.py +++ b/micropython/examples/galactic_unicorn/feature_test.py @@ -3,6 +3,12 @@ import math from galactic import GalacticUnicorn from picographics import PicoGraphics, DISPLAY_GALACTIC_UNICORN as DISPLAY +''' +Displays some text, gradients and colours and demonstrates button use. + +You can adjust the brightness with LUX + and -. +''' + gu = GalacticUnicorn() graphics = PicoGraphics(DISPLAY) diff --git a/micropython/examples/galactic_unicorn/feature_test_with_audio.py b/micropython/examples/galactic_unicorn/feature_test_with_audio.py index ea97e90c..482ce5d5 100644 --- a/micropython/examples/galactic_unicorn/feature_test_with_audio.py +++ b/micropython/examples/galactic_unicorn/feature_test_with_audio.py @@ -5,6 +5,17 @@ from machine import Timer from galactic import GalacticUnicorn, Channel from picographics import PicoGraphics, DISPLAY_GALACTIC_UNICORN as DISPLAY +''' +Displays some text, gradients and colours and demonstrates button use. +Also demonstrates some of the audio / synth features. + +- Button A plays a synth tune +- Button B plays a solo channel of the synth tune +- Button C plays a sinewave (it's frequency can be adjusted with VOL + and -) +- Button D plays a second sinewave (it's frequency can be adjusted with LUX + and -) +- Sleep button stops the sounds +''' + gc.collect() gu = GalacticUnicorn() diff --git a/micropython/examples/galactic_unicorn/fire_effect.py b/micropython/examples/galactic_unicorn/fire_effect.py index 8d801a7b..9c12bd1b 100644 --- a/micropython/examples/galactic_unicorn/fire_effect.py +++ b/micropython/examples/galactic_unicorn/fire_effect.py @@ -3,6 +3,13 @@ import random from galactic import GalacticUnicorn from picographics import PicoGraphics, DISPLAY_GALACTIC_UNICORN as DISPLAY +''' +A pretty, procedural fire effect. + +Switch between landscape fire and vertical fire using the A and B buttons! +You can adjust the brightness with LUX + and -. +''' + gu = GalacticUnicorn() graphics = PicoGraphics(DISPLAY) diff --git a/micropython/examples/galactic_unicorn/lava_lamp.py b/micropython/examples/galactic_unicorn/lava_lamp.py index 49a40f3f..ed577e5c 100644 --- a/micropython/examples/galactic_unicorn/lava_lamp.py +++ b/micropython/examples/galactic_unicorn/lava_lamp.py @@ -4,6 +4,12 @@ import math from galactic import GalacticUnicorn from picographics import PicoGraphics, DISPLAY_GALACTIC_UNICORN as DISPLAY +''' +A 70s-tastic, procedural rainbow lava lamp. + +You can adjust the brightness with LUX + and -. +''' + gu = GalacticUnicorn() graphics = PicoGraphics(DISPLAY) diff --git a/micropython/examples/galactic_unicorn/nostalgia_prompt.py b/micropython/examples/galactic_unicorn/nostalgia_prompt.py index ca222f91..5cb23aa6 100644 --- a/micropython/examples/galactic_unicorn/nostalgia_prompt.py +++ b/micropython/examples/galactic_unicorn/nostalgia_prompt.py @@ -2,6 +2,14 @@ import time from galactic import GalacticUnicorn from picographics import PicoGraphics, DISPLAY_GALACTIC_UNICORN as DISPLAY +''' +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. + +You can adjust the brightness with LUX + and -. +''' + gu = GalacticUnicorn() graphics = PicoGraphics(DISPLAY) diff --git a/micropython/examples/galactic_unicorn/rainbow.py b/micropython/examples/galactic_unicorn/rainbow.py index 818ee0a1..019132bb 100644 --- a/micropython/examples/galactic_unicorn/rainbow.py +++ b/micropython/examples/galactic_unicorn/rainbow.py @@ -3,6 +3,15 @@ import math from galactic import GalacticUnicorn from picographics import PicoGraphics, DISPLAY_GALACTIC_UNICORN as DISPLAY +''' +Some good old fashioned rainbows! + +You can adjust the cycling speed with A and B, +stripe width with C and D, hue with VOL + and -, +and the brightness with LUX + and -. +The sleep button stops the animation (can be started again with A or B). +''' + gu = GalacticUnicorn() graphics = PicoGraphics(DISPLAY) diff --git a/micropython/examples/galactic_unicorn/scrolling_text.py b/micropython/examples/galactic_unicorn/scrolling_text.py index 3210dec1..40d8c764 100644 --- a/micropython/examples/galactic_unicorn/scrolling_text.py +++ b/micropython/examples/galactic_unicorn/scrolling_text.py @@ -2,6 +2,12 @@ import time from galactic import GalacticUnicorn from picographics import PicoGraphics, DISPLAY_GALACTIC_UNICORN as DISPLAY +''' +Display scrolling wisdom, quotes or greetz. + +You can adjust the brightness with LUX + and -. +''' + # constants for controlling scrolling text PADDING = 5 MESSAGE_COLOUR = (255, 255, 255)