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

esphome/components/apds9306/apds9306.cpp

@@ -0,0 +1,151 @@
+// Based on this datasheet:
+// https://www.mouser.ca/datasheet/2/678/AVGO_S_A0002854364_1-2574547.pdf
+
+#include "apds9306.h"
+#include "esphome/core/helpers.h"
+#include "esphome/core/log.h"
+
+namespace esphome {
+namespace apds9306 {
+
+static const char *const TAG = "apds9306";
+
+enum {  // APDS9306 registers
+  APDS9306_MAIN_CTRL = 0x00,
+  APDS9306_ALS_MEAS_RATE = 0x04,
+  APDS9306_ALS_GAIN = 0x05,
+  APDS9306_PART_ID = 0x06,
+  APDS9306_MAIN_STATUS = 0x07,
+  APDS9306_CLEAR_DATA_0 = 0x0A,  // LSB
+  APDS9306_CLEAR_DATA_1 = 0x0B,
+  APDS9306_CLEAR_DATA_2 = 0x0C,  // MSB
+  APDS9306_ALS_DATA_0 = 0x0D,    // LSB
+  APDS9306_ALS_DATA_1 = 0x0E,
+  APDS9306_ALS_DATA_2 = 0x0F,  // MSB
+  APDS9306_INT_CFG = 0x19,
+  APDS9306_INT_PERSISTENCE = 0x1A,
+  APDS9306_ALS_THRES_UP_0 = 0x21,  // LSB
+  APDS9306_ALS_THRES_UP_1 = 0x22,
+  APDS9306_ALS_THRES_UP_2 = 0x23,   // MSB
+  APDS9306_ALS_THRES_LOW_0 = 0x24,  // LSB
+  APDS9306_ALS_THRES_LOW_1 = 0x25,
+  APDS9306_ALS_THRES_LOW_2 = 0x26,  // MSB
+  APDS9306_ALS_THRES_VAR = 0x27
+};
+
+#define APDS9306_ERROR_CHECK(func, error) \
+  if (!(func)) { \
+    ESP_LOGE(TAG, error); \
+    this->mark_failed(); \
+    return; \
+  }
+#define APDS9306_WARNING_CHECK(func, warning) \
+  if (!(func)) { \
+    ESP_LOGW(TAG, warning); \
+    this->status_set_warning(); \
+    return; \
+  }
+#define APDS9306_WRITE_BYTE(reg, value) \
+  ESP_LOGV(TAG, "Writing 0x%02x to 0x%02x", value, reg); \
+  if (!this->write_byte(reg, value)) { \
+    ESP_LOGE(TAG, "Failed writing 0x%02x to 0x%02x", value, reg); \
+    this->mark_failed(); \
+    return; \
+  }
+
+void APDS9306::setup() {
+  ESP_LOGCONFIG(TAG, "Setting up APDS9306...");
+
+  uint8_t id;
+  if (!this->read_byte(APDS9306_PART_ID, &id)) {  // Part ID register
+    this->error_code_ = COMMUNICATION_FAILED;
+    this->mark_failed();
+    return;
+  }
+
+  if (id != 0xB1 && id != 0xB3) {  // 0xB1 for APDS9306 0xB3 for APDS9306-065
+    this->error_code_ = WRONG_ID;
+    this->mark_failed();
+    return;
+  }
+
+  // ALS resolution and measurement, see datasheet or init.py for options
+  uint8_t als_meas_rate = ((this->bit_width_ & 0x07) << 4) | (this->measurement_rate_ & 0x07);
+  APDS9306_WRITE_BYTE(APDS9306_ALS_MEAS_RATE, als_meas_rate);
+
+  // ALS gain, see datasheet or init.py for options
+  uint8_t als_gain = (this->gain_ & 0x07);
+  APDS9306_WRITE_BYTE(APDS9306_ALS_GAIN, als_gain);
+
+  // Set to standby mode
+  APDS9306_WRITE_BYTE(APDS9306_MAIN_CTRL, 0x00);
+
+  // Check for data, clear main status
+  uint8_t status;
+  APDS9306_WARNING_CHECK(this->read_byte(APDS9306_MAIN_STATUS, &status), "Reading MAIN STATUS failed.");
+
+  // Set to active mode
+  APDS9306_WRITE_BYTE(APDS9306_MAIN_CTRL, 0x02);
+
+  ESP_LOGCONFIG(TAG, "APDS9306 setup complete");
+}
+
+void APDS9306::dump_config() {
+  LOG_SENSOR("", "APDS9306", this);
+  LOG_I2C_DEVICE(this);
+
+  if (this->is_failed()) {
+    switch (this->error_code_) {
+      case COMMUNICATION_FAILED:
+        ESP_LOGE(TAG, "Communication with APDS9306 failed!");
+        break;
+      case WRONG_ID:
+        ESP_LOGE(TAG, "APDS9306 has invalid id!");
+        break;
+      default:
+        ESP_LOGE(TAG, "Setting up APDS9306 registers failed!");
+        break;
+    }
+  }
+
+  ESP_LOGCONFIG(TAG, "  Gain: %u", AMBIENT_LIGHT_GAIN_VALUES[this->gain_]);
+  ESP_LOGCONFIG(TAG, "  Measurement rate: %u", MEASUREMENT_RATE_VALUES[this->measurement_rate_]);
+  ESP_LOGCONFIG(TAG, "  Measurement Resolution/Bit width: %d", MEASUREMENT_BIT_WIDTH_VALUES[this->bit_width_]);
+
+  LOG_UPDATE_INTERVAL(this);
+}
+
+void APDS9306::update() {
+  // Check for new data
+  uint8_t status;
+  APDS9306_WARNING_CHECK(this->read_byte(APDS9306_MAIN_STATUS, &status), "Reading MAIN STATUS failed.");
+
+  this->status_clear_warning();
+
+  if (!(status &= 0b00001000)) {  // No new data
+    return;
+  }
+
+  // Set to standby mode
+  APDS9306_WRITE_BYTE(APDS9306_MAIN_CTRL, 0x00);
+
+  // Clear MAIN STATUS
+  APDS9306_WARNING_CHECK(this->read_byte(APDS9306_MAIN_STATUS, &status), "Reading MAIN STATUS failed.");
+
+  uint8_t als_data[3];
+  APDS9306_WARNING_CHECK(this->read_bytes(APDS9306_ALS_DATA_0, als_data, 3), "Reading ALS data has failed.");
+
+  // Set to active mode
+  APDS9306_WRITE_BYTE(APDS9306_MAIN_CTRL, 0x02);
+
+  uint32_t light_level = 0x00 | encode_uint24(als_data[2], als_data[1], als_data[0]);
+
+  float lux = ((float) light_level / AMBIENT_LIGHT_GAIN_VALUES[this->gain_]) *
+              (100.0f / MEASUREMENT_RATE_VALUES[this->measurement_rate_]);
+
+  ESP_LOGD(TAG, "Got illuminance=%.1flx from", lux);
+  this->publish_state(lux);
+}
+
+}  // namespace apds9306
+}  // namespace esphome

