Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.datetime Namespace Reference

Namespaces

 const
 

Classes

class  DateTimeEntity
 
class  DateTimeEntityDescription
 

Functions

None _async_set_value (DateTimeEntity entity, ServiceCall service_call)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 

Variables

list __all__ = ["ATTR_DATETIME", "DOMAIN", "DateTimeEntity", "DateTimeEntityDescription"]
 
 _LOGGER = logging.getLogger(__name__)
 
dictionary CACHED_PROPERTIES_WITH_ATTR_
 
string ENTITY_ID_FORMAT = DOMAIN + ".{}"
 
 PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA
 
 PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE
 
 SCAN_INTERVAL = timedelta(seconds=30)
 

Detailed Description

Component to allow setting date/time as platforms.

Function Documentation

◆ _async_set_value()

None homeassistant.components.datetime._async_set_value ( DateTimeEntity  entity,
ServiceCall  service_call 
)
private
Service call wrapper to set a new date/time.

Definition at line 35 of file __init__.py.

◆ async_setup()

bool homeassistant.components.datetime.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up Date/Time entities.

Definition at line 43 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.datetime.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set up a config entry.

Definition at line 61 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.datetime.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unload a config entry.

Definition at line 66 of file __init__.py.

Variable Documentation

◆ __all__

list homeassistant.components.datetime.__all__ = ["ATTR_DATETIME", "DOMAIN", "DateTimeEntity", "DateTimeEntityDescription"]
private

Definition at line 32 of file __init__.py.

◆ _LOGGER

homeassistant.components.datetime._LOGGER = logging.getLogger(__name__)
private

Definition at line 23 of file __init__.py.

◆ CACHED_PROPERTIES_WITH_ATTR_

dictionary homeassistant.components.datetime.CACHED_PROPERTIES_WITH_ATTR_
Initial value:
1 = {
2  "native_value",
3 }

Definition at line 75 of file __init__.py.

◆ ENTITY_ID_FORMAT

string homeassistant.components.datetime.ENTITY_ID_FORMAT = DOMAIN + ".{}"

Definition at line 26 of file __init__.py.

◆ PLATFORM_SCHEMA

homeassistant.components.datetime.PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA

Definition at line 27 of file __init__.py.

◆ PLATFORM_SCHEMA_BASE

homeassistant.components.datetime.PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE

Definition at line 28 of file __init__.py.

◆ SCAN_INTERVAL

homeassistant.components.datetime.SCAN_INTERVAL = timedelta(seconds=30)

Definition at line 29 of file __init__.py.