jinks_core.widget

Module dedicated to discovering and registering widgets.

Functions

get_widgets(names)	Discover and load all installed widgets and filter to configuration requested widgets.
register_widget(name)	Register a device with the given name.

Classes

WidgetProtocol(*args, **kwargs)

Abstract class for widget templates.

Exceptions

JinksWidgetRegistryError

Widget registry error.

exception jinks_core.widget.JinksWidgetRegistryError

Bases: JinksError

Widget registry error.

class jinks_core.widget.WidgetProtocol(*args, **kwargs)

Bases: Protocol

Abstract class for widget templates.

width: int

Width in terms of display units (not pixels).

height: int

Height in terms of display units (not pixels).

color: ColorType

Color type of the widget.

display(*args, **kwargs)

Return the displayed widget.

Return type:

Image

__init__(*args, **kwargs)

jinks_core.widget.register_widget(name)

Register a device with the given name.

Parameters:

name (str) – Device name

Return type:

Callable

jinks_core.widget.get_widgets(names)

Discover and load all installed widgets and filter to configuration requested widgets.

Return type:

dict[str, type[WidgetProtocol]]