esphome/components/apds9306/apds9306.h

@@ -0,0 +1,66 @@
+// Based on this datasheet:
+// https://www.mouser.ca/datasheet/2/678/AVGO_S_A0002854364_1-2574547.pdf
+
+#pragma once
+
+#include "esphome/components/i2c/i2c.h"
+#include "esphome/components/sensor/sensor.h"
+#include "esphome/core/component.h"
+
+namespace esphome {
+namespace apds9306 {
+
+enum MeasurementBitWidth : uint8_t {
+  MEASUREMENT_BIT_WIDTH_20 = 0,
+  MEASUREMENT_BIT_WIDTH_19 = 1,
+  MEASUREMENT_BIT_WIDTH_18 = 2,
+  MEASUREMENT_BIT_WIDTH_17 = 3,
+  MEASUREMENT_BIT_WIDTH_16 = 4,
+  MEASUREMENT_BIT_WIDTH_13 = 5,
+};
+static const uint8_t MEASUREMENT_BIT_WIDTH_VALUES[] = {20, 19, 18, 17, 16, 13};
+
+enum MeasurementRate : uint8_t {
+  MEASUREMENT_RATE_25 = 0,
+  MEASUREMENT_RATE_50 = 1,
+  MEASUREMENT_RATE_100 = 2,
+  MEASUREMENT_RATE_200 = 3,
+  MEASUREMENT_RATE_500 = 4,
+  MEASUREMENT_RATE_1000 = 5,
+  MEASUREMENT_RATE_2000 = 6,
+};
+static const uint16_t MEASUREMENT_RATE_VALUES[] = {25, 50, 100, 200, 500, 1000, 2000};
+
+enum AmbientLightGain : uint8_t {
+  AMBIENT_LIGHT_GAIN_1 = 0,
+  AMBIENT_LIGHT_GAIN_3 = 1,
+  AMBIENT_LIGHT_GAIN_6 = 2,
+  AMBIENT_LIGHT_GAIN_9 = 3,
+  AMBIENT_LIGHT_GAIN_18 = 4,
+};
+static const uint8_t AMBIENT_LIGHT_GAIN_VALUES[] = {1, 3, 6, 9, 18};
+
+class APDS9306 : public sensor::Sensor, public PollingComponent, public i2c::I2CDevice {
+ public:
+  void setup() override;
+  float get_setup_priority() const override { return setup_priority::BUS; }
+  void dump_config() override;
+  void update() override;
+  void set_bit_width(MeasurementBitWidth bit_width) { this->bit_width_ = bit_width; }
+  void set_measurement_rate(MeasurementRate measurement_rate) { this->measurement_rate_ = measurement_rate; }
+  void set_ambient_light_gain(AmbientLightGain gain) { this->gain_ = gain; }
+
+ protected:
+  enum ErrorCode {
+    NONE = 0,
+    COMMUNICATION_FAILED,
+    WRONG_ID,
+  } error_code_{NONE};
+
+  MeasurementBitWidth bit_width_;
+  MeasurementRate measurement_rate_;
+  AmbientLightGain gain_;
+};
+
+}  // namespace apds9306
+}  // namespace esphome

