homeassistant.components.input_text Namespace Reference

Namespaces
	reproduce_state

Classes
class	InputText
class	InputTextStorageCollection

Functions
dict[str, Any]	_cv_input_text (dict[str, Any] config)
bool	async_setup (HomeAssistant hass, ConfigType config)

Variables
	_LOGGER = logging.getLogger(__name__)
string	ATTR_MAX = "max"
string	ATTR_MIN = "min"
string	ATTR_PATTERN = CONF_PATTERN
string	ATTR_VALUE = CONF_VALUE
string	CONF_INITIAL = "initial"
string	CONF_MAX = "max"
int	CONF_MAX_VALUE = 100
string	CONF_MIN = "min"
int	CONF_MIN_VALUE = 0
	CONF_MODE
string	CONF_PATTERN = "pattern"
string	CONF_VALUE = "value"
	CONFIG_SCHEMA
	default
string	DOMAIN = "input_text"
string	MODE_PASSWORD = "password"
string	MODE_TEXT = "text"
	RELOAD_SERVICE_SCHEMA = vol.Schema({})
string	SERVICE_SET_VALUE = "set_value"
string	STORAGE_KEY = DOMAIN
int	STORAGE_VERSION = 1
	VolDictType

Detailed Description

Support to enter a value into a text box.

Function Documentation

_cv_input_text()

dict[str, Any] homeassistant.components.input_text._cv_input_text ( dict[str, Any]  config )

private

Configure validation helper for input box (voluptuous).

Definition at line 65 of file __init__.py.

async_setup()

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

Set up an input text.

Definition at line 107 of file __init__.py.

Variable Documentation

_LOGGER

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

private

Definition at line 29 of file __init__.py.

ATTR_MAX

string homeassistant.components.input_text.ATTR_MAX = "max"

Definition at line 46 of file __init__.py.

ATTR_MIN

string homeassistant.components.input_text.ATTR_MIN = "min"

Definition at line 45 of file __init__.py.

ATTR_PATTERN

string homeassistant.components.input_text.ATTR_PATTERN = CONF_PATTERN

Definition at line 47 of file __init__.py.

ATTR_VALUE

string homeassistant.components.input_text.ATTR_VALUE = CONF_VALUE

Definition at line 44 of file __init__.py.

CONF_INITIAL

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

Definition at line 33 of file __init__.py.

CONF_MAX

homeassistant.components.input_text.CONF_MAX = "max"

Definition at line 36 of file __init__.py.

CONF_MAX_VALUE

int homeassistant.components.input_text.CONF_MAX_VALUE = 100

Definition at line 37 of file __init__.py.

CONF_MIN

homeassistant.components.input_text.CONF_MIN = "min"

Definition at line 34 of file __init__.py.

CONF_MIN_VALUE

int homeassistant.components.input_text.CONF_MIN_VALUE = 0

Definition at line 35 of file __init__.py.

CONF_MODE

homeassistant.components.input_text.CONF_MODE

Definition at line 61 of file __init__.py.

CONF_PATTERN

string homeassistant.components.input_text.CONF_PATTERN = "pattern"

Definition at line 38 of file __init__.py.

CONF_VALUE

string homeassistant.components.input_text.CONF_VALUE = "value"

Definition at line 39 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.input_text.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {
        DOMAIN: cv.schema_with_slug_keys(
            vol.All(
                lambda value: value or {},
                {
                    vol.Optional(CONF_NAME): cv.string,
                    vol.Optional(CONF_MIN, default=CONF_MIN_VALUE): vol.Coerce(int),
                    vol.Optional(CONF_MAX, default=CONF_MAX_VALUE): vol.Coerce(int),
                    vol.Optional(CONF_INITIAL): cv.string,
                    vol.Optional(CONF_ICON): cv.icon,
                    vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string,
                    vol.Optional(CONF_PATTERN): cv.string,
                    vol.Optional(CONF_MODE, default=MODE_TEXT): vol.In(
                        [MODE_TEXT, MODE_PASSWORD]
                    ),
                },
                _cv_input_text,
            ),
        )
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 81 of file __init__.py.

default

homeassistant.components.input_text.default

Definition at line 55 of file __init__.py.

DOMAIN

string homeassistant.components.input_text.DOMAIN = "input_text"

Definition at line 31 of file __init__.py.

MODE_PASSWORD

string homeassistant.components.input_text.MODE_PASSWORD = "password"

Definition at line 42 of file __init__.py.

MODE_TEXT

string homeassistant.components.input_text.MODE_TEXT = "text"

Definition at line 41 of file __init__.py.

RELOAD_SERVICE_SCHEMA

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

Definition at line 104 of file __init__.py.

SERVICE_SET_VALUE

string homeassistant.components.input_text.SERVICE_SET_VALUE = "set_value"

Definition at line 49 of file __init__.py.

STORAGE_KEY

string homeassistant.components.input_text.STORAGE_KEY = DOMAIN

Definition at line 50 of file __init__.py.

STORAGE_VERSION

int homeassistant.components.input_text.STORAGE_VERSION = 1

Definition at line 51 of file __init__.py.

VolDictType

homeassistant.components.input_text.VolDictType

Definition at line 53 of file __init__.py.