The MIT License (MIT)

Copyright (c) 2017 Radomir Dopieralski

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.

Stage – a Tile and Sprite Engine

Stage is a library that lets you display tile grids and sprites on SPI-based

RGB displays in MicroPython. It is mostly made with video games in mind, but it

can be useful in making any kind of graphical user interface too.

For performance reasons, a part of this library has been written in C and has

to be compiled as part of the MicroPython firmware as the ``_stage`` module.

For memory saving reasons, it's best if the Python library is also included in

the firmware, as a frozen module.

API Reference

The API reference is available at `<http://circuitpython-stage.readthedocs.io>`_.

Compiling

Please refer to the official guide on compiling external modules available

at `<http://docs.micropython.org/en/latest/develop/cmodules.html>`_.

The sub-directories contain example library initialization files for different

platforms. You should freeze the files for the platform you target into your

firmware.

Example::

import ustruct

import utime

class ST7735R:

width = 128

height = 128

def __init__(self, spi, dc, cs, rotation=0x06):

self.spi = spi

self.dc = dc

self.dc(1)

self.cs = cs

self.cs(0)

self.rotation = rotation

utime.sleep_ms(100)

for command, data, delay in (

(b'\x01', b'', 120),

(b'\x11', b'', 120),

(b'\x36', bytes(((rotation & 0x07) << 5,)), 0),

(b'\x3a', b'\x05', 0),

(b'\xb4', b'\x07', 0),

(b'\xb1', b'\x01\x2c\x2d', 0),

(b'\xb2', b'\x01\x2c\x2d', 0),

(b'\xb3', b'\x01\x2c\x2d\x01\x2c\x2d', 0),

(b'\xc0', b'\x02\x02\x84', 0),

(b'\xc1', b'\xc5', 0),

(b'\xc2', b'\x0a\x00', 0),

(b'\xc3', b'\x8a\x2a', 0),

(b'\xc4', b'\x8a\xee', 0),

(b'\xc5', b'\x0e', 0),

(b'\x20', b'', 0),

(b'\xe0', b'\x02\x1c\x07\x12\x37\x32\x29\x2d'

b'\x29\x25\x2B\x39\x00\x01\x03\x10', 0),

(b'\xe1', b'\x03\x1d\x07\x06\x2E\x2C\x29\x2D'

b'\x2E\x2E\x37\x3F\x00\x00\x02\x10', 0),

(b'\x13', b'', 10),

(b'\x29', b'', 120),

):

self.write(command, data)

utime.sleep_ms(delay)

self.dc(0)

self.cs(1)

def block(self, x0, y0, x1, y1):

if self.rotation & 0x01:

x0 += 3 # 32 # alternate st7735 display

x1 += 3 # 32

y0 += 2 # 0

y1 += 2 # 0

else:

x0 += 2 # 0

x1 += 2 # 0

y0 += 3 # 32

y1 += 3 # 32

xpos = ustruct.pack('>HH', x0, x1)

ypos = ustruct.pack('>HH', y0, y1)

self.write(b'\x2a', xpos)

self.write(b'\x2b', ypos)

self.write(b'\x2c')

self.dc(1)

def write(self, command=None, data=None):

if command is not None:

self.dc(0)

self.spi.write(command)

if data:

self.dc(1)

self.spi.write(data)

def clear(self, color=0x00):

self.block(0, 0, self.width - 1, self.height - 1)

pixel = color.to_bytes(2, 'big')

data = pixel * 256

