Skip to main content

DisplaySettings Class

Package: GHIElectronics.Endpoint.Devices.Display
Namespace: GHIElectronics.Endpoint.Devices.Display

Everything in /config/display.json. Read with DisplayController.GetSettings and apply with DisplayController.SetSettings. Only the built-in Parallel transport has schema here; custom panels live in the customer's own Display.DisplayController subclass.

class DisplaySettings: ...

Constructors​

DisplaySettings()​

def __init__(self):

Properties​

Backlight​

Backlight: BacklightSettings  # @property / @setter

GPIO pin that drives the backlight, or null for "no backlight" or "customer's external backlight controller". The DisplayController does not fail when this is null - the panel is enabled, Flush works, the backlight is simply left alone.

Returns BacklightSettings

EnableAtBoot​

EnableAtBoot: bool  # @property / @setter

True = the board brings up the built-in display during boot so the user's program sees a ready framebuffer. Only honoured for the built-in Parallel transport; custom subclasses init from their own code.

Returns bool

Logo: str  # @property / @setter

Filename of a 24-bit uncompressed BMP on the config partition to show after Enable (null = none).

Returns string

Parallel​

Parallel: ParallelLcdSettings  # @property / @setter

Timings for the SoC's parallel RGB panel. Required when DisplaySettings.Type is Parallel.

Returns ParallelLcdSettings

Type​

Type: DisplayType  # @property / @setter

Which transport the built-in display uses.

Returns DisplayType