homeassistant.components.input_boolean Namespace Reference

Namespaces
	reproduce_state

Classes
class	InputBoolean
class	InputBooleanStorageCollection

Functions
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	is_on (HomeAssistant hass, str entity_id)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CONF_INITIAL = "initial"
	CONFIG_SCHEMA
string	DOMAIN = "input_boolean"
	RELOAD_SERVICE_SCHEMA = vol.Schema({})
string	STORAGE_KEY = DOMAIN
int	STORAGE_VERSION = 1
	VolDictType

Detailed Description

Support to keep track of user controlled booleans for within automation.

Function Documentation

async_setup()

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

Set up an input boolean.

Definition at line 91 of file __init__.py.

is_on()

bool homeassistant.components.input_boolean.is_on	(	HomeAssistant	hass,
		str	entity_id
	)

Test if input_boolean is True.

Definition at line 86 of file __init__.py.

Variable Documentation

_LOGGER

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

private

Definition at line 34 of file __init__.py.

CONF_INITIAL

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

Definition at line 36 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.input_boolean.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {
        DOMAIN: cv.schema_with_slug_keys(
            vol.Any(
                {
                    vol.Optional(CONF_NAME): cv.string,
                    vol.Optional(CONF_INITIAL): cv.boolean,
                    vol.Optional(CONF_ICON): cv.icon,
                },
                None,
            )
        )
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 44 of file __init__.py.

DOMAIN

string homeassistant.components.input_boolean.DOMAIN = "input_boolean"

Definition at line 32 of file __init__.py.

RELOAD_SERVICE_SCHEMA

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

Definition at line 60 of file __init__.py.

STORAGE_KEY

string homeassistant.components.input_boolean.STORAGE_KEY = DOMAIN

Definition at line 61 of file __init__.py.

STORAGE_VERSION

int homeassistant.components.input_boolean.STORAGE_VERSION = 1

Definition at line 62 of file __init__.py.

VolDictType

homeassistant.components.input_boolean.VolDictType

Definition at line 38 of file __init__.py.