esphome 2024.7.2__py3-none-any.whl → 2024.8.0__py3-none-any.whl

esphome/components/lvgl/styles.py

@@ -0,0 +1,58 @@
+import esphome.codegen as cg
+from esphome.const import CONF_ID
+from esphome.core import ID
+from esphome.cpp_generator import MockObj
+
+from .defines import (
+    CONF_STYLE_DEFINITIONS,
+    CONF_THEME,
+    CONF_TOP_LAYER,
+    LValidator,
+    literal,
+)
+from .helpers import add_lv_use
+from .lvcode import LambdaContext, LocalVariable, lv, lv_assign, lv_variable
+from .schemas import ALL_STYLES
+from .types import lv_lambda_t, lv_obj_t, lv_obj_t_ptr
+from .widgets import Widget, add_widgets, set_obj_properties, theme_widget_map
+from .widgets.obj import obj_spec
+
+TOP_LAYER = literal("lv_disp_get_layer_top(lv_component->get_disp())")
+
+
+async def styles_to_code(config):
+    """Convert styles to C__ code."""
+    for style in config.get(CONF_STYLE_DEFINITIONS, ()):
+        svar = cg.new_Pvariable(style[CONF_ID])
+        lv.style_init(svar)
+        for prop, validator in ALL_STYLES.items():
+            if (value := style.get(prop)) is not None:
+                if isinstance(validator, LValidator):
+                    value = await validator.process(value)
+                if isinstance(value, list):
+                    value = "|".join(value)
+                lv.call(f"style_set_{prop}", svar, literal(value))
+
+
+async def theme_to_code(config):
+    if theme := config.get(CONF_THEME):
+        add_lv_use(CONF_THEME)
+        for w_name, style in theme.items():
+            if not isinstance(style, dict):
+                continue
+
+            lname = "lv_theme_apply_" + w_name
+            apply = lv_variable(lv_lambda_t, lname)
+            theme_widget_map[w_name] = apply
+            ow = Widget.create("obj", MockObj(ID("obj")), obj_spec)
+            async with LambdaContext([(lv_obj_t_ptr, "obj")], where=w_name) as context:
+                await set_obj_properties(ow, style)
+            lv_assign(apply, await context.get_lambda())
+
+
+async def add_top_layer(config):
+    if top_conf := config.get(CONF_TOP_LAYER):
+        with LocalVariable("top_layer", lv_obj_t, TOP_LAYER) as top_layer_obj:
+            top_w = Widget(top_layer_obj, obj_spec, top_conf)
+            await set_obj_properties(top_w, top_conf)
+            await add_widgets(top_w, top_conf)

esphome/components/lvgl/switch/__init__.py

@@ -0,0 +1,56 @@
+import esphome.codegen as cg
+from esphome.components.switch import Switch, new_switch, switch_schema
+import esphome.config_validation as cv
+from esphome.cpp_generator import MockObj
+
+from ..defines import CONF_LVGL_ID, CONF_WIDGET
+from ..lvcode import (
+    API_EVENT,
+    EVENT_ARG,
+    UPDATE_EVENT,
+    LambdaContext,
+    LvConditional,
+    LvContext,
+    lv,
+    lv_add,
+)
+from ..schemas import LVGL_SCHEMA
+from ..types import LV_EVENT, LV_STATE, lv_pseudo_button_t, lvgl_ns
+from ..widgets import get_widgets
+
+LVGLSwitch = lvgl_ns.class_("LVGLSwitch", Switch)
+CONFIG_SCHEMA = (
+    switch_schema(LVGLSwitch)
+    .extend(LVGL_SCHEMA)
+    .extend(
+        {
+            cv.Required(CONF_WIDGET): cv.use_id(lv_pseudo_button_t),
+        }
+    )
+)
+
+
+async def to_code(config):
+    switch = await new_switch(config)
+    paren = await cg.get_variable(config[CONF_LVGL_ID])
+    widget = await get_widgets(config, CONF_WIDGET)
+    widget = widget[0]
+    async with LambdaContext(EVENT_ARG) as checked_ctx:
+        checked_ctx.add(switch.publish_state(widget.get_value()))
+    async with LambdaContext([(cg.bool_, "v")]) as control:
+        with LvConditional(MockObj("v")) as cond:
+            widget.add_state(LV_STATE.CHECKED)
+            cond.else_()
+            widget.clear_state(LV_STATE.CHECKED)
+        lv.event_send(widget.obj, API_EVENT, cg.nullptr)
+    async with LvContext(paren) as ctx:
+        lv_add(switch.set_control_lambda(await control.get_lambda()))
+        ctx.add(
+            paren.add_event_cb(
+                widget.obj,
+                await checked_ctx.get_lambda(),
+                LV_EVENT.VALUE_CHANGED,
+                UPDATE_EVENT,
+            )
+        )
+        lv_add(switch.publish_state(widget.get_value()))