esphome/components/apds9306/sensor.py

@@ -0,0 +1,95 @@
+# Based on this datasheet:
+# https://www.mouser.ca/datasheet/2/678/AVGO_S_A0002854364_1-2574547.pdf
+
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import i2c, sensor
+from esphome.const import (
+    CONF_GAIN,
+    DEVICE_CLASS_ILLUMINANCE,
+    ICON_LIGHTBULB,
+    STATE_CLASS_MEASUREMENT,
+    UNIT_LUX,
+)
+
+DEPENDENCIES = ["i2c"]
+
+CONF_APDS9306_ID = "apds9306_id"
+CONF_BIT_WIDTH = "bit_width"
+CONF_MEASUREMENT_RATE = "measurement_rate"
+
+apds9306_ns = cg.esphome_ns.namespace("apds9306")
+APDS9306 = apds9306_ns.class_(
+    "APDS9306", sensor.Sensor, cg.PollingComponent, i2c.I2CDevice
+)
+
+MeasurementBitWidth = apds9306_ns.enum("MeasurementBitWidth")
+MeasurementRate = apds9306_ns.enum("MeasurementRate")
+AmbientLightGain = apds9306_ns.enum("AmbientLightGain")
+
+MEASUREMENT_BIT_WIDTHS = {
+    20: MeasurementBitWidth.MEASUREMENT_BIT_WIDTH_20,
+    19: MeasurementBitWidth.MEASUREMENT_BIT_WIDTH_19,
+    18: MeasurementBitWidth.MEASUREMENT_BIT_WIDTH_18,
+    17: MeasurementBitWidth.MEASUREMENT_BIT_WIDTH_17,
+    16: MeasurementBitWidth.MEASUREMENT_BIT_WIDTH_16,
+    13: MeasurementBitWidth.MEASUREMENT_BIT_WIDTH_13,
+}
+
+MEASUREMENT_RATES = {
+    25: MeasurementRate.MEASUREMENT_RATE_25,
+    50: MeasurementRate.MEASUREMENT_RATE_50,
+    100: MeasurementRate.MEASUREMENT_RATE_100,
+    200: MeasurementRate.MEASUREMENT_RATE_200,
+    500: MeasurementRate.MEASUREMENT_RATE_500,
+    1000: MeasurementRate.MEASUREMENT_RATE_1000,
+    2000: MeasurementRate.MEASUREMENT_RATE_2000,
+}
+
+AMBIENT_LIGHT_GAINS = {
+    1: AmbientLightGain.AMBIENT_LIGHT_GAIN_1,
+    3: AmbientLightGain.AMBIENT_LIGHT_GAIN_3,
+    6: AmbientLightGain.AMBIENT_LIGHT_GAIN_6,
+    9: AmbientLightGain.AMBIENT_LIGHT_GAIN_9,
+    18: AmbientLightGain.AMBIENT_LIGHT_GAIN_18,
+}
+
+
+def _validate_measurement_rate(value):
+    value = cv.positive_time_period_milliseconds(value)
+    return cv.enum(MEASUREMENT_RATES, int=True)(value.total_milliseconds)
+
+
+CONFIG_SCHEMA = (
+    sensor.sensor_schema(
+        APDS9306,
+        unit_of_measurement=UNIT_LUX,
+        accuracy_decimals=1,
+        device_class=DEVICE_CLASS_ILLUMINANCE,
+        state_class=STATE_CLASS_MEASUREMENT,
+        icon=ICON_LIGHTBULB,
+    )
+    .extend(
+        {
+            cv.Optional(CONF_GAIN, default="1"): cv.enum(AMBIENT_LIGHT_GAINS, int=True),
+            cv.Optional(CONF_BIT_WIDTH, default="18"): cv.enum(
+                MEASUREMENT_BIT_WIDTHS, int=True
+            ),
+            cv.Optional(
+                CONF_MEASUREMENT_RATE, default="100ms"
+            ): _validate_measurement_rate,
+        }
+    )
+    .extend(cv.polling_component_schema("60s"))
+    .extend(i2c.i2c_device_schema(0x52))
+)
+
+
+async def to_code(config):
+    var = await sensor.new_sensor(config)
+    await cg.register_component(var, config)
+    await i2c.register_i2c_device(var, config)
+
+    cg.add(var.set_bit_width(config[CONF_BIT_WIDTH]))
+    cg.add(var.set_measurement_rate(config[CONF_MEASUREMENT_RATE]))
+    cg.add(var.set_ambient_light_gain(config[CONF_GAIN]))

