API Reference

adafruit_qualia

Portal Style Library for the Adafruit Qualia ESP32-S3

  • Author(s): Melissa LeBlanc-Williams

Implementation Notes

Hardware:

Software and Dependencies:

class adafruit_qualia.Qualia(display_type: str, *, url: str | None = None, headers: Dict[str, str] = None, json_path: List[str] | List[List[str]] | None = None, regexp_path: Sequence[str] | None = None, default_bg: int = 0, json_transform: Callable | List[Callable] | None = None, rotation: int = 0, scale: int = 1, debug: bool = False, use_network: bool = True)

Class representing the Adafruit Qualia ESP32-S3.

Parameters:

  • display_type – The lowercase model of the display that you are using.

  • url – The URL of your data source. Defaults to None.

  • headers – The headers for authentication, typically used by Azure API’s.

  • json_path – The list of json traversal to get data out of. Can be list of lists for multiple data points. Defaults to None to not use json.

  • regexp_path – The list of regexp strings to get data out (use a single regexp group). Can be list of regexps for multiple data points. Defaults to None to not use regexp.

  • default_bg – The path to your default background image file or a hex color. Defaults to 0x000000.

  • json_transform – A function or a list of functions to call with the parsed JSON. Changes and additions are permitted for the dict object.

  • rotation – Default rotation is landscape (270) but can be 0, 90, or 180 for portrait/rotated

  • scale – Default scale is 1, but can be an integer of 1 or greater

  • debug – Turn on debug print outs. Defaults to False.

  • use_network – Enable network initialization. Defaults to True. Setting to False will allow you to use the library without a settings.toml file with wifi configuration in it.

adafruit_qualia.graphics

Portal Style Library for the Adafruit Qualia ESP32-S3

  • Author(s): Melissa LeBlanc-Williams

Implementation Notes

Hardware:

Software and Dependencies:

class adafruit_qualia.graphics.Displays

Class that automatically loads displays from the displays folder.

static load_displays()

Load a list of available displays and set them as attributes

static valid_displays()

Return the available valid displays

class adafruit_qualia.graphics.Graphics(display_type: str, *, auto_refresh: bool = True, default_bg: int = 0, rotation: int = 0, scale: int = 1, debug: bool = False)

Graphics Helper Class for the Adafruit Qualia ESP32-S3 Library

Parameters:

  • display_type – The lowercase model of the display that you are using.

  • auto_refresh – Set to False to disable auto refresh. Defaults to True.

  • default_bg – The path to your default background image file or a hex color. Defaults to 0x000000.

  • rotation – Default rotation is portrait (0) but can be 90, 180, 270 for landscape/rotated

  • debug – Turn on debug print outs. Defaults to False.

property dotclockdisplay

Return the dotclock display object

property i2c_bus

Return the I2C bus

init_display(display_type: str, *, auto_refresh: bool = True)

Load the Display Class, then initialize the display and touch driver

property rotation

Return the rotation

property touch

Return the touch driver

adafruit_qualia.network

Portal Style Library for the Adafruit Qualia ESP32-S3

  • Author(s): Melissa LeBlanc-Williams

Implementation Notes

Hardware:

Software and Dependencies:

class adafruit_qualia.network.Network(*, extract_values: bool = True, debug: bool = False)

Network Helper Class for the Adafruit Qualia ESP32-S3 Library

Parameters:

  • extract_values (bool) – If true, single-length fetched values are automatically extracted from lists and tuples. Defaults to True.

  • debug – Turn on debug print outs. Defaults to False.

property enabled: bool

Get or Set whether the WiFi is enabled

init_io_mqtt() → IO_MQTT

Initialize MQTT for Adafruit IO

init_mqtt(broker: str, port: int = 8883, username: str = None, password: str = None, use_io: bool = False) → MQTT | IO_MQTT

Initialize MQTT

mqtt_connect(*args: bool | str | int, **kwargs: bool | str | int) → None

Connect to MQTT

mqtt_loop(*args: int, suppress_mqtt_errors: bool = True, **kwargs: int) → None

Run the MQTT Loop

mqtt_publish(*args: str | int | float, suppress_mqtt_errors: bool = True, **kwargs: str | int | float) → None

Publish to MQTT

property on_mqtt_connect: Callable | None

Get or Set the MQTT Connect Handler

property on_mqtt_disconnect: Callable | None

Get or Set the MQTT Disconnect Handler

property on_mqtt_message: Callable | None

Get or Set the MQTT Message Handler

property on_mqtt_subscribe: Callable | None

Get or Set the MQTT Subscribe Handler

property on_mqtt_unsubscribe: Callable | None

Get or Set the MQTT Unsubscribe Handler

adafruit_qualia.peripherals

Portal Style Library for the Adafruit Qualia ESP32-S3

  • Author(s): Melissa LeBlanc-Williams

Implementation Notes

Hardware:

Software and Dependencies:

class adafruit_qualia.peripherals.Peripherals(*, i2c_bus: I2C = None, address: int = 0x3F)

Peripherals Helper Class for the Adafruit Qualia ESP32-S3 Library

property backlight: bool

Return whether the backlight is on

property button_down: bool

Return whether Down Button is pressed

property button_up: bool

Return whether Up Button is pressed

deinit() → None

Call deinit on all resources to free them

adafruit_qualia.displays

DotClock Display Base Class

  • Author(s): Melissa LeBlanc-Williams

class adafruit_qualia.displays.DotClockDisplay

DotClock Display Base Class for the Adafruit Qualia ESP32-S3 Library

property height

The height of the display in pixels

property i2c_bus

Return the I2C bus

init(*, auto_refresh: bool = True)

Initialize the display

init_touch()

Attempt to initialize the touch driver

property rotation

Return the display touch rotation

property round

Return whether the display is circular

property touch

Return the touch driver

property width

The width of the display in pixels

class adafruit_qualia.displays.Touch(touch_driver, display, rotation=0)

Simple passthrough touch class that allows rotation transformation

property rotation

Return the rotation

property touched

Return whether the screen is touched

property touches

Return the number of touches

transform(x, y)

Transform touch coordinates based on rotation

adafruit_qualia.displays.round21

2.1” 480x480 Round DotClock Display Class

  • Author(s): Melissa LeBlanc-Williams

Implementation Notes

Hardware:

class adafruit_qualia.displays.round21.Round21

TL021WVC02 display driver

adafruit_qualia.displays.round40

4” 720x720 Round DotClock Display Class

  • Author(s): Melissa LeBlanc-Williams

Implementation Notes

Hardware:

class adafruit_qualia.displays.round40.Round40

HD40015C40/NV3052C display driver

adafruit_qualia.displays.square34

3.4” 480x480 Square DotClock Display Class

  • Author(s): Melissa LeBlanc-Williams

Implementation Notes

Hardware:

class adafruit_qualia.displays.square34.Square34

TL034WVS05 display driver

adafruit_qualia.displays.square40

4” 720x720 Square DotClock Display Class

  • Author(s): Melissa LeBlanc-Williams

Implementation Notes

Hardware:

class adafruit_qualia.displays.square40.Square40

TL040HDS20 display driver

adafruit_qualia.displays.bar320x820

3.2” 320x820 Bar DotClock Display Class

  • Author(s): Melissa LeBlanc-Williams

Implementation Notes

Hardware:

class adafruit_qualia.displays.bar320x820.Bar320x820

TL032FWV01 display driver