esphome/components/lvgl/switch/lvgl_switch.h

@@ -0,0 +1,34 @@
+#pragma once
+
+#include "esphome/components/switch/switch.h"
+#include "esphome/core/automation.h"
+#include "esphome/core/component.h"
+#include "esphome/core/preferences.h"
+
+namespace esphome {
+namespace lvgl {
+
+class LVGLSwitch : public switch_::Switch {
+ public:
+  void set_control_lambda(std::function<void(bool)> state_lambda) {
+    this->state_lambda_ = state_lambda;
+    if (this->initial_state_.has_value()) {
+      this->state_lambda_(this->initial_state_.value());
+      this->initial_state_.reset();
+    }
+  }
+
+ protected:
+  void write_state(bool value) override {
+    if (this->state_lambda_ != nullptr) {
+      this->state_lambda_(value);
+    } else {
+      this->initial_state_ = value;
+    }
+  }
+  std::function<void(bool)> state_lambda_{};
+  optional<bool> initial_state_{};
+};
+
+}  // namespace lvgl
+}  // namespace esphome

esphome/components/lvgl/text/__init__.py

@@ -0,0 +1,50 @@
+import esphome.codegen as cg
+from esphome.components import text
+from esphome.components.text import new_text
+import esphome.config_validation as cv
+
+from ..defines import CONF_LVGL_ID, CONF_WIDGET
+from ..lvcode import (
+    API_EVENT,
+    EVENT_ARG,
+    UPDATE_EVENT,
+    LambdaContext,
+    LvContext,
+    lv,
+    lv_add,
+)
+from ..schemas import LVGL_SCHEMA
+from ..types import LV_EVENT, LvText, lvgl_ns
+from ..widgets import get_widgets
+
+LVGLText = lvgl_ns.class_("LVGLText", text.Text)
+
+CONFIG_SCHEMA = text.TEXT_SCHEMA.extend(LVGL_SCHEMA).extend(
+    {
+        cv.GenerateID(): cv.declare_id(LVGLText),
+        cv.Required(CONF_WIDGET): cv.use_id(LvText),
+    }
+)
+
+
+async def to_code(config):
+    textvar = await new_text(config)
+    paren = await cg.get_variable(config[CONF_LVGL_ID])
+    widget = await get_widgets(config, CONF_WIDGET)
+    widget = widget[0]
+    async with LambdaContext([(cg.std_string, "text_value")]) as control:
+        await widget.set_property("text", "text_value.c_str())")
+        lv.event_send(widget.obj, API_EVENT, None)
+    async with LambdaContext(EVENT_ARG) as lamb:
+        lv_add(textvar.publish_state(widget.get_value()))
+    async with LvContext(paren):
+        widget.var.set_control_lambda(await control.get_lambda())
+        lv_add(
+            paren.add_event_cb(
+                widget.obj,
+                await lamb.get_lambda(),
+                LV_EVENT.VALUE_CHANGED,
+                UPDATE_EVENT,
+            )
+        )
+        lv_add(textvar.publish_state(widget.get_value()))

esphome/components/lvgl/text/lvgl_text.h

@@ -0,0 +1,34 @@
+#pragma once
+
+#include "esphome/components/text/text.h"
+#include "esphome/core/automation.h"
+#include "esphome/core/component.h"
+#include "esphome/core/preferences.h"
+
+namespace esphome {
+namespace lvgl {
+
+class LVGLText : public text::Text {
+ public:
+  void set_control_lambda(std::function<void(const std::string)> control_lambda) {
+    this->control_lambda_ = control_lambda;
+    if (this->initial_state_.has_value()) {
+      this->control_lambda_(this->initial_state_.value());
+      this->initial_state_.reset();
+    }
+  }
+
+ protected:
+  void control(const std::string &value) override {
+    if (this->control_lambda_ != nullptr) {
+      this->control_lambda_(value);
+    } else {
+      this->initial_state_ = value;
+    }
+  }
+  std::function<void(const std::string)> control_lambda_{};
+  optional<std::string> initial_state_{};
+};
+
+}  // namespace lvgl
+}  // namespace esphome

