esphome 2024.7.3__py3-none-any.whl → 2024.8.0b1__py3-none-any.whl

esphome/components/lvgl/light/__init__.py

@@ -0,0 +1,32 @@
+import esphome.codegen as cg
+from esphome.components import light
+from esphome.components.light import LightOutput
+import esphome.config_validation as cv
+from esphome.const import CONF_GAMMA_CORRECT, CONF_LED, CONF_OUTPUT_ID
+
+from ..defines import CONF_LVGL_ID
+from ..lvcode import LvContext
+from ..schemas import LVGL_SCHEMA
+from ..types import LvType, lvgl_ns
+from ..widgets import get_widgets
+
+lv_led_t = LvType("lv_led_t")
+LVLight = lvgl_ns.class_("LVLight", LightOutput)
+CONFIG_SCHEMA = light.RGB_LIGHT_SCHEMA.extend(
+    {
+        cv.Optional(CONF_GAMMA_CORRECT, default=0.0): cv.positive_float,
+        cv.Required(CONF_LED): cv.use_id(lv_led_t),
+        cv.GenerateID(CONF_OUTPUT_ID): cv.declare_id(LVLight),
+    }
+).extend(LVGL_SCHEMA)
+
+
+async def to_code(config):
+    var = cg.new_Pvariable(config[CONF_OUTPUT_ID])
+    await light.register_light(var, config)
+
+    paren = await cg.get_variable(config[CONF_LVGL_ID])
+    widget = await get_widgets(config, CONF_LED)
+    widget = widget[0]
+    async with LvContext(paren) as ctx:
+        ctx.add(var.set_obj(widget.obj))

esphome/components/lvgl/light/lvgl_light.h

@@ -0,0 +1,48 @@
+#pragma once
+
+#include "esphome/core/component.h"
+#include "esphome/components/light/light_output.h"
+#include "../lvgl_esphome.h"
+
+namespace esphome {
+namespace lvgl {
+
+class LVLight : public light::LightOutput {
+ public:
+  light::LightTraits get_traits() override {
+    auto traits = light::LightTraits();
+    traits.set_supported_color_modes({light::ColorMode::RGB});
+    return traits;
+  }
+  void write_state(light::LightState *state) override {
+    float red, green, blue;
+    state->current_values_as_rgb(&red, &green, &blue, false);
+    auto color = lv_color_make(red * 255, green * 255, blue * 255);
+    if (this->obj_ != nullptr) {
+      this->set_value_(color);
+    } else {
+      this->initial_value_ = color;
+    }
+  }
+
+  void set_obj(lv_obj_t *obj) {
+    this->obj_ = obj;
+    if (this->initial_value_) {
+      lv_led_set_color(obj, this->initial_value_.value());
+      lv_led_on(obj);
+      this->initial_value_.reset();
+    }
+  }
+
+ protected:
+  void set_value_(lv_color_t value) {
+    lv_led_set_color(this->obj_, value);
+    lv_led_on(this->obj_);
+    lv_event_send(this->obj_, lv_api_event, nullptr);
+  }
+  lv_obj_t *obj_{};
+  optional<lv_color_t> initial_value_{};
+};
+
+}  // namespace lvgl
+}  // namespace esphome

esphome/components/lvgl/lv_validation.py

