Merge 88a8191545 into 0257210087

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.github/workflows/ci.yml

@@ -89,7 +89,7 @@ jobs:
       - run: pytest -vv --cov=aioesphomeapi --cov-report=xml --tb=native tests
         name: Run tests with pytest
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
       - run: |
           docker run \
             -v "$PWD":/aioesphomeapi \

aioesphomeapi/api.proto

@@ -44,9 +44,11 @@ service APIConnection {
   rpc siren_command (SirenCommandRequest) returns (void) {}
   rpc button_command (ButtonCommandRequest) returns (void) {}
   rpc lock_command (LockCommandRequest) returns (void) {}
+  rpc valve_command (ValveCommandRequest) returns (void) {}
   rpc media_player_command (MediaPlayerCommandRequest) returns (void) {}
   rpc date_command (DateCommandRequest) returns (void) {}
   rpc time_command (TimeCommandRequest) returns (void) {}
+  rpc datetime_command (DateTimeCommandRequest) returns (void) {}
 
   rpc subscribe_bluetooth_le_advertisements (SubscribeBluetoothLEAdvertisementsRequest) returns (void) {}
   rpc bluetooth_device_request(BluetoothDeviceRequest) returns (void) {}
@@ -1718,3 +1720,89 @@ message TimeCommandRequest {
   uint32 minute = 3;
   uint32 second = 4;
 }
+
+// ==================== VALVE ====================
+message ListEntitiesValveResponse {
+  option (id) = 109;
+  option (source) = SOURCE_SERVER;
+  option (ifdef) = "USE_VALVE";
+
+  string object_id = 1;
+  fixed32 key = 2;
+  string name = 3;
+  string unique_id = 4;
+
+  string icon = 5;
+  bool disabled_by_default = 6;
+  EntityCategory entity_category = 7;
+  string device_class = 8;
+
+  bool assumed_state = 9;
+  bool supports_position = 10;
+  bool supports_stop = 11;
+}
+
+enum ValveOperation {
+  VALVE_OPERATION_IDLE = 0;
+  VALVE_OPERATION_IS_OPENING = 1;
+  VALVE_OPERATION_IS_CLOSING = 2;
+}
+message ValveStateResponse {
+  option (id) = 110;
+  option (source) = SOURCE_SERVER;
+  option (ifdef) = "USE_VALVE";
+  option (no_delay) = true;
+
+  fixed32 key = 1;
+  float position = 2;
+  ValveOperation current_operation = 3;
+}
+
+message ValveCommandRequest {
+  option (id) = 111;
+  option (source) = SOURCE_CLIENT;
+  option (ifdef) = "USE_VALVE";
+  option (no_delay) = true;
+
+  fixed32 key = 1;
+  bool has_position = 2;
+  float position = 3;
+  bool stop = 4;
+}
+
+// ==================== DATETIME DATETIME ====================
+message ListEntitiesDateTimeResponse {
+  option (id) = 112;
+  option (source) = SOURCE_SERVER;
+  option (ifdef) = "USE_DATETIME_DATETIME";
+
+  string object_id = 1;
+  fixed32 key = 2;
+  string name = 3;
+  string unique_id = 4;
+
+  string icon = 5;
+  bool disabled_by_default = 6;
+  EntityCategory entity_category = 7;
+}
+message DateTimeStateResponse {
+  option (id) = 113;
+  option (source) = SOURCE_SERVER;
+  option (ifdef) = "USE_DATETIME_DATETIME";
+  option (no_delay) = true;
+
+  fixed32 key = 1;
+  // If the datetime does not have a valid state yet.
+  // Equivalent to `!obj->has_state()` - inverse logic to make state packets smaller
+  bool missing_state = 2;
+  fixed32 epoch_seconds = 3;
+}
+message DateTimeCommandRequest {
+  option (id) = 114;
+  option (source) = SOURCE_CLIENT;
+  option (ifdef) = "USE_DATETIME_DATETIME";
+  option (no_delay) = true;
+
+  fixed32 key = 1;
+  fixed32 epoch_seconds = 2;
+}

aioesphomeapi/client.py

@@ -38,6 +38,7 @@ from .api_pb2 import (  # type: ignore
     ClimateCommandRequest,
     CoverCommandRequest,
     DateCommandRequest,
+    DateTimeCommandRequest,
     DeviceInfoRequest,
     DeviceInfoResponse,
     ExecuteServiceArgument,
@@ -67,6 +68,7 @@ from .api_pb2 import (  # type: ignore
     TextCommandRequest,
     TimeCommandRequest,
     UnsubscribeBluetoothLEAdvertisementsRequest,
+    ValveCommandRequest,
     VoiceAssistantAudio,
     VoiceAssistantEventData,
     VoiceAssistantEventResponse,
@@ -1117,6 +1119,18 @@ class APIClient:
             TimeCommandRequest(key=key, hour=hour, minute=minute, second=second)
         )
 
+    def datetime_command(
+        self,
+        key: int,
+        epoch_seconds: int,
+    ) -> None:
+        self._get_connection().send_message(
+            DateTimeCommandRequest(
+                key=key,
+                epoch_seconds=epoch_seconds,
+            )
+        )
+
     def select_command(self, key: int, state: str) -> None:
         self._get_connection().send_message(SelectCommandRequest(key=key, state=state))
 
@@ -1157,6 +1171,20 @@ class APIClient:
             req.code = code
         self._get_connection().send_message(req)
 
+    def valve_command(
+        self,
+        key: int,
+        position: float | None = None,
+        stop: bool = False,
+    ) -> None:
+        req = ValveCommandRequest(key=key)
+        if position is not None:
+            req.has_position = True
+            req.position = position
+        if stop:
+            req.stop = stop
+        self._get_connection().send_message(req)
+
     def media_player_command(
         self,
         key: int,

aioesphomeapi/core.py

@@ -40,6 +40,8 @@ from .api_pb2 import (  # type: ignore
     CoverStateResponse,
     DateCommandRequest,
     DateStateResponse,
+    DateTimeCommandRequest,
+    DateTimeStateResponse,
     DeviceInfoRequest,
     DeviceInfoResponse,
     DisconnectRequest,
@@ -62,6 +64,7 @@ from .api_pb2 import (  # type: ignore
     ListEntitiesClimateResponse,
     ListEntitiesCoverResponse,
     ListEntitiesDateResponse,
+    ListEntitiesDateTimeResponse,
     ListEntitiesDoneResponse,
     ListEntitiesFanResponse,
     ListEntitiesLightResponse,
@@ -77,6 +80,7 @@ from .api_pb2 import (  # type: ignore
     ListEntitiesTextResponse,
     ListEntitiesTextSensorResponse,
     ListEntitiesTimeResponse,
+    ListEntitiesValveResponse,
     LockCommandRequest,
     LockStateResponse,
     MediaPlayerCommandRequest,
@@ -107,6 +111,8 @@ from .api_pb2 import (  # type: ignore
     TimeCommandRequest,
     TimeStateResponse,
     UnsubscribeBluetoothLEAdvertisementsRequest,
+    ValveCommandRequest,
+    ValveStateResponse,
     VoiceAssistantAudio,
     VoiceAssistantEventResponse,
     VoiceAssistantRequest,
@@ -368,4 +374,10 @@ MESSAGE_TYPE_TO_PROTO = {
     104: TimeStateResponse,
     105: TimeCommandRequest,
     106: VoiceAssistantAudio,
+    109: ListEntitiesValveResponse,
+    110: ValveStateResponse,
+    111: ValveCommandRequest,
+    112: ListEntitiesDateTimeResponse,
+    113: DateTimeStateResponse,
+    114: DateTimeCommandRequest,
 }

aioesphomeapi/model.py

@@ -690,6 +690,18 @@ class TimeState(EntityState):
     second: int = 0
 
 
+# ==================== DATETIME DATETIME ====================
+@_frozen_dataclass_decorator
+class DateTimeInfo(EntityInfo):
+    pass
+
+
+@_frozen_dataclass_decorator
+class DateTimeState(EntityState):
+    missing_state: bool = False
+    epoch_seconds: int = 0
+
+
 # ==================== SELECT ====================
 @_frozen_dataclass_decorator
 class SelectInfo(EntityInfo):
@@ -753,6 +765,31 @@ class LockEntityState(EntityState):
     )
 
 
+# ==================== VALVE ====================
+@_frozen_dataclass_decorator
+class ValveInfo(EntityInfo):
+    device_class: str = ""
+    assumed_state: bool = False
+    supports_stop: bool = False
+    supports_position: bool = False
+
+
+class ValveOperation(APIIntEnum):
+    IDLE = 0
+    IS_OPENING = 1
+    IS_CLOSING = 2
+
+
+@_frozen_dataclass_decorator
+class ValveState(EntityState):
+    position: float = converter_field(
+        default=0.0, converter=fix_float_single_double_conversion
+    )
+    current_operation: ValveOperation | None = converter_field(
+        default=ValveOperation.IDLE, converter=ValveOperation.convert
+    )
+
+
 # ==================== MEDIA PLAYER ====================
 class MediaPlayerState(APIIntEnum):
     NONE = 0
@@ -860,6 +897,7 @@ COMPONENT_TYPE_TO_INFO: dict[str, type[EntityInfo]] = {
     "climate": ClimateInfo,
     "number": NumberInfo,
     "date": DateInfo,
+    "datetime": DateTimeInfo,
     "select": SelectInfo,
     "siren": SirenInfo,
     "button": ButtonInfo,
@@ -868,6 +906,7 @@ COMPONENT_TYPE_TO_INFO: dict[str, type[EntityInfo]] = {
     "alarm_control_panel": AlarmControlPanelInfo,
     "text": TextInfo,
     "time": TimeInfo,
+    "valve": ValveInfo,
 }
 
 
@@ -1216,6 +1255,7 @@ _TYPE_TO_NAME = {
     LightInfo: "light",
     NumberInfo: "number",
     DateInfo: "date",
+    DateTimeInfo: "datetime",
     SelectInfo: "select",
     SensorInfo: "sensor",
     SirenInfo: "siren",
@@ -1228,6 +1268,7 @@ _TYPE_TO_NAME = {
     AlarmControlPanelInfo: "alarm_control_panel",
     TextInfo: "text_info",
     TimeInfo: "time",
+    ValveInfo: "valve",
 }
 
 

aioesphomeapi/model_conversions.py

@@ -8,6 +8,7 @@ from .api_pb2 import (  # type: ignore
     ClimateStateResponse,
     CoverStateResponse,
     DateStateResponse,
+    DateTimeStateResponse,
     FanStateResponse,
     LightStateResponse,
     ListEntitiesAlarmControlPanelResponse,
@@ -17,6 +18,7 @@ from .api_pb2 import (  # type: ignore
     ListEntitiesClimateResponse,
     ListEntitiesCoverResponse,
     ListEntitiesDateResponse,
+    ListEntitiesDateTimeResponse,
     ListEntitiesFanResponse,
     ListEntitiesLightResponse,
     ListEntitiesLockResponse,
@@ -30,6 +32,7 @@ from .api_pb2 import (  # type: ignore
     ListEntitiesTextResponse,
     ListEntitiesTextSensorResponse,
     ListEntitiesTimeResponse,
+    ListEntitiesValveResponse,
     LockStateResponse,
     MediaPlayerStateResponse,
     NumberStateResponse,
@@ -40,6 +43,7 @@ from .api_pb2 import (  # type: ignore
     TextSensorStateResponse,
     TextStateResponse,
     TimeStateResponse,
+    ValveStateResponse,
 )
 from .model import (
     AlarmControlPanelEntityState,
@@ -54,6 +58,8 @@ from .model import (
     CoverState,
     DateInfo,
     DateState,
+    DateTimeInfo,
+    DateTimeState,
     EntityInfo,
     EntityState,
     FanInfo,
@@ -80,6 +86,8 @@ from .model import (
     TextState,
     TimeInfo,
     TimeState,
+    ValveInfo,
+    ValveState,
 )
 
 SUBSCRIBE_STATES_RESPONSE_TYPES: dict[Any, type[EntityState]] = {
@@ -89,6 +97,7 @@ SUBSCRIBE_STATES_RESPONSE_TYPES: dict[Any, type[EntityState]] = {
     LightStateResponse: LightState,
     NumberStateResponse: NumberState,
     DateStateResponse: DateState,
+    DateTimeStateResponse: DateTimeState,
     SelectStateResponse: SelectState,
     SensorStateResponse: SensorState,
     SirenStateResponse: SirenState,
@@ -100,6 +109,7 @@ SUBSCRIBE_STATES_RESPONSE_TYPES: dict[Any, type[EntityState]] = {
     MediaPlayerStateResponse: MediaPlayerEntityState,
     AlarmControlPanelStateResponse: AlarmControlPanelEntityState,
     TimeStateResponse: TimeState,
+    ValveStateResponse: ValveState,
 }
 
 LIST_ENTITIES_SERVICES_RESPONSE_TYPES: dict[Any, type[EntityInfo] | None] = {
@@ -110,6 +120,7 @@ LIST_ENTITIES_SERVICES_RESPONSE_TYPES: dict[Any, type[EntityInfo] | None] = {
     ListEntitiesLightResponse: LightInfo,
     ListEntitiesNumberResponse: NumberInfo,
     ListEntitiesDateResponse: DateInfo,
+    ListEntitiesDateTimeResponse: DateTimeInfo,
     ListEntitiesSelectResponse: SelectInfo,
     ListEntitiesSensorResponse: SensorInfo,
     ListEntitiesSirenResponse: SirenInfo,
@@ -123,4 +134,5 @@ LIST_ENTITIES_SERVICES_RESPONSE_TYPES: dict[Any, type[EntityInfo] | None] = {
     ListEntitiesMediaPlayerResponse: MediaPlayerInfo,
     ListEntitiesAlarmControlPanelResponse: AlarmControlPanelInfo,
     ListEntitiesTimeResponse: TimeInfo,
+    ListEntitiesValveResponse: ValveInfo,
 }

aioesphomeapi/reconnect_logic.py

@@ -413,16 +413,11 @@ class ReconnectLogic(zeroconf.RecordUpdateListener):
                 self._cli.log_name,
                 record_update.new,
             )
-            # We can't stop the zeroconf listener here because we are in the middle of
-            # a zeroconf callback which is iterating the listeners.
-            #
-            # So we schedule a stop for the next event loop iteration as well as the
-            # connect attempt.
             #
             # If we scheduled the connect attempt immediately, the listener could fire
             # again before the connect attempt and we cancel and reschedule the connect
             # attempt again.
             #
-            self.loop.call_soon(self._connect_from_zeroconf)
+            self._connect_from_zeroconf()
             self._accept_zeroconf_records = False
             return

requirements.txt

@@ -1,7 +1,7 @@
 aiohappyeyeballs>=2.3.0
 async-interrupt>=1.1.1
 protobuf>=3.19.0
-zeroconf>=0.128.4,<1.0
+zeroconf>=0.132.2,<1.0
 chacha20poly1305-reuseable>=0.12.1
 cryptography>=42.0.2
 noiseprotocol>=0.3.1,<1.0

requirements_test.txt

@@ -3,7 +3,7 @@ black==24.4.0
 flake8==7.0.0
 isort==5.13.2
 mypy==1.9.0
-types-protobuf==4.25.0.20240410
+types-protobuf==4.25.0.20240417
 pytest>=6.2.4,<9
 pytest-asyncio==0.23.6
 mock>=4.0.3,<6

setup.py

@@ -11,7 +11,7 @@ with open(os.path.join(here, "README.rst"), encoding="utf-8") as readme_file:
     long_description = readme_file.read()
 
 
-VERSION = "24.0.1"
+VERSION = "24.2.0"
 PROJECT_NAME = "aioesphomeapi"
 PROJECT_PACKAGE_NAME = "aioesphomeapi"
 PROJECT_LICENSE = "MIT"

tests/test_client.py

@@ -42,6 +42,7 @@ from aioesphomeapi.api_pb2 import (
     ClimateCommandRequest,
     CoverCommandRequest,
     DateCommandRequest,
+    DateTimeCommandRequest,
     DeviceInfoResponse,
     DisconnectResponse,
     ExecuteServiceArgument,
@@ -64,6 +65,7 @@ from aioesphomeapi.api_pb2 import (
     SwitchCommandRequest,
     TextCommandRequest,
     TimeCommandRequest,
+    ValveCommandRequest,
     VoiceAssistantAudio,
     VoiceAssistantAudioSettings,
     VoiceAssistantEventData,
@@ -667,6 +669,30 @@ async def test_time_command(
     send.assert_called_once_with(TimeCommandRequest(**req))
 
 
+# Test date_time command
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "cmd, req",
+    [
+        (
+            dict(key=1, epoch_seconds=1735648230),
+            dict(key=1, epoch_seconds=1735648230),
+        ),
+        (
+            dict(key=1, epoch_seconds=1735689600),
+            dict(key=1, epoch_seconds=1735689600),
+        ),
+    ],
+)
+async def test_datetime_command(
+    auth_client: APIClient, cmd: dict[str, Any], req: dict[str, Any]
+) -> None:
+    send = patch_send(auth_client)
+
+    auth_client.datetime_command(**cmd)
+    send.assert_called_once_with(DateTimeCommandRequest(**req))
+
+
 @pytest.mark.asyncio
 @pytest.mark.parametrize(
     "cmd, req",
@@ -692,6 +718,49 @@ async def test_lock_command(
     send.assert_called_once_with(LockCommandRequest(**req))
 
 
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "cmd, req",
+    [
+        (dict(key=1), dict(key=1)),
+        (dict(key=1, position=1.0),),
+        (dict(key=1, position=0.0),),
+        (dict(key=1, stop=True),),
+    ],
+)
+async def test_valve_command(
+    auth_client: APIClient, cmd: dict[str, Any], req: dict[str, Any]
+) -> None:
+    send = patch_send(auth_client)
+
+    auth_client.valve_command(**cmd)
+    send.assert_called_once_with(ValveCommandRequest(**req))
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "cmd, req",
+    [
+        (dict(key=1), dict(key=1)),
+        (dict(key=1, position=0.5), dict(key=1, has_position=True, position=0.5)),
+        (dict(key=1, position=0.0), dict(key=1, has_position=True, position=0.0)),
+        (dict(key=1, stop=True), dict(key=1, stop=True)),
+        (
+            dict(key=1, position=1.0),
+            dict(key=1, has_position=True, position=1.0),
+        ),
+    ],
+)
+async def test_valve_command(
+    auth_client: APIClient, cmd: dict[str, Any], req: dict[str, Any]
+) -> None:
+    send = patch_send(auth_client)
+    patch_api_version(auth_client, APIVersion(1, 1))
+
+    auth_client.valve_command(**cmd)
+    send.assert_called_once_with(ValveCommandRequest(**req))
+
+
 @pytest.mark.asyncio
 @pytest.mark.parametrize(
     "cmd, req",
@@ -2443,6 +2512,7 @@ async def test_calls_after_connection_closed(
         client.cover_command,
         client.fan_command,
         client.light_command,
+        client.valve_command,
         client.media_player_command,
         client.siren_command,
     ):

tests/test_model.py

@@ -14,6 +14,7 @@ from aioesphomeapi.api_pb2 import (
     ClimateStateResponse,
     CoverStateResponse,
     DateStateResponse,
+    DateTimeStateResponse,
     DeviceInfoResponse,
     FanStateResponse,
     HomeassistantServiceMap,
@@ -25,6 +26,7 @@ from aioesphomeapi.api_pb2 import (
     ListEntitiesClimateResponse,
     ListEntitiesCoverResponse,
     ListEntitiesDateResponse,
+    ListEntitiesDateTimeResponse,
     ListEntitiesFanResponse,
     ListEntitiesLightResponse,
     ListEntitiesLockResponse,
@@ -37,6 +39,7 @@ from aioesphomeapi.api_pb2 import (
     ListEntitiesSwitchResponse,
     ListEntitiesTextSensorResponse,
     ListEntitiesTimeResponse,
+    ListEntitiesValveResponse,
     LockStateResponse,
     MediaPlayerStateResponse,
     NumberStateResponse,
@@ -47,6 +50,7 @@ from aioesphomeapi.api_pb2 import (
     TextSensorStateResponse,
     TextStateResponse,
     TimeStateResponse,
+    ValveStateResponse,
 )
 from aioesphomeapi.model import (
     _TYPE_TO_NAME,
@@ -75,6 +79,8 @@ from aioesphomeapi.model import (
     CoverState,
     DateInfo,
     DateState,
+    DateTimeInfo,
+    DateTimeState,
     DeviceInfo,
     FanInfo,
     FanState,
@@ -105,6 +111,8 @@ from aioesphomeapi.model import (
     UserService,
     UserServiceArg,
     UserServiceArgType,
+    ValveInfo,
+    ValveState,
     VoiceAssistantFeature,
     build_unique_id,
     converter_field,
@@ -261,6 +269,8 @@ def test_api_version_ord():
         (ButtonInfo, ListEntitiesButtonResponse),
         (LockInfo, ListEntitiesLockResponse),
         (LockEntityState, LockStateResponse),
+        (ValveInfo, ListEntitiesValveResponse),
+        (ValveState, ValveStateResponse),
         (MediaPlayerInfo, ListEntitiesMediaPlayerResponse),
         (MediaPlayerEntityState, MediaPlayerStateResponse),
         (AlarmControlPanelInfo, ListEntitiesAlarmControlPanelResponse),
@@ -268,6 +278,8 @@ def test_api_version_ord():
         (TextState, TextStateResponse),
         (TimeInfo, ListEntitiesTimeResponse),
         (TimeState, TimeStateResponse),
+        (DateTimeInfo, ListEntitiesDateTimeResponse),
+        (DateTimeState, DateTimeStateResponse),
     ],
 )
 def test_basic_pb_conversions(model, pb):
@@ -380,6 +392,7 @@ def test_user_service_conversion():
         CameraInfo,
         ClimateInfo,
         LockInfo,
+        ValveInfo,
         MediaPlayerInfo,
         AlarmControlPanelInfo,
         TextInfo,

tests/test_reconnect_logic.py

@@ -441,8 +441,6 @@ async def test_reconnect_zeroconf(
             "Triggering connect because of received mDNS record" in caplog.text
         ) is should_trigger_zeroconf
         assert rl._accept_zeroconf_records is not should_trigger_zeroconf
-        assert rl._zc_listening is True  # should change after one iteration of the loop
-        await asyncio.sleep(0)
         assert rl._zc_listening is not should_trigger_zeroconf
 
         # The reconnect is scheduled to run in the next loop iteration