esphome/components/lvgl/text_sensor/__init__.py

@@ -0,0 +1,42 @@
+import esphome.codegen as cg
+from esphome.components.text_sensor import (
+    TextSensor,
+    new_text_sensor,
+    text_sensor_schema,
+)
+import esphome.config_validation as cv
+
+from ..defines import CONF_LVGL_ID, CONF_WIDGET
+from ..lvcode import API_EVENT, EVENT_ARG, UPDATE_EVENT, LambdaContext, LvContext
+from ..schemas import LVGL_SCHEMA
+from ..types import LV_EVENT, LvText
+from ..widgets import get_widgets
+
+CONFIG_SCHEMA = (
+    text_sensor_schema(TextSensor)
+    .extend(LVGL_SCHEMA)
+    .extend(
+        {
+            cv.Required(CONF_WIDGET): cv.use_id(LvText),
+        }
+    )
+)
+
+
+async def to_code(config):
+    sensor = await new_text_sensor(config)
+    paren = await cg.get_variable(config[CONF_LVGL_ID])
+    widget = await get_widgets(config, CONF_WIDGET)
+    widget = widget[0]
+    async with LambdaContext(EVENT_ARG) as pressed_ctx:
+        pressed_ctx.add(sensor.publish_state(widget.get_value()))
+    async with LvContext(paren) as ctx:
+        ctx.add(
+            paren.add_event_cb(
+                widget.obj,
+                await pressed_ctx.get_lambda(),
+                LV_EVENT.VALUE_CHANGED,
+                API_EVENT,
+                UPDATE_EVENT,
+            )
+        )

esphome/components/lvgl/touchscreens.py

@@ -0,0 +1,45 @@
+import esphome.codegen as cg
+from esphome.components.touchscreen import CONF_TOUCHSCREEN_ID, Touchscreen
+import esphome.config_validation as cv
+from esphome.const import CONF_ID
+from esphome.core import CORE
+
+from .defines import (
+    CONF_LONG_PRESS_REPEAT_TIME,
+    CONF_LONG_PRESS_TIME,
+    CONF_TOUCHSCREENS,
+)
+from .helpers import lvgl_components_required
+from .lvcode import lv
+from .schemas import PRESS_TIME
+from .types import LVTouchListener
+
+CONF_TOUCHSCREEN = "touchscreen"
+TOUCHSCREENS_CONFIG = cv.maybe_simple_value(
+    {
+        cv.Required(CONF_TOUCHSCREEN_ID): cv.use_id(Touchscreen),
+        cv.Optional(CONF_LONG_PRESS_TIME, default="400ms"): PRESS_TIME,
+        cv.Optional(CONF_LONG_PRESS_REPEAT_TIME, default="100ms"): PRESS_TIME,
+        cv.GenerateID(): cv.declare_id(LVTouchListener),
+    },
+    key=CONF_TOUCHSCREEN_ID,
+)
+
+
+def touchscreen_schema(config):
+    value = cv.ensure_list(TOUCHSCREENS_CONFIG)(config)
+    if value or CONF_TOUCHSCREEN not in CORE.loaded_integrations:
+        return value
+    return [TOUCHSCREENS_CONFIG(config)]
+
+
+async def touchscreens_to_code(var, config):
+    for tconf in config[CONF_TOUCHSCREENS]:
+        lvgl_components_required.add(CONF_TOUCHSCREEN)
+        touchscreen = await cg.get_variable(tconf[CONF_TOUCHSCREEN_ID])
+        lpt = tconf[CONF_LONG_PRESS_TIME].total_milliseconds
+        lprt = tconf[CONF_LONG_PRESS_REPEAT_TIME].total_milliseconds
+        listener = cg.new_Pvariable(tconf[CONF_ID], lpt, lprt)
+        await cg.register_parented(listener, var)
+        lv.indev_drv_register(listener.get_drv())
+        cg.add(touchscreen.register_listener(listener))

esphome/components/lvgl/trigger.py