@@ -0,0 +1,279 @@
+from typing import Union
+
+import esphome.codegen as cg
+from esphome.components.binary_sensor import BinarySensor
+from esphome.components.color import ColorStruct
+from esphome.components.font import Font
+from esphome.components.image import Image_
+from esphome.components.sensor import Sensor
+from esphome.components.text_sensor import TextSensor
+import esphome.config_validation as cv
+from esphome.const import CONF_ARGS, CONF_COLOR, CONF_FORMAT, CONF_VALUE
+from esphome.core import HexInt
+from esphome.cpp_generator import MockObj
+from esphome.cpp_types import uint32
+from esphome.helpers import cpp_string_escape
+from esphome.schema_extractors import SCHEMA_EXTRACT, schema_extractor
+
+from . import types as ty
+from .defines import (
+    CONF_END_VALUE,
+    CONF_START_VALUE,
+    LV_FONTS,
+    LValidator,
+    LvConstant,
+    literal,
+)
+from .helpers import (
+    esphome_fonts_used,
+    lv_fonts_used,
+    lvgl_components_required,
+    requires_component,
+)
+from .lvcode import lv_expr
+from .types import lv_font_t, lv_img_t
+
+opacity_consts = LvConstant("LV_OPA_", "TRANSP", "COVER")
+
+
+@schema_extractor("one_of")
+def opacity_validator(value):
+    if value == SCHEMA_EXTRACT:
+        return opacity_consts.choices
+    value = cv.Any(cv.percentage, opacity_consts.one_of)(value)
+    if isinstance(value, float):
+        return int(value * 255)
+    return value
+
+
+opacity = LValidator(opacity_validator, uint32, retmapper=literal)
+
+
+@schema_extractor("one_of")
+def color(value):
+    if value == SCHEMA_EXTRACT:
+        return ["hex color value", "color ID"]
+    if isinstance(value, int):
+        return value
+    return cv.use_id(ColorStruct)(value)
+
+
+def color_retmapper(value):
+    if isinstance(value, cv.Lambda):
+        return cv.returning_lambda(value)
+    if isinstance(value, int):
+        hexval = HexInt(value)
+        return lv_expr.color_hex(hexval)
+    # Must be an id
+    lvgl_components_required.add(CONF_COLOR)
+    return lv_expr.color_from(MockObj(value))
+
+
+def option_string(value):
+    value = cv.string(value).strip()
+    if value.find("\n") != -1:
+        raise cv.Invalid("Options strings must not contain newlines")
+    return value
+
+
+lv_color = LValidator(color, ty.lv_color_t, retmapper=color_retmapper)
+
+
+def pixels_or_percent_validator(value):
+    """A length in one axis - either a number (pixels) or a percentage"""
+    if value == SCHEMA_EXTRACT:
+        return ["pixels", "..%"]
+    if isinstance(value, int):
+        return cv.int_(value)
+    # Will throw an exception if not a percentage.
+    return f"lv_pct({int(cv.percentage(value) * 100)})"
+
+
+pixels_or_percent = LValidator(pixels_or_percent_validator, uint32, retmapper=literal)
+
+
+def zoom(value):
+    value = cv.float_range(0.1, 10.0)(value)
+    return int(value * 256)
+
+
+def angle(value):
+    """
+    Validation for an angle in degrees, converted to an integer representing 0.1deg units
+    :param value: The input in the range 0..360
+    :return: An angle in 1/10 degree units.
+    """
+    return int(cv.float_range(0.0, 360.0)(cv.angle(value)) * 10)
+
+
+@schema_extractor("one_of")
+def size_validator(value):
+    """A size in one axis - one of "size_content", a number (pixels) or a percentage"""
+    if value == SCHEMA_EXTRACT:
+        return ["size_content", "pixels", "..%"]
+    if isinstance(value, str) and value.lower().endswith("px"):
+        value = cv.int_(value[:-2])
+    if isinstance(value, str) and not value.endswith("%"):
+        if value.upper() == "SIZE_CONTENT":
+            return "LV_SIZE_CONTENT"
+        raise cv.Invalid("must be 'size_content', a pixel position or a percentage")
+    if isinstance(value, int):
+        return cv.int_(value)
+    # Will throw an exception if not a percentage.
+    return f"lv_pct({int(cv.percentage(value) * 100)})"
+
+
+size = LValidator(size_validator, uint32, retmapper=literal)
+
+radius_consts = LvConstant("LV_RADIUS_", "CIRCLE")
+
+
+@schema_extractor("one_of")
+def radius_validator(value):
+    if value == SCHEMA_EXTRACT:
+        return radius_consts.choices
+    value = cv.Any(size, cv.percentage, radius_consts.one_of)(value)
+    if isinstance(value, float):
+        return int(value * 255)
+    return value
+
+
+radius = LValidator(radius_validator, uint32, retmapper=literal)
+
+
+def id_name(value):
+    if value == SCHEMA_EXTRACT:
+        return "id"
+    return cv.validate_id_name(value)
+
+
+def stop_value(value):
+    return cv.int_range(0, 255)(value)
+
+
+lv_images_used = set()
+
+
+def image_validator(value):
+    value = requires_component("image")(value)
+    value = cv.use_id(Image_)(value)
+    lv_images_used.add(value)
+    return value
+
+
+lv_image = LValidator(
+    image_validator,
+    lv_img_t,
+    retmapper=lambda x: lv_expr.img_from(MockObj(x)),
+    requires="image",
+)
+lv_bool = LValidator(
+    cv.boolean, cg.bool_, BinarySensor, "get_state()", retmapper=literal
+)
+
+
+def lv_pct(value: Union[int, float]):
+    if isinstance(value, float):
+        value = int(value * 100)
+    return literal(f"lv_pct({value})")
+
+
+def lvms_validator_(value):
+    if value == "never":
+        value = "2147483647ms"
+    return cv.positive_time_period_milliseconds(value)
+
+
+lv_milliseconds = LValidator(
+    lvms_validator_,
+    cg.int32,
+    retmapper=lambda x: x.total_milliseconds,
+)
+
+
+class TextValidator(LValidator):
+    def __init__(self):
+        super().__init__(
+            cv.string,
+            cg.const_char_ptr,
+            TextSensor,
+            "get_state().c_str()",
+            lambda s: cg.safe_exp(f"{s}"),
+        )
+
+    def __call__(self, value):
+        if isinstance(value, dict):
+            return value
+        return super().__call__(value)
+
+    async def process(self, value, args=()):
+        if isinstance(value, dict):
+            args = [str(x) for x in value[CONF_ARGS]]
+            arg_expr = cg.RawExpression(",".join(args))
+            format_str = cpp_string_escape(value[CONF_FORMAT])
+            return literal(f"str_sprintf({format_str}, {arg_expr}).c_str()")
+        return await super().process(value, args)
+
+
+lv_text = TextValidator()
+lv_float = LValidator(cv.float_, cg.float_, Sensor, "get_state()")
+lv_int = LValidator(cv.int_, cg.int_, Sensor, "get_state()")
+lv_brightness = LValidator(
+    cv.percentage, cg.float_, Sensor, "get_state()", retmapper=lambda x: int(x * 255)
+)
+
+
+def is_lv_font(font):
+    return isinstance(font, str) and font.lower() in LV_FONTS
+
+
+class LvFont(LValidator):
+    def __init__(self):
+        def lv_builtin_font(value):
+            fontval = cv.one_of(*LV_FONTS, lower=True)(value)
+            lv_fonts_used.add(fontval)
+            return fontval
+
+        def validator(value):
+            if value == SCHEMA_EXTRACT:
+                return LV_FONTS
+            if is_lv_font(value):
+                return lv_builtin_font(value)
+            fontval = cv.use_id(Font)(value)
+            esphome_fonts_used.add(fontval)
+            return requires_component("font")(fontval)
+
+        super().__init__(validator, lv_font_t)
+
+    async def process(self, value, args=()):
+        if is_lv_font(value):
+            return literal(f"&lv_font_{value}")
+        return literal(f"{value}_engine->get_lv_font()")
+
+
+lv_font = LvFont()
+
+
+def animated(value):
+    if isinstance(value, bool):
+        value = "ON" if value else "OFF"
+    return LvConstant("LV_ANIM_", "OFF", "ON").one_of(value)
+
+
+def key_code(value):
+    value = cv.Any(cv.All(cv.string_strict, cv.Length(min=1, max=1)), cv.uint8_t)(value)
+    if isinstance(value, str):
+        return ord(value[0])
+    return value
+
+
+async def get_end_value(config):
+    return await lv_int.process(config.get(CONF_END_VALUE))
+
+
+async def get_start_value(config):
+    if CONF_START_VALUE in config:
+        value = config[CONF_START_VALUE]
+    else:
+        value = config.get(CONF_VALUE)
+    return await lv_int.process(value)

