jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-27 15:17:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Correct / tidy up entity doc strings for evohome (#126380)

Browse Source 
* correct / tidy up entity doc strings

* tweak
This commit is contained in:
David Bonnes 2024-09-21 15:44:35 +01:00 committed by GitHub
parent 5b22cfa9b3
commit 24106114b4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
homeassistant/components/evohome/climate.py
View File

@ -148,7 +148,7 @@ async def async_setup_platform(
class EvoClimateEntity(EvoDevice, ClimateEntity):
"""Base for an evohome Climate device."""
"""Base for any evohome-compatible climate entity (controller, zone)."""
_attr_temperature_unit = UnitOfTemperature.CELSIUS
_enable_turn_on_off_backwards_compatibility = False
@ -160,14 +160,14 @@ class EvoClimateEntity(EvoDevice, ClimateEntity):
class EvoZone(EvoChild, EvoClimateEntity):
"""Base for a Honeywell TCC Zone."""
"""Base for any evohome-compatible heating zone."""
_attr_preset_modes = list(HA_PRESET_TO_EVO)
_evo_device: evo.Zone # mypy hint
def __init__(self, evo_broker: EvoBroker, evo_device: evo.Zone) -> None:
"""Initialize a Honeywell TCC Zone."""
"""Initialize an evohome-compatible heating zone."""
super().__init__(evo_broker, evo_device)
self._evo_id = evo_device.zoneId
@ -342,7 +342,7 @@ class EvoZone(EvoChild, EvoClimateEntity):
class EvoController(EvoClimateEntity):
"""Base for a Honeywell TCC Controller/Location.
"""Base for any evohome-compatible controller.
The Controller (aka TCS, temperature control system) is the parent of all the child
(CH/DHW) devices. It is implemented as a Climate entity to expose the controller's
@ -357,7 +357,7 @@ class EvoController(EvoClimateEntity):
_evo_device: evo.ControlSystem # mypy hint
def __init__(self, evo_broker: EvoBroker, evo_device: evo.ControlSystem) -> None:
"""Initialize a Honeywell TCC Controller/Location."""
"""Initialize an evohome-compatible controller."""
super().__init__(evo_broker, evo_device)
self._evo_id = evo_device.systemId

12
homeassistant/components/evohome/entity.py
View File

@ -26,9 +26,9 @@ _LOGGER = logging.getLogger(__name__)
class EvoDevice(Entity):
"""Base for any evohome device.
"""Base for any evohome-compatible entity (controller, DHW, zone).
This includes the Controller, (up to 12) Heating Zones and (optionally) a
This includes the controller, (1 to 12) heating zones and (optionally) a
DHW controller.
"""
@ -39,7 +39,7 @@ class EvoDevice(Entity):
evo_broker: EvoBroker,
evo_device: evo.ControlSystem | evo.HotWater | evo.Zone,
) -> None:
"""Initialize the evohome entity."""
"""Initialize an evohome-compatible entity (TCS, DHW, zone)."""
self._evo_device = evo_device
self._evo_broker = evo_broker
self._evo_tcs = evo_broker.tcs
@ -88,9 +88,9 @@ class EvoDevice(Entity):
class EvoChild(EvoDevice):
"""Base for any evohome child.
"""Base for any evohome-compatible child entity (DHW, zone).
This includes (up to 12) Heating Zones and (optionally) a DHW controller.
This includes (1 to 12) heating zones and (optionally) a DHW controller.
"""
_evo_id: str # mypy hint
@ -98,7 +98,7 @@ class EvoChild(EvoDevice):
def __init__(
self, evo_broker: EvoBroker, evo_device: evo.HotWater | evo.Zone
) -> None:
"""Initialize a evohome Controller (hub)."""
"""Initialize an evohome-compatible child entity (DHW, zone)."""
super().__init__(evo_broker, evo_device)
self._schedule: dict[str, Any] = {}

4
homeassistant/components/evohome/water_heater.py
View File

@ -74,7 +74,7 @@ async def async_setup_platform(
class EvoDHW(EvoChild, WaterHeaterEntity):
"""Base for a Honeywell TCC DHW controller (aka boiler)."""
"""Base for any evohome-compatible DHW controller."""
_attr_name = "DHW controller"
_attr_icon = "mdi:thermometer-lines"
@ -84,7 +84,7 @@ class EvoDHW(EvoChild, WaterHeaterEntity):
_evo_device: evo.HotWater # mypy hint
def __init__(self, evo_broker: EvoBroker, evo_device: evo.HotWater) -> None:
"""Initialize an evohome DHW controller."""
"""Initialize an evohome-compatible DHW controller."""
super().__init__(evo_broker, evo_device)
self._evo_id = evo_device.dhwId