@@ -0,0 +1,74 @@
+from esphome import automation
+import esphome.codegen as cg
+from esphome.const import CONF_ID, CONF_ON_VALUE, CONF_TRIGGER_ID
+
+from .defines import (
+    CONF_ALIGN,
+    CONF_ALIGN_TO,
+    CONF_X,
+    CONF_Y,
+    LV_EVENT_MAP,
+    LV_EVENT_TRIGGERS,
+    literal,
+)
+from .lvcode import (
+    API_EVENT,
+    EVENT_ARG,
+    UPDATE_EVENT,
+    LambdaContext,
+    LvConditional,
+    lv,
+    lv_add,
+)
+from .types import LV_EVENT
+from .widgets import widget_map
+
+
+async def generate_triggers(lv_component):
+    """
+    Generate LVGL triggers for all defined widgets
+    Must be done after all widgets completed
+    :param lv_component:  The parent component
+    :return:
+    """
+
+    for w in widget_map.values():
+        if w.config:
+            for event, conf in {
+                event: conf
+                for event, conf in w.config.items()
+                if event in LV_EVENT_TRIGGERS
+            }.items():
+                conf = conf[0]
+                w.add_flag("LV_OBJ_FLAG_CLICKABLE")
+                event = literal("LV_EVENT_" + LV_EVENT_MAP[event[3:].upper()])
+                await add_trigger(conf, lv_component, w, event)
+            for conf in w.config.get(CONF_ON_VALUE, ()):
+                await add_trigger(
+                    conf,
+                    lv_component,
+                    w,
+                    LV_EVENT.VALUE_CHANGED,
+                    API_EVENT,
+                    UPDATE_EVENT,
+                )
+
+            # Generate align to directives while we're here
+            if align_to := w.config.get(CONF_ALIGN_TO):
+                target = widget_map[align_to[CONF_ID]].obj
+                align = literal(align_to[CONF_ALIGN])
+                x = align_to[CONF_X]
+                y = align_to[CONF_Y]
+                lv.obj_align_to(w.obj, target, align, x, y)
+
+
+async def add_trigger(conf, lv_component, w, *events):
+    tid = conf[CONF_TRIGGER_ID]
+    trigger = cg.new_Pvariable(tid)
+    args = w.get_args()
+    value = w.get_value()
+    await automation.build_automation(trigger, args, conf)
+    async with LambdaContext(EVENT_ARG, where=tid) as context:
+        with LvConditional(w.is_selected()):
+            lv_add(trigger.trigger(value))
+    lv_add(lv_component.add_event_cb(w.obj, await context.get_lambda(), *events))

esphome/components/lvgl/types.py

