google_nest_sdm.device_traits

 1"""Library for traits about devices."""
 2
 3import datetime
 4from typing import Any, Dict, ClassVar
 5from dataclasses import dataclass, field
 6
 7import aiohttp
 8from mashumaro import field_options, DataClassDictMixin
 9
10from .traits import CommandDataClass, TraitType
11
12
13@dataclass
14class ConnectivityTrait(DataClassDictMixin):
15    """This trait belongs to any device that has connectivity information."""
16
17    NAME: ClassVar[TraitType] = TraitType.CONNECTIVITY
18
19    status: str
20    """Device connectivity status.
21
22    Return:
23        "OFFLINE", "ONLINE"
24    """
25
26
27@dataclass
28class FanTrait(DataClassDictMixin, CommandDataClass):
29    """This trait belongs to any device that can control the fan."""
30
31    NAME: ClassVar[TraitType] = TraitType.FAN
32
33    timer_mode: str | None = field(
34        metadata=field_options(alias="timerMode"), default=None
35    )
36    """Timer mode for the fan.
37
38    Return:
39        "ON", "OFF"
40    """
41
42    timer_timeout: datetime.datetime | None = field(
43        metadata=field_options(alias="timerTimeout"), default=None
44    )
45
46    async def set_timer(
47        self, timer_mode: str, duration: int | None = None
48    ) -> aiohttp.ClientResponse:
49        """Change the fan timer."""
50        data: Dict[str, Any] = {
51            "command": "sdm.devices.commands.Fan.SetTimer",
52            "params": {
53                "timerMode": timer_mode,
54            },
55        }
56        if duration:
57            data["params"]["duration"] = f"{duration}s"
58        return await self.cmd.execute(data)
59
60
61@dataclass
62class InfoTrait(DataClassDictMixin):
63    """This trait belongs to any device for device-related information."""
64
65    NAME: ClassVar[TraitType] = TraitType.INFO
66
67    custom_name: str | None = field(
68        metadata=field_options(alias="customName"), default=None
69    )
70    """Name of the device."""
71
72
73@dataclass
74class HumidityTrait(DataClassDictMixin):
75    """This trait belongs to any device that has a sensor to measure humidity."""
76
77    NAME: ClassVar[TraitType] = TraitType.HUMIDITY
78
79    ambient_humidity_percent: float = field(
80        metadata=field_options(alias="ambientHumidityPercent")
81    )
82    """Percent humidity, measured at the device."""
83
84
85@dataclass
86class TemperatureTrait(DataClassDictMixin):
87    """This trait belongs to any device that has a sensor to measure temperature."""
88
89    NAME: ClassVar[TraitType] = TraitType.TEMPERATURE
90
91    ambient_temperature_celsius: float = field(
92        metadata=field_options(alias="ambientTemperatureCelsius")
93    )
94    """Percent humidity, measured at the device."""