1.0 KiB
1.0 KiB
title | sidebar_label |
---|---|
Time entity | Time |
A time
is an entity that allows the user to input a time to an integration. Derive entity platforms from homeassistant.components.time.TimeEntity
Properties
:::tip
Properties should always only return information from memory and not do I/O (like network requests). Implement update()
or async_update()
to fetch data.
:::
Name | Type | Default | Description |
---|---|---|---|
native_value | time | Required | The value of the time. |
Other properties that are common to all entities such as icon
, name
etc. are also applicable.
Methods
Set value
Called when the user or an automation wants to update the value.
class MyTime(TimeEntity):
# Implement one of these methods.
def set_value(self, value: time) -> None:
"""Update the current value."""
async def async_set_value(self, value: time) -> None:
"""Update the current value."""