_images/logo.svg

A dashboarding library aimimg to provide a unified way of creating dashboards for various uses, on various devices.

Image Based

As long as it can run Python and print images, it can display inkBoard dashboards (performance not guaranteed).

YAML Configured

Dashboards can be configured entirely within YAML. Python experience is not required, just some comfort with using the command line.

Emulate and Design

A UI interface to ease the design process and provide options to emulate the platform of your dashboard.

Integrate and Extend

Extend your dashboard’s capabilities with various integrations, or use your own custom functions and elements.

Integrations
Home Assistant Inspired

Inspired by, and written for, Home Assistant, inkBoard’s syntax is similar to that of Home Assistant’s yaml dashboards, with a mixture of ESPHome thrown in too.

Home Assistant
Package, Install, Run

Package any configuration you made, including any required integrations and platforms. Easily install every requirement via the command line, and run your new dashboard.

/extensions/nbsphinx/

inkBoard dashboards are entirely image based, meaning all that is needed to make it work is a way to print pixels onto a screen using Python. inkBoard takes care of building your dashboard from the configuration, integrating extensions and platforms, and making it all easy to share with your own devices, or others online. To aid in designing dashboards, inkBoard also provides a seperate designer package, allowing dashboards to made outside of any device limitations (except those of the PC it is running on).

It is build on PythonScreenStackManager as the dashboarding backend, which is only dependent on Pillow. That means a minimal install of inkBoard only requires two installed additional packages (three if you count PythonScreenStackManager too), meaning space requirements are kept to a minimum (in Python terms). A dashboard’s functionality can then be extended using various integrations.