pimoroni-pico/micropython/modules/pico_scroll
Philip Howard 7c87e0c65a
Merge pull request #47 from UnfinishedStuff/main
Added Pico Scroll documentation
2021-02-12 12:46:47 +00:00
..
README.md Initial commit of pico scroll documentation 2021-02-08 22:11:53 +00:00
micropython.mk Added mpy wrapper for pico_scroll 2021-01-19 18:43:43 +00:00
pico_scroll.c Fixed issue with clear of picoscroll not working under mpy, and added demo 2021-01-21 16:56:04 +00:00
pico_scroll.cpp Fix for hardlock on calling a module function prior to calling init() 2021-02-11 15:45:39 +00:00
pico_scroll.h Added mpy wrapper for pico_scroll 2021-01-19 18:43:43 +00:00
usermod.cmake Add usermod.cmake files for building against upstream usermod micropython usermod branch 2021-01-20 16:03:02 +00:00

README.md

Pico Scroll Pack - MicroPython

Our Pico Scroll Pack offers a 17x7 white LED matrix for your Raspberry Pi Pico. It also includes four buttons!

We've included helper functions to handle every aspect of drawing to the matrix and interfacing with the buttons. See the function reference for details.

Example Program

The following example sets up the matrix, sets each pixel to an increasing brightnesses level, and then clears the matrix only after button A is pressed.

import picoscroll

# Initialise the board
picoscroll.init()

brightness = 0

# For each pixel in the matrix
for y in range (0, picoscroll.get_height()):
  for x in range (0, picoscroll.get_width()):
    # Set that pixel to an increasing level of brightness
    picoscroll.set_pixel(x, y, brightness)
    brightness += 2

# Push the data to the matrix
picoscroll.update()

# Wait until the A button is pressed
while picoscroll.is_pressed(picoscroll.BUTTON_A) == False:
    pass

# Set the brightness of all pixels to 0
picoscroll.clear()
picoscroll.update()

Function reference

init

Sets up the Pico Scroll Pack. The init function must be called before any other functions as it configures the required pins on the Pico board.

picoscroll.init()

get_width

get_height

These return integers describing the height and width of the Scroll Pack in pixels.

width_in_pixels = picoscroll.get_width()
height_in_pixels = picoscroll.get_height()

set_pixel

This function sets a pixel at the x and y coordinates to a brightness level specified by the l parameter. The value of l must be 0-255. Changes will not be visible until update() is called.

picoscroll.set_pixel(x, y, l)

update

Pushes pixel data from the Pico to the Scroll Pack. Until this function is called any set_pixel or clear calls won't have any visible effect.

picoscroll.update()

clear

Sets the brightness of all pixels to 0. Will not visibly take effect until update is called.

picoscroll.clear()

is_pressed

Checks if a specified button is currently being pressed. Valid values of b are picoscroll.BUTTON_A, picoscroll.BUTTON_B, picoscroll.BUTTON_X, or picoscroll.BUTTON_Y, which match the silkscreen labels beside the buttons on the board.

picoscroll.is_pressed(b)