esphome/components/api/__init__.py

@@ -1,25 +1,27 @@
 import base64
 
-import esphome.codegen as cg
-import esphome.config_validation as cv
 from esphome import automation
 from esphome.automation import Condition
+import esphome.codegen as cg
+import esphome.config_validation as cv
 from esphome.const import (
+    CONF_ACTION,
+    CONF_ACTIONS,
     CONF_DATA,
     CONF_DATA_TEMPLATE,
+    CONF_EVENT,
     CONF_ID,
     CONF_KEY,
+    CONF_ON_CLIENT_CONNECTED,
+    CONF_ON_CLIENT_DISCONNECTED,
     CONF_PASSWORD,
     CONF_PORT,
     CONF_REBOOT_TIMEOUT,
     CONF_SERVICE,
-    CONF_VARIABLES,
     CONF_SERVICES,
-    CONF_TRIGGER_ID,
-    CONF_EVENT,
     CONF_TAG,
-    CONF_ON_CLIENT_CONNECTED,
-    CONF_ON_CLIENT_DISCONNECTED,
+    CONF_TRIGGER_ID,
+    CONF_VARIABLES,
 )
 from esphome.core import coroutine_with_priority
 
@@ -63,40 +65,51 @@ def validate_encryption_key(value):
     return value
 
 
