mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-22 08:46:30 +00:00
Add datetime
entity developer docs (#1535)
This commit is contained in:
parent
454db1b207
commit
2131bf7bcd
36
docs/core/entity/datetime.md
Normal file
36
docs/core/entity/datetime.md
Normal file
@ -0,0 +1,36 @@
|
||||
---
|
||||
title: Date/Time Entity
|
||||
sidebar_label: Date/Time
|
||||
---
|
||||
|
||||
A `datetime` is an entity that allows the user to input a timestamp to an integration. Derive entity platforms from [`homeassistant.components.datetime.DateTimeEntity`](https://github.com/home-assistant/core/blob/dev/homeassistant/components/datetime/__init__.py)
|
||||
|
||||
## 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 | datetime | **Required** | The value of the datetime. Must include timezone info.
|
||||
|
||||
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. The input datetime will always be in UTC.
|
||||
|
||||
```python
|
||||
class MyDateTime(DateTimeEntity):
|
||||
# Implement one of these methods.
|
||||
|
||||
def set_value(self, value: datetime) -> None:
|
||||
"""Update the current value."""
|
||||
|
||||
async def async_set_value(self, value: datetime) -> None:
|
||||
"""Update the current value."""
|
||||
|
||||
```
|
Loading…
x
Reference in New Issue
Block a user