homeassistant.components.input_number Namespace Reference

Namespaces
	reproduce_state

Classes
class	InputNumber
class	NumberStorageCollection

Functions
def	_cv_input_number (cfg)
bool	async_setup (HomeAssistant hass, ConfigType config)

Variables
	_LOGGER = logging.getLogger(__name__)
string	ATTR_INITIAL = "initial"
string	ATTR_MAX = "max"
string	ATTR_MIN = "min"
string	ATTR_STEP = "step"
string	ATTR_VALUE = "value"
string	CONF_INITIAL = "initial"
string	CONF_MAX = "max"
string	CONF_MIN = "min"
string	CONF_STEP = "step"
	CONFIG_SCHEMA
string	DOMAIN = "input_number"
string	MODE_BOX = "box"
string	MODE_SLIDER = "slider"
	RELOAD_SERVICE_SCHEMA = vol.Schema({})
string	SERVICE_DECREMENT = "decrement"
string	SERVICE_INCREMENT = "increment"
string	SERVICE_SET_VALUE = "set_value"
string	STORAGE_KEY = DOMAIN
int	STORAGE_VERSION = 1

Detailed Description

Support to set a numeric value from a slider or text box.

Function Documentation

_cv_input_number()

def homeassistant.components.input_number._cv_input_number (   cfg )

private

Configure validation helper for input number (voluptuous).

Definition at line 53 of file __init__.py.

async_setup()

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

Set up an input slider.

Definition at line 107 of file __init__.py.

Variable Documentation

_LOGGER

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

private

Definition at line 30 of file __init__.py.

ATTR_INITIAL

string homeassistant.components.input_number.ATTR_INITIAL = "initial"

Definition at line 42 of file __init__.py.

ATTR_MAX

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

Definition at line 45 of file __init__.py.

ATTR_MIN

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

Definition at line 44 of file __init__.py.

ATTR_STEP

string homeassistant.components.input_number.ATTR_STEP = "step"

Definition at line 46 of file __init__.py.

ATTR_VALUE

string homeassistant.components.input_number.ATTR_VALUE = "value"

Definition at line 43 of file __init__.py.

CONF_INITIAL

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

Definition at line 34 of file __init__.py.

CONF_MAX

string homeassistant.components.input_number.CONF_MAX = "max"

Definition at line 36 of file __init__.py.

CONF_MIN

string homeassistant.components.input_number.CONF_MIN = "min"

Definition at line 35 of file __init__.py.

CONF_STEP

string homeassistant.components.input_number.CONF_STEP = "step"

Definition at line 37 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.input_number.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {
        DOMAIN: cv.schema_with_slug_keys(
            vol.All(
                {
                    vol.Optional(CONF_NAME): cv.string,
                    vol.Required(CONF_MIN): vol.Coerce(float),
                    vol.Required(CONF_MAX): vol.Coerce(float),
                    vol.Optional(CONF_INITIAL): vol.Coerce(float),
                    vol.Optional(CONF_STEP, default=1): vol.All(
                        vol.Coerce(float), vol.Range(min=1e-9)
                    ),
                    vol.Optional(CONF_ICON): cv.icon,
                    vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string,
                    vol.Optional(CONF_MODE, default=MODE_SLIDER): vol.In(
                        [MODE_BOX, MODE_SLIDER]
                    ),
                },
                _cv_input_number,
            )
        )
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 78 of file __init__.py.

DOMAIN

string homeassistant.components.input_number.DOMAIN = "input_number"

Definition at line 32 of file __init__.py.

MODE_BOX

string homeassistant.components.input_number.MODE_BOX = "box"

Definition at line 40 of file __init__.py.

MODE_SLIDER

string homeassistant.components.input_number.MODE_SLIDER = "slider"

Definition at line 39 of file __init__.py.

RELOAD_SERVICE_SCHEMA

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

Definition at line 102 of file __init__.py.

SERVICE_DECREMENT

string homeassistant.components.input_number.SERVICE_DECREMENT = "decrement"

Definition at line 50 of file __init__.py.

SERVICE_INCREMENT

string homeassistant.components.input_number.SERVICE_INCREMENT = "increment"

Definition at line 49 of file __init__.py.

SERVICE_SET_VALUE

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

Definition at line 48 of file __init__.py.

STORAGE_KEY

string homeassistant.components.input_number.STORAGE_KEY = DOMAIN

Definition at line 103 of file __init__.py.

STORAGE_VERSION

int homeassistant.components.input_number.STORAGE_VERSION = 1

Definition at line 104 of file __init__.py.