Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.input_button Namespace Reference

Classes

class  InputButton
 
class  InputButtonStorageCollection
 

Functions

bool async_setup (HomeAssistant hass, ConfigType config)
 

Variables

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

Detailed Description

Support to keep track of user controlled buttons which can be used in automations.

Function Documentation

◆ async_setup()

bool homeassistant.components.input_button.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up an input button.

Definition at line 76 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.input_button._LOGGER = logging.getLogger(__name__)
private

Definition at line 29 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.input_button.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: cv.schema_with_slug_keys(
4  vol.Any(
5  {
6  vol.Optional(CONF_NAME): cv.string,
7  vol.Optional(CONF_ICON): cv.icon,
8  },
9  None,
10  )
11  )
12  },
13  extra=vol.ALLOW_EXTRA,
14 )

Definition at line 36 of file __init__.py.

◆ DOMAIN

string homeassistant.components.input_button.DOMAIN = "input_button"

Definition at line 27 of file __init__.py.

◆ RELOAD_SERVICE_SCHEMA

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

Definition at line 51 of file __init__.py.

◆ STORAGE_KEY

string homeassistant.components.input_button.STORAGE_KEY = DOMAIN

Definition at line 52 of file __init__.py.

◆ STORAGE_VERSION

int homeassistant.components.input_button.STORAGE_VERSION = 1

Definition at line 53 of file __init__.py.

◆ VolDictType

homeassistant.components.input_button.VolDictType

Definition at line 31 of file __init__.py.