ESPHome: Add datetime entities
This commit is contained in:
parent
e7076ac83f
commit
b2f880163e
|
@ -0,0 +1,65 @@
|
|||
"""Support for esphome datetimes."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from datetime import datetime
|
||||
|
||||
from aioesphomeapi import DateTimeInfo, DateTimeState
|
||||
|
||||
from homeassistant.components.datetime import DateTimeEntity
|
||||
from homeassistant.config_entries import ConfigEntry
|
||||
from homeassistant.core import HomeAssistant
|
||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||
import homeassistant.util.dt as dt_util
|
||||
|
||||
from .entity import EsphomeEntity, esphome_state_property, platform_async_setup_entry
|
||||
|
||||
|
||||
async def async_setup_entry(
|
||||
hass: HomeAssistant,
|
||||
entry: ConfigEntry,
|
||||
async_add_entities: AddEntitiesCallback,
|
||||
) -> None:
|
||||
"""Set up esphome datetimes based on a config entry."""
|
||||
await platform_async_setup_entry(
|
||||
hass,
|
||||
entry,
|
||||
async_add_entities,
|
||||
info_type=DateTimeInfo,
|
||||
entity_type=EsphomeDateTime,
|
||||
state_type=DateTimeState,
|
||||
)
|
||||
|
||||
|
||||
class EsphomeDateTime(EsphomeEntity[DateTimeInfo, DateTimeState], DateTimeEntity):
|
||||
"""A datetime implementation for esphome."""
|
||||
|
||||
@property
|
||||
@esphome_state_property
|
||||
def native_value(self) -> datetime | None:
|
||||
"""Return the state of the entity."""
|
||||
state = self._state
|
||||
if state.missing_state:
|
||||
return None
|
||||
return datetime(
|
||||
state.year,
|
||||
state.month,
|
||||
state.day,
|
||||
state.hour,
|
||||
state.minute,
|
||||
state.second,
|
||||
tzinfo=dt_util.DEFAULT_TIME_ZONE,
|
||||
)
|
||||
|
||||
async def async_set_value(self, value: datetime) -> None:
|
||||
"""Update the current datetime."""
|
||||
tz_value = value.astimezone(dt_util.DEFAULT_TIME_ZONE)
|
||||
self._client.datetime_command(
|
||||
self._key,
|
||||
tz_value.year,
|
||||
tz_value.month,
|
||||
tz_value.day,
|
||||
tz_value.hour,
|
||||
tz_value.minute,
|
||||
tz_value.second,
|
||||
)
|
|
@ -20,6 +20,7 @@ from aioesphomeapi import (
|
|||
ClimateInfo,
|
||||
CoverInfo,
|
||||
DateInfo,
|
||||
DateTimeInfo,
|
||||
DeviceInfo,
|
||||
EntityInfo,
|
||||
EntityState,
|
||||
|
@ -67,6 +68,7 @@ INFO_TYPE_TO_PLATFORM: dict[type[EntityInfo], Platform] = {
|
|||
ClimateInfo: Platform.CLIMATE,
|
||||
CoverInfo: Platform.COVER,
|
||||
DateInfo: Platform.DATE,
|
||||
DateTimeInfo: Platform.DATETIME,
|
||||
FanInfo: Platform.FAN,
|
||||
LightInfo: Platform.LIGHT,
|
||||
LockInfo: Platform.LOCK,
|
||||
|
|
|
@ -0,0 +1,81 @@
|
|||
"""Test ESPHome datetimes."""
|
||||
|
||||
from unittest.mock import call
|
||||
|
||||
from aioesphomeapi import APIClient, DateTimeInfo, DateTimeState
|
||||
|
||||
from homeassistant.components.datetime import (
|
||||
ATTR_DATETIME,
|
||||
DOMAIN as DATETIME_DOMAIN,
|
||||
SERVICE_SET_VALUE,
|
||||
)
|
||||
from homeassistant.const import ATTR_ENTITY_ID, STATE_UNKNOWN
|
||||
from homeassistant.core import HomeAssistant
|
||||
|
||||
|
||||
async def test_generic_datetime_entity(
|
||||
hass: HomeAssistant,
|
||||
mock_client: APIClient,
|
||||
mock_generic_device_entry,
|
||||
) -> None:
|
||||
"""Test a generic datetime entity."""
|
||||
entity_info = [
|
||||
DateTimeInfo(
|
||||
object_id="mydatetime",
|
||||
key=1,
|
||||
name="my datetime",
|
||||
unique_id="my_datetime",
|
||||
)
|
||||
]
|
||||
states = [
|
||||
DateTimeState(key=1, year=2024, month=4, day=16, hour=12, minute=34, second=56)
|
||||
]
|
||||
user_service = []
|
||||
await mock_generic_device_entry(
|
||||
mock_client=mock_client,
|
||||
entity_info=entity_info,
|
||||
user_service=user_service,
|
||||
states=states,
|
||||
)
|
||||
state = hass.states.get("datetime.test_mydatetime")
|
||||
assert state is not None
|
||||
assert state.state == "2024-04-16T12:34:56+00:00"
|
||||
|
||||
await hass.services.async_call(
|
||||
DATETIME_DOMAIN,
|
||||
SERVICE_SET_VALUE,
|
||||
{
|
||||
ATTR_ENTITY_ID: "datetime.test_mydatetime",
|
||||
ATTR_DATETIME: "2000-01-01 01:23:45",
|
||||
},
|
||||
blocking=True,
|
||||
)
|
||||
mock_client.datetime_command.assert_has_calls([call(1, 2000, 1, 1, 1, 23, 45)])
|
||||
mock_client.datetime_command.reset_mock()
|
||||
|
||||
|
||||
async def test_generic_datetime_missing_state(
|
||||
hass: HomeAssistant,
|
||||
mock_client: APIClient,
|
||||
mock_generic_device_entry,
|
||||
) -> None:
|
||||
"""Test a generic datetime entity with missing state."""
|
||||
entity_info = [
|
||||
DateTimeInfo(
|
||||
object_id="mydatetime",
|
||||
key=1,
|
||||
name="my datetime",
|
||||
unique_id="my_datetime",
|
||||
)
|
||||
]
|
||||
states = [DateTimeState(key=1, missing_state=True)]
|
||||
user_service = []
|
||||
await mock_generic_device_entry(
|
||||
mock_client=mock_client,
|
||||
entity_info=entity_info,
|
||||
user_service=user_service,
|
||||
states=states,
|
||||
)
|
||||
state = hass.states.get("datetime.test_mydatetime")
|
||||
assert state is not None
|
||||
assert state.state == STATE_UNKNOWN
|
Loading…
Reference in New Issue