rpi-inky-layout 0.3.0

A layout companion library for Pimoroni's Inky HATs

RPi Inky Layout Manager

This is a layout manager I wrote to help me break up the display of a Pimoroni Inky-pHAT into seperate drawable areas.

You might find other uses for it - let me know if it's handy!

The outline process is:

1. Use the Layout class to create a top-level Layout object.
2. Next, add new layers to a Layout - it automatically resizes the other Layouts at the same level.
3. Take each added sublayer Layout, and use its size to define a new PIL Image to draw on.
4. Draw on the image, Set the Image on the appropriate Layout.
5. Invoke the top-level Layout's draw() method to merge them all together, drawing borders as necessary.

And you end up with a nicely-spaced regions.

How it works

Create a new Layout:

layout = Layout( size, packingMode, border)

where:

• size is a 2-part tuple of the form (width, height).
• packingMode is the packing direction: currently either h (horizontal) or v (vertical).
• border is either a) the width of border (colour defaults to 2) or b) a 2-tuple containing (width, colour).

Next, add multiple sub-layouts to layout

sublayout1 = layout.addLayer()
sublayout2 = layout.addLayer()

Then, for leach sublayout, use sublayout.size as the size of the image to draw on.

im1 = Image.new(mode, sublayout1.size, bgColour)
...

Draw on the image; Set it back on the sublayout:

sublayout1.setImage(im1)
...

And finally, draw the top level layout and write to file:

layout.draw()
layout.write(filename)

You can then do what you want with the file, e.g., load it onto an Inky display using setImage

Detailed usage example

Here's a detailed example.

Prerequisites

You will definitely need some sort of image manipulation library, such as pillow

from PIL import Image, ImageDraw

And, since this is built initially for use with Inky displays, you should probably import that, too:

from inky.auto import auto

Create new Layers

Create the top-level Layout:

toplevel = Level( (400,100), packingMode='h', border=(1,2))

Or, if you're using your inky:

board = auto()
toplevel = Level (board.resolution, 'h', (0,0) )

Add as many new layers as you want:

sublayout1 = layout.addLayer()
sublayout2 = layout.addLayer()
sublayout3 = layout.AddLayer()
sublayout31 = sublayout3.addLayer()
sublayout32 = sublayout3.addLayer()

Use the sub-layouts to create images:

mode = "P"
bgColour = 0
image31 = Image.new(mode, sublayout31.size, bgColour)
draw = ImageDraw.Draw(image31)
draw.text(tuple(s/2 for s in sublayout31.size), "Hello",1)
sublayout31.setImage(image31)

image32 = Image.new(mode, sublayout32.size, bgColour)
draw = ImageDraw.Draw(image32)
draw.text(tuple(s/2 for s in sublayout32.size), "World!",1)
sublayout32.setImage(image32)

layout.draw()
layout.write("hello-world.png")

If you're using the Inky, you can load the image up:

inky_image = Image.open("hello-world.png")
board.set_image(inky_image)

And you're done!

Advanced Features

Rotation

If you want to render the Layout in a rotated orientation, you can set the Rotation parameter. It takes the values:

• UP - normal, no rotation;
• LEFT - rotation by -90 or 270 degrees
• RIGHT - rotation by +90 degrees
• DOWN - rotated 180 degrees (up side down)

see under library/test/expected-images/test-rotated*.png for some examples.

Packing Bias

When adding a layer, you can specify packing bias:

layout = new Layout()
sublayout1 = layout.addLayer(packingBias=2)
sublayout2 = layout.addLayer()  # default packingBias=1

In this example, sublayout1 will take up 2/3rds of the space (2/(1+2)), while sublayout2 will be left with the remaining 1/3rd.