Make module names consistent and remove redundant module casting (#909)

Address the inconsistent naming of smart modules by removing all "Module" suffixes and aligning filenames with class names. Removes the casting of modules to the correct module type now that is is redundant. Update the adding of iot modules to use the ModuleName class rather than a free string.
This commit is contained in:
Steven B
2024-05-11 19:28:18 +01:00
committed by GitHub
parent 9473d97ad2
commit f259a8f162
34 changed files with 162 additions and 171 deletions

View File

@@ -0,0 +1,66 @@
"""Implementation of waterleak module."""
from __future__ import annotations
from enum import Enum
from typing import TYPE_CHECKING
from ...feature import Feature
from ..smartmodule import SmartModule
if TYPE_CHECKING:
from ..smartdevice import SmartDevice
class WaterleakStatus(Enum):
"""Waterleawk status."""
Normal = "normal"
LeakDetected = "water_leak"
Drying = "water_dry"
class WaterleakSensor(SmartModule):
"""Implementation of waterleak module."""
REQUIRED_COMPONENT = "sensor_alarm"
def __init__(self, device: SmartDevice, module: str):
super().__init__(device, module)
self._add_feature(
Feature(
device,
id="water_leak",
name="Water leak",
container=self,
attribute_getter="status",
icon="mdi:water",
category=Feature.Category.Debug,
)
)
self._add_feature(
Feature(
device,
id="water_alert",
name="Water alert",
container=self,
attribute_getter="alert",
icon="mdi:water-alert",
category=Feature.Category.Primary,
)
)
def query(self) -> dict:
"""Query to execute during the update cycle."""
# Water leak information is contained in the main device info response.
return {}
@property
def status(self) -> WaterleakStatus:
"""Return current humidity in percentage."""
return WaterleakStatus(self._device.sys_info["water_leak_status"])
@property
def alert(self) -> bool:
"""Return true if alarm is active."""
return self._device.sys_info["in_alarm"]