homeassistant.components.template.button Namespace Reference

Classes
class	TemplateButtonEntity

Functions
list[TemplateButtonEntity]	_async_create_entities (HomeAssistant hass, list[dict[str, Any]] definitions, str|None unique_id_prefix)
None	async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
None	async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)
tuple	BUTTON_SCHEMA
	CONFIG_BUTTON_SCHEMA
string	DEFAULT_NAME = "Template Button"
bool	DEFAULT_OPTIMISTIC = False

Detailed Description

Support for buttons which integrates with other components.

Function Documentation

_async_create_entities()

list[TemplateButtonEntity] homeassistant.components.template.button._async_create_entities ( HomeAssistant  hass, list[dict[str, Any]]  definitions, str | None   unique_id_prefix  )

private

Create the Template button.

Definition at line 61 of file button.py.

async_setup_entry()

None homeassistant.components.template.button.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry,
		AddEntitiesCallback	async_add_entities
	)

Initialize config entry.

Definition at line 93 of file button.py.

async_setup_platform()

None homeassistant.components.template.button.async_setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	async_add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up the template button.

Definition at line 74 of file button.py.

Variable Documentation

_LOGGER

homeassistant.components.template.button._LOGGER = logging.getLogger(__name__)

private

Definition at line 33 of file button.py.

BUTTON_SCHEMA

tuple homeassistant.components.template.button.BUTTON_SCHEMA

Initial value:

=  (
    vol.Schema(
        {
            vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.template,
            vol.Required(CONF_PRESS): cv.SCRIPT_SCHEMA,
            vol.Optional(CONF_DEVICE_CLASS): DEVICE_CLASSES_SCHEMA,
            vol.Optional(CONF_UNIQUE_ID): cv.string,
        }
    )
    .extend(TEMPLATE_ENTITY_AVAILABILITY_SCHEMA.schema)
    .extend(TEMPLATE_ENTITY_ICON_SCHEMA.schema)
)

Definition at line 38 of file button.py.

CONFIG_BUTTON_SCHEMA

homeassistant.components.template.button.CONFIG_BUTTON_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Optional(CONF_NAME): cv.template,
        vol.Optional(CONF_PRESS): cv.SCRIPT_SCHEMA,
        vol.Optional(CONF_DEVICE_CLASS): DEVICE_CLASSES_SCHEMA,
        vol.Optional(CONF_DEVICE_ID): selector.DeviceSelector(),
    }
)

Definition at line 51 of file button.py.

DEFAULT_NAME

string homeassistant.components.template.button.DEFAULT_NAME = "Template Button"

Definition at line 35 of file button.py.

DEFAULT_OPTIMISTIC

bool homeassistant.components.template.button.DEFAULT_OPTIMISTIC = False

Definition at line 36 of file button.py.