@@ -0,0 +1,191 @@
+import sys
+
+from esphome import automation, codegen as cg
+from esphome.const import CONF_MAX_VALUE, CONF_MIN_VALUE, CONF_TEXT, CONF_VALUE
+from esphome.cpp_generator import MockObj, MockObjClass
+
+from .defines import lvgl_ns
+from .lvcode import lv_expr
+
+
+class LvType(cg.MockObjClass):
+    def __init__(self, *args, **kwargs):
+        parens = kwargs.pop("parents", ())
+        super().__init__(*args, parents=parens + (lv_obj_base_t,))
+        self.args = kwargs.pop("largs", [(lv_obj_t_ptr, "obj")])
+        self.value = kwargs.pop("lvalue", lambda w: w.obj)
+        self.has_on_value = kwargs.pop("has_on_value", False)
+        self.value_property = None
+
+    def get_arg_type(self):
+        return self.args[0][0] if len(self.args) else None
+
+
+class LvNumber(LvType):
+    def __init__(self, *args):
+        super().__init__(
+            *args,
+            largs=[(cg.float_, "x")],
+            lvalue=lambda w: w.get_number_value(),
+            has_on_value=True,
+        )
+        self.value_property = CONF_VALUE
+
+
+uint16_t_ptr = cg.uint16.operator("ptr")
+char_ptr = cg.global_ns.namespace("char").operator("ptr")
+void_ptr = cg.void.operator("ptr")
+lv_coord_t = cg.global_ns.namespace("lv_coord_t")
+lv_event_code_t = cg.global_ns.enum("lv_event_code_t")
+lv_indev_type_t = cg.global_ns.enum("lv_indev_type_t")
+FontEngine = lvgl_ns.class_("FontEngine")
+IdleTrigger = lvgl_ns.class_("IdleTrigger", automation.Trigger.template())
+ObjUpdateAction = lvgl_ns.class_("ObjUpdateAction", automation.Action)
+LvglCondition = lvgl_ns.class_("LvglCondition", automation.Condition)
+LvglAction = lvgl_ns.class_("LvglAction", automation.Action)
+lv_lambda_t = lvgl_ns.class_("LvLambdaType")
+LvCompound = lvgl_ns.class_("LvCompound")
+lv_font_t = cg.global_ns.class_("lv_font_t")
+lv_style_t = cg.global_ns.struct("lv_style_t")
+# fake parent class for first class widgets and matrix buttons
+lv_pseudo_button_t = lvgl_ns.class_("LvPseudoButton")
+lv_obj_base_t = cg.global_ns.class_("lv_obj_t", lv_pseudo_button_t)
+lv_obj_t_ptr = lv_obj_base_t.operator("ptr")
+lv_disp_t = cg.global_ns.struct("lv_disp_t")
+lv_color_t = cg.global_ns.struct("lv_color_t")
+lv_group_t = cg.global_ns.struct("lv_group_t")
+LVTouchListener = lvgl_ns.class_("LVTouchListener")
+LVEncoderListener = lvgl_ns.class_("LVEncoderListener")
+lv_obj_t = LvType("lv_obj_t")
+lv_page_t = cg.global_ns.class_("LvPageType", LvCompound)
+lv_img_t = LvType("lv_img_t")
+
+LV_EVENT = MockObj(base="LV_EVENT_", op="")
+LV_STATE = MockObj(base="LV_STATE_", op="")
+LV_BTNMATRIX_CTRL = MockObj(base="LV_BTNMATRIX_CTRL_", op="")
+
+
+class LvText(LvType):
+    def __init__(self, *args, **kwargs):
+        super().__init__(
+            *args,
+            largs=[(cg.std_string, "text")],
+            lvalue=lambda w: w.get_property("text"),
+            has_on_value=True,
+            **kwargs,
+        )
+        self.value_property = CONF_TEXT
+
+
+class LvBoolean(LvType):
+    def __init__(self, *args, **kwargs):
+        super().__init__(
+            *args,
+            largs=[(cg.bool_, "x")],
+            lvalue=lambda w: w.is_checked(),
+            has_on_value=True,
+            **kwargs,
+        )
+
+
+class LvSelect(LvType):
+    def __init__(self, *args, **kwargs):
+        super().__init__(
+            *args,
+            largs=[(cg.int_, "x")],
+            lvalue=lambda w: w.get_property("selected"),
+            has_on_value=True,
+            **kwargs,
+        )
+
+
+class WidgetType:
+    """
+    Describes a type of Widget, e.g. "bar" or "line"
+    """
+
+    def __init__(
+        self,
+        name: str,
+        w_type: LvType,
+        parts: tuple,
+        schema=None,
+        modify_schema=None,
+        lv_name=None,
+    ):
+        """
+        :param name: The widget name, e.g. "bar"
+        :param w_type: The C type of the widget
+        :param parts: What parts this widget supports
+        :param schema: The config schema for defining a widget
+        :param modify_schema: A schema to update the widget
+        """
+        self.name = name
+        self.lv_name = lv_name or name
+        self.w_type = w_type
+        self.parts = parts
+        if schema is None:
+            self.schema = {}
+        else:
+            self.schema = schema
+        if modify_schema is None:
+            self.modify_schema = self.schema
+        else:
+            self.modify_schema = modify_schema
+        self.mock_obj = MockObj(f"lv_{self.lv_name}", "_")
+
+    @property
+    def animated(self):
+        return False
+
+    @property
+    def required_component(self):
+        return None
+
+    def is_compound(self):
+        return self.w_type.inherits_from(LvCompound)
+
+    async def to_code(self, w, config: dict):
+        """
+        Generate code for a given widget
+        :param w: The widget
+        :param config: Its configuration
+        :return: Generated code as a list of text lines
+        """
+        return []
+
+    def obj_creator(self, parent: MockObjClass, config: dict):
+        """
+        Create an instance of the widget type
+        :param parent: The parent to which it should be attached
+        :param config:  Its configuration
+        :return: Generated code as a single text line
+        """
+        return lv_expr.call(f"{self.lv_name}_create", parent)
+
+    def get_uses(self):
+        """
+        Get a list of other widgets used by this one
+        :return:
+        """
+        return ()
+
+    def get_max(self, config: dict):
+        return sys.maxsize
+
+    def get_min(self, config: dict):
+        return -sys.maxsize
+
+    def get_step(self, config: dict):
+        return 1
+
+    def get_scale(self, config: dict):
+        return 1.0
+
+
+class NumberType(WidgetType):
+    def get_max(self, config: dict):
+        return int(config[CONF_MAX_VALUE] or 100)
+
+    def get_min(self, config: dict):
+        return int(config[CONF_MIN_VALUE] or 0)