Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sensor platform to eq3btsmart #130438

Merged
merged 1 commit into from
Nov 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions homeassistant/components/eq3btsmart/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
Platform.BINARY_SENSOR,
Platform.CLIMATE,
Platform.NUMBER,
Platform.SENSOR,
Platform.SWITCH,
]

Expand Down
2 changes: 2 additions & 0 deletions homeassistant/components/eq3btsmart/const.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
ENTITY_KEY_OFFSET = "offset"
ENTITY_KEY_WINDOW_OPEN_TEMPERATURE = "window_open_temperature"
ENTITY_KEY_WINDOW_OPEN_TIMEOUT = "window_open_timeout"
ENTITY_KEY_VALVE = "valve"
ENTITY_KEY_AWAY_UNTIL = "away_until"

GET_DEVICE_TIMEOUT = 5 # seconds

Expand Down
10 changes: 9 additions & 1 deletion homeassistant/components/eq3btsmart/icons.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,19 @@
"default": "mdi:timer-refresh"
}
},
"sensor": {
"away_until": {
"default": "mdi:home-export-outline"
},
"valve": {
"default": "mdi:pipe-valve"
}
},
"switch": {
"away": {
"default": "mdi:home-account",
"state": {
"on": "mdi:home-export"
"on": "mdi:home-export-outline"
}
},
"lock": {
Expand Down
84 changes: 84 additions & 0 deletions homeassistant/components/eq3btsmart/sensor.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
"""Platform for eq3 sensor entities."""

from collections.abc import Callable
from dataclasses import dataclass
from datetime import datetime
from typing import TYPE_CHECKING

from eq3btsmart.models import Status

from homeassistant.components.sensor import (
SensorDeviceClass,
SensorEntity,
SensorEntityDescription,
)
from homeassistant.components.sensor.const import SensorStateClass
from homeassistant.const import PERCENTAGE
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback

from . import Eq3ConfigEntry
from .const import ENTITY_KEY_AWAY_UNTIL, ENTITY_KEY_VALVE
from .entity import Eq3Entity


@dataclass(frozen=True, kw_only=True)
class Eq3SensorEntityDescription(SensorEntityDescription):
"""Entity description for eq3 sensor entities."""

value_func: Callable[[Status], int | datetime | None]


SENSOR_ENTITY_DESCRIPTIONS = [
Eq3SensorEntityDescription(
key=ENTITY_KEY_VALVE,
translation_key=ENTITY_KEY_VALVE,
value_func=lambda status: status.valve,
native_unit_of_measurement=PERCENTAGE,
state_class=SensorStateClass.MEASUREMENT,
),
Eq3SensorEntityDescription(
key=ENTITY_KEY_AWAY_UNTIL,
translation_key=ENTITY_KEY_AWAY_UNTIL,
value_func=lambda status: (
status.away_until.value if status.away_until else None
),
device_class=SensorDeviceClass.DATE,
),
]


async def async_setup_entry(
hass: HomeAssistant,
entry: Eq3ConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up the entry."""

async_add_entities(
Eq3SensorEntity(entry, entity_description)
for entity_description in SENSOR_ENTITY_DESCRIPTIONS
)


class Eq3SensorEntity(Eq3Entity, SensorEntity):
"""Base class for eq3 sensor entities."""

entity_description: Eq3SensorEntityDescription

def __init__(
self, entry: Eq3ConfigEntry, entity_description: Eq3SensorEntityDescription
) -> None:
"""Initialize the entity."""

super().__init__(entry, entity_description.key)
self.entity_description = entity_description

@property
def native_value(self) -> int | datetime | None:
"""Return the value reported by the sensor."""

if TYPE_CHECKING:
assert self._thermostat.status is not None

return self.entity_description.value_func(self._thermostat.status)
8 changes: 8 additions & 0 deletions homeassistant/components/eq3btsmart/strings.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,14 @@
"name": "Window open timeout"
}
},
"sensor": {
"away_until": {
"name": "Away until"
},
"valve": {
"name": "Valve"
}
},
"switch": {
"lock": {
"name": "Lock"
Expand Down
Loading