Platforms¶

Platforms are defined under the device entry in your config. The platform key is always required, as it indicates to inkBoard which device it should load in.

Features¶

To indicate to inkBoard what capabilities a device has, a feature class is implemented. Some features may not do much (or are not fully implemented even). Accessing features, for example for Device Elements, can generally be done by specifying them with the FEATURE_ prefix. For example, FEATURE_BACKLIGHT can be accessed via backlight.

class InkboardDeviceFeatures¶

The features available for inkBoard devices.

FEATURE_AUTOSTART¶: Feature to indicate the device allows starting the programme on boot AND change this setting from within the programme

FEATURE_BACKLIGHT¶

Backlight feature to indicate the device can control the screen’s brightness, or something akin to it.

Adds the following shorthand functions:

backlight-toggle to toggle the backlight
backlight-turn-on to turn on the backlight
backlight-turn-off to turn off the backlight
backlight-temporary to temporarily turn on the backlight
backlight-set-behaviour to set the behaviour of the backlight when interacting with the screen

FEATURE_BATTERY¶: Battery feature to indicate the device has a battery and is able to report the charge level and state

FEATURE_CONNECTION¶

Subfeature of network, indicates the device is able to manage the network connection (i.e. disconnect, connect, etc.

The feature is a work in progress, so no shorthand functions are provided yet.

FEATURE_INTERACTIVE¶: Interactive feature to indicate the device supports screen interaction

FEATURE_NETWORK¶: Network feature to indicate the device has internet connectivity and is able to retrieve information on it

FEATURE_POWER¶

Power feature to indicate the device is able to turn the hardware off and reboot it

Adds the following shorthand functions:

power-off to power off the device
reboot to reboot the device

FEATURE_PRESS_RELEASE¶

Feature to indicate the device is interactive and can report the coordinates of a press and the coordinates of a release

This feature allows elements to use the hold_release_action.

FEATURE_RESIZE¶: Resize feature to indicate the device’s screen size can change and this functionality is implemented

FEATURE_ROTATION¶

Rotation feature to indicate the device can rotate during runtime.

Adds the following shorthand functions: - rotate to rotate the screen