homeassistant.components.input_datetime Namespace Reference

Namespaces
	reproduce_state

Classes
class	DateTimeStorageCollection
class	InputDatetime

Functions
bool	async_setup (HomeAssistant hass, ConfigType config)
def	has_date_or_time (conf)
py_datetime.datetime	parse_initial_datetime (dict[str, Any] conf)
dict[str, Any]	valid_initial (dict[str, Any] conf)
def	validate_set_datetime_attrs (config)

Variables
	_LOGGER = logging.getLogger(__name__)
string	ATTR_DATETIME = "datetime"
string	ATTR_TIMESTAMP = "timestamp"
string	CONF_HAS_DATE = "has_date"
string	CONF_HAS_TIME = "has_time"
string	CONF_INITIAL = "initial"
	CONFIG_SCHEMA
	default
	DEFAULT_TIME = py_datetime.time(0, 0, 0)
string	DOMAIN = "input_datetime"
string	FMT_DATE = "%Y-%m-%d"
string	FMT_DATETIME = f"{FMT_DATE} {FMT_TIME}"
string	FMT_TIME = "%H:%M:%S"
	RELOAD_SERVICE_SCHEMA = vol.Schema({})
string	STORAGE_KEY = DOMAIN
int	STORAGE_VERSION = 1
	VolDictType

Detailed Description

Support to select a date and/or a time.

Function Documentation

async_setup()

bool homeassistant.components.input_datetime.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up an input datetime.

Definition at line 129 of file __init__.py.

has_date_or_time()

def homeassistant.components.input_datetime.has_date_or_time

(

conf

)

Check at least date or time is true.

Definition at line 71 of file __init__.py.

parse_initial_datetime()

py_datetime.datetime homeassistant.components.input_datetime.parse_initial_datetime

(

dict[str, Any]

conf

)

Check the initial value is valid.

Definition at line 89 of file __init__.py.

valid_initial()

dict[str, Any] homeassistant.components.input_datetime.valid_initial

(

dict[str, Any]

conf

)

Check the initial value is valid.

Definition at line 79 of file __init__.py.

validate_set_datetime_attrs()

def homeassistant.components.input_datetime.validate_set_datetime_attrs

(

config

)

Validate set_datetime service attributes.

Definition at line 48 of file __init__.py.

Variable Documentation

_LOGGER

homeassistant.components.input_datetime._LOGGER = logging.getLogger(__name__)

private

Definition at line 30 of file __init__.py.

ATTR_DATETIME

string homeassistant.components.input_datetime.ATTR_DATETIME = "datetime"

Definition at line 40 of file __init__.py.

ATTR_TIMESTAMP

string homeassistant.components.input_datetime.ATTR_TIMESTAMP = "timestamp"

Definition at line 41 of file __init__.py.

CONF_HAS_DATE

homeassistant.components.input_datetime.CONF_HAS_DATE = "has_date"

Definition at line 34 of file __init__.py.

CONF_HAS_TIME

homeassistant.components.input_datetime.CONF_HAS_TIME = "has_time"

Definition at line 35 of file __init__.py.

CONF_INITIAL

string homeassistant.components.input_datetime.CONF_INITIAL = "initial"

Definition at line 36 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.input_datetime.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {
        DOMAIN: cv.schema_with_slug_keys(
            vol.All(
                {
                    vol.Optional(CONF_NAME): cv.string,
                    vol.Optional(CONF_HAS_DATE, default=False): cv.boolean,
                    vol.Optional(CONF_HAS_TIME, default=False): cv.boolean,
                    vol.Optional(CONF_ICON): cv.icon,
                    vol.Optional(CONF_INITIAL): cv.string,
                },
                has_date_or_time,
                valid_initial,
            )
        )
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 108 of file __init__.py.

default

homeassistant.components.input_datetime.default

Definition at line 64 of file __init__.py.

DEFAULT_TIME

homeassistant.components.input_datetime.DEFAULT_TIME = py_datetime.time(0, 0, 0)

Definition at line 38 of file __init__.py.

DOMAIN

string homeassistant.components.input_datetime.DOMAIN = "input_datetime"

Definition at line 32 of file __init__.py.

FMT_DATE

string homeassistant.components.input_datetime.FMT_DATE = "%Y-%m-%d"

Definition at line 43 of file __init__.py.

FMT_DATETIME

string homeassistant.components.input_datetime.FMT_DATETIME = f"{FMT_DATE} {FMT_TIME}"

Definition at line 45 of file __init__.py.

FMT_TIME

string homeassistant.components.input_datetime.FMT_TIME = "%H:%M:%S"

Definition at line 44 of file __init__.py.

RELOAD_SERVICE_SCHEMA

homeassistant.components.input_datetime.RELOAD_SERVICE_SCHEMA = vol.Schema({})

Definition at line 126 of file __init__.py.

STORAGE_KEY

string homeassistant.components.input_datetime.STORAGE_KEY = DOMAIN

Definition at line 59 of file __init__.py.

STORAGE_VERSION

int homeassistant.components.input_datetime.STORAGE_VERSION = 1

Definition at line 60 of file __init__.py.

VolDictType

homeassistant.components.input_datetime.VolDictType

Definition at line 62 of file __init__.py.