-CONFIG_SCHEMA = cv.Schema(
+ACTIONS_SCHEMA = automation.validate_automation(
     {
-        cv.GenerateID(): cv.declare_id(APIServer),
-        cv.Optional(CONF_PORT, default=6053): cv.port,
-        cv.Optional(CONF_PASSWORD, default=""): cv.string_strict,
-        cv.Optional(
-            CONF_REBOOT_TIMEOUT, default="15min"
-        ): cv.positive_time_period_milliseconds,
-        cv.Optional(CONF_SERVICES): automation.validate_automation(
-            {
-                cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(UserServiceTrigger),
-                cv.Required(CONF_SERVICE): cv.valid_name,
-                cv.Optional(CONF_VARIABLES, default={}): cv.Schema(
-                    {
-                        cv.validate_id_name: cv.one_of(
-                            *SERVICE_ARG_NATIVE_TYPES, lower=True
-                        ),
-                    }
-                ),
-            }
-        ),
-        cv.Optional(CONF_ENCRYPTION): cv.Schema(
+        cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(UserServiceTrigger),
+        cv.Exclusive(CONF_SERVICE, group_of_exclusion=CONF_ACTION): cv.valid_name,
+        cv.Exclusive(CONF_ACTION, group_of_exclusion=CONF_ACTION): cv.valid_name,
+        cv.Optional(CONF_VARIABLES, default={}): cv.Schema(
             {
-                cv.Required(CONF_KEY): validate_encryption_key,
+                cv.validate_id_name: cv.one_of(*SERVICE_ARG_NATIVE_TYPES, lower=True),
             }
         ),
-        cv.Optional(CONF_ON_CLIENT_CONNECTED): automation.validate_automation(
-            single=True
-        ),
-        cv.Optional(CONF_ON_CLIENT_DISCONNECTED): automation.validate_automation(
-            single=True
-        ),
-    }
-).extend(cv.COMPONENT_SCHEMA)
+    },
+    cv.All(
+        cv.has_exactly_one_key(CONF_SERVICE, CONF_ACTION),
+        cv.rename_key(CONF_SERVICE, CONF_ACTION),
+    ),
+)
+
+CONFIG_SCHEMA = cv.All(
+    cv.Schema(
+        {
+            cv.GenerateID(): cv.declare_id(APIServer),
+            cv.Optional(CONF_PORT, default=6053): cv.port,
+            cv.Optional(CONF_PASSWORD, default=""): cv.string_strict,
+            cv.Optional(
+                CONF_REBOOT_TIMEOUT, default="15min"
+            ): cv.positive_time_period_milliseconds,
+            cv.Exclusive(
+                CONF_SERVICES, group_of_exclusion=CONF_ACTIONS
+            ): ACTIONS_SCHEMA,
+            cv.Exclusive(CONF_ACTIONS, group_of_exclusion=CONF_ACTIONS): ACTIONS_SCHEMA,
+            cv.Optional(CONF_ENCRYPTION): cv.Schema(
+                {
+                    cv.Required(CONF_KEY): validate_encryption_key,
+                }
+            ),
+            cv.Optional(CONF_ON_CLIENT_CONNECTED): automation.validate_automation(
+                single=True
+            ),
+            cv.Optional(CONF_ON_CLIENT_DISCONNECTED): automation.validate_automation(
+                single=True
+            ),
+        }
+    ).extend(cv.COMPONENT_SCHEMA),
+    cv.rename_key(CONF_SERVICES, CONF_ACTIONS),
+)
 
 
 @coroutine_with_priority(40.0)
@@ -108,7 +121,7 @@ async def to_code(config):
     cg.add(var.set_password(config[CONF_PASSWORD]))
     cg.add(var.set_reboot_timeout(config[CONF_REBOOT_TIMEOUT]))
 