esphome/components/lvgl/lvcode.py

@@ -0,0 +1,349 @@
+import abc
+from typing import Union
+
+from esphome import codegen as cg
+from esphome.config import Config
+from esphome.core import CORE, ID, Lambda
+from esphome.cpp_generator import (
+    AssignmentExpression,
+    CallExpression,
+    Expression,
+    ExpressionStatement,
+    LambdaExpression,
+    MockObj,
+    RawExpression,
+    RawStatement,
+    SafeExpType,
+    Statement,
+    VariableDeclarationExpression,
+    statement,
+)
+from esphome.yaml_util import ESPHomeDataBase
+
+from .defines import literal, lvgl_ns
+
+LVGL_COMP = "lv_component"  # used as a lambda argument in lvgl_comp()
+
+# Argument tuple for use in lambdas
+LvglComponent = lvgl_ns.class_("LvglComponent", cg.PollingComponent)
+LVGL_COMP_ARG = [(LvglComponent.operator("ptr"), LVGL_COMP)]
+lv_event_t_ptr = cg.global_ns.namespace("lv_event_t").operator("ptr")
+EVENT_ARG = [(lv_event_t_ptr, "ev")]
+# Two custom events; API_EVENT is fired when an entity is updated remotely by an API interaction;
+# UPDATE_EVENT is fired when an entity is programmatically updated locally.
+# VALUE_CHANGED is the event generated by LVGL when an entity's value changes through user interaction.
+API_EVENT = literal("lvgl::lv_api_event")
+UPDATE_EVENT = literal("lvgl::lv_update_event")
+
+
+def get_line_marks(value) -> list:
+    """
+    If possible, return a preprocessor directive to identify the line number where the given id was defined.
+    :param value: The id or other token to get the line number for
+    :return: A list containing zero or more line directives
+    """
+    path = None
+    if isinstance(value, ESPHomeDataBase):
+        path = value.esp_range
+    elif isinstance(value, ID) and isinstance(CORE.config, Config):
+        path = CORE.config.get_path_for_id(value)[:-1]
+        path = CORE.config.get_deepest_document_range_for_path(path)
+    if path is None:
+        return []
+    return [path.start_mark.as_line_directive]
+
+
+class IndentedStatement(Statement):
+    def __init__(self, stmt: Statement, indent: int):
+        self.statement = stmt
+        self.indent = indent
+
+    def __str__(self):
+        result = " " * self.indent * 4 + str(self.statement).strip()
+        if not isinstance(self.statement, RawStatement):
+            result += ";"
+        return result
+
+
+class CodeContext(abc.ABC):
+    """
+    A class providing a context for code generation. Generated code will be added to the
+    current context. A new context will stack on the current context, and restore it
+    when done. Used with the `with` statement.
+    """
+
+    code_context = None
+
+    @abc.abstractmethod
+    def add(self, expression: Union[Expression, Statement]):
+        pass
+
+    @staticmethod
+    def start_block():
+        CodeContext.append(RawStatement("{"))
+        CodeContext.code_context.indent()
+
+    @staticmethod
+    def end_block():
+        CodeContext.code_context.detent()
+        CodeContext.append(RawStatement("}"))
+
+    @staticmethod
+    def append(expression: Union[Expression, Statement]):
+        if CodeContext.code_context is not None:
+            CodeContext.code_context.add(expression)
+        return expression
+
+    def __init__(self):
+        self.previous: Union[CodeContext | None] = None
+        self.indent_level = 0
+
+    async def __aenter__(self):
+        self.previous = CodeContext.code_context
+        CodeContext.code_context = self
+        return self
+
+    async def __aexit__(self, *args):
+        CodeContext.code_context = self.previous
+
+    def indent(self):
+        self.indent_level += 1
+
+    def detent(self):
+        self.indent_level -= 1
+
+    def indented_statement(self, stmt):
+        return IndentedStatement(stmt, self.indent_level)
+
+
+class MainContext(CodeContext):
+    """
+    Code generation into the main() function
+    """
+
+    def add(self, expression: Union[Expression, Statement]):
+        return cg.add(self.indented_statement(expression))
+
+
+class LambdaContext(CodeContext):
+    """
+    A context that will accumlate code for use in a lambda.
+    """
+
+    def __init__(
+        self,
+        parameters: list[tuple[SafeExpType, str]] = None,
+        return_type: SafeExpType = cg.void,
+        capture: str = "",
+        where=None,
+    ):
+        super().__init__()
+        self.code_list: list[Statement] = []
+        self.parameters = parameters or []
+        self.return_type = return_type
+        self.capture = capture
+        self.where = where
+
+    def add(self, expression: Union[Expression, Statement]):
+        self.code_list.append(self.indented_statement(expression))
+        return expression
+
+    async def get_lambda(self) -> LambdaExpression:
+        code_text = self.get_code()
+        return await cg.process_lambda(
+            Lambda("\n".join(code_text) + "\n"),
+            self.parameters,
+            capture=self.capture,
+            return_type=self.return_type,
+        )
+
+    def get_code(self):
+        code_text = []
+        for exp in self.code_list:
+            text = str(statement(exp))
+            text = text.rstrip()
+            code_text.append(text)
+        return code_text
+
+    async def __aenter__(self):
+        await super().__aenter__()
+        add_line_marks(self.where)
+        return self
+
+
+class LvContext(LambdaContext):
+    """
+    Code generation into the LVGL initialisation code (called in `setup()`)
+    """
+
+    def __init__(self, lv_component, args=None):
+        self.args = args or LVGL_COMP_ARG
+        super().__init__(parameters=self.args)
+        self.lv_component = lv_component
+
+    async def add_init_lambda(self):
+        cg.add(self.lv_component.add_init_lambda(await self.get_lambda()))
+
+    async def __aexit__(self, exc_type, exc_val, exc_tb):
+        await super().__aexit__(exc_type, exc_val, exc_tb)
+        await self.add_init_lambda()
+
+    def add(self, expression: Union[Expression, Statement]):
+        self.code_list.append(self.indented_statement(expression))
+        return expression
+
+    def __call__(self, *args):
+        return self.add(*args)
+
+
+class LocalVariable(MockObj):
+    """
+    Create a local variable and enclose the code using it within a block.
+    """
+
+    def __init__(self, name, type, rhs=None, modifier="*"):
+        base = ID(name + "_VAR_", True, type)
+        super().__init__(base, "")
+        self.modifier = modifier
+        self.rhs = rhs
+
+    def __enter__(self):
+        CodeContext.start_block()
+        CodeContext.append(
+            VariableDeclarationExpression(self.base.type, self.modifier, self.base.id)
+        )
+        if self.rhs is not None:
+            CodeContext.append(AssignmentExpression(None, "", self.base, self.rhs))
+        return MockObj(self.base)
+
+    def __exit__(self, *args):
+        CodeContext.end_block()
+
+
+class MockLv:
+    """
+    A mock object that can be used to generate LVGL calls.
+    """
+
+    def __init__(self, base):
+        self.base = base
+
+    def __getattr__(self, attr: str) -> "MockLv":
+        return MockLv(f"{self.base}{attr}")
+
+    def append(self, expression):
+        CodeContext.append(expression)
+
+    def __call__(self, *args: SafeExpType) -> "MockObj":
+        call = CallExpression(self.base, *args)
+        result = MockObj(call, "")
+        self.append(result)
+        return result
+
+    def __str__(self):
+        return str(self.base)
+
+    def __repr__(self):
+        return f"MockLv<{str(self.base)}>"
+
+    def call(self, prop, *args):
+        call = CallExpression(RawExpression(f"{self.base}{prop}"), *args)
+        result = MockObj(call, "")
+        self.append(result)
+        return result
+
+
+class LvConditional:
+    def __init__(self, condition):
+        self.condition = condition
+
+    def __enter__(self):
+        if self.condition is not None:
+            CodeContext.append(RawStatement(f"if ({self.condition}) {{"))
+            CodeContext.code_context.indent()
+        return self
+
+    def __exit__(self, *args):
+        if self.condition is not None:
+            CodeContext.code_context.detent()
+            CodeContext.append(RawStatement("}"))
+
+    def else_(self):
+        assert self.condition is not None
+        CodeContext.code_context.detent()
+        CodeContext.append(RawStatement("} else {"))
+        CodeContext.code_context.indent()
+
+
+class ReturnStatement(ExpressionStatement):
+    def __str__(self):
+        return f"return {self.expression};"
+
+
+class LvExpr(MockLv):
+    def __getattr__(self, attr: str) -> "MockLv":
+        return LvExpr(f"{self.base}{attr}")
+
+    def append(self, expression):
+        pass
+
+
+# Top level mock for generic lv_ calls to be recorded
+lv = MockLv("lv_")
+# Just generate an expression
+lv_expr = LvExpr("lv_")
+# Mock for lv_obj_ calls
+lv_obj = MockLv("lv_obj_")
+# Operations on the LVGL component
+lvgl_comp = MockObj(LVGL_COMP, "->")
+
+
+# equivalent to cg.add() for the current code context
+def lv_add(expression: Union[Expression, Statement]):
+    return CodeContext.append(expression)
+
+
+def add_line_marks(where):
+    """
+    Add line marks for the current code context
+    :param where: An object to identify the source of the line marks
+    :return:
+    """
+    for mark in get_line_marks(where):
+        lv_add(cg.RawStatement(mark))
+
+
+def lv_assign(target, expression):
+    lv_add(AssignmentExpression("", "", target, expression))
+
+
+def lv_Pvariable(type, name):
+    """
+    Create but do not initialise a pointer variable
+    :param type: Type of the variable target
+    :param name: name of the variable, or an ID
+    :return:  A MockObj of the variable
+    """
+    if isinstance(name, str):
+        name = ID(name, True, type)
+    decl = VariableDeclarationExpression(type, "*", name)
+    CORE.add_global(decl)
+    var = MockObj(name, "->")
+    CORE.register_variable(name, var)
+    return var
+
+
+def lv_variable(type, name):
+    """
+    Create but do not initialise a variable
+    :param type: Type of the variable target
+    :param name: name of the variable, or an ID
+    :return:  A MockObj of the variable
+    """
+    if isinstance(name, str):
+        name = ID(name, True, type)
+    decl = VariableDeclarationExpression(type, "", name)
+    CORE.add_global(decl)
+    var = MockObj(name, ".")
+    CORE.register_variable(name, var)
+    return var