pimoroni-pico/micropython/modules/pico_unicorn
Phil Howard 540bc2f75f Pico Unicorn/Scroll: Add buttons/dimensions to both module and class. 2023-03-27 15:11:30 +01:00
..
README.md Update Pico Unicorn readme 2022-10-24 12:53:58 +01:00
micropython.cmake Pico Unicorn: Add support for PicoGraphics. 2023-03-16 15:02:28 +00:00
pico_unicorn.c Pico Unicorn/Scroll: Add buttons/dimensions to both module and class. 2023-03-27 15:11:30 +01:00
pico_unicorn.cpp Pico Unicorn: Add support for PicoGraphics. 2023-03-16 15:02:28 +00:00
pico_unicorn.h Pico Unicorn: Add support for PicoGraphics. 2023-03-16 15:02:28 +00:00

README.md

Pico Unicorn Pack - MicroPython

Our Pico Unicorn Pack offers 7x17 bright RGB LEDs driven by Pico's PIO.

We've included helper functions for lighting up the LEDs and interfacing with the buttons. See the function reference for details.

Example Program

The following example sets up Pico Unicorn, displays a rainbow across the LEDs and turns them all off when a button is pressed.

import math
import time
import picounicorn

picounicorn.init()

# From CPython Lib/colorsys.py
def hsv_to_rgb(h, s, v):
    if s == 0.0:
        return v, v, v
    i = int(h*6.0)
    f = (h*6.0) - i
    p = v*(1.0 - s)
    q = v*(1.0 - s*f)
    t = v*(1.0 - s*(1.0-f))
    i = i%6
    if i == 0:
        return v, t, p
    if i == 1:
        return q, v, p
    if i == 2:
        return p, v, t
    if i == 3:
        return p, q, v
    if i == 4:
        return t, p, v
    if i == 5:
        return v, p, q

w = picounicorn.get_width()
h = picounicorn.get_height()

# Display a rainbow across Pico Unicorn
for x in range(w):
    for y in range(h):
        r, g, b = [int(c * 255) for c in hsv_to_rgb(x / w, y / h, 1.0)]
        picounicorn.set_pixel(x, y, r, g, b)

print("Press Button A")

while not picounicorn.is_pressed(picounicorn.BUTTON_A):  # Wait for Button A to be pressed
    pass

# Clear the display
picounicorn.clear()

print("Button A pressed!")

Function Reference

init

Sets up Pico Unicorn. init must be called before any other functions since it configures the PIO and require GPIO inputs. Just call init() like so:

picounicorn.init()

set_pixel

Sets an RGB LED on Pico Unicorn with an RGB triplet:

picounicorn.set_pixel(x, y, r, g, b)

Uses hardware PWM to drive the LED. Values are automatically gamma-corrected to provide smooth brightness transitions and low values may map as "off."

set_pixel_value

Sets all elements of an RGB LED on Pico Unicorn to a single value:

picounicorn.set_pixel_value(x, y, v)

This lights an LED up white at varying intensity and is useful if you want to pretend Pico Unicorn is a monochrome display.

is_pressed

Reads the GPIO pin connected to one of Pico Unicorn's buttons, returning True if it's pressed and False if it is released.

picounicorn.is_pressed(button)

The button value should be a number denoting a pin, and constants picounicorn.BUTTON_A, picounicorn.BUTTON_B, picounicorn.BUTTON_X and picounicorn.BUTTON_Y are supplied to make it easier. e:

is_a_button_pressed = picounicorn.is_pressed(picounicorn.BUTTON_A)

get_width / get_height

You can get the width and height of the Pico Unicorn display:

width = picounicorn.get_width()
height = picounicorn.get_height()

This is useful where you're looping through the rows and columns to display a pattern- such as a rainbow using hsv_to_rgb.

clear

Turn off all the LEDs:

picounicorn.clear()