-    for conf in config.get(CONF_SERVICES, []):
+    for conf in config.get(CONF_ACTIONS, []):
         template_args = []
         func_args = []
         service_arg_names = []
@@ -119,7 +132,7 @@ async def to_code(config):
             service_arg_names.append(name)
         templ = cg.TemplateArguments(*template_args)
         trigger = cg.new_Pvariable(
-            conf[CONF_TRIGGER_ID], templ, conf[CONF_SERVICE], service_arg_names
+            conf[CONF_TRIGGER_ID], templ, conf[CONF_ACTION], service_arg_names
         )
         cg.add(var.register_user_service(trigger))
         await automation.build_automation(trigger, func_args, conf)
@@ -142,7 +155,7 @@ async def to_code(config):
         decoded = base64.b64decode(encryption_config[CONF_KEY])
         cg.add(var.set_noise_psk(list(decoded)))
         cg.add_define("USE_API_NOISE")
-        cg.add_library("esphome/noise-c", "0.1.4")
+        cg.add_library("esphome/noise-c", "0.1.6")
     else:
         cg.add_define("USE_API_PLAINTEXT")
 
@@ -152,28 +165,43 @@ async def to_code(config):
 
 KEY_VALUE_SCHEMA = cv.Schema({cv.string: cv.templatable(cv.string_strict)})
 
-HOMEASSISTANT_SERVICE_ACTION_SCHEMA = cv.Schema(
-    {
-        cv.GenerateID(): cv.use_id(APIServer),
-        cv.Required(CONF_SERVICE): cv.templatable(cv.string),
-        cv.Optional(CONF_DATA, default={}): KEY_VALUE_SCHEMA,
-        cv.Optional(CONF_DATA_TEMPLATE, default={}): KEY_VALUE_SCHEMA,
-        cv.Optional(CONF_VARIABLES, default={}): cv.Schema(
-            {cv.string: cv.returning_lambda}
-        ),
-    }
+
+HOMEASSISTANT_ACTION_ACTION_SCHEMA = cv.All(
+    cv.Schema(
+        {
+            cv.GenerateID(): cv.use_id(APIServer),
+            cv.Exclusive(CONF_SERVICE, group_of_exclusion=CONF_ACTION): cv.templatable(
+                cv.string
+            ),
+            cv.Exclusive(CONF_ACTION, group_of_exclusion=CONF_ACTION): cv.templatable(
+                cv.string
+            ),
+            cv.Optional(CONF_DATA, default={}): KEY_VALUE_SCHEMA,
+            cv.Optional(CONF_DATA_TEMPLATE, default={}): KEY_VALUE_SCHEMA,
+            cv.Optional(CONF_VARIABLES, default={}): cv.Schema(
+                {cv.string: cv.returning_lambda}
+            ),
+        }
+    ),
+    cv.has_exactly_one_key(CONF_SERVICE, CONF_ACTION),
+    cv.rename_key(CONF_SERVICE, CONF_ACTION),
 )
 
 
+@automation.register_action(
+    "homeassistant.action",
+    HomeAssistantServiceCallAction,
+    HOMEASSISTANT_ACTION_ACTION_SCHEMA,
+)
 @automation.register_action(
     "homeassistant.service",
     HomeAssistantServiceCallAction,
-    HOMEASSISTANT_SERVICE_ACTION_SCHEMA,
+    HOMEASSISTANT_ACTION_ACTION_SCHEMA,
 )
 async def homeassistant_service_to_code(config, action_id, template_arg, args):
     serv = await cg.get_variable(config[CONF_ID])
     var = cg.new_Pvariable(action_id, template_arg, serv, False)
-    templ = await cg.templatable(config[CONF_SERVICE], args, None)
+    templ = await cg.templatable(config[CONF_ACTION], args, None)
     cg.add(var.set_service(templ))
     for key, value in config[CONF_DATA].items():
         templ = await cg.templatable(value, args, None)

esphome/components/api/api_connection.cpp

@@ -1328,7 +1328,20 @@ void APIConnection::update_command(const UpdateCommandRequest &msg) {
   if (update == nullptr)
     return;
 
-  update->perform();
+  switch (msg.command) {
+    case enums::UPDATE_COMMAND_UPDATE:
+      update->perform();
+      break;
+    case enums::UPDATE_COMMAND_CHECK:
+      update->check();
+      break;
+    case enums::UPDATE_COMMAND_NONE:
+      ESP_LOGE(TAG, "UPDATE_COMMAND_NONE not handled. Check client is sending the correct command");
+      break;
+    default:
+      ESP_LOGW(TAG, "Unknown update command: %" PRIu32, msg.command);
+      break;
+  }
 }
 #endif
 

esphome/components/api/api_pb2.cpp

@@ -567,6 +567,20 @@ template<> const char *proto_enum_to_string<enums::ValveOperation>(enums::ValveO
   }
 }
 #endif
