mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-23 18:46:50 +00:00

* States: add unavailable and unknown * rephrase intro * Make states lowercase * Update source/_integrations/humidifier.markdown Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com> * Revert "Make states lowercase" This reverts commit daf7f06630c4a2cc1f7e7fe5d043d9754a79cd1d. * Apply bold to the UI string of state names * Climate: fix grammar --------- Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>
48 lines
1.9 KiB
Markdown
48 lines
1.9 KiB
Markdown
---
|
|
title: Date/Time
|
|
description: Instructions on how to set up date/time entities within Home Assistant.
|
|
ha_category:
|
|
- Date/Time
|
|
ha_release: '2023.6'
|
|
ha_domain: datetime
|
|
ha_quality_scale: internal
|
|
ha_codeowners:
|
|
- '@home-assistant/core'
|
|
ha_integration_type: entity
|
|
---
|
|
|
|
The **Date/Time** {% term integration %} is built for the controlling and monitoring of timestamps on devices.
|
|
|
|
{% include integrations/building_block_integration.md %}
|
|
|
|
If you are looking for a way to create a Date/Time entity, please take a look at the [Date/Time helper](/integrations/input_datetime).
|
|
|
|
## The state of a date/time entity
|
|
|
|
The state of a date/time entity is the actual date and time value.
|
|
|
|
<p class='img'>
|
|
<img src='/images/integrations/datetime/state_datetime.png' alt='Screenshot showing the state of a date/time entity in the developer tools' />
|
|
Screenshot showing the state of a date/time entity in the developer tools. In the example shown, the state is January 1, 2020 at 12:00 in the format YYYY-MM-DD T HH:MM:SS.
|
|
</p>
|
|
|
|
In addition, the entity can have the following states:
|
|
|
|
- **Unavailable**: The entity is currently unavailable.
|
|
- **Unknown**: The state is not yet known.
|
|
|
|
## Actions
|
|
|
|
### datetime actions
|
|
|
|
Available {% term actions %}: `datetime.set_value`
|
|
|
|
### Action `datetime.set_value`
|
|
|
|
Set a new value for the datetime {% term entity %}.
|
|
|
|
| Data attribute | Optional | Description |
|
|
| -------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
|
|
| `entity_id` | no | String or list of strings that point at `entity_id`'s of datetimes to control. |
|
|
| `datetime` | no | New datetime value to set. If timezone is not included, the Home Assistant instance's timezone will be used. |
|