homeassistant.components.mqtt.button Namespace Reference

Classes
class	MqttButton

Functions
None	async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)

Variables
string	CONF_PAYLOAD_PRESS = "payload_press"
string	DEFAULT_NAME = "MQTT Button"
string	DEFAULT_PAYLOAD_PRESS = "PRESS"
	DISCOVERY_SCHEMA = PLATFORM_SCHEMA_MODERN.extend({}, extra=vol.REMOVE_EXTRA)
int	PARALLEL_UPDATES = 0
	PLATFORM_SCHEMA_MODERN

Detailed Description

Support for MQTT buttons.

Function Documentation

async_setup_entry()

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

Set up MQTT button through YAML and through MQTT discovery.

Definition at line 43 of file button.py.

Variable Documentation

CONF_PAYLOAD_PRESS

string homeassistant.components.mqtt.button.CONF_PAYLOAD_PRESS = "payload_press"

Definition at line 25 of file button.py.

DEFAULT_NAME

string homeassistant.components.mqtt.button.DEFAULT_NAME = "MQTT Button"

Definition at line 26 of file button.py.

DEFAULT_PAYLOAD_PRESS

string homeassistant.components.mqtt.button.DEFAULT_PAYLOAD_PRESS = "PRESS"

Definition at line 27 of file button.py.

DISCOVERY_SCHEMA

homeassistant.components.mqtt.button.DISCOVERY_SCHEMA = PLATFORM_SCHEMA_MODERN.extend({}, extra=vol.REMOVE_EXTRA)

Definition at line 40 of file button.py.

PARALLEL_UPDATES

int homeassistant.components.mqtt.button.PARALLEL_UPDATES = 0

Definition at line 23 of file button.py.

PLATFORM_SCHEMA_MODERN

homeassistant.components.mqtt.button.PLATFORM_SCHEMA_MODERN

Initial value:

=  MQTT_BASE_SCHEMA.extend(
    {
        vol.Optional(CONF_COMMAND_TEMPLATE): cv.template,
        vol.Required(CONF_COMMAND_TOPIC): valid_publish_topic,
        vol.Optional(CONF_DEVICE_CLASS): vol.Any(DEVICE_CLASSES_SCHEMA, None),
        vol.Optional(CONF_NAME): vol.Any(cv.string, None),
        vol.Optional(CONF_PAYLOAD_PRESS, default=DEFAULT_PAYLOAD_PRESS): cv.string,
        vol.Optional(CONF_RETAIN, default=DEFAULT_RETAIN): cv.boolean,
    }
).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)

Definition at line 29 of file button.py.