for count in range(self.width * self.height // 256):

self.write(None, data)

def __enter__(self):

self.cs(0)

return self

def __exit__(self, exc_type, exc_val, exc_tb):

self.cs(1)

../stage.py

from machine import SPI, I2C, Pin

import st7735r

K_X = 0x20

K_DOWN = 0x01

K_LEFT = 0x08

K_RIGHT = 0x04

K_UP = 0x02

K_O = 0x10

class Audio:

def __init__(self):

pass

def play(self, audio_file):

pass

def stop(self):

pass

def mute(self, value=True):

pass

class Buttons:

def __init__(self, i2c, address=0x10):

self._i2c = i2c

self._address = address

def get_pressed(self):

return self._i2c.readfrom(self._address, 1)[0]

spi = SPI(1, baudrate=40000000)

display = st7735r.ST7735R(spi, Pin(12, Pin.OUT), Pin(15, Pin.OUT))

i2c = I2C(sda=Pin(4), scl=Pin(5))

buttons = Buttons(i2c)

audio = Audio()

import ustruct

import utime

class Display(object):

_BUF = bytearray(4)

width = 320

height = 240

def __init__(self, spi, dc, cs=None, rst=None):

self.spi = spi

self.dc = dc

self.cs = cs or (lambda x: x)

self.rst = rst or (lambda x: x)

self.reset()

def reset(self):

self.rst(0)

utime.sleep_ms(50)

self.rst(1)

utime.sleep_ms(50)

self.cs(0)

for command, data in (

(b'\xef', b'\x03\x80\x02'),

(b'\xcf', b'\x00\xc1\x30'),

(b'\xed', b'\x64\x03\x12\x81'),

(b'\xe8', b'\x85\x00\x78'),

(b'\xcb', b'\x39\x2c\x00\x34\x02'),

(b'\xf7', b'\x20'),

(b'\xea', b'\x00\x00'),

(b'\xc0', b'\x23'), # Power Control 1, VRH[5:0]

(b'\xc1', b'\x10'), # Power Control 2, SAP[2:0], BT[3:0]

(b'\xc5', b'\x3e\x28'), # VCM Control 1

(b'\xc7', b'\x86'), # VCM Control 2

(b'\x36', b'\x10'), # Memory Access Control

(b'\x3a', b'\x55'), # Pixel Format

(b'\xb1', b'\x00\x18'), # FRMCTR1

(b'\xb6', b'\x08\x82\x27'), # Display Function Control

(b'\xf2', b'\x00'), # 3Gamma Function Disable

(b'\x26', b'\x01'), # Gamma Curve Selected

(b'\xe0', # Set Gamma

b'\x0f\x31\x2b\x0c\x0e\x08\x4e\xf1\x37\x07\x10\x03\x0e\x09\x00'),

(b'\xe1', # Set Gamma

b'\x00\x0e\x14\x03\x11\x07\x31\xc1\x48\x08\x0f\x0c\x31\x36\x0f'),

(b'\x11', None),

(b'\x29', None),

):

self.write(command, data)

self.cs(1)

utime.sleep_ms(50)

def write(self, command=None, data=None):

if command is not None:

self.dc(0)

self.spi.write(command)

if data:

self.dc(1)

self.spi.write(data)

def block(self, x0, y0, x1, y1):

ustruct.pack_into('>HH', self._BUF, 0, x0, x1)

self.write(b'\x2a', self._BUF)

ustruct.pack_into('>HH', self._BUF, 0, y0, y1)

self.write(b'\x2b', self._BUF)

self.write(b'\x2c')

self.dc(1)

def clear(self, color=0x00):

self.cs(0)

self.block(0, 0, self.width, self.height)

chunks, rest = divmod(self.width * self.height, 512)

pixel = ustruct.pack('>H', color)

if chunks:

data = pixel * 512

for count in range(chunks):

self.spi.write(data)

if rest:

self.spi.write(pixel * rest)

self.cs(1)

def __enter__(self):

self.cs(0)

return self

def __exit__(self, exc_type, exc_val, exc_tb):

self.cs(1)

../stage.py

from machine import SPI, I2C, Pin

import ili9341

K_X = 0x20

K_DOWN = 0x01

K_LEFT = 0x08

K_RIGHT = 0x04

K_UP = 0x02

K_O = 0x10

class Audio:

def __init__(self):

pass

def play(self, audio_file):

pass

def stop(self):

pass

def mute(self, value=True):

pass

class Buttons:

def __init__(self, i2c, address=0x10):

self._i2c = i2c

self._address = address

def get_pressed(self):

return self._i2c.readfrom(self._address, 1)[0]

spi = SPI(2, baudrate=40000000, sck=Pin(18), mosi=Pin(23))

display = ili9341.Display(spi, Pin(27, Pin.OUT), Pin(14, Pin.OUT),

Pin(33, Pin.OUT))

lite = Pin(32, Pin.OUT)

lite(1)

i2c = I2C(sda=Pin(21), scl=Pin(22))

buttons = Buttons(i2c)

audio = Audio()

STAGE_MOD_DIR := $(USERMOD_DIR)

SRC_USERMOD += $(STAGE_MOD_DIR)/mod_stage.c