jinks_core.display

Module dedicated to discovering and registering displays.

Functions

get_display(name)	Discover displays and load the required display.
register_display(name)	Register a display with the given name.

Classes

DisplayProtocol(device)

Protocol class for display templates.

Exceptions

JinksDisplayRegistryError

Display registry error.

exception jinks_core.display.JinksDisplayRegistryError

Bases: JinksError

Display registry error.

class jinks_core.display.DisplayProtocol(device)

Bases: Protocol

Protocol class for display templates.

width: int

Width of the display in pixels.

height: int

Height of the display in pixels.

color: ColorType

Display color capability.

unit_density: int

Pixels per unit, same height and width.

units_width: int

Units in the width direction of the display.

units_height: int

Units in the height direction of the display.

__init__(device)

init()

Full initialisation of the display before displaying an image.

Return type:

None

partial_init()

Partial initialisation of the display before displaying an image.

Return type:

None

display(image)

Full display update with image.

Return type:

None

partial_display(image)

Partial display update with image.

Return type:

None

sleep()

Place display in sleep mode.

Return type:

None

jinks_core.display.register_display(name)

Register a display with the given name.

Parameters:

name (str) – Display name

Return type:

Callable

jinks_core.display.get_display(name)

Discover displays and load the required display.

Return type:

type[DisplayProtocol]