+#ifdef HAS_PROTO_MESSAGE_DUMP
+template<> const char *proto_enum_to_string<enums::UpdateCommand>(enums::UpdateCommand value) {
+  switch (value) {
+    case enums::UPDATE_COMMAND_NONE:
+      return "UPDATE_COMMAND_NONE";
+    case enums::UPDATE_COMMAND_UPDATE:
+      return "UPDATE_COMMAND_UPDATE";
+    case enums::UPDATE_COMMAND_CHECK:
+      return "UPDATE_COMMAND_CHECK";
+    default:
+      return "UNKNOWN";
+  }
+}
+#endif
 bool HelloRequest::decode_varint(uint32_t field_id, ProtoVarInt value) {
   switch (field_id) {
     case 2: {
@@ -3095,6 +3109,16 @@ void SubscribeHomeAssistantStatesRequest::dump_to(std::string &out) const {
   out.append("SubscribeHomeAssistantStatesRequest {}");
 }
 #endif
+bool SubscribeHomeAssistantStateResponse::decode_varint(uint32_t field_id, ProtoVarInt value) {
+  switch (field_id) {
+    case 3: {
+      this->once = value.as_bool();
+      return true;
+    }
+    default:
+      return false;
+  }
+}
 bool SubscribeHomeAssistantStateResponse::decode_length(uint32_t field_id, ProtoLengthDelimited value) {
   switch (field_id) {
     case 1: {
@@ -3112,6 +3136,7 @@ bool SubscribeHomeAssistantStateResponse::decode_length(uint32_t field_id, Proto
 void SubscribeHomeAssistantStateResponse::encode(ProtoWriteBuffer buffer) const {
   buffer.encode_string(1, this->entity_id);
   buffer.encode_string(2, this->attribute);
+  buffer.encode_bool(3, this->once);
 }
 #ifdef HAS_PROTO_MESSAGE_DUMP
 void SubscribeHomeAssistantStateResponse::dump_to(std::string &out) const {
@@ -3124,6 +3149,10 @@ void SubscribeHomeAssistantStateResponse::dump_to(std::string &out) const {
   out.append("  attribute: ");
   out.append("'").append(this->attribute).append("'");
   out.append("\n");
+
+  out.append("  once: ");
+  out.append(YESNO(this->once));
+  out.append("\n");
   out.append("}");
 }
 #endif
@@ -8596,7 +8625,7 @@ void UpdateStateResponse::dump_to(std::string &out) const {
 bool UpdateCommandRequest::decode_varint(uint32_t field_id, ProtoVarInt value) {
   switch (field_id) {
     case 2: {
-      this->install = value.as_bool();
+      this->command = value.as_enum<enums::UpdateCommand>();
       return true;
     }
     default:
@@ -8615,7 +8644,7 @@ bool UpdateCommandRequest::decode_32bit(uint32_t field_id, Proto32Bit value) {
 }
 void UpdateCommandRequest::encode(ProtoWriteBuffer buffer) const {
   buffer.encode_fixed32(1, this->key);
-  buffer.encode_bool(2, this->install);
+  buffer.encode_enum<enums::UpdateCommand>(2, this->command);
 }
 #ifdef HAS_PROTO_MESSAGE_DUMP
 void UpdateCommandRequest::dump_to(std::string &out) const {
@@ -8626,8 +8655,8 @@ void UpdateCommandRequest::dump_to(std::string &out) const {
   out.append(buffer);
   out.append("\n");
 
-  out.append("  install: ");
-  out.append(YESNO(this->install));
+  out.append("  command: ");
+  out.append(proto_enum_to_string<enums::UpdateCommand>(this->command));
   out.append("\n");
   out.append("}");
 }

esphome/components/api/api_pb2.h

@@ -227,6 +227,11 @@ enum ValveOperation : uint32_t {
   VALVE_OPERATION_IS_OPENING = 1,
   VALVE_OPERATION_IS_CLOSING = 2,
 };
+enum UpdateCommand : uint32_t {
+  UPDATE_COMMAND_NONE = 0,
+  UPDATE_COMMAND_UPDATE = 1,
+  UPDATE_COMMAND_CHECK = 2,
+};
 
 }  // namespace enums
 
@@ -831,6 +836,7 @@ class SubscribeHomeAssistantStateResponse : public ProtoMessage {
  public:
   std::string entity_id{};
   std::string attribute{};
+  bool once{false};
   void encode(ProtoWriteBuffer buffer) const override;
 #ifdef HAS_PROTO_MESSAGE_DUMP
   void dump_to(std::string &out) const override;
@@ -838,6 +844,7 @@ class SubscribeHomeAssistantStateResponse : public ProtoMessage {
 
  protected:
   bool decode_length(uint32_t field_id, ProtoLengthDelimited value) override;
+  bool decode_varint(uint32_t field_id, ProtoVarInt value) override;
 };
 class HomeAssistantStateResponse : public ProtoMessage {
  public:
@@ -2175,7 +2182,7 @@ class UpdateStateResponse : public ProtoMessage {
 class UpdateCommandRequest : public ProtoMessage {
  public:
   uint32_t key{0};
-  bool install{false};
+  enums::UpdateCommand command{};
   void encode(ProtoWriteBuffer buffer) const override;
 #ifdef HAS_PROTO_MESSAGE_DUMP
   void dump_to(std::string &out) const override;

esphome/components/api/api_server.cpp

@@ -359,8 +359,18 @@ void APIServer::subscribe_home_assistant_state(std::string entity_id, optional<s
       .entity_id = std::move(entity_id),
       .attribute = std::move(attribute),
       .callback = std::move(f),
+      .once = false,
   });
 }
+void APIServer::get_home_assistant_state(std::string entity_id, optional<std::string> attribute,
+                                         std::function<void(std::string)> f) {
+  this->state_subs_.push_back(HomeAssistantStateSubscription{
+      .entity_id = std::move(entity_id),
+      .attribute = std::move(attribute),
+      .callback = std::move(f),
+      .once = true,
+  });
+};
 const std::vector<APIServer::HomeAssistantStateSubscription> &APIServer::get_state_subs() const {
   return this->state_subs_;
 }

esphome/components/api/api_server.h

@@ -112,10 +112,13 @@ class APIServer : public Component, public Controller {
     std::string entity_id;
     optional<std::string> attribute;
     std::function<void(std::string)> callback;
+    bool once;
   };
 
   void subscribe_home_assistant_state(std::string entity_id, optional<std::string> attribute,
                                       std::function<void(std::string)> f);
+  void get_home_assistant_state(std::string entity_id, optional<std::string> attribute,
+                                std::function<void(std::string)> f);
   const std::vector<HomeAssistantStateSubscription> &get_state_subs() const;
   const std::vector<UserServiceDescriptor *> &get_user_services() const